Skip to content

Commit

Permalink
Upgrade notes.
Browse files Browse the repository at this point in the history
  • Loading branch information
olsgreen committed May 23, 2021
1 parent 3843c5d commit 3a58e49
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@
[![License](https://poser.pugx.org/boxed-code/laravel-scout-elasticsearch/license)](https://packagist.org/packages/boxed-code/laravel-scout-elasticsearch)
[![Tests](https://github.com/boxed-code/laravel-scout-elasticsearch/actions/workflows/run_tests.yml/badge.svg)](https://github.com/boxed-code/laravel-scout-elasticsearch/actions/workflows/run_tests.yml)

A basic [elastic](https://www.elastic.co/products/elasticsearch) search backed driver [for Laravel Scout](https://laravel.com/docs/6.0/scout).
A basic [elastic](https://www.elastic.co/products/elasticsearch) search backed driver [for Laravel Scout](https://laravel.com/docs/8.0/scout).

This driver has a simple configuration, requiring you to set the hostname of your elasticsearch node.

Note that this driver uses a separate index for each model type as elasticsearch mapping types have been deprecated in elasticsearch 6.0 and will be removed in 8.0, for more information see https://bit.ly/2TZVZvq.

By default, the driver uses the `simple_query_string` full text parser with `and` as the default operator. More information on the functionality & syntax of this query format can be found [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html).

**Requires Scout ^7.0 or ^8.0, Laravel >=5.4 & PHP >=7.0**. Based on the original work of [ErickTamayo](https://github.com/ErickTamayo/laravel-scout-elastic)
**Requires Scout ^8.0 or ^9.0 & PHP >=7.2**. Based on the original work of [ErickTamayo](https://github.com/ErickTamayo/laravel-scout-elastic)
(Scout 5/6/7 & elastic search server 5.x are supported by versions of 1.x)

## Contents

- [Installation](#installation)
- [Upgrading from 1.x --> 2.x](#upgrading-from-1x---2x)
- [Usage](#usage)
- [Credits](#credits)
- [License](#license)
Expand Down Expand Up @@ -60,6 +62,14 @@ Add the following to your scout configuration:
...
```

## Upgrading from 1.x -> 2.x

If you are upgrading from 1.x -> 2.x and are using an elastic server version < 7.x you will need to constrain the version of the base elastic driver used in your composer.json. For example if you're running 6.x:

composer require elasticsearch/elasticsearch:^6.0

** Remember: When you upgrade your server version to 7.x you will need to remove the package or upgrade it to the 7.x driver. **

## Usage

Now you can use Laravel Scout as described in the [official documentation](https://laravel.com/docs/5.8/scout)
Expand Down

0 comments on commit 3a58e49

Please sign in to comment.