Skip to content

Commit 3a58e49

Browse files
committed
Upgrade notes.
1 parent 3843c5d commit 3a58e49

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,21 @@
44
[![License](https://poser.pugx.org/boxed-code/laravel-scout-elasticsearch/license)](https://packagist.org/packages/boxed-code/laravel-scout-elasticsearch)
55
[![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)
66

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

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

1111
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.
1212

1313
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).
1414

15-
**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)
15+
**Requires Scout ^8.0 or ^9.0 & PHP >=7.2**. Based on the original work of [ErickTamayo](https://github.com/ErickTamayo/laravel-scout-elastic)
16+
(Scout 5/6/7 & elastic search server 5.x are supported by versions of 1.x)
1617

1718
## Contents
1819

1920
- [Installation](#installation)
21+
- [Upgrading from 1.x --> 2.x](#upgrading-from-1x---2x)
2022
- [Usage](#usage)
2123
- [Credits](#credits)
2224
- [License](#license)
@@ -60,6 +62,14 @@ Add the following to your scout configuration:
6062
...
6163
```
6264

65+
## Upgrading from 1.x -> 2.x
66+
67+
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:
68+
69+
composer require elasticsearch/elasticsearch:^6.0
70+
71+
** 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. **
72+
6373
## Usage
6474

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

0 commit comments

Comments
 (0)