Skip to content

Commit 6fb6421

Browse files
committed
[DOCS] 5.0 doc updates, readme, breaking changes
1 parent 30be1c0 commit 6fb6421

File tree

5 files changed

+28
-18
lines changed

5 files changed

+28
-18
lines changed

BREAKING_CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- MoreLikeThis (MLT) endpoint has been removed
1010
- DeleteByQuery endpoint has been removed.
1111
- Tasks/List and Tasks/Get are now separate endpoints (see: [[e0cc5f9]](http://github.com/elasticsearch/elasticsearch-php/commit/752d5a2))
12+
- Client requires PHP 5.6.6 or higher
1213

1314
## Deprecations
1415

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The recommended method to install _Elasticsearch-PHP_ is through [Composer](http
4848
```json
4949
{
5050
"require": {
51-
"elasticsearch/elasticsearch": "~2.0"
51+
"elasticsearch/elasticsearch": "~5.0"
5252
}
5353
}
5454
```
@@ -90,7 +90,7 @@ eventually stop being supported.
9090

9191
| PHP Version | Elasticsearch-PHP Branch |
9292
| ----------- | ------------------------ |
93-
| >= 5.6.6 | Dev-Master |
93+
| >= 5.6.6 | 5.0 |
9494
| >= 5.4.0 | 2.0 |
9595
| >= 5.3.9 | 0.4, 1.0 |
9696

docs/breaking-changes.asciidoc

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
1+
== Breaking changes from 2.x
12

2-
== Breaking changes from 1.x
3-
4-
- The client now requires PHP version 5.4 or higher
5-
- The entire client configuration and initialization system has changed to a builder pattern. Please see
6-
link:_configuration.html[Configuration] for more details
7-
- Notably, `GuzzleConnection` and `CurlMultiConnection` have been removed. If your code relied on these classes specifically,
8-
or configured cURL options explicitly, please see the docs about how the new HTTP handler functions
9-
- The client no longer ships with a default logger, and Monolog has been moved to "suggest". Please see
10-
<<enabling_logger>> for details on how to use Monolog (or equivalent PSR/Log implementation)
11-
- `custom` parameters are now part of the `client` options (e.g. `['client' => ['custom' => 'abc'] ]`)
12-
- Exception ignoring is now now part of the `client` options (e.g. `['client' => ['ignore' => 404] ]`)
3+
- Indices/Analyze Endpoint: `filters` and `char_filters` URI parameters have renamed to `filter` and `char_filter` respectively
4+
- SearchExists endpoint has been removed ([use `size=0` and `terminate_after=1` instead](https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_50_search_changes.html#_search_exists_api_removed))
5+
- Warmers have been removed because they are [no longer useful](https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_50_index_apis.html#_warmers)
6+
- Indices/Optimize Endpoint has been removed ([use `_forcemerge` instead](https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_50_rest_api_changes.html#_literal__optimize_literal_endpoint_removed))
7+
- MoreLikeThis (MLT) endpoint has been removed
8+
- DeleteByQuery endpoint has been removed.
9+
- Tasks/List and Tasks/Get are now separate endpoints (see: [[e0cc5f9]](http://github.com/elasticsearch/elasticsearch-php/commit/752d5a2))
10+
- Client requires PHP 5.6.6 or higher
11+
12+
=== Deprecations
13+
14+
- Percolator endpoints are deprecated and will be removed in Elasticsearch 6.0
15+
16+
=== Internal BWC Breaks
17+
18+
- Namespace injection has changed slightly. If you use custom namespaces, you'll need to update your code (see: Add better ability to inject namespaces [[b1a27b7]](http://github.com/elasticsearch/elasticsearch-php/commit/b1a27b7))
19+
- Endpoints no longer use the Transport directly. If you use custom endpoints, you'll need to do some minor
20+
refactoring (see: Refactor to remove Transport dependence in endpoints [[ecd454c]](http://github.com/elasticsearch/elasticsearch-php/commit/ecd454c))
21+
- To facilitate testing and other features, the `ConnectionInterface` has expanded to obtain some more methods ([[getPath()]](http://github.com/elasticsearch/elasticsearch-php/commit/8bcf1a8), [[getUserPass()]](http://github.com/elasticsearch/elasticsearch-php/commit/586fbdb), [[getHost()]](http://github.com/elasticsearch/elasticsearch-php/commit/445fdea))

docs/installation.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ alternate HTTP handler based on PHP streams. Performance _will_ suffer, as the
1818

1919
=== Version Matrix
2020

21-
Since there are breaking changes in Elasticsearch 1.0, you need to match your version of Elasticsearch to the appropriate version of this library.
22-
If you are using a version older than 1.0, you must install the `0.4` Elasticsearch-PHP branch. Otherwise, use the `2.0` branch.
21+
You need to match your version of Elasticsearch to the appropriate version of this library.
2322

2423
The master branch will always track Elasticsearch master, but it is not recommended to use `dev-master` in your production code.
2524

2625
[width="40%",options="header",frame="topbot"]
2726
|============================
2827
|Elasticsearch Version | Elasticsearch-PHP Branch
29-
| >= 1.0 | `1.0`, `2.0`
28+
| >= 5.0 | `5.0`
29+
| >= 1.0, <= 5.0 | `1.0`, `2.0`
3030
| <= 0.90.* | `0.4`
3131
|============================
3232

@@ -38,7 +38,7 @@ The master branch will always track Elasticsearch master, but it is not recommen
3838
--------------------------
3939
{
4040
"require": {
41-
"elasticsearch/elasticsearch": "~2.0@beta"
41+
"elasticsearch/elasticsearch": "~5.0"
4242
}
4343
}
4444
--------------------------

docs/quickstart.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This section will give you a quick overview of the client and how the major func
1111
----------------------------
1212
{
1313
"require": {
14-
"elasticsearch/elasticsearch": "~2.0"
14+
"elasticsearch/elasticsearch": "~5.0"
1515
}
1616
}
1717
----------------------------

0 commit comments

Comments
 (0)