Releases: elastic/elasticsearch-py
Releases · elastic/elasticsearch-py
7.16.3
Client
- API is compatible with Elasticsearch 7.16.3
8.0.0-alpha4
Client
Added
- Added the top-level
.options()
method toElasticsearch
andAsyncElasticsearch
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 toApiError
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.gindex(document={...})
instead ofindex(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, andbody
for a typed body. - Changed
AsyncElasticsearch
to always be available, regardless of whetheraiohttp
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 (previouslyelasticsearch.exceptions.TransportError
, nowelastic_transport.TransportError
) and one raised from the API layer - Changed the name of
JSONSerializer
toJsonSerializer
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 theelastic-transport
package - Removed the default URL of
http://localhost:9200
due to Elasticsearch 8.0 default configuration beinghttps://localhost:9200
.
The client's connection to Elasticsearch now must be specified with scheme, host, and port or with thecloud_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
, andopaque_id
All of these settings should instead be set via the.options()
method - Deprecated the
elasticsearch.transport
andelasticsearch.client
modules. These modules will be removed in a future version - Deprecated the
body
andparams
parameters on all APIs
API
- Removed the
doc_type
andinclude_type_name
parameters from many document and index APIs
CAT
- Removed the deprecated
local
parameter from thecat.indices
,cat.nodes
,cat.shards
API - Removed the deprecated
allow_no_datafeeds
parameter from thecat.ml_datafeeds
API - Removed the deprecated
allow_no_jobs
parameter from thecat.ml_jobs
API - Removed the deprecated
size
parameter from thecat.thread_pool
API - Added the
time
parameter to thecat.thread_pool
API
Documents
- Removed the deprecated
size
parameter from thedelete_by_query
API - Removed the deprecated
size
parameter from theupdate_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 theindices.shrink
API
License / X-Pack
- Deprecated the
accept_enterprise
parameter of thelicense.get
API - Deprecated the
accept_enterprise
parameter of thexpack.info
API
Machine Learning
- Removed the deprecated
allow_no_jobs
parameter from theml.close_job
API - Added the
timeout
parameter to theml.delete_trained_model
API - Removed the deprecated
ml.find_text_structure
API - Removed the deprecated
allow_no_datafeeds
parameter from theml.get_datafeed_stats
API - Removed the deprecated
allow_no_datafeeds
parameter from theml.get_datafeeds
API - Removed the deprecated
allow_no_jobs
parameter from theml.get_job_stats
API - Removed the deprecated
allow_no_jobs
parameter from theml.get_jobs
API - Removed the deprecated
allow_no_jobs
parameter from theml.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
7.16.2
Client
- API is compatible with Elasticsearch 7.16.2
7.16.1
Client
- API is compatible with Elasticsearch 7.16.1
Transport
- Fixed an issue where the
AIOHttpConnection
wouldn't log query parameters for URLs.
7.16.0
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 thesort
andscroll
parameters
API
Search
- Changed the
keep_alive
parameter of theopen_point_in_time
API to be required
to reflect its required status within Elasticsearch - Added the
track_total_hits
parameter to thesearch_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 theingest.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 theml.put_trained_model
API
Transforms
- Added the
transform.upgrade_transforms
API
7.15.2
Client
- API is compatible with Elasticsearch 7.15.2
Nodes
- Documented additional options the
metric
parameter of thenodes.info
API.
7.15.1
Client
- Fixed a performance regression in
JSONSerializer.default()
whennumpy
andpandas
weren't installed. - Changed the
DeprecationWarning
for thebody
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 theopen_point_in_time
API is now required, was optional.
7.15.0
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
andAIOHttpConnection
- Added
MapboxVectorTileSerializer
for handling theapplication/vnd.mapbox-vector-tile
mimetype. Because this mimetype is binary rather than text the raw responsebytes
are forwarded from the serializer without decoding
Fixed
- Reduced amount of time to import the
elasticsearch
module by delaying imports ofpandas
andnumpy
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
, andclear_scroll
APIs - Deprecated the
body
parameter of thesearch
,scroll
, andclear_scroll
APIs
Documents
- Added body field parameters to the
update
API - Added the
document
parameter to thecreate
andindex
APIs - Deprecated the
body
parameter of thecreate
,index
, andupdate
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 theindices.create
API
Machine Learning
- Added the
ignore_unavailable
,allow_no_indices
,ignore_throttled
, andexpand_wildcards
parameters to theml.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 theindex_metric
parameter of thenodes.stats
API - Deprecated the
doc_type
parameter of thenodes.hot_threads
API, instead use thetype
parameter
Security
- Added the
security.query_api_keys
API
License
- Deprecated the
doc_type
parameter of thelicense.post_start_trial
API, instead use thetype
parameter
7.14.2
Client
- Client is compatible with Elasticsearch 7.14.2
7.15.0-alpha1
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
andAIOHttpConnection
- Added
MapboxVectorTileSerializer
for handling theapplication/vnd.mapbox-vector-tile
mimetype. Because this mimetype is binary rather than text the raw responsebytes
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
, andclear_scroll
APIs - Deprecated the
body
parameter of thesearch
,scroll
, andclear_scroll
APIs
Documents
- Added body field parameters to the
update
API - Added the
document
parameter to thecreate
andindex
APIs - Deprecated the
body
parameter of thecreate
,index
, andupdate
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 theindices.create
API
Machine Learning
- Added the
ignore_unavailable
,allow_no_indices
,ignore_throttled
, andexpand_wildcards
parameters to theml.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 theindex_metric
parameter of thenodes.stats
API - Deprecated the
doc_type
parameter of thenodes.hot_threads
API, instead use thetype
parameter
Security
- Added the
security.query_api_keys
API
License
- Deprecated the
doc_type
parameter of thelicense.post_start_trial
API, instead use thetype
parameter