elasticsearch 8.11.0__tar.gz → 8.12.0__tar.gz

{elasticsearch-8.11.0 → elasticsearch-8.12.0}/CONTRIBUTING.md

@@ -13,7 +13,7 @@ before writing too much code.
 ## Running Elasticsearch locally
 
 We've provided a script to start an Elasticsearch cluster of a certain version
-found at `.ci/run-elasticsearch.sh`.
+found at `.buildkite/run-elasticsearch.sh`.
 
 There are several environment variables that control integration tests:
 

{elasticsearch-8.11.0 → elasticsearch-8.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: elasticsearch
-Version: 8.11.0
+Version: 8.12.0
 Summary: Python client for Elasticsearch
 Home-page: https://github.com/elastic/elasticsearch-py
 Author: Elastic Client Library Maintainers
@@ -15,7 +15,6 @@ Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
@@ -24,7 +23,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: NOTICE
@@ -35,7 +34,6 @@ Provides-Extra: async
 Requires-Dist: aiohttp<4,>=3; extra == "async"
 
 
-
 Elasticsearch Python Client
 ===========================
 
@@ -75,6 +73,11 @@ Features
 Installation
 ------------
 
+`Download the latest version of Elasticsearch <https://www.elastic.co/downloads/elasticsearch>`_
+or
+`sign-up <https://cloud.elastic.co/registration?elektra=en-ess-sign-up-page>`_
+for a free trial of Elastic Cloud.
+
 Refer to the `Installation section <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_installation>`_ 
 of the getting started documentation.
 

{elasticsearch-8.11.0 → elasticsearch-8.12.0}/README.rst

@@ -2,7 +2,6 @@
 
    <img align="right" width="auto" height="auto" src="https://www.elastic.co/static-res/images/elastic-logo-200.png">
 
-
 Elasticsearch Python Client
 ===========================
 
@@ -42,6 +41,11 @@ Features
 Installation
 ------------
 
+`Download the latest version of Elasticsearch <https://www.elastic.co/downloads/elasticsearch>`_
+or
+`sign-up <https://cloud.elastic.co/registration?elektra=en-ess-sign-up-page>`_
+for a free trial of Elastic Cloud.
+
 Refer to the `Installation section <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_installation>`_ 
 of the getting started documentation.
 

elasticsearch-8.12.0/docs/sphinx/api/autoscaling.rst

@@ -0,0 +1,9 @@
+.. _autoscaling:
+
+Autoscaling
+-----------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: AutoscalingClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/cat.rst

@@ -0,0 +1,9 @@
+.. _cat:
+
+Cat
+---
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: CatClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/ccr.rst

@@ -0,0 +1,9 @@
+.. _ccr:
+
+Cross-Cluster Replication (CCR)
+-------------------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: CcrClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/cluster.rst

@@ -0,0 +1,9 @@
+.. _cluster:
+
+Cluster
+-------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: ClusterClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/dangling-indices.rst

@@ -0,0 +1,9 @@
+.. _dangling-indices:
+
+Dangling Indices
+----------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: DanglingIndicesClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/elasticsearch.rst

@@ -0,0 +1,11 @@
+.. _elasticsearch:
+
+Elasticsearch
+-------------
+
+.. py:module:: elasticsearch
+
+.. autoclass:: Elasticsearch
+   :members:
+
+.. py:module:: elasticsearch.client

elasticsearch-8.12.0/docs/sphinx/api/enrich-policies.rst

@@ -0,0 +1,9 @@
+.. _enrich-policies:
+
+Enrich Policies
+---------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: EnrichClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/eql.rst

@@ -0,0 +1,9 @@
+.. _eql:
+
+Event Query Language (EQL)
+--------------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: EqlClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/esql.rst

@@ -0,0 +1,9 @@
+.. _esql:
+
+ES|QL
+-----
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: EsqlClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/fleet.rst

@@ -0,0 +1,9 @@
+.. _fleet:
+
+Fleet
+-----
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: FleetClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/graph-explore.rst

@@ -0,0 +1,9 @@
+.. _graph-explore:
+
+Graph Explore
+-------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: GraphClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/index-lifecycle-management.rst

@@ -0,0 +1,9 @@
+.. _index-lifecycle-management:
+
+Index Lifecycle Management (ILM)
+--------------------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: IlmClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/indices.rst

@@ -0,0 +1,9 @@
+.. _indices:
+
+Indices
+-------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: IndicesClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/inference.rst

@@ -0,0 +1,9 @@
+.. _inference:
+
+Inference
+---------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: InferenceClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/ingest-pipelines.rst

@@ -0,0 +1,9 @@
+.. _ingest-pipelines:
+
+Ingest Pipelines
+----------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: IngestClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/license.rst

@@ -0,0 +1,9 @@
+.. _license:
+
+License
+-------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: LicenseClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/logstash.rst

@@ -0,0 +1,9 @@
+.. _logstash:
+
+Logstash
+--------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: LogstashClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/migration.rst

@@ -0,0 +1,9 @@
+.. _migration:
+
+Migration
+---------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: MigrationClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/ml.rst

@@ -0,0 +1,9 @@
+.. _ml:
+
+Machine Learning (ML)
+---------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: MlClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/monitoring.rst

@@ -0,0 +1,9 @@
+.. _monitoring:
+
+Monitoring
+----------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: MonitoringClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/nodes.rst

@@ -0,0 +1,9 @@
+.. _nodes:
+
+Nodes
+-----
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: NodesClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/query-rules.rst

@@ -0,0 +1,9 @@
+.. _query-rules:
+
+Query rules
+-----------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: QueryRulesetClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/rollup-indices.rst

@@ -0,0 +1,9 @@
+.. _rollup-indices:
+
+Rollup Indices
+--------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: RollupClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/search-application.rst

@@ -0,0 +1,9 @@
+.. _search-application:
+
+Search Applications
+-------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: SearchApplicationClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/searchable-snapshots.rst

@@ -0,0 +1,9 @@
+.. _searchable-snapshots:
+
+Searchable Snapshots
+--------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: SearchableSnapshotsClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/security.rst

@@ -0,0 +1,9 @@
+.. _security:
+
+Security
+--------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: SecurityClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/shutdown.rst

@@ -0,0 +1,9 @@
+.. _shutdown:
+
+Shutdown
+--------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: ShutdownClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/snapshot-lifecycle-management.rst

@@ -0,0 +1,9 @@
+.. _snapshot-lifecycle-management:
+
+Snapshot Lifecycle Management (SLM)
+-----------------------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: SlmClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/snapshots.rst

@@ -0,0 +1,9 @@
+.. _snapshots:
+
+Snapshots
+---------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: SnapshotClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/snapshottable-features.rst

@@ -0,0 +1,9 @@
+.. _snapshottable-features:
+
+Snapshottable Features
+----------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: FeaturesClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/sql.rst

@@ -0,0 +1,9 @@
+.. _sql:
+
+SQL
+---
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: SqlClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/synonyms.rst

@@ -0,0 +1,9 @@
+.. _synonyms:
+
+Synonyms
+--------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: SynonymsClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/tasks.rst

@@ -0,0 +1,9 @@
+.. _tasks:
+
+Tasks
+-----
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: TasksClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/text-structure.rst

@@ -0,0 +1,9 @@
+.. _text-structure:
+
+Text Structure
+--------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: TextStructureClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/tls-ssl.rst

@@ -0,0 +1,9 @@
+.. _tls-ssl:
+
+TLS/SSL
+-------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: SslClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/transforms.rst

@@ -0,0 +1,9 @@
+.. _transforms:
+
+Transforms
+----------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: TransformClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/watcher.rst

@@ -0,0 +1,9 @@
+.. _watcher:
+
+Watcher
+-------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: WatcherClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api/x-pack.rst

@@ -0,0 +1,9 @@
+.. _x-pack:
+
+X-Pack
+------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: XPackClient
+   :members:

elasticsearch-8.12.0/docs/sphinx/api.rst

@@ -0,0 +1,56 @@
+.. _api:
+
+Elasticsearch API Reference
+===========================
+
+All the API calls map the raw REST API as closely as possible, including the
+distinction between required and optional arguments to the calls. Keyword
+arguments are required for all calls.
+
+.. note::
+
+   Some API parameters in Elasticsearch are reserved keywords in Python.
+   For example the ``from`` query parameter for pagination would be aliased as
+   ``from_``.
+
+.. toctree::
+   :maxdepth: 1
+
+   api/elasticsearch
+   api/autoscaling
+   api/cat
+   api/ccr
+   api/cluster
+   api/dangling-indices
+   api/enrich-policies
+   api/eql
+   api/esql
+   api/fleet
+   api/graph-explore
+   api/index-lifecycle-management
+   api/indices
+   api/inference
+   api/ingest-pipelines
+   api/license
+   api/logstash
+   api/migration
+   api/ml
+   api/monitoring
+   api/nodes
+   api/query-rules
+   api/rollup-indices
+   api/search-application
+   api/searchable-snapshots
+   api/security
+   api/shutdown
+   api/snapshot-lifecycle-management
+   api/snapshots
+   api/snapshottable-features
+   api/sql
+   api/synonyms
+   api/tls-ssl
+   api/tasks
+   api/text-structure
+   api/transforms
+   api/watcher
+   api/x-pack

{elasticsearch-8.11.0 → elasticsearch-8.12.0}/docs/sphinx/async.rst

@@ -2,23 +2,19 @@ Using Asyncio with Elasticsearch
 ================================
 
  .. py:module:: elasticsearch
+    :no-index:
 
-Starting in ``elasticsearch-py`` v7.8.0 for Python 3.6+ the ``elasticsearch`` package supports async/await with
+The ``elasticsearch`` package supports async/await with
 `Asyncio <https://docs.python.org/3/library/asyncio.html>`_ and `Aiohttp <https://docs.aiohttp.org>`_.
 You can either install ``aiohttp`` directly or use the ``[async]`` extra:
 
  .. code-block:: bash
 
-    $ python -m pip install elasticsearch>=7.8.0 aiohttp
+    $ python -m pip install elasticsearch aiohttp
 
     # - OR -
 
-    $ python -m pip install elasticsearch[async]>=7.8.0
-
- .. note::
-    Async functionality is a new feature of this library in v7.8.0+ so
-    `please open an issue <https://github.com/elastic/elasticsearch-py/issues>`_
-    if you find an issue or have a question about async support.
+    $ python -m pip install elasticsearch[async]
 
 Getting Started with Async
 --------------------------
@@ -66,13 +62,13 @@ in the ``examples/fastapi-apm`` directory.
 Frequently Asked Questions
 --------------------------
 
-NameError / ImportError when importing ``AsyncElasticsearch``?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ValueError when initializing ``AsyncElasticsearch``?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-If when trying to use ``AsyncElasticsearch`` and you're receiving a ``NameError`` or ``ImportError``
-you should ensure that you're running Python 3.6+ (check with ``$ python --version``) and
-that you have ``aiohttp`` installed in your environment (check with ``$ python -m pip freeze | grep aiohttp``).
-If either of the above conditions is not met then async support won't be available.
+If when trying to use ``AsyncElasticsearch`` you receive ``ValueError: You must
+have 'aiohttp' installed to use AiohttpHttpNode`` you should ensure that you
+have ``aiohttp`` installed in your environment (check with ``$ python -m pip
+freeze | grep aiohttp``). Otherwise, async support won't be available.
 
 What about the ``elasticsearch-async`` package?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -131,6 +127,7 @@ All async helpers that accept an iterator or generator also accept async iterato
 and async generators.
 
  .. py:module:: elasticsearch.helpers
+    :no-index:
 
 Bulk and Streaming Bulk
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -220,6 +217,7 @@ API Reference
 -------------
 
  .. py:module:: elasticsearch
+    :no-index:
 
 The API of :class:`~elasticsearch.AsyncElasticsearch` is nearly identical
 to the API of :class:`~elasticsearch.Elasticsearch` with the exception that

{elasticsearch-8.11.0 → elasticsearch-8.12.0}/docs/sphinx/exceptions.rst

@@ -4,6 +4,7 @@ Exceptions & Warnings
 =====================
 
 .. py:module:: elasticsearch
+   :noindex:
 
 API Errors
 ----------