Skip to content

Commit

Permalink
[DOCS] Update version tables
Browse files Browse the repository at this point in the history
  • Loading branch information
polyfractal committed Nov 14, 2017
1 parent c71524c commit b824bb7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 28 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,14 @@ Version Matrix

| Elasticsearch Version | Elasticsearch-PHP Branch |
| --------------------- | ------------------------ |
| >= 5.0 | 5.0 |
| >= 6.0 | 6.0 |
| >= 5.0, < 6.0 | 5.0 |
| >= 2.0, < 5.0 | 1.0 or 2.0 |
| >= 1.0, < 2.0 | 1.0 or 2.0 |
| <= 0.90.x | 0.4 |

- If you are using Elasticsearch 5.0+ , use Elasticsearch-PHP 5.0 branch.
- If you are using Elasticsearch 6.0+ , use Elasticsearch-PHP 6.0 branch.
- If you are using Elasticsearch 5.x , use Elasticsearch-PHP 5.0 branch.
- If you are using Elasticsearch 1.x or 2.x, prefer using the Elasticsearch-PHP 2.0 branch. The 1.0 branch is compatible however.
- If you are using a version older than 1.0, you must install the `0.4` Elasticsearch-PHP branch. Since ES 0.90.x and below is now EOL, the corresponding `0.4` branch will not receive any more development or bugfixes. Please upgrade.
- You should never use Elasticsearch-PHP Master branch, as it tracks Elasticearch master and may contain incomplete features or breaks in backwards compat. Only use ES-PHP master if you are developing against ES master for some reason.
Expand All @@ -48,7 +50,7 @@ The recommended method to install _Elasticsearch-PHP_ is through [Composer](http
```json
{
"require": {
"elasticsearch/elasticsearch": "~5.0"
"elasticsearch/elasticsearch": "~6.0"
}
}
```
Expand Down Expand Up @@ -82,11 +84,12 @@ You can find out more on how to install Composer, configure autoloading, and oth

PHP Version Requirement
----
Version 5.0 of this library requires at least PHP version 5.6.6 to function. In addition, it requires the native JSON
Version 6.0 of this library requires at least PHP version 7.0.0 to function. In addition, it requires the native JSON
extension to be version 1.3.7 or higher.

| Elasticsearch-PHP Branch | PHP Version |
| ----------- | ------------------------ |
| 6.0 | >= 7.0.0 |
| 5.0 | >= 5.6.6 |
| 2.0 | >= 5.4.0 |
| 0.4, 1.0 | >= 5.3.9 |
Expand Down
22 changes: 1 addition & 21 deletions docs/breaking-changes.asciidoc
Original file line number Diff line number Diff line change
@@ -1,21 +1 @@
== Breaking changes from 2.x

- 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)
- Warmers have been removed because they are no longer useful
- Indices/Optimize Endpoint has been removed (use `_forcemerge` instead)
- MoreLikeThis (MLT) endpoint has been removed
- DeleteByQuery endpoint has been removed.
- Tasks/List and Tasks/Get are now separate endpoints (see: link:http://github.com/elasticsearch/elasticsearch-php/commit/752d5a2[e0cc5f9])
- 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 link:http://github.com/elasticsearch/elasticsearch-php/commit/b1a27b7[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 link:http://github.com/elasticsearch/elasticsearch-php/commit/ecd454c[ecd454c])
- To facilitate testing and other features, the `ConnectionInterface` has expanded to obtain some more methods (link:http://github.com/elasticsearch/elasticsearch-php/commit/8bcf1a8[getPath()], link:http://github.com/elasticsearch/elasticsearch-php/commit/586fbdb[getUserPass()], link:http://github.com/elasticsearch/elasticsearch-php/commit/445fdea[getHost()])
== Breaking changes from 5.x
7 changes: 4 additions & 3 deletions docs/installation.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Elasticsearch-php only has a three requirements that you need to worry about:

* PHP 5.6.6 or higher
* PHP 7.0.0 or higher
* http://getcomposer.org[Composer]
* http://php.net/manual/en/book.curl.php[ext-curl]: the Libcurl extension for PHP (see note below)
* Native JSON Extensions (`ext-json`) 1.3.7 or higher
Expand All @@ -26,7 +26,8 @@ The master branch will always track Elasticsearch master, but it is not recommen
[width="40%",options="header",frame="topbot"]
|============================
|Elasticsearch Version | Elasticsearch-PHP Branch
| >= 5.0 | `5.0`
| >= 6.0 | `6.0`
| >= 5.0, <= 6.0 | `5.0`
| >= 1.0, <= 5.0 | `1.0`, `2.0`
| <= 0.90.* | `0.4`
|============================
Expand All @@ -39,7 +40,7 @@ The master branch will always track Elasticsearch master, but it is not recommen
--------------------------
{
"require": {
"elasticsearch/elasticsearch": "~5.0"
"elasticsearch/elasticsearch": "~6.0"
}
}
--------------------------
Expand Down

0 comments on commit b824bb7

Please sign in to comment.