elasticsearch9 9.0.0__tar.gz → 9.0.2__tar.gz

{elasticsearch9-9.0.0 → elasticsearch9-9.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elasticsearch9
-Version: 9.0.0
+Version: 9.0.2
 Summary: Python client for Elasticsearch
 Project-URL: Documentation, https://elasticsearch9-py.readthedocs.io/
 Project-URL: Homepage, https://github.com/elastic/elasticsearch9-py
@@ -142,24 +142,23 @@ of the getting started documentation.
 
 ## Compatibility
 
-Language clients are forward compatible; meaning that the clients support
-communicating with greater or equal minor versions of Elasticsearch without
-breaking. It does not mean that the clients automatically support new features
-of newer Elasticsearch versions; it is only possible after a release of a new
-client version. For example, a 8.12 client version won't automatically support
-the new features of the 8.13 version of Elasticsearch, the 8.13 client version
-is required for that. Elasticsearch language clients are only backwards
-compatible with default distributions and without guarantees made.
+Language clients are _forward compatible:_ each client version works with equivalent and later minor versions of Elasticsearch without breaking.
 
-| Elasticsearch Version | Elasticsearch-Python Branch | Supported |
-| --------------------- | ------------------------ | --------- |
-| main                  | main                     |           |
-| 8.x                   | 8.x                      | 8.x       |
-| 7.x                   | 7.x                      | 7.17      |
+Compatibility does not imply full feature parity. New Elasticsearch features are supported only in equivalent client versions. For example, an 8.12 client fully supports Elasticsearch 8.12 features and works with 8.13 without breaking; however, it does not support new Elasticsearch 8.13 features. An 8.13 client fully supports Elasticsearch 8.13 features.
 
+| Elasticsearch version | elasticsearch-py branch |
+| --- | --- |
+| main | main |
+| 9.x | 9.x |
+| 9.x | 8.x |
+| 8.x | 8.x |
 
-If you have a need to have multiple versions installed at the same time older
-versions are also released as ``elasticsearch7`` and ``elasticsearch8``.
+Elasticsearch language clients are also _backward compatible_ across minor versions — with default distributions and without guarantees.
+
+> [!TIP]
+> To upgrade to a new major version, first upgrade Elasticsearch, then upgrade the Python Elasticsearch client.
+
+If you need to work with multiple client versions, note that older versions are also released as `elasticsearch7` and `elasticsearch8`.
 
 
 ## Documentation

{elasticsearch9-9.0.0 → elasticsearch9-9.0.2}/README.md

@@ -63,24 +63,23 @@ of the getting started documentation.
 
 ## Compatibility
 
-Language clients are forward compatible; meaning that the clients support
-communicating with greater or equal minor versions of Elasticsearch without
-breaking. It does not mean that the clients automatically support new features
-of newer Elasticsearch versions; it is only possible after a release of a new
-client version. For example, a 8.12 client version won't automatically support
-the new features of the 8.13 version of Elasticsearch, the 8.13 client version
-is required for that. Elasticsearch language clients are only backwards
-compatible with default distributions and without guarantees made.
-
-| Elasticsearch Version | Elasticsearch-Python Branch | Supported |
-| --------------------- | ------------------------ | --------- |
-| main                  | main                     |           |
-| 8.x                   | 8.x                      | 8.x       |
-| 7.x                   | 7.x                      | 7.17      |
-
-
-If you have a need to have multiple versions installed at the same time older
-versions are also released as ``elasticsearch7`` and ``elasticsearch8``.
+Language clients are _forward compatible:_ each client version works with equivalent and later minor versions of Elasticsearch without breaking.
+
+Compatibility does not imply full feature parity. New Elasticsearch features are supported only in equivalent client versions. For example, an 8.12 client fully supports Elasticsearch 8.12 features and works with 8.13 without breaking; however, it does not support new Elasticsearch 8.13 features. An 8.13 client fully supports Elasticsearch 8.13 features.
+
+| Elasticsearch version | elasticsearch-py branch |
+| --- | --- |
+| main | main |
+| 9.x | 9.x |
+| 9.x | 8.x |
+| 8.x | 8.x |
+
+Elasticsearch language clients are also _backward compatible_ across minor versions — with default distributions and without guarantees.
+
+> [!TIP]
+> To upgrade to a new major version, first upgrade Elasticsearch, then upgrade the Python Elasticsearch client.
+
+If you need to work with multiple client versions, note that older versions are also released as `elasticsearch7` and `elasticsearch8`.
 
 
 ## Documentation

elasticsearch9-9.0.2/docs/sphinx/api_helpers.rst

@@ -0,0 +1,26 @@
+.. _helpers:
+
+Helpers
+=======
+
+.. py:module:: elasticsearch.helpers
+
+Streaming Bulk
+--------------
+.. autofunction:: streaming_bulk
+
+Parallel Bulk
+-------------
+.. autofunction:: parallel_bulk
+
+Bulk
+----
+.. autofunction:: bulk
+
+Scan
+----
+.. autofunction:: scan
+
+Reindex
+-------
+.. autofunction:: reindex

elasticsearch9-9.0.2/docs/sphinx/async_api_helpers.rst

@@ -0,0 +1,29 @@
+Async Helpers
+=============
+
+Async variants of all helpers are available in ``elasticsearch.helpers``
+and are all prefixed with ``async_*``. You'll notice that these APIs
+are identical to the ones in the sync :ref:`helpers` documentation.
+
+All async helpers that accept an iterator or generator also accept async iterators
+and async generators.
+
+ .. py:module:: elasticsearch.helpers
+    :no-index:
+
+Streaming Bulk
+--------------
+ .. autofunction:: async_streaming_bulk
+
+Bulk
+----
+ .. autofunction:: async_bulk
+
+Scan
+----
+ .. autofunction:: async_scan
+
+Reindex
+-------
+ .. autofunction:: async_reindex
+

elasticsearch9-9.0.2/docs/sphinx/async_dsl.rst

@@ -0,0 +1,49 @@
+.. _async_dsl:
+
+Async DSL
+=========
+
+.. py:module:: elasticsearch.dsl
+   :no-index:
+
+Search
+------
+.. autoclass:: AsyncSearch
+   :inherited-members:
+   :members:
+
+Multi-Search
+------------
+.. autoclass:: AsyncMultiSearch
+   :inherited-members:
+   :members:
+
+Document
+--------
+.. autoclass:: AsyncDocument
+   :inherited-members:
+   :members:
+
+Index
+-----
+.. autoclass:: AsyncIndex
+   :inherited-members:
+   :members:
+
+Mapping
+-------
+.. autoclass:: AsyncMapping
+   :inherited-members:
+   :members:
+
+Faceted Search
+--------------
+.. autoclass:: AsyncFacetedSearch
+   :inherited-members:
+   :members:
+
+Update by Query
+---------------
+.. autoclass:: AsyncUpdateByQuery
+   :inherited-members:
+   :members:

elasticsearch9-9.0.2/docs/sphinx/async_es_api.rst

@@ -0,0 +1,15 @@
+Async Elasticsearch API
+=======================
+
+ .. py:module:: elasticsearch
+    :no-index:
+
+ .. note::
+
+    To reference Elasticsearch APIs that are namespaced like ``.indices.create()``
+    refer to the sync API reference. These APIs are identical between sync and async.
+
+Elasticsearch
+-------------
+ .. autoclass:: AsyncElasticsearch
+   :members:

elasticsearch9-9.0.2/docs/sphinx/dsl.rst

@@ -0,0 +1,49 @@
+.. _dsl:
+
+DSL
+===
+
+.. py:module:: elasticsearch.dsl
+
+Search
+------
+.. autoclass:: Search
+   :inherited-members:
+   :members:
+
+Multi-Search
+------------
+.. autoclass:: MultiSearch
+   :inherited-members:
+   :members:
+
+Document
+--------
+.. autoclass:: Document
+   :inherited-members:
+   :members:
+
+Index
+-----
+.. autoclass:: Index
+   :inherited-members:
+   :members:
+
+Mapping
+-------
+.. autoclass:: Mapping
+   :inherited-members:
+   :members:
+
+Faceted Search
+--------------
+.. autoclass:: FacetedSearch
+   :inherited-members:
+   :members:
+
+Update by Query
+---------------
+.. autoclass:: UpdateByQuery
+   :inherited-members:
+   :members:
+

elasticsearch9-9.0.0/docs/sphinx/api.rst → elasticsearch9-9.0.2/docs/sphinx/es_api.rst

@@ -1,7 +1,7 @@
 .. _api:
 
-Elasticsearch API Reference
-===========================
+Elasticsearch API
+=================
 
 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

elasticsearch9-9.0.2/docs/sphinx/index.rst

@@ -0,0 +1,38 @@
+Python Elasticsearch Client
+===========================
+
+Welcome to the API documentation of the official Python client for Elasticsearch!
+The goal of this client is to provide common ground for all Elasticsearch-related
+code in Python; because of this it tries to be opinion-free and very extendable.
+
+High-level documentation for this client is `also available <https://www.elastic.co/docs/reference/elasticsearch/clients/python>`_.
+
+.. toctree::
+   :maxdepth: 2 
+
+   es_api
+   dsl
+   api_helpers
+   exceptions
+
+.. toctree::
+   :caption: Async
+   :maxdepth: 2
+
+   async_es_api
+   async_dsl
+   async_api_helpers
+
+
+License
+-------
+
+Copyright 2023 Elasticsearch B.V. Licensed under the Apache License, Version 2.0.
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

{elasticsearch9-9.0.0 → elasticsearch9-9.0.2}/elasticsearch9/_async/client/__init__.py

@@ -4652,11 +4652,11 @@ class AsyncElasticsearch(BaseClient):
             of the specified nodes are available, select shards from any available node
             using the default method. * `_prefer_nodes:<node-id>,<node-id>` to if possible,
             run the search on the specified nodes IDs. If not, select shards using the
-            default method. `_shards:<shard>,<shard>` to run the search only on the specified
-            shards. You can combine this value with other `preference` values. However,
-            the `_shards` value must come first. For example: `_shards:2,3|_local`. `<custom-string>`
-            (any string that does not start with `_`) to route searches with the same
-            `<custom-string>` to the same shards in the same order.
+            default method. * `_shards:<shard>,<shard>` to run the search only on the
+            specified shards. You can combine this value with other `preference` values.
+            However, the `_shards` value must come first. For example: `_shards:2,3|_local`.
+            * `<custom-string>` (any string that does not start with `_`) to route searches
+            with the same `<custom-string>` to the same shards in the same order.
         :param profile: Set to `true` to return detailed timing information about the
             execution of individual components in a search request. NOTE: This is a debugging
             tool and adds significant overhead to search execution.

{elasticsearch9-9.0.0 → elasticsearch9-9.0.2}/elasticsearch9/_async/client/cat.py

@@ -1767,7 +1767,200 @@ class CatClient(NamespacedClient):
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         format: t.Optional[str] = None,
         full_id: t.Optional[t.Union[bool, str]] = None,
-        h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        h: t.Optional[
+            t.Union[
+                t.Sequence[
+                    t.Union[
+                        str,
+                        t.Literal[
+                            "build",
+                            "completion.size",
+                            "cpu",
+                            "disk.avail",
+                            "disk.total",
+                            "disk.used",
+                            "disk.used_percent",
+                            "fielddata.evictions",
+                            "fielddata.memory_size",
+                            "file_desc.current",
+                            "file_desc.max",
+                            "file_desc.percent",
+                            "flush.total",
+                            "flush.total_time",
+                            "get.current",
+                            "get.exists_time",
+                            "get.exists_total",
+                            "get.missing_time",
+                            "get.missing_total",
+                            "get.time",
+                            "get.total",
+                            "heap.current",
+                            "heap.max",
+                            "heap.percent",
+                            "http_address",
+                            "id",
+                            "indexing.delete_current",
+                            "indexing.delete_time",
+                            "indexing.delete_total",
+                            "indexing.index_current",
+                            "indexing.index_failed",
+                            "indexing.index_failed_due_to_version_conflict",
+                            "indexing.index_time",
+                            "indexing.index_total",
+                            "ip",
+                            "jdk",
+                            "load_15m",
+                            "load_1m",
+                            "load_5m",
+                            "mappings.total_count",
+                            "mappings.total_estimated_overhead_in_bytes",
+                            "master",
+                            "merges.current",
+                            "merges.current_docs",
+                            "merges.current_size",
+                            "merges.total",
+                            "merges.total_docs",
+                            "merges.total_size",
+                            "merges.total_time",
+                            "name",
+                            "node.role",
+                            "pid",
+                            "port",
+                            "query_cache.evictions",
+                            "query_cache.hit_count",
+                            "query_cache.memory_size",
+                            "query_cache.miss_count",
+                            "ram.current",
+                            "ram.max",
+                            "ram.percent",
+                            "refresh.time",
+                            "refresh.total",
+                            "request_cache.evictions",
+                            "request_cache.hit_count",
+                            "request_cache.memory_size",
+                            "request_cache.miss_count",
+                            "script.cache_evictions",
+                            "script.compilations",
+                            "search.fetch_current",
+                            "search.fetch_time",
+                            "search.fetch_total",
+                            "search.open_contexts",
+                            "search.query_current",
+                            "search.query_time",
+                            "search.query_total",
+                            "search.scroll_current",
+                            "search.scroll_time",
+                            "search.scroll_total",
+                            "segments.count",
+                            "segments.fixed_bitset_memory",
+                            "segments.index_writer_memory",
+                            "segments.memory",
+                            "segments.version_map_memory",
+                            "shard_stats.total_count",
+                            "suggest.current",
+                            "suggest.time",
+                            "suggest.total",
+                            "uptime",
+                            "version",
+                        ],
+                    ]
+                ],
+                t.Union[
+                    str,
+                    t.Literal[
+                        "build",
+                        "completion.size",
+                        "cpu",
+                        "disk.avail",
+                        "disk.total",
+                        "disk.used",
+                        "disk.used_percent",
+                        "fielddata.evictions",
+                        "fielddata.memory_size",
+                        "file_desc.current",
+                        "file_desc.max",
+                        "file_desc.percent",
+                        "flush.total",
+                        "flush.total_time",
+                        "get.current",
+                        "get.exists_time",
+                        "get.exists_total",
+                        "get.missing_time",
+                        "get.missing_total",
+                        "get.time",
+                        "get.total",
+                        "heap.current",
+                        "heap.max",
+                        "heap.percent",
+                        "http_address",
+                        "id",
+                        "indexing.delete_current",
+                        "indexing.delete_time",
+                        "indexing.delete_total",
+                        "indexing.index_current",
+                        "indexing.index_failed",
+                        "indexing.index_failed_due_to_version_conflict",
+                        "indexing.index_time",
+                        "indexing.index_total",
+                        "ip",
+                        "jdk",
+                        "load_15m",
+                        "load_1m",
+                        "load_5m",
+                        "mappings.total_count",
+                        "mappings.total_estimated_overhead_in_bytes",
+                        "master",
+                        "merges.current",
+                        "merges.current_docs",
+                        "merges.current_size",
+                        "merges.total",
+                        "merges.total_docs",
+                        "merges.total_size",
+                        "merges.total_time",
+                        "name",
+                        "node.role",
+                        "pid",
+                        "port",
+                        "query_cache.evictions",
+                        "query_cache.hit_count",
+                        "query_cache.memory_size",
+                        "query_cache.miss_count",
+                        "ram.current",
+                        "ram.max",
+                        "ram.percent",
+                        "refresh.time",
+                        "refresh.total",
+                        "request_cache.evictions",
+                        "request_cache.hit_count",
+                        "request_cache.memory_size",
+                        "request_cache.miss_count",
+                        "script.cache_evictions",
+                        "script.compilations",
+                        "search.fetch_current",
+                        "search.fetch_time",
+                        "search.fetch_total",
+                        "search.open_contexts",
+                        "search.query_current",
+                        "search.query_time",
+                        "search.query_total",
+                        "search.scroll_current",
+                        "search.scroll_time",
+                        "search.scroll_total",
+                        "segments.count",
+                        "segments.fixed_bitset_memory",
+                        "segments.index_writer_memory",
+                        "segments.memory",
+                        "segments.version_map_memory",
+                        "shard_stats.total_count",
+                        "suggest.current",
+                        "suggest.time",
+                        "suggest.total",
+                        "uptime",
+                        "version",
+                    ],
+                ],
+            ]
+        ] = None,
         help: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
         include_unloaded_segments: t.Optional[bool] = None,
@@ -1794,16 +1987,17 @@ class CatClient(NamespacedClient):
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :param full_id: If `true`, return the full node ID. If `false`, return the shortened
             node ID.
-        :param h: List of columns to appear in the response. Supports simple wildcards.
+        :param h: A comma-separated list of columns names to display. It supports simple
+            wildcards.
         :param help: When set to `true` will output available columns. This option can't
             be combined with any other query string option.
         :param include_unloaded_segments: If true, the response includes information
             from segments that are not loaded into memory.
-        :param master_timeout: Period to wait for a connection to the master node.
-        :param s: List of columns that determine how the table should be sorted. Sorting
-            defaults to ascending and can be changed by setting `:asc` or `:desc` as
-            a suffix to the column name.
-        :param time: Unit used to display time values.
+        :param master_timeout: The period to wait for a connection to the master node.
+        :param s: A comma-separated list of column names or aliases that determines the
+            sort order. Sorting defaults to ascending and can be changed by setting `:asc`
+            or `:desc` as a suffix to the column name.
+        :param time: The unit used to display time values.
         :param v: When set to `true` will enable verbose output.
         """
         __path_parts: t.Dict[str, str] = {}

{elasticsearch9-9.0.0 → elasticsearch9-9.0.2}/elasticsearch9/_async/client/indices.py

@@ -265,7 +265,7 @@ class IndicesClient(NamespacedClient):
           <p>Cancel a migration reindex attempt for a data stream or index.</p>
 
 
-        `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-migration>`_
+        `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-cancel-migrate-reindex>`_
 
         :param index: The index or data stream name
         """
@@ -656,7 +656,15 @@ class IndicesClient(NamespacedClient):
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create>`_
 
-        :param index: Name of the index you wish to create.
+        :param index: Name of the index you wish to create. Index names must meet the
+            following criteria: * Lowercase only * Cannot include `\\`, `/`, `*`, `?`,
+            `"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#` * Indices prior to
+            7.0 could contain a colon (`:`), but that has been deprecated and will not
+            be supported in later versions * Cannot start with `-`, `_`, or `+` * Cannot
+            be `.` or `..` * Cannot be longer than 255 bytes (note thtat it is bytes,
+            so multi-byte characters will reach the limit faster) * Names starting with
+            `.` are deprecated, except for hidden indices and internal indices managed
+            by plugins
         :param aliases: Aliases for the index.
         :param mappings: Mapping for fields in the index. If specified, this mapping
             can include: - Field names - Field data types - Mapping parameters
@@ -794,7 +802,7 @@ class IndicesClient(NamespacedClient):
           <p>Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.</p>
 
 
-        `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-migration>`_
+        `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create-from>`_
 
         :param source: The source index or data stream name
         :param dest: The destination index or data stream name
@@ -1246,7 +1254,8 @@ class IndicesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a legacy index template.</p>
+          <p>Delete a legacy index template.
+          IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-template>`_
@@ -2880,7 +2889,7 @@ class IndicesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get index templates.
+          <p>Get legacy index templates.
           Get information about one or more index templates.</p>
           <p>IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
 
@@ -2952,7 +2961,7 @@ class IndicesClient(NamespacedClient):
           The persistent task ID is returned immediately and the reindexing work is completed in that task.</p>
 
 
-        `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-migration>`_
+        `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-reindex>`_
 
         :param reindex:
         """
@@ -3973,7 +3982,7 @@ class IndicesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update an index template.
+          <p>Create or update a legacy index template.
           Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
           Elasticsearch applies templates to new indices based on an index pattern that matches the index name.</p>
           <p>IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>