Elasticsearch Php Versions Save

Official PHP client for Elasticsearch.

v8.0.0-rc2

2 years ago
  • Added the common parameters in all the endpoints 6427f8c

v8.0.0-rc1

2 years ago
  • Fixed query string in API endpoints + added a first integration test e404235
  • Added AdapterOptions class and setNodePool() in ClientBuilder 9150f71
  • Fixed urlencode in params, Exception in test code generation 142327b
  • Improved client/server response exception messages 50de3e6

v8.0.0-alpha

2 years ago

This is an alpha release of 8.0.0. This new major version of elasticsearch-php contains a brand new implementation compared with 7.x. It supports PSR-7 for HTTP messages and PSR-18 for HTTP client communications. We used the elastic-transport-php library for HTTP communications.

We tried to reduce the BC breaks as much as possible with 7.x but there are some (big) differences:

  • we changed the namespace, now everything is under Elastic\Elasticsearch;
  • we changed the Exception model, using the namespace Elastic\Elasticsearch\Exception. All the exceptions extends the ElasticsearchException interface, as in 7.x;
  • we changed the response type of each endpoints using an Elasticsearch response class. This class wraps a a PSR-7 response allowing the access of the body response as array or object. This means you can access the API response as in 7.x, no BC break here! :angel:

You can have a look at the BREAKING_CHANGES file for more information.

We are still working on the new documentation for 8.0, in the meantime you can have a look at the README where we reported a quick start guide.

v7.17.0

2 years ago

This release is compatible with the latest Elasticsearch 7.17.0 released the 1st February 2022.

It includes the following fixes and improvements:

  • Allow psr/log v3 #1184

Added the following new APIs 🎉 (1 stable):

API changes

  • Ml.forecast, added body for HTTP request where query parameters can be specified in the body
  • Ml.openJob, added body for HTTP request where query parameters can be specified in the body
  • Transform.deleteTransform, added the timeout parameter, (time) controls the time to wait for the transform deletion
  • Transform.previewTransform, added the timeout parameter, (time) Controls the time to wait for the preview
  • Transform.putTransform, added the timeout parameter, (time) Controls the time to wait for the transform to start
  • Transform.updateTransform, added the timeout parameter, (time) Controls the time to wait for the update
  • Transform.upgradeTransforms, added the timeout parameter, (time) Controls the time to wait for the upgrade

v7.16.0

2 years ago

This release is compatible with PHP 8.1 (thanks to @karyna-tsymbal-atwix) and the latest Elasticsearch 7.16.0 released in 7th December 2021.

It includes the following fixes and improvements:

  • Added support of includePortInHostHeader in ClientBuilder::fromConfig #1181
  • Fixed UTF-16 issue in SmartSerializer with single unpaired surrogate in unicode escape #1179
  • Replace trait with abstract class to avoid Deprecated Functionality issue in PHP 8.1 #1175

Added the following new APIs 🎉 (4 stable, and 2 experimental):

Stable

Experimental

API changes

  • deleteByQuery, removed _source, _source_excludes, _source_includes parameters
  • openPointInTime, the parameter keep_alive is now required. Changed the index parameter to be required (was optional)
  • Nodes.stats, added the shards option to the index_metric parameter
  • searchMvt, added the track_total_hits (boolean|long) parameter. Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number
  • termsEnum, this API is now stable
  • updateByQuery, removed _source, _source_excludes, _source_includes parameters
  • Fleet.globalCheckpoints, this API is now stable
  • Indices.getIndexTeamplate, changed the name parameter as string. A pattern that returned template names must match
  • Ingest.putPipeline, added the if_version parameter (int). Required version for optimistic concurrency control for pipeline updates
  • Ml.putTrainedModel, added the defer_definition_decompression parameter. (boolean) If set to true and a compressed_definition is provided, the request defers definition decompression and skips relevant validations. (Default = false)
  • Monitoring.bulk, this API is now stable
  • Nodes.hotThreads, added the sort parameter (enum). The sort order for 'cpu' type (default: total) (Options = cpu,total)
  • Nodes.info, changed the description of metric parameter (list). A comma-separated list of metrics you wish returned. Use _all to retrieve all metrics and _none to retrieve the node identity without any additional metrics
  • SearchableSnapshots.mount, this API is now stable
  • SearchableSnapshots.stats, this API is now stable
  • Security.clearCachedServiceTokens, this API is now stable
  • Security.createServiceToken, this API is now stable
  • Security.deleteServiceToken, this API is now stable
  • Security.getServiceAccounts, this API is now stable
  • Security.getServiceCredentials, this API is now stable
  • Shutdown.deleteNode, this API is now stable
  • Shutdown.getNode, this API is now stable
  • Shutdown.putNode, this API is now stable
  • Transform.deleteTransform, added the timeout parameter (time). Controls the time to wait for the transform deletion
  • Transform.previewTransform, added the transform_id parameter (string), The id of the transform to preview. Added the timeout parameter (time). Controls the time to wait for the preview
  • Transform.putTransform, added the timeout parameter (time). Controls the time to wait for the transform to start
  • Transform.updateTransform, added the timeout parameter (time). Controls the time to wait for the update

v7.15.0

2 years ago

This release is compatible with the latest Elasticsearch 7.15.0 released in 22nd September 2021.

Added the following new APIs 🎉 (1 stable and 5 experimental):

Stable

Experimental

API changes

Ml.putJob

Added the ignore_unavailable parameter, (boolean) to ignore unavailable indexes (default: false)

Added the allow_no_indices parameter, (boolean) to ignore if the source indices expressions resolves to no concrete indices (default: true)

Added the ignore_throttled parameter, (boolean) to ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided

Added the expand_wildcards parameter, (enum) whether source index expressions should get expanded to open or closed indices

Nodes.stats

Added the shards option to the index_metric parameter

OpenPointInTime

Changed the index parameter to be required (was optional)

v7.14.0

2 years ago

This release is compatible with the latest Elasticsearch 7.14.0 released in 3rd August 2021.

It includes the following fixes and improvements:

  • Usage of psr/log version 2 #1154
  • Update search iterators to send scroll_id inside the request body #1134
  • Added the ingest.geoip.downloader.enabled=false setting for ES 5867351
  • Removed phpcs for autogenerated files (endpoints) 651c57b

Added the following new APIs 🎉 (8 stable, and 1 beta):

Stable

Beta

API changes

  • Msearch, removed the query_and_fetch and dfs_query_and_fetch options in search_type parameter.
  • MsearchTemplate, removed the query_and_fetch and dfs_query_and_fetch options in search_type parameter.
  • SearchTemplate, removed the query_and_fetch and dfs_query_and_fetch options in search_type parameter.
  • Snapshot.get, added include_repository parameter, (boolean) whether to include the repository name in the snapshot info. Defaults to true.
  • Snapshot.repositoryAnalyze, added rarely_abort_writes parameter, (boolean) whether to rarely abort writes before they complete. Defaults to 'true'.

v6.8.2

2 years ago

v7.13.1

3 years ago

This is a patch release that includes PR #1126. It was scheduled for 7.13.0 but not included in the release.

  • Added port in url for trace and logger messages #1126

v7.13.0

3 years ago

This release is compatible with the latest Elasticsearch 7.13.0 released in 25th May 2021.

It includes the following fixes and improvements:

  • (DOCS) Added the HTTP meta data section #1143
  • Added support for API Compatibility Header #1142
  • (DOCS) Added Helpers section to PHP book #1129
  • Added the API description in phpdoc section for each endpoint 9e05c81
  • Usage of PHPUnit 9 only + migrated xml configurations 038b5dd

Added the following new APIs 🎉 (4 stable, 7 experimental, and 5 beta):

Stable

Experimental

Beta

API changes

  • Cat.nodes, added the include_unloaded_segments parameter (boolean). If set to true segment stats will include stats for segments that are not currently loaded into memory (Default = false).
  • Ml.deleteDataFrameAnalytics, this API is now stable, previosuly it was beta.
  • Ml.deleteTrainedModel, this API is now stable, previosuly it was beta.
  • Ml.explainDataFrameAnalytics, this API is now stable, previosuly it was beta.
  • Ml.getDataFrameAnalytics, this API is now stable, previosuly it was beta.
  • Ml.getDataFrameAnalyticsStats, this API is now stable, previosuly it was beta.
  • Ml.getTrainedModels, this API is now stable, previosuly it was beta.
  • Ml.getTrainedModelsStats, this API is now stable, previosuly it was beta.
  • Ml.putDataFrameAnalytics, this API is now stable, previosuly it was beta.
  • Ml.putTrainedModel, this API is now stable, previosuly it was beta.
  • Ml.startDataFrameAnalytics, this API is now stable, previosuly it was beta.
  • Ml.stopDataFrameAnalytics, this API is now stable, previosuly it was beta.
  • Ml.updateDataFrameAnalytics, this API is now stable, previosuly it was beta.
  • Nodes.stats, added include_unloaded_segments parameter (boolean). If set to true segment stats will include stats for segments that are not currently loaded into memory (Default = false).
  • Snapshot.get, added index_details parameter (boolean). Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
  • TextStructure.findStructure, this API is now stable, previosuly it was experimental.