forked from elastic/elasticsearch-php
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated the Client version to 7.4.0 + updated docs
- Loading branch information
Showing
7 changed files
with
182 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
[[experimental_and_beta_apis]] | ||
== Experimental and beta APIs | ||
|
||
The PHP client offers also `experimental` and `beta` APIs for Elasticsearch. | ||
|
||
The Elasticsearch API are marked using the following convention: | ||
|
||
- **Stable** APIs should be safe to use extensively in production. | ||
Any breaking changes to these APIs should only occur in major versions and | ||
will be clearly documented in the breaking changes documentation for that | ||
release. | ||
- **Beta** APIs are on track to become stable and permanent features. | ||
Caution should be exercised in their use since it is possible we’d have to make | ||
a breaking change to these APIs in a minor version, but we’ll avoid this | ||
wherever possible. | ||
- **Experimental** APIs are just that - an experiment. An experimental API might | ||
have breaking changes in any future version, or it might even be removed | ||
entirely. | ||
|
||
All the `experimental` and `beta` APIs are marked with a `@note` tag in the | ||
phpdoc section of the code. | ||
|
||
=== Experimental | ||
|
||
The experimental APIs included in the current version of `elasticsearch-php` are: | ||
|
||
- [Ranking Evaluation](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/search-rank-eval.html) | ||
|
||
[source,php] | ||
---- | ||
$client = ClientBuilder::create()->build(); | ||
$params = [ | ||
// ... | ||
]; | ||
$result = $client->rankEval($params); | ||
---- | ||
|
||
- [Painless Execute](https://www.elastic.co/guide/en/elasticsearch/painless/7.4/painless-execute-api.html) | ||
|
||
[source,php] | ||
---- | ||
$client = ClientBuilder::create()->build(); | ||
$params = [ | ||
// ... | ||
]; | ||
$result = $client->scriptsPainlessExecute($params); | ||
---- | ||
|
||
=== Beta | ||
|
||
There are no beta APIs in the current version of `elasticsearch-php`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.