elasticsearch9 9.1.1__py3-none-any.whl → 9.1.3__py3-none-any.whl

elasticsearch9/_sync/client/transform.py

@@ -85,6 +85,45 @@ class TransformClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters()
+    def get_node_stats(
+        self,
+        *,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        pretty: t.Optional[bool] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        .. raw:: html
+
+          <p>Get node stats.</p>
+          <p>Get per-node information about transform usage.</p>
+
+
+        `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-node-stats>`_
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_transform/_node_stats"
+        __query: t.Dict[str, t.Any] = {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if pretty is not None:
+            __query["pretty"] = pretty
+        __headers = {"accept": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="transform.get_node_stats",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters(
         parameter_aliases={"from": "from_"},
     )
@@ -104,8 +143,8 @@ class TransformClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get transforms.
-          Get configuration information for transforms.</p>
+          <p>Get transforms.</p>
+          <p>Get configuration information for transforms.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform>`_
@@ -262,8 +301,8 @@ class TransformClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Preview a transform.
-          Generates a preview of the results that you will get when you create a transform with the same configuration.</p>
+          <p>Preview a transform.</p>
+          <p>Generates a preview of the results that you will get when you create a transform with the same configuration.</p>
           <p>It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
           generates a list of mappings and settings for the destination index. These values are determined based on the field
           types of the source index and the transform aggregations.</p>
@@ -386,8 +425,8 @@ class TransformClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create a transform.
-          Creates a transform.</p>
+          <p>Create a transform.</p>
+          <p>Creates a transform.</p>
           <p>A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
           a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
           unique row per entity.</p>
@@ -616,8 +655,8 @@ class TransformClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Set upgrade_mode for transform indices.
-          Sets a cluster wide upgrade_mode setting that prepares transform
+          <p>Set upgrade_mode for transform indices.</p>
+          <p>Sets a cluster wide upgrade_mode setting that prepares transform
           indices for an upgrade.
           When upgrading your cluster, in some circumstances you must restart your
           nodes and reindex your transform indices. In those circumstances,
@@ -749,8 +788,8 @@ class TransformClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Stop transforms.
-          Stops one or more transforms.</p>
+          <p>Stop transforms.</p>
+          <p>Stops one or more transforms.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform>`_
@@ -846,8 +885,8 @@ class TransformClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Update a transform.
-          Updates certain properties of a transform.</p>
+          <p>Update a transform.</p>
+          <p>Updates certain properties of a transform.</p>
           <p>All updated properties except <code>description</code> do not take effect until after the transform starts the next checkpoint,
           thus there is data consistency in each checkpoint. To use this API, you must have <code>read</code> and <code>view_index_metadata</code>
           privileges for the source indices. You must also have <code>index</code> and <code>read</code> privileges for the destination index. When

elasticsearch9/_sync/client/utils.py

@@ -79,6 +79,12 @@ class Stability(Enum):
     EXPERIMENTAL = auto()
 
 
+class Visibility(Enum):
+    PUBLIC = auto()
+    FEATURE_FLAG = auto()
+    PRIVATE = auto()
+
+
 _TYPE_HOSTS = Union[
     str, Sequence[Union[str, Mapping[str, Union[str, int]], NodeConfig]]
 ]
@@ -419,15 +425,23 @@ def _rewrite_parameters(
     return wrapper
 
 
-def _stability_warning(
+def _availability_warning(
     stability: Stability,
+    visibility: Visibility = Visibility.PUBLIC,
     version: Optional[str] = None,
     message: Optional[str] = None,
 ) -> Callable[[F], F]:
     def wrapper(api: F) -> F:
         @wraps(api)
         def wrapped(*args: Any, **kwargs: Any) -> Any:
-            if stability == Stability.BETA:
+            if visibility == Visibility.PRIVATE:
+                warnings.warn(
+                    "This API is private. "
+                    "Private APIs are not subject to the support SLA of official GA features.",
+                    category=GeneralAvailabilityWarning,
+                    stacklevel=warn_stacklevel(),
+                )
+            elif stability == Stability.BETA:
                 warnings.warn(
                     "This API is in beta and is subject to change. "
                     "The design and code is less mature than official GA features and is being provided as-is with no warranties. "

elasticsearch9/_sync/client/watcher.py

@@ -39,8 +39,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Acknowledge a watch.
-          Acknowledging a watch enables you to manually throttle the execution of the watch's actions.</p>
+          <p>Acknowledge a watch.</p>
+          <p>Acknowledging a watch enables you to manually throttle the execution of the watch's actions.</p>
           <p>The acknowledgement state of an action is stored in the <code>status.actions.&lt;id&gt;.ack.state</code> structure.</p>
           <p>IMPORTANT: If the specified watch is currently being executed, this API will return an error
           The reason for this behavior is to prevent overwriting the watch status from a watch execution.</p>
@@ -101,8 +101,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Activate a watch.
-          A watch can be either active or inactive.</p>
+          <p>Activate a watch.</p>
+          <p>A watch can be either active or inactive.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch>`_
@@ -145,8 +145,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Deactivate a watch.
-          A watch can be either active or inactive.</p>
+          <p>Deactivate a watch.</p>
+          <p>A watch can be either active or inactive.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch>`_
@@ -189,8 +189,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a watch.
-          When the watch is removed, the document representing the watch in the <code>.watches</code> index is gone and it will never be run again.</p>
+          <p>Delete a watch.</p>
+          <p>When the watch is removed, the document representing the watch in the <code>.watches</code> index is gone and it will never be run again.</p>
           <p>Deleting a watch does not delete any watch execution records related to this watch from the watch history.</p>
           <p>IMPORTANT: Deleting a watch must be done by using only this API.
           Do not delete the watch directly from the <code>.watches</code> index using the Elasticsearch delete document API
@@ -266,8 +266,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Run a watch.
-          This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.</p>
+          <p>Run a watch.</p>
+          <p>This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.</p>
           <p>For testing and debugging purposes, you also have fine-grained control on how the watch runs.
           You can run the watch without running all of its actions or alternatively by simulating them.
           You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.</p>
@@ -362,8 +362,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get Watcher index settings.
-          Get settings for the Watcher internal index (<code>.watches</code>).
+          <p>Get Watcher index settings.</p>
+          <p>Get settings for the Watcher internal index (<code>.watches</code>).
           Only a subset of settings are shown, for example <code>index.auto_expand_replicas</code> and <code>index.number_of_replicas</code>.</p>
 
 
@@ -476,8 +476,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a watch.
-          When a watch is registered, a new document that represents the watch is added to the <code>.watches</code> index and its trigger is immediately registered with the relevant trigger engine.
+          <p>Create or update a watch.</p>
+          <p>When a watch is registered, a new document that represents the watch is added to the <code>.watches</code> index and its trigger is immediately registered with the relevant trigger engine.
           Typically for the <code>schedule</code> trigger, the scheduler is the trigger engine.</p>
           <p>IMPORTANT: You must use Kibana or this API to create a watch.
           Do not add a watch directly to the <code>.watches</code> index by using the Elasticsearch index API.
@@ -494,9 +494,9 @@ class WatcherClient(NamespacedClient):
         :param active: The initial state of the watch. The default value is `true`, which
             means the watch is active by default.
         :param condition: The condition that defines if the actions should be run.
-        :param if_primary_term: only update the watch if the last operation that has
+        :param if_primary_term: Only update the watch if the last operation that has
             changed the watch has the specified primary term
-        :param if_seq_no: only update the watch if the last operation that has changed
+        :param if_seq_no: Only update the watch if the last operation that has changed
             the watch has the specified sequence number
         :param input: The input that defines the input that loads the data for the watch.
         :param metadata: Metadata JSON that will be copied into the history entries.
@@ -552,11 +552,7 @@ class WatcherClient(NamespacedClient):
                 __body["transform"] = transform
             if trigger is not None:
                 __body["trigger"] = trigger
-        if not __body:
-            __body = None  # type: ignore[assignment]
-        __headers = {"accept": "application/json"}
-        if __body is not None:
-            __headers["content-type"] = "application/json"
+        __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "PUT",
             __path,
@@ -595,8 +591,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Query watches.
-          Get all registered watches in a paginated manner and optionally filter watches by a query.</p>
+          <p>Query watches.</p>
+          <p>Get all registered watches in a paginated manner and optionally filter watches by a query.</p>
           <p>Note that only the <code>_id</code> and <code>metadata.*</code> fields are queryable or sortable.</p>
 
 
@@ -671,8 +667,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Start the watch service.
-          Start the Watcher service if it is not already running.</p>
+          <p>Start the watch service.</p>
+          <p>Start the Watcher service if it is not already running.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-start>`_
@@ -736,8 +732,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get Watcher statistics.
-          This API always returns basic metrics.
+          <p>Get Watcher statistics.</p>
+          <p>This API always returns basic metrics.
           You retrieve more metrics by using the metric parameter.</p>
 
 
@@ -788,8 +784,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Stop the watch service.
-          Stop the Watcher service if it is running.</p>
+          <p>Stop the watch service.</p>
+          <p>Stop the Watcher service if it is running.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stop>`_
@@ -844,8 +840,8 @@ class WatcherClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Update Watcher index settings.
-          Update settings for the Watcher internal index (<code>.watches</code>).
+          <p>Update Watcher index settings.</p>
+          <p>Update settings for the Watcher internal index (<code>.watches</code>).
           Only a subset of settings can be modified.
           This includes <code>index.auto_expand_replicas</code>, <code>index.number_of_replicas</code>, <code>index.routing.allocation.exclude.*</code>,
           <code>index.routing.allocation.include.*</code> and <code>index.routing.allocation.require.*</code>.

elasticsearch9/_sync/client/xpack.py

@@ -45,8 +45,8 @@ class XPackClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get information.
-          The information provided by the API includes:</p>
+          <p>Get information.</p>
+          <p>The information provided by the API includes:</p>
           <ul>
           <li>Build information including the build number and timestamp.</li>
           <li>License information about the currently installed license.</li>
@@ -56,7 +56,8 @@ class XPackClient(NamespacedClient):
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-info>`_
 
-        :param accept_enterprise: If this param is used it must be set to true
+        :param accept_enterprise: If used, this otherwise ignored parameter must be set
+            to true
         :param categories: A comma-separated list of the information categories to include
             in the response. For example, `build,license,features`.
         """
@@ -98,8 +99,8 @@ class XPackClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get usage information.
-          Get information about the features that are currently enabled and available under the current license.
+          <p>Get usage information.</p>
+          <p>Get information about the features that are currently enabled and available under the current license.
           The API also provides some usage statistics.</p>
 
 

elasticsearch9/_version.py

@@ -15,4 +15,5 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-__versionstr__ = "9.1.1"
+__versionstr__ = "9.1.3"
+__es_specification_commit__ = "69144c05ec6727c4ee39aec454f7ad6a57d240fc"

elasticsearch9/client.py

@@ -62,6 +62,7 @@ from ._sync.client.slm import SlmClient as SlmClient  # noqa: F401
 from ._sync.client.snapshot import SnapshotClient as SnapshotClient  # noqa: F401
 from ._sync.client.sql import SqlClient as SqlClient  # noqa: F401
 from ._sync.client.ssl import SslClient as SslClient  # noqa: F401
+from ._sync.client.streams import StreamsClient as StreamsClient  # noqa: F401
 from ._sync.client.synonyms import SynonymsClient as SynonymsClient  # noqa: F401
 from ._sync.client.tasks import TasksClient as TasksClient  # noqa: F401
 from ._sync.client.text_structure import (  # noqa: F401
@@ -115,6 +116,7 @@ __all__ = [
     "SnapshotClient",
     "SqlClient",
     "SslClient",
+    "StreamsClient",
     "TasksClient",
     "TextStructureClient",
     "TransformClient",

elasticsearch9/compat.py

@@ -15,11 +15,14 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+import asyncio
 import inspect
 import os
 import sys
+from contextlib import asynccontextmanager, contextmanager
 from pathlib import Path
-from typing import Tuple, Type, Union
+from threading import Thread
+from typing import Any, AsyncIterator, Callable, Coroutine, Iterator, Tuple, Type, Union
 
 string_types: Tuple[Type[str], Type[bytes]] = (str, bytes)
 
@@ -76,9 +79,48 @@ def warn_stacklevel() -> int:
     return 0
 
 
+@contextmanager
+def safe_thread(
+    target: Callable[..., Any], *args: Any, **kwargs: Any
+) -> Iterator[Thread]:
+    """Run a thread within a context manager block.
+
+    The thread is automatically joined when the block ends. If the thread raised
+    an exception, it is raised in the caller's context.
+    """
+    captured_exception = None
+
+    def run() -> None:
+        try:
+            target(*args, **kwargs)
+        except BaseException as exc:
+            nonlocal captured_exception
+            captured_exception = exc
+
+    thread = Thread(target=run)
+    thread.start()
+    yield thread
+    thread.join()
+    if captured_exception:
+        raise captured_exception
+
+
+@asynccontextmanager
+async def safe_task(coro: Coroutine[Any, Any, Any]) -> AsyncIterator[asyncio.Task[Any]]:
+    """Run a background task within a context manager block.
+
+    The task is awaited when the block ends.
+    """
+    task = asyncio.create_task(coro)
+    yield task
+    await task
+
+
 __all__ = [
     "string_types",
     "to_str",
     "to_bytes",
     "warn_stacklevel",
+    "safe_thread",
+    "safe_task",
 ]

elasticsearch9/dsl/__init__.py

@@ -38,23 +38,30 @@ from .faceted_search import (
     TermsFacet,
 )
 from .field import (
+    AggregateMetricDouble,
+    Alias,
     Binary,
     Boolean,
     Byte,
     Completion,
     ConstantKeyword,
+    CountedKeyword,
     CustomField,
     Date,
+    DateNanos,
     DateRange,
     DenseVector,
     Double,
     DoubleRange,
     Field,
+    Flattened,
     Float,
     FloatRange,
     GeoPoint,
     GeoShape,
     HalfFloat,
+    Histogram,
+    IcuCollationKeyword,
     Integer,
     IntegerRange,
     Ip,
@@ -63,21 +70,28 @@ from .field import (
     Keyword,
     Long,
     LongRange,
+    MatchOnlyText,
     Murmur3,
     Nested,
     Object,
+    Passthrough,
     Percolator,
     Point,
     RangeField,
     RankFeature,
     RankFeatures,
+    RankVectors,
     ScaledFloat,
     SearchAsYouType,
+    SemanticText,
     Shape,
     Short,
     SparseVector,
     Text,
     TokenCount,
+    UnsignedLong,
+    Version,
+    Wildcard,
     construct_field,
 )
 from .function import SF
@@ -108,6 +122,8 @@ __all__ = [
     "A",
     "Agg",
     "AggResponse",
+    "AggregateMetricDouble",
+    "Alias",
     "AsyncComposableIndexTemplate",
     "AsyncDocument",
     "AsyncEmptySearch",
@@ -126,9 +142,11 @@ __all__ = [
     "Completion",
     "ComposableIndexTemplate",
     "ConstantKeyword",
+    "CountedKeyword",
     "CustomField",
     "Date",
     "DateHistogramFacet",
+    "DateNanos",
     "DateRange",
     "DenseVector",
     "Document",
@@ -142,12 +160,15 @@ __all__ = [
     "FacetedResponse",
     "FacetedSearch",
     "Field",
+    "Flattened",
     "Float",
     "FloatRange",
     "GeoPoint",
     "GeoShape",
     "HalfFloat",
+    "Histogram",
     "HistogramFacet",
+    "IcuCollationKeyword",
     "IllegalOperation",
     "Index",
     "IndexTemplate",
@@ -162,12 +183,14 @@ __all__ = [
     "LongRange",
     "M",
     "Mapping",
+    "MatchOnlyText",
     "MetaField",
     "MultiSearch",
     "Murmur3",
     "Nested",
     "NestedFacet",
     "Object",
+    "Passthrough",
     "Percolator",
     "Point",
     "Q",
@@ -177,11 +200,13 @@ __all__ = [
     "RangeField",
     "RankFeature",
     "RankFeatures",
+    "RankVectors",
     "Response",
     "SF",
     "ScaledFloat",
     "Search",
     "SearchAsYouType",
+    "SemanticText",
     "Shape",
     "Short",
     "SparseVector",
@@ -189,9 +214,12 @@ __all__ = [
     "Text",
     "TokenCount",
     "UnknownDslObject",
+    "UnsignedLong",
     "UpdateByQuery",
     "UpdateByQueryResponse",
     "ValidationException",
+    "Version",
+    "Wildcard",
     "analyzer",
     "async_connections",
     "char_filter",

elasticsearch9/dsl/_async/document.py

@@ -31,9 +31,8 @@ from typing import (
 
 from typing_extensions import Self, dataclass_transform
 
-from elasticsearch.exceptions import NotFoundError, RequestError
-from elasticsearch.helpers import async_bulk
-
+from ...exceptions import NotFoundError, RequestError
+from ...helpers import async_bulk
 from .._async.index import AsyncIndex
 from ..async_connections import get_connection
 from ..document_base import DocumentBase, DocumentMeta, mapped_field
@@ -42,8 +41,8 @@ from ..utils import DOC_META_FIELDS, META_FIELDS, AsyncUsingType, merge
 from .search import AsyncSearch
 
 if TYPE_CHECKING:
-    from elasticsearch import AsyncElasticsearch
-    from elasticsearch.esql.esql import ESQLBase
+    from ... import AsyncElasticsearch
+    from ...esql.esql import ESQLBase
 
 
 class AsyncIndexMeta(DocumentMeta):

elasticsearch9/dsl/_async/index.py

@@ -30,7 +30,7 @@ from .update_by_query import AsyncUpdateByQuery
 if TYPE_CHECKING:
     from elastic_transport import ObjectApiResponse
 
-    from elasticsearch import AsyncElasticsearch
+    from ... import AsyncElasticsearch
 
 
 class AsyncIndexTemplate:

elasticsearch9/dsl/_async/search.py

@@ -29,9 +29,8 @@ from typing import (
 
 from typing_extensions import Self
 
-from elasticsearch.exceptions import ApiError
-from elasticsearch.helpers import async_scan
-
+from ...exceptions import ApiError
+from ...helpers import async_scan
 from ..async_connections import get_connection
 from ..response import Response
 from ..search_base import MultiSearchBase, SearchBase

elasticsearch9/dsl/_sync/document.py

@@ -31,9 +31,8 @@ from typing import (
 
 from typing_extensions import Self, dataclass_transform
 
-from elasticsearch.exceptions import NotFoundError, RequestError
-from elasticsearch.helpers import bulk
-
+from ...exceptions import NotFoundError, RequestError
+from ...helpers import bulk
 from .._sync.index import Index
 from ..connections import get_connection
 from ..document_base import DocumentBase, DocumentMeta, mapped_field
@@ -42,8 +41,8 @@ from ..utils import DOC_META_FIELDS, META_FIELDS, UsingType, merge
 from .search import Search
 
 if TYPE_CHECKING:
-    from elasticsearch import Elasticsearch
-    from elasticsearch.esql.esql import ESQLBase
+    from ... import Elasticsearch
+    from ...esql.esql import ESQLBase
 
 
 class IndexMeta(DocumentMeta):

elasticsearch9/dsl/_sync/index.py

@@ -30,7 +30,7 @@ from .update_by_query import UpdateByQuery
 if TYPE_CHECKING:
     from elastic_transport import ObjectApiResponse
 
-    from elasticsearch import Elasticsearch
+    from ... import Elasticsearch
 
 
 class IndexTemplate:

elasticsearch9/dsl/_sync/search.py

@@ -28,9 +28,8 @@ from typing import (
 
 from typing_extensions import Self
 
-from elasticsearch.exceptions import ApiError
-from elasticsearch.helpers import scan
-
+from ...exceptions import ApiError
+from ...helpers import scan
 from ..connections import get_connection
 from ..response import Response
 from ..search_base import MultiSearchBase, SearchBase