Official Python client for Elasticsearch
APACHE-2.0 License
Bot releases are visible (Hide)
Published by sethmlarson over 2 years ago
Published by sethmlarson over 2 years ago
source
and dest
parameters of the reindex
API to be required.fields
parameter of the field_caps
API to be required.Published by sethmlarson over 2 years ago
transform.reset_transform
APIPublished by sethmlarson over 2 years ago
sort
parameter of multiple APIs to serialize in the query string when using the shorthand formindex
parameter to be required for the indices.field_usage_stats
APIcatalog
, keep_alive
, keep_on_completion
, params
, runtime_mappings
, and wait_for_completion_timeout
parameters to the sql.query
APIPublished by sethmlarson over 2 years ago
from
parameter to be rewritten to from_
when used with the scan
and async_scan
helpers (https://github.com/elastic/elasticsearch-py/pull/1897)AiohttpHttpConnection
to not leak TLS connections when the socket isn't explicitly shutdown by the peer (https://github.com/elastic/elasticsearch-py/pull/1919)Published by sethmlarson over 2 years ago
⚠️ 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.
.options()
method to Elasticsearch
and AsyncElasticsearch
for modifying transport options.basic_auth
parameter for specifying username and password authenticationbearer_auth
parameter for specifying an HTTP bearer token or service tokenmeta
property to ApiError
to access the HTTP response metadata of an error.elastic-transport
package is installed.elastic-transport
packagebody
parameters to have semantic names (e.g index(document={...})
instead of index(body={...})
).meta
for response metadata (HTTP status, headers, node, etc) and body
for a typed body.AsyncElasticsearch
to always be available, regardless of whether aiohttp
is installedApiError
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 layerJSONSerializer
to JsonSerializer
for consistency with other serializer names. Added an alias to the old name for backwards compatibilityapplication/json
) to instead use compatibility mimetypes (application/vnd.elasticsearch+json
) which always request for responses compatibility with version 8.x.elasticsearch.connection
module as all functionality has been moved to the elastic-transport
packagehttp://localhost:9200
due to Elasticsearch 8.0 default configuration being https://localhost:9200
.cloud_id
parameterbody
and params
parameters on all APIshttp_auth
, api_key
, ignore
, request_timeout
, headers
, and opaque_id
.options()
methodelasticsearch.transport
and elasticsearch.client
modules. These modules will be removed in a future versiondoc_type
, include_type_name
, and copy_settings
parameters from many document and index APIslocal
parameter from the cat.indices
, cat.nodes
, cat.shards
APIallow_no_datafeeds
parameter from the cat.ml_datafeeds
APIallow_no_jobs
parameter from the cat.ml_jobs
APIsize
parameter from the cat.thread_pool
APItime
parameter to the cat.thread_pool
APIsize
parameter from the delete_by_query
APIsize
parameter from the update_by_query
APIindices.flush_synced
APIindices.freeze
APIindices.get_upgrade
APIindices.upgrade
APIindices.exist_type
APIcopy_settings
from the indices.shrink
APIverbose
parameter of the indices.segments
APIaccept_enterprise
parameter of the license.get
APIaccept_enterprise
parameter of the xpack.info
APIml.infer_trained_model_deployment
APIml.put_trained_model_definition_part
APIml.put_trained_model_vocabulary
APIml.start_trained_model_deployment
APIml.stop_trained_model_deployment
APItimeout
parameter to the ml.delete_trained_model
APIallow_no_jobs
parameter from the ml.close_job
APIml.find_text_structure
APIallow_no_datafeeds
parameter from the ml.get_datafeed_stats
APIallow_no_datafeeds
parameter from the ml.get_datafeeds
APIallow_no_jobs
parameter from the ml.get_job_stats
APIallow_no_jobs
parameter from the ml.get_jobs
APIallow_no_jobs
parameter from the ml.get_overall_buckets
APIknn_search
APIsearchable_snapshots.repository_stats
APIsnapshot.delete
API to accept multiple snapshotssecurity.enroll_kibana
APIsecurity.enroll_node
APIPublished by sethmlarson over 2 years ago
.options()
method to Elasticsearch
and AsyncElasticsearch
for modifying transport options.basic_auth
parameter for specifying username and password authenticationbearer_auth
parameter for specifying an HTTP bearer token or service tokenmeta
property to ApiError
to access the HTTP response metadata of an error.elastic-transport
package is installed.elastic-transport
packagebody
parameters to have semantic names (e.g index(document={...})
instead of index(body={...})
).meta
for response metadata (HTTP status, headers, node, etc) and body
for a typed body.AsyncElasticsearch
to always be available, regardless of whether aiohttp
is installedApiError
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 layerJSONSerializer
to JsonSerializer
for consistency with other serializer names. Added an alias to the old name for backwards compatibilityapplication/json
) to instead use compatibility mimetypes (application/vnd.elasticsearch+json
) which always request for responses compatibility with version 8.x.elasticsearch.connection
module as all functionality has been moved to the elastic-transport
packagehttp://localhost:9200
due to Elasticsearch 8.0 default configuration being https://localhost:9200
.cloud_id
parameterbody
and params
parameters on all APIshttp_auth
, api_key
, ignore
, request_timeout
, headers
, and opaque_id
.options()
methodelasticsearch.transport
and elasticsearch.client
modules. These modules will be removed in a future versiondoc_type
and include_type_name
parameters from many document and index APIslocal
parameter from the cat.indices
, cat.nodes
, cat.shards
APIallow_no_datafeeds
parameter from the cat.ml_datafeeds
APIallow_no_jobs
parameter from the cat.ml_jobs
APIsize
parameter from the cat.thread_pool
APItime
parameter to the cat.thread_pool
APIsize
parameter from the delete_by_query
APIsize
parameter from the update_by_query
APIindices.flush_synced
APIindices.freeze
APIindices.get_upgrade
APIindices.upgrade
APIcopy_settings
from the indices.shrink
APIaccept_enterprise
parameter of the license.get
APIaccept_enterprise
parameter of the xpack.info
APIallow_no_jobs
parameter from the ml.close_job
APItimeout
parameter to the ml.delete_trained_model
APIml.find_text_structure
APIallow_no_datafeeds
parameter from the ml.get_datafeed_stats
APIallow_no_datafeeds
parameter from the ml.get_datafeeds
APIallow_no_jobs
parameter from the ml.get_job_stats
APIallow_no_jobs
parameter from the ml.get_jobs
APIallow_no_jobs
parameter from the ml.get_overall_buckets
APIml.infer_trained_model_deployment
APIml.put_trained_model_definition_part
APIml.put_trained_model_vocabulary
APIml.start_trained_model_deployment
APIml.stop_trained_model_deployment
APIknn_search
APIsearchable_snapshots.repository_stats
APIsecurity.enroll_kibana
APIsecurity.enroll_node
APIPublished by sethmlarson over 2 years ago
ml.get_model_snapshot_upgrade_stats
APIbody
parameter to the ml.forecast
and ml.open_job
APIstimeout
parameter to the transform.delete_transform
, transform.preview_transform
, transform.put_transform
, transform.update_transform
, and transform.upgrade_transform
APIsPublished by sethmlarson over 2 years ago
.options()
method to Elasticsearch
and AsyncElasticsearch
for modifying transport options.basic_auth
parameter for specifying username and password authenticationbearer_auth
parameter for specifying an HTTP bearer token or service tokenmeta
property to ApiError
to access the HTTP response metadata of an error.elastic-transport
package is installed.elastic-transport
packagebody
parameters to have semantic names (e.g index(document={...})
instead of index(body={...})
).meta
for response metadata (HTTP status, headers, node, etc) and body
for a typed body.AsyncElasticsearch
to always be available, regardless of whether aiohttp
is installedApiError
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 layerJSONSerializer
to JsonSerializer
for consistency with other serializer names. Added an alias to the old name for backwards compatibilityelasticsearch.connection
module as all functionality has been moved to the elastic-transport
packagehttp://localhost:9200
due to Elasticsearch 8.0 default configuration being https://localhost:9200
.cloud_id
parameterbody
and params
parameters on all APIshttp_auth
, api_key
, ignore
, request_timeout
, headers
, and opaque_id
.options()
methodelasticsearch.transport
and elasticsearch.client
modules. These modules will be removed in a future versiondoc_type
and include_type_name
parameters from many document and index APIslocal
parameter from the cat.indices
, cat.nodes
, cat.shards
APIallow_no_datafeeds
parameter from the cat.ml_datafeeds
APIallow_no_jobs
parameter from the cat.ml_jobs
APIsize
parameter from the cat.thread_pool
APItime
parameter to the cat.thread_pool
APIsize
parameter from the delete_by_query
APIsize
parameter from the update_by_query
APIindices.flush_synced
APIindices.freeze
APIindices.get_upgrade
APIindices.upgrade
APIcopy_settings
from the indices.shrink
APIaccept_enterprise
parameter of the license.get
APIaccept_enterprise
parameter of the xpack.info
APIallow_no_jobs
parameter from the ml.close_job
APItimeout
parameter to the ml.delete_trained_model
APIml.find_text_structure
APIallow_no_datafeeds
parameter from the ml.get_datafeed_stats
APIallow_no_datafeeds
parameter from the ml.get_datafeeds
APIallow_no_jobs
parameter from the ml.get_job_stats
APIallow_no_jobs
parameter from the ml.get_jobs
APIallow_no_jobs
parameter from the ml.get_overall_buckets
APIml.infer_trained_model_deployment
APIml.put_trained_model_definition_part
APIml.put_trained_model_vocabulary
APIml.start_trained_model_deployment
APIml.stop_trained_model_deployment
APIknn_search
APIsearchable_snapshots.repository_stats
APIsecurity.enroll_kibana
APIsecurity.enroll_node
APIPublished by sethmlarson almost 3 years ago
Published by sethmlarson almost 3 years ago
.options()
method to Elasticsearch
and AsyncElasticsearch
for modifying transport options.basic_auth
parameter for specifying username and password authenticationbearer_auth
parameter for specifying an HTTP bearer token or service tokenmeta
property to ApiError
to access the HTTP response metadata of an error.elastic-transport
package is installed.elastic-transport
packagebody
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) )
.meta
for response metadata, raw
for the raw deserialized response, and body
for a typed body.AsyncElasticsearch
to always be available, regardless of whether aiohttp
is installedApiError
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 layerJSONSerializer
to JsonSerializer
for consistency with other serializer names. Added an alias to the old name for backwards compatibilityelasticsearch.connection
module as all functionality has been moved to the elastic-transport
packagehttp://localhost:9200
due to Elasticsearch 8.0 default configuration being https://localhost:9200
.cloud_id
parameterhttp_auth
, api_key
, ignore
, request_timeout
, headers
, and opaque_id
.options()
methodelasticsearch.transport
and elasticsearch.client
modules. These modules will be removed in a future versionbody
and params
parameters on all APIsdoc_type
and include_type_name
parameters from many document and index APIslocal
parameter from the cat.indices
, cat.nodes
, cat.shards
APIallow_no_datafeeds
parameter from the cat.ml_datafeeds
APIallow_no_jobs
parameter from the cat.ml_jobs
APIsize
parameter from the cat.thread_pool
APItime
parameter to the cat.thread_pool
APIsize
parameter from the delete_by_query
APIsize
parameter from the update_by_query
APIindices.flush_synced
APIindices.freeze
APIindices.get_upgrade
APIindices.upgrade
APIcopy_settings
from the indices.shrink
APIaccept_enterprise
parameter of the license.get
APIaccept_enterprise
parameter of the xpack.info
APIallow_no_jobs
parameter from the ml.close_job
APItimeout
parameter to the ml.delete_trained_model
APIml.find_text_structure
APIallow_no_datafeeds
parameter from the ml.get_datafeed_stats
APIallow_no_datafeeds
parameter from the ml.get_datafeeds
APIallow_no_jobs
parameter from the ml.get_job_stats
APIallow_no_jobs
parameter from the ml.get_jobs
APIallow_no_jobs
parameter from the ml.get_overall_buckets
APIml.infer_trained_model_deployment
APIml.put_trained_model_definition_part
APIml.put_trained_model_vocabulary
APIml.start_trained_model_deployment
APIml.stop_trained_model_deployment
APIknn_search
APIsearchable_snapshots.repository_stats
APIsecurity.enroll_kibana
APIsecurity.enroll_node
APIPublished by sethmlarson almost 3 years ago
Published by sethmlarson almost 3 years ago
AIOHttpConnection
wouldn't log query parameters for URLs.Published by sethmlarson almost 3 years ago
send_get_body_as
parameter. This parameter is no longer necessarybody
, params
, and other per-request parameters has been delayed beyond 8.0.0.unicode
HTTP headers with the urllib3 HTTP clientscan
helper to always set the sort
and scroll
parameterskeep_alive
parameter of the open_point_in_time
API to be requiredtrack_total_hits
parameter to the search_mvt
APIfleet.global_checkpoints
API from experimental to stable
fleet.search
experimental APIfleet.msearch
experimental APIindices.modify_data_stream
APIif_version
parameter to the ingest.put_pipeline
APImigration.get_feature_upgrade_status
APImigration.post_feature_upgrade
APIdefer_definition_decompression
parameter to the ml.put_trained_model
APItransform.upgrade_transforms
APIPublished by sethmlarson almost 3 years ago
metric
parameter of the nodes.info
API.Published by sethmlarson about 3 years ago
JSONSerializer.default()
when numpy
and pandas
weren't installed.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.index
parameter of the open_point_in_time
API is now required, was optional.Published by sethmlarson about 3 years ago
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.
AsyncTransport
and AIOHttpConnection
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 decodingelasticsearch
module by delaying imports of pandas
and numpy
until later in the JSON serialization stage if necessarysearch_mvt
experimental APIsearch
, scroll
, and clear_scroll
APIsbody
parameter of the search
, scroll
, and clear_scroll
APIsupdate
APIdocument
parameter to the create
and index
APIsbody
parameter of the create
, index
, and update
APIsindices.disk_usage
experimental APIindices.fields_usage_stats
experimental APIindices.create
APIbody
parameter of the indices.create
APIignore_unavailable
, allow_no_indices
, ignore_throttled
, and expand_wildcards
parameters to the ml.put_job
APInodes.clear_repositories_metering_archive
experimental APInodes.get_repositories_metering_info
experimental APIshards
option to the index_metric
parameter of the nodes.stats
APIdoc_type
parameter of the nodes.hot_threads
API, instead use the type
parametersecurity.query_api_keys
APIdoc_type
parameter of the license.post_start_trial
API, instead use the type
parameterPublished by sethmlarson about 3 years ago
Published by sethmlarson about 3 years ago
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.
AsyncTransport
and AIOHttpConnection
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.search_mvt
experimental APIsearch
, scroll
, and clear_scroll
APIsbody
parameter of the search
, scroll
, and clear_scroll
APIsupdate
APIdocument
parameter to the create
and index
APIsbody
parameter of the create
, index
, and update
APIsindices.disk_usage
experimental APIindices.fields_usage_stats
experimental APIindices.create
APIbody
parameter of the indices.create
APIignore_unavailable
, allow_no_indices
, ignore_throttled
, and expand_wildcards
parameters to the ml.put_job
API.nodes.clear_repositories_metering_archive
experimental APInodes.get_repositories_metering_info
experimental APIshards
option to the index_metric
parameter of the nodes.stats
APIdoc_type
parameter of the nodes.hot_threads
API, instead use the type
parametersecurity.query_api_keys
APIdoc_type
parameter of the license.post_start_trial
API, instead use the type
parameterPublished by sethmlarson about 3 years ago