Client

• Client is compatible with Elasticsearch 7.17.2

Documents

• Changed the source and dest parameters of the reindex API to be required.

Mappings

• Changed the fields parameter of the field_caps API to be required.

Transforms

• Added the transform.reset_transform API

Client

• Fixed the sort parameter of multiple APIs to serialize in the query string when using the shorthand form

Indices

• Fixed the index parameter to be required for the indices.field_usage_stats API

SQL

• Added the catalog, keep_alive, keep_on_completion, params, runtime_mappings, and wait_for_completion_timeout parameters to the sql.query API

Helpers

• Fixed the from parameter to be rewritten to from_ when used with the scan and async_scan helpers (https://github.com/elastic/elasticsearch-py/pull/1897)

Transport

• Fixed AiohttpHttpConnection to not leak TLS connections when the socket isn't explicitly shutdown by the peer (https://github.com/elastic/elasticsearch-py/pull/1919)

⚠️ v8.0.0 is a new major release and contains some breaking changes.
For information on how migrate your application from v7.x to v8.0.0 you can read the migration guide here.

Client

Added

• Added the top-level .options() method to Elasticsearch and AsyncElasticsearch for modifying transport options.
• Added parameters corresponding to JSON request body fields for all APIs
• Added basic_auth parameter for specifying username and password authentication
• Added bearer_auth parameter for specifying an HTTP bearer token or service token
• Added the meta property to ApiError to access the HTTP response metadata of an error.
• Added a check that a compatible version of the elastic-transport package is installed.

Changed

• Changed the transport layer to use the elastic-transport package
• Changed user-defined body parameters to have semantic names (e.g index(document={...}) instead of index(body={...})).
• Changed responses to be objects with two properties, meta for response metadata (HTTP status, headers, node, etc) and body for a typed body.
• Changed AsyncElasticsearch to always be available, regardless of whether aiohttp is installed
• Changed exception hierarchy, the major change is a new exception ApiError which differentiates between an error that's raised from the transport layer (previously elasticsearch.exceptions.TransportError, now elastic_transport.TransportError) and one raised from the API layer
• Changed the name of JSONSerializer to JsonSerializer for consistency with other serializer names. Added an alias to the old name for backwards compatibility
• Changed the default mimetypes (application/json) to instead use compatibility mimetypes (application/vnd.elasticsearch+json) which always request for responses compatibility with version 8.x.

Removed

• Removed support for Python 2.7 and Python 3.5, the library now supports only Python 3.6+
• Removed the elasticsearch.connection module as all functionality has been moved to the elastic-transport package
• Removed the default URL of http://localhost:9200 due to Elasticsearch 8.0 default configuration being https://localhost:9200.
  The client's connection to Elasticsearch now must be specified with scheme, host, and port or with the cloud_id parameter
• Removed the ability to use positional arguments with API methods. Going forward all API parameters must be keyword-only parameters

Deprecated

• Deprecated the body and params parameters on all APIs
• Deprecated setting transport options http_auth, api_key, ignore, request_timeout, headers, and opaque_id
  All of these settings should instead be set via the .options() method
• Deprecated the elasticsearch.transport and elasticsearch.client modules. These modules will be removed in a future version

API

• Removed the doc_type, include_type_name, and copy_settings parameters from many document and index APIs

CAT

• Removed the deprecated local parameter from the cat.indices, cat.nodes, cat.shards API
• Removed the deprecated allow_no_datafeeds parameter from the cat.ml_datafeeds API
• Removed the deprecated allow_no_jobs parameter from the cat.ml_jobs API
• Removed the deprecated size parameter from the cat.thread_pool API
• Added the time parameter to the cat.thread_pool API

Documents

• Removed the deprecated size parameter from the delete_by_query API
• Removed the deprecated size parameter from the update_by_query API

Indices

• Removed the deprecated indices.flush_synced API
• Removed the deprecated indices.freeze API
• Removed the deprecated indices.get_upgrade API
• Removed the deprecated indices.upgrade API
• Removed the deprecated indices.exist_type API
• Removed the deprecated parameter copy_settings from the indices.shrink API
• Deprecated the verbose parameter of the indices.segments API

License / X-Pack

• Deprecated the accept_enterprise parameter of the license.get API
• Deprecated the accept_enterprise parameter of the xpack.info API

Machine Learning

• Added the experimental ml.infer_trained_model_deployment API
• Added the experimental ml.put_trained_model_definition_part API
• Added the experimental ml.put_trained_model_vocabulary API
• Added the experimental ml.start_trained_model_deployment API
• Added the experimental ml.stop_trained_model_deployment API
• Added the timeout parameter to the ml.delete_trained_model API
• Removed the deprecated allow_no_jobs parameter from the ml.close_job API
• Removed the deprecated ml.find_text_structure API
• Removed the deprecated allow_no_datafeeds parameter from the ml.get_datafeed_stats API
• Removed the deprecated allow_no_datafeeds parameter from the ml.get_datafeeds API
• Removed the deprecated allow_no_jobs parameter from the ml.get_job_stats API
• Removed the deprecated allow_no_jobs parameter from the ml.get_jobs API
• Removed the deprecated allow_no_jobs parameter from the ml.get_overall_buckets API

Search

• Added the experimental knn_search API

Searchable Snapshots

• Removed the deprecated searchable_snapshots.repository_stats API

Snapshots

• Changed the snapshot.delete API to accept multiple snapshots

Security

• Added the security.enroll_kibana API
• Added the security.enroll_node API

Client

Added

• Added the top-level .options() method to Elasticsearch and AsyncElasticsearch for modifying transport options.
• Added parameters corresponding to JSON request body fields for all APIs
• Added basic_auth parameter for specifying username and password authentication
• Added bearer_auth parameter for specifying an HTTP bearer token or service token
• Added the meta property to ApiError to access the HTTP response metadata of an error.
• Added a check that a compatible version of the elastic-transport package is installed.

Changed

• Changed the transport layer to use the elastic-transport package
• Changed user-defined body parameters to have semantic names (e.g index(document={...}) instead of index(body={...})).
• Changed responses to be objects with two properties, meta for response metadata (HTTP status, headers, node, etc) and body for a typed body.
• Changed AsyncElasticsearch to always be available, regardless of whether aiohttp is installed
• Changed exception hierarchy, the major change is a new exception ApiError which differentiates between an error that's raised from the transport layer (previously elasticsearch.exceptions.TransportError, now elastic_transport.TransportError) and one raised from the API layer
• Changed the name of JSONSerializer to JsonSerializer for consistency with other serializer names. Added an alias to the old name for backwards compatibility
• Changed the default mimetypes (application/json) to instead use compatibility mimetypes (application/vnd.elasticsearch+json) which always request for responses compatibility with version 8.x.

Removed

• Removed support for Python 2.7 and Python 3.5, the library now supports only Python 3.6+
• Removed the elasticsearch.connection module as all functionality has been moved to the elastic-transport package
• Removed the default URL of http://localhost:9200 due to Elasticsearch 8.0 default configuration being https://localhost:9200.
  The client's connection to Elasticsearch now must be specified with scheme, host, and port or with the cloud_id parameter
• Removed the ability to use positional arguments with API methods. Going forward all API parameters must be keyword-only parameters

Deprecated

• Deprecated the body and params parameters on all APIs
• Deprecated setting transport options http_auth, api_key, ignore, request_timeout, headers, and opaque_id
  All of these settings should instead be set via the .options() method
• Deprecated the elasticsearch.transport and elasticsearch.client modules. These modules will be removed in a future version

API

• Removed the doc_type and include_type_name parameters from many document and index APIs

CAT

• Removed the deprecated local parameter from the cat.indices, cat.nodes, cat.shards API
• Removed the deprecated allow_no_datafeeds parameter from the cat.ml_datafeeds API
• Removed the deprecated allow_no_jobs parameter from the cat.ml_jobs API
• Removed the deprecated size parameter from the cat.thread_pool API
• Added the time parameter to the cat.thread_pool API

Documents

• Removed the deprecated size parameter from the delete_by_query API
• Removed the deprecated size parameter from the update_by_query API

Indices

• Removed the deprecated indices.flush_synced API
• Removed the deprecated indices.freeze API
• Removed the deprecated indices.get_upgrade API
• Removed the deprecated indices.upgrade API
• Removed the deprecated parameter copy_settings from the indices.shrink API

License / X-Pack

• Deprecated the accept_enterprise parameter of the license.get API
• Deprecated the accept_enterprise parameter of the xpack.info API

Machine Learning

• Removed the deprecated allow_no_jobs parameter from the ml.close_job API
• Added the timeout parameter to the ml.delete_trained_model API
• Removed the deprecated ml.find_text_structure API
• Removed the deprecated allow_no_datafeeds parameter from the ml.get_datafeed_stats API
• Removed the deprecated allow_no_datafeeds parameter from the ml.get_datafeeds API
• Removed the deprecated allow_no_jobs parameter from the ml.get_job_stats API
• Removed the deprecated allow_no_jobs parameter from the ml.get_jobs API
• Removed the deprecated allow_no_jobs parameter from the ml.get_overall_buckets API
• Added the experimental ml.infer_trained_model_deployment API
• Added the experimental ml.put_trained_model_definition_part API
• Added the experimental ml.put_trained_model_vocabulary API
• Added the experimental ml.start_trained_model_deployment API
• Added the experimental ml.stop_trained_model_deployment API

Search

• Added the experimental knn_search API

Searchable Snapshots

• Removed the deprecated searchable_snapshots.repository_stats API

Security

• Added the security.enroll_kibana API
• Added the security.enroll_node API

Machine Learning

• Added the ml.get_model_snapshot_upgrade_stats API
• Added the body parameter to the ml.forecast and ml.open_job APIs

Transform

• Added the timeout parameter to the transform.delete_transform, transform.preview_transform, transform.put_transform, transform.update_transform, and transform.upgrade_transform APIs

Client

Added

• Added the top-level .options() method to Elasticsearch and AsyncElasticsearch for modifying transport options.
• Added parameters corresponding to JSON request body fields for all APIs
• Added basic_auth parameter for specifying username and password authentication
• Added bearer_auth parameter for specifying an HTTP bearer token or service token
• Added the meta property to ApiError to access the HTTP response metadata of an error.
• Added a check that a compatible version of the elastic-transport package is installed.

Changed

• Changed the transport layer to use the elastic-transport package
• Changed user-defined body parameters to have semantic names (e.g index(document={...}) instead of index(body={...})).
• Changed responses to be objects with two properties, meta for response metadata (HTTP status, headers, node, etc) and body for a typed body.
• Changed AsyncElasticsearch to always be available, regardless of whether aiohttp is installed
• Changed exception hierarchy, the major change is a new exception ApiError which differentiates between an error that's raised from the transport layer (previously elasticsearch.exceptions.TransportError, now elastic_transport.TransportError) and one raised from the API layer
• Changed the name of JSONSerializer to JsonSerializer for consistency with other serializer names. Added an alias to the old name for backwards compatibility

Removed

• Removed support for Python 2.7 and Python 3.5, the library now supports only Python 3.6+
• Removed the elasticsearch.connection module as all functionality has been moved to the elastic-transport package
• Removed the default URL of http://localhost:9200 due to Elasticsearch 8.0 default configuration being https://localhost:9200.
  The client's connection to Elasticsearch now must be specified with scheme, host, and port or with the cloud_id parameter
• Removed the ability to use positional arguments with API methods. Going forward all API parameters must be keyword-only parameters

Deprecated

• Deprecated the body and params parameters on all APIs
• Deprecated setting transport options http_auth, api_key, ignore, request_timeout, headers, and opaque_id
  All of these settings should instead be set via the .options() method
• Deprecated the elasticsearch.transport and elasticsearch.client modules. These modules will be removed in a future version

API

• Removed the doc_type and include_type_name parameters from many document and index APIs

CAT

• Removed the deprecated local parameter from the cat.indices, cat.nodes, cat.shards API
• Removed the deprecated allow_no_datafeeds parameter from the cat.ml_datafeeds API
• Removed the deprecated allow_no_jobs parameter from the cat.ml_jobs API
• Removed the deprecated size parameter from the cat.thread_pool API
• Added the time parameter to the cat.thread_pool API

Documents

• Removed the deprecated size parameter from the delete_by_query API
• Removed the deprecated size parameter from the update_by_query API

Indices

• Removed the deprecated indices.flush_synced API
• Removed the deprecated indices.freeze API
• Removed the deprecated indices.get_upgrade API
• Removed the deprecated indices.upgrade API
• Removed the deprecated parameter copy_settings from the indices.shrink API

License / X-Pack

• Deprecated the accept_enterprise parameter of the license.get API
• Deprecated the accept_enterprise parameter of the xpack.info API

Machine Learning

• Removed the deprecated allow_no_jobs parameter from the ml.close_job API
• Added the timeout parameter to the ml.delete_trained_model API
• Removed the deprecated ml.find_text_structure API
• Removed the deprecated allow_no_datafeeds parameter from the ml.get_datafeed_stats API
• Removed the deprecated allow_no_datafeeds parameter from the ml.get_datafeeds API
• Removed the deprecated allow_no_jobs parameter from the ml.get_job_stats API
• Removed the deprecated allow_no_jobs parameter from the ml.get_jobs API
• Removed the deprecated allow_no_jobs parameter from the ml.get_overall_buckets API
• Added the experimental ml.infer_trained_model_deployment API
• Added the experimental ml.put_trained_model_definition_part API
• Added the experimental ml.put_trained_model_vocabulary API
• Added the experimental ml.start_trained_model_deployment API
• Added the experimental ml.stop_trained_model_deployment API

Search

• Added the experimental knn_search API

Searchable Snapshots

• Removed the deprecated searchable_snapshots.repository_stats API

Security

• Added the security.enroll_kibana API
• Added the security.enroll_node API

Client

• API is compatible with Elasticsearch 7.16.3

Client

Added

• Added the top-level .options() method to Elasticsearch and AsyncElasticsearch for modifying transport options.
• Added parameters corresponding to JSON request body fields for all APIs
• Added basic_auth parameter for specifying username and password authentication
• Added bearer_auth parameter for specifying an HTTP bearer token or service token
• Added the meta property to ApiError to access the HTTP response metadata of an error.
• Added a check that a compatible version of the elastic-transport package is installed.

Changed

• Changed the transport layer to use the elastic-transport package
• Changed user-defined body parameters to have semantic names (e.g index(document={...}) instead of index(body={...} [elasticsearch8-8.0.0a3.tar.gz](https://github.com/elastic/elasticsearch-py/files/7686727/elasticsearch8-8.0.0a3.tar.gz) ).
• Changed responses to be objects with three properties, meta for response metadata, raw for the raw deserialized response, and body for a typed body.
• Changed AsyncElasticsearch to always be available, regardless of whether aiohttp is installed
• Changed exception hierarchy, the major change is a new exception ApiError which differentiates between an error that's raised from the transport layer (previously elasticsearch.exceptions.TransportError, now elastic_transport.TransportError) and one raised from the API layer
• Changed the name of JSONSerializer to JsonSerializer for consistency with other serializer names. Added an alias to the old name for backwards compatibility

Removed

• Removed the elasticsearch.connection module as all functionality has been moved to the elastic-transport package
• Removed the default URL of http://localhost:9200 due to Elasticsearch 8.0 default configuration being https://localhost:9200.
  The client's connection to Elasticsearch now must be specified with scheme, host, and port or with the cloud_id parameter
• Removed the ability to use positional arguments with API methods. Going forward all API parameters must be keyword-only parameters

Deprecated

• Deprecated setting transport options http_auth, api_key, ignore, request_timeout, headers, and opaque_id
  All of these settings should instead be set via the .options() method
• Deprecated the elasticsearch.transport and elasticsearch.client modules. These modules will be removed in a future version
• Deprecated the body and params parameters on all APIs

API

• Removed the doc_type and include_type_name parameters from many document and index APIs

CAT

• Removed the deprecated local parameter from the cat.indices, cat.nodes, cat.shards API
• Removed the deprecated allow_no_datafeeds parameter from the cat.ml_datafeeds API
• Removed the deprecated allow_no_jobs parameter from the cat.ml_jobs API
• Removed the deprecated size parameter from the cat.thread_pool API
• Added the time parameter to the cat.thread_pool API

Documents

• Removed the deprecated size parameter from the delete_by_query API
• Removed the deprecated size parameter from the update_by_query API

Indices

• Removed the deprecated indices.flush_synced API
• Removed the deprecated indices.freeze API
• Removed the deprecated indices.get_upgrade API
• Removed the deprecated indices.upgrade API
• Removed the deprecated parameter copy_settings from the indices.shrink API

License / X-Pack

• Deprecated the accept_enterprise parameter of the license.get API
• Deprecated the accept_enterprise parameter of the xpack.info API

Machine Learning

• Removed the deprecated allow_no_jobs parameter from the ml.close_job API
• Added the timeout parameter to the ml.delete_trained_model API
• Removed the deprecated ml.find_text_structure API
• Removed the deprecated allow_no_datafeeds parameter from the ml.get_datafeed_stats API
• Removed the deprecated allow_no_datafeeds parameter from the ml.get_datafeeds API
• Removed the deprecated allow_no_jobs parameter from the ml.get_job_stats API
• Removed the deprecated allow_no_jobs parameter from the ml.get_jobs API
• Removed the deprecated allow_no_jobs parameter from the ml.get_overall_buckets API
• Added the experimental ml.infer_trained_model_deployment API
• Added the experimental ml.put_trained_model_definition_part API
• Added the experimental ml.put_trained_model_vocabulary API
• Added the experimental ml.start_trained_model_deployment API
• Added the experimental ml.stop_trained_model_deployment API

Search

• Added the experimental knn_search API

Searchable Snapshots

• Removed the deprecated searchable_snapshots.repository_stats API

Security

• Added the security.enroll_kibana API
• Added the security.enroll_node API

Client

• API is compatible with Elasticsearch 7.16.2

Client

• API is compatible with Elasticsearch 7.16.1

Transport

• Fixed an issue where the AIOHttpConnection wouldn't log query parameters for URLs.

Client

Deprecated

• Deprecated the send_get_body_as parameter. This parameter is no longer necessary
  as APIs all use non-GET HTTP methods when using a body.
• Removal of body, params, and other per-request parameters has been delayed beyond 8.0.0.
  Changed deprecation warnings to mention "future version" instead of 8.0.0.

Fixed

• Fixed an issue with unicode HTTP headers with the urllib3 HTTP client
• Fixed an issue with the scan helper to always set the sort and scroll parameters

API

Search

• Changed the keep_alive parameter of the open_point_in_time API to be required
  to reflect its required status within Elasticsearch
• Added the track_total_hits parameter to the search_mvt API

Fleet

• Changed the fleet.global_checkpoints API from experimental to stable
• Added the fleet.search experimental API
• Added the fleet.msearch experimental API

Indices

• Added the indices.modify_data_stream API

Ingest

• Added the if_version parameter to the ingest.put_pipeline API

Migration

• Added the migration.get_feature_upgrade_status API
• Added the migration.post_feature_upgrade API

Machine Learning

• Added the defer_definition_decompression parameter to the ml.put_trained_model API

Transforms

• Added the transform.upgrade_transforms API

Client

• API is compatible with Elasticsearch 7.15.2

Nodes

• Documented additional options the metric parameter of the nodes.info API.

Client

• Fixed a performance regression in JSONSerializer.default() when numpy and pandas weren't installed.
• Changed the DeprecationWarning for the body parameter to be a "removed in a future version" instead of "removed in 8.0" in line with the 8.0 roadmap.

API

Search

• The index parameter of the open_point_in_time API is now required, was optional.

Client

We've recently announced our roadmap for 8.0.0 and have begun issuing deprecation warnings in the 7.x release stream to prepare users for upgrading to 8.0.0 when available.

Added

• Added more precise type hints to many API parameters
• Added explicit parameters to AsyncTransport and AIOHttpConnection
• Added MapboxVectorTileSerializer for handling the application/vnd.mapbox-vector-tile mimetype. Because this mimetype is binary rather than text the raw response bytes are forwarded from the serializer without decoding

Fixed

• Reduced amount of time to import the elasticsearch module by delaying imports of pandas and numpy until later in the JSON serialization stage if necessary

APIs

• Deprecated positional arguments for APIs, instead use keyword arguments exclusively.

Search

• Added the search_mvt experimental API
• Added body field parameters to the search, scroll, and clear_scroll APIs
• Deprecated the body parameter of the search, scroll, and clear_scroll APIs

Documents

• Added body field parameters to the update API
• Added the document parameter to the create and index APIs
• Deprecated the body parameter of the create, index, and update APIs

Indices

• Added the indices.disk_usage experimental API
• Added the indices.fields_usage_stats experimental API
• Added body field parameters to the indices.create API
• Deprecated the body parameter of the indices.create API

Machine Learning

• Added the ignore_unavailable, allow_no_indices, ignore_throttled, and expand_wildcards parameters to the ml.put_job API

Nodes

• Added the nodes.clear_repositories_metering_archive experimental API
• Added the nodes.get_repositories_metering_info experimental API
• Added the shards option to the index_metric parameter of the nodes.stats API
• Deprecated the doc_type parameter of the nodes.hot_threads API, instead use the type parameter

Security

• Added the security.query_api_keys API

License

• Deprecated the doc_type parameter of the license.post_start_trial API, instead use the type parameter

Client

• Client is compatible with Elasticsearch 7.14.2

Client

We've recently announced our roadmap for 8.0.0 and have begun issuing deprecation warnings in the 7.x release stream to prepare users for upgrading to 8.0.0 when available.

Added

• Added more precise type hints to many API parameters
• Added explicit parameters to AsyncTransport and AIOHttpConnection
• Added MapboxVectorTileSerializer for handling the application/vnd.mapbox-vector-tile mimetype. Because this mimetype is binary rather than text the raw response bytes are forwarded from the serializer without decoding.

APIs

• Deprecated positional arguments for APIs, instead use keyword arguments exclusively.

Search

• Added the search_mvt experimental API
• Added body field parameters to the search, scroll, and clear_scroll APIs
• Deprecated the body parameter of the search, scroll, and clear_scroll APIs

Documents

• Added body field parameters to the update API
• Added the document parameter to the create and index APIs
• Deprecated the body parameter of the create, index, and update APIs

Indices

• Added the indices.disk_usage experimental API
• Added the indices.fields_usage_stats experimental API
• Added body field parameters to the indices.create API
• Deprecated the body parameter of the indices.create API

Machine Learning

• Added the ignore_unavailable, allow_no_indices, ignore_throttled, and expand_wildcards parameters to the ml.put_job API.

Nodes

• Added the nodes.clear_repositories_metering_archive experimental API
• Added the nodes.get_repositories_metering_info experimental API
• Added the shards option to the index_metric parameter of the nodes.stats API
• Deprecated the doc_type parameter of the nodes.hot_threads API, instead use the type parameter

Security

• Added the security.query_api_keys API

License

• Deprecated the doc_type parameter of the license.post_start_trial API, instead use the type parameter

Client

• Client is compatible with Elasticsearch 7.14.1