Experimental and beta APIsedit

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.

Experimentaledit

The experimental APIs included in the current version of elasticsearch-php are:

$client = ClientBuilder::create()->build();
$params = [
    // ...
];
$result = $client->rankEval($params);
$client = ClientBuilder::create()->build();
$params = [
    // ...
];
$result = $client->scriptsPainlessExecute($params);

Betaedit

There are no beta APIs in the current version of elasticsearch-php.