Skip to content

Commit

Permalink
[DOCS] 5.0 doc updates, readme, breaking changes
Browse files Browse the repository at this point in the history
  • Loading branch information
polyfractal committed Oct 26, 2016
1 parent 30be1c0 commit 6fb6421
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 18 deletions.
1 change: 1 addition & 0 deletions BREAKING_CHANGES.md
Expand Up @@ -9,6 +9,7 @@
- MoreLikeThis (MLT) endpoint has been removed
- DeleteByQuery endpoint has been removed.
- Tasks/List and Tasks/Get are now separate endpoints (see: [[e0cc5f9]](http://github.com/elasticsearch/elasticsearch-php/commit/752d5a2))
- Client requires PHP 5.6.6 or higher

## Deprecations

Expand Down
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -48,7 +48,7 @@ The recommended method to install _Elasticsearch-PHP_ is through [Composer](http
```json
{
"require": {
"elasticsearch/elasticsearch": "~2.0"
"elasticsearch/elasticsearch": "~5.0"
}
}
```
Expand Down Expand Up @@ -90,7 +90,7 @@ eventually stop being supported.

| PHP Version | Elasticsearch-PHP Branch |
| ----------- | ------------------------ |
| >= 5.6.6 | Dev-Master |
| >= 5.6.6 | 5.0 |
| >= 5.4.0 | 2.0 |
| >= 5.3.9 | 0.4, 1.0 |

Expand Down
31 changes: 20 additions & 11 deletions docs/breaking-changes.asciidoc
@@ -1,12 +1,21 @@
== Breaking changes from 2.x

== Breaking changes from 1.x

- The client now requires PHP version 5.4 or higher
- The entire client configuration and initialization system has changed to a builder pattern. Please see
link:_configuration.html[Configuration] for more details
- Notably, `GuzzleConnection` and `CurlMultiConnection` have been removed. If your code relied on these classes specifically,
or configured cURL options explicitly, please see the docs about how the new HTTP handler functions
- The client no longer ships with a default logger, and Monolog has been moved to "suggest". Please see
<<enabling_logger>> for details on how to use Monolog (or equivalent PSR/Log implementation)
- `custom` parameters are now part of the `client` options (e.g. `['client' => ['custom' => 'abc'] ]`)
- Exception ignoring is now now part of the `client` options (e.g. `['client' => ['ignore' => 404] ]`)
- Indices/Analyze Endpoint: `filters` and `char_filters` URI parameters have renamed to `filter` and `char_filter` respectively
- 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))
- 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)
- 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))
- MoreLikeThis (MLT) endpoint has been removed
- DeleteByQuery endpoint has been removed.
- Tasks/List and Tasks/Get are now separate endpoints (see: [[e0cc5f9]](http://github.com/elasticsearch/elasticsearch-php/commit/752d5a2))
- Client requires PHP 5.6.6 or higher
=== Deprecations
- Percolator endpoints are deprecated and will be removed in Elasticsearch 6.0
=== Internal BWC Breaks
- 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))
- Endpoints no longer use the Transport directly. If you use custom endpoints, you'll need to do some minor
refactoring (see: Refactor to remove Transport dependence in endpoints [[ecd454c]](http://github.com/elasticsearch/elasticsearch-php/commit/ecd454c))
- 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))
8 changes: 4 additions & 4 deletions docs/installation.asciidoc
Expand Up @@ -18,15 +18,15 @@ alternate HTTP handler based on PHP streams. Performance _will_ suffer, as the

=== Version Matrix

Since there are breaking changes in Elasticsearch 1.0, you need to match your version of Elasticsearch to the appropriate version of this library.
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.
You need to match your version of Elasticsearch to the appropriate version of this library.

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

[width="40%",options="header",frame="topbot"]
|============================
|Elasticsearch Version | Elasticsearch-PHP Branch
| >= 1.0 | `1.0`, `2.0`
| >= 5.0 | `5.0`
| >= 1.0, <= 5.0 | `1.0`, `2.0`
| <= 0.90.* | `0.4`
|============================

Expand All @@ -38,7 +38,7 @@ The master branch will always track Elasticsearch master, but it is not recommen
--------------------------
{
"require": {
"elasticsearch/elasticsearch": "~2.0@beta"
"elasticsearch/elasticsearch": "~5.0"
}
}
--------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.asciidoc
Expand Up @@ -11,7 +11,7 @@ This section will give you a quick overview of the client and how the major func
----------------------------
{
"require": {
"elasticsearch/elasticsearch": "~2.0"
"elasticsearch/elasticsearch": "~5.0"
}
}
----------------------------
Expand Down

0 comments on commit 6fb6421

Please sign in to comment.