opensearch-py API reference

127 public APIs from opensearch-py (opensearch-project/opensearch-py) — 27 classes, 4 functions, 96 methods. Signatures extracted by static analysis of the actual source.

Repository: opensearch-project/opensearch-py

Kind	Count
Classes	27
Functions	4
Methods	96

API list

classopensearch_grpc.grpc_transport.GrpcTransport

Transport that routes bulk operations over gRPC.

methodopensearch_grpc.grpc_transport.GrpcTransport.close() -> None

Close gRPC channel and REST connections.

method

opensearch_grpc.grpc_transport.GrpcTransport.perform_request(method:str, url:str, params:Optional[Mapping[str, Any]]=None, body:Any=None, timeout:Optional[Union[int, float]]=None, ignore:Collection[int]=(), headers:Optional[Mapping[str, str]]=None) -> Any

Route to gRPC or REST based on the URL pattern.

classopensearchpy._async.client.AsyncOpenSearch

OpenSearch client.

methodopensearchpy._async.client.AsyncOpenSearch.close() -> None

Closes the Transport and all internal connections

method

opensearchpy._async.client.AsyncOpenSearch.count(*body:Any=None, *index:Any=None, *params:Any=None, *headers:Any=None) -> Any

Returns number of documents matching a query.

method

opensearchpy._async.client.AsyncOpenSearch.create(*index:Any, *id:Any, *body:Any, *params:Any=None, *headers:Any=None) -> Any

Creates a new document in the index.

methodopensearchpy._async.client.AsyncOpenSearch.create_pit(*index:Any, *params:Any=None, *headers:Any=None) -> Any

Creates point in time context.

methodopensearchpy._async.client.AsyncOpenSearch.delete(*index:Any, *id:Any, *params:Any=None, *headers:Any=None) -> Any

Removes a document from the index.

methodopensearchpy._async.client.AsyncOpenSearch.delete_all_pits(*params:Any=None, *headers:Any=None) -> Any

Deletes all active point in time searches.

method

opensearchpy._async.client.AsyncOpenSearch.delete_by_query(*index:Any, *body:Any, *params:Any=None, *headers:Any=None) -> Any

Deletes documents matching the provided query.

methodopensearchpy._async.client.AsyncOpenSearch.delete_script(*id:Any, *params:Any=None, *headers:Any=None) -> Any

Deletes a script.

methodopensearchpy._async.client.AsyncOpenSearch.get(*index:Any, *id:Any, *params:Any=None, *headers:Any=None) -> Any

Returns a document.

methodopensearchpy._async.client.AsyncOpenSearch.get_all_pits(*params:Any=None, *headers:Any=None) -> Any

Lists all active point in time searches.

methodopensearchpy._async.client.AsyncOpenSearch.get_script(*id:Any, *params:Any=None, *headers:Any=None) -> Any

Returns a script.

methodopensearchpy._async.client.AsyncOpenSearch.get_script_context(*params:Any=None, *headers:Any=None) -> Any

Returns all script contexts.

methodopensearchpy._async.client.AsyncOpenSearch.get_source(*index:Any, *id:Any, *params:Any=None, *headers:Any=None) -> Any

Returns the source of a document.

method

opensearchpy._async.client.AsyncOpenSearch.index(*index:Any, *body:Any, *id:Any=None, *params:Any=None, *headers:Any=None) -> Any

Creates or updates a document in an index.

methodopensearchpy._async.client.AsyncOpenSearch.info(*params:Any=None, *headers:Any=None) -> Any

Returns basic information about the cluster.

methodopensearchpy._async.client.AsyncOpenSearch.mget(*body:Any, *index:Any=None, *params:Any=None, *headers:Any=None) -> Any

Allows to get multiple documents in one request.

method

opensearchpy._async.client.AsyncOpenSearch.mtermvectors(*body:Any=None, *index:Any=None, *params:Any=None, *headers:Any=None) -> Any

Returns multiple termvectors in one request.

methodopensearchpy._async.client.AsyncOpenSearch.ping(*params:Any=None, *headers:Any=None) -> Any

Returns whether the cluster is running.

method

opensearchpy._async.client.AsyncOpenSearch.put_script(*id:Any, *body:Any, *context:Any=None, *params:Any=None, *headers:Any=None) -> Any

Creates or updates a script.

method

opensearchpy._async.client.AsyncOpenSearch.search(*body:Any=None, *index:Any=None, *params:Any=None, *headers:Any=None) -> Any

Returns results matching a query.

classopensearchpy._async.client.client.Client

A generic async OpenSearch client.

classopensearchpy._async.transport.AsyncTransport

Encapsulation of transport-related to logic.

methodopensearchpy._async.transport.AsyncTransport.close() -> None

Explicitly closes connections

methodopensearchpy._async.transport.AsyncTransport.create_sniff_task(initial:bool=False) -> None

Initiate a sniffing task.

classopensearchpy.client.OpenSearch

OpenSearch client.

methodopensearchpy.client.OpenSearch.close() -> None

Closes the Transport and all internal connections

methodopensearchpy.client.OpenSearch.count(*body:Any=None, *index:Any=None, *params:Any=None, *headers:Any=None) -> Any

Returns number of documents matching a query.

methodopensearchpy.client.OpenSearch.create(*index:Any, *id:Any, *body:Any, *params:Any=None, *headers:Any=None) -> Any

Creates a new document in the index.

methodopensearchpy.client.OpenSearch.create_pit(*index:Any, *params:Any=None, *headers:Any=None) -> Any

Creates point in time context.

methodopensearchpy.client.OpenSearch.delete(*index:Any, *id:Any, *params:Any=None, *headers:Any=None) -> Any

Removes a document from the index.

methodopensearchpy.client.OpenSearch.delete_all_pits(*params:Any=None, *headers:Any=None) -> Any

Deletes all active point in time searches.

methodopensearchpy.client.OpenSearch.delete_by_query(*index:Any, *body:Any, *params:Any=None, *headers:Any=None) -> Any

Deletes documents matching the provided query.

methodopensearchpy.client.OpenSearch.delete_script(*id:Any, *params:Any=None, *headers:Any=None) -> Any

Deletes a script.

methodopensearchpy.client.OpenSearch.get(*index:Any, *id:Any, *params:Any=None, *headers:Any=None) -> Any

Returns a document.

methodopensearchpy.client.OpenSearch.get_all_pits(*params:Any=None, *headers:Any=None) -> Any

Lists all active point in time searches.

methodopensearchpy.client.OpenSearch.get_script(*id:Any, *params:Any=None, *headers:Any=None) -> Any

Returns a script.

methodopensearchpy.client.OpenSearch.get_script_context(*params:Any=None, *headers:Any=None) -> Any

Returns all script contexts.

methodopensearchpy.client.OpenSearch.get_source(*index:Any, *id:Any, *params:Any=None, *headers:Any=None) -> Any

Returns the source of a document.

methodopensearchpy.client.OpenSearch.index(*index:Any, *body:Any, *id:Any=None, *params:Any=None, *headers:Any=None) -> Any

Creates or updates a document in an index.

methodopensearchpy.client.OpenSearch.info(*params:Any=None, *headers:Any=None) -> Any

Returns basic information about the cluster.

methodopensearchpy.client.OpenSearch.mget(*body:Any, *index:Any=None, *params:Any=None, *headers:Any=None) -> Any

Allows to get multiple documents in one request.

methodopensearchpy.client.OpenSearch.mtermvectors(*body:Any=None, *index:Any=None, *params:Any=None, *headers:Any=None) -> Any

Returns multiple termvectors in one request.

methodopensearchpy.client.OpenSearch.ping(*params:Any=None, *headers:Any=None) -> Any

Returns whether the cluster is running.

method

opensearchpy.client.OpenSearch.put_script(*id:Any, *body:Any, *context:Any=None, *params:Any=None, *headers:Any=None) -> Any

Creates or updates a script.

methodopensearchpy.client.OpenSearch.search(*body:Any=None, *index:Any=None, *params:Any=None, *headers:Any=None) -> Any

Returns results matching a query.

classopensearchpy.client.client.Client

A generic async OpenSearch client.

method

opensearchpy.connection.base.Connection.log_request_success(method:str, full_url:str, path:str, body:Any, status_code:int, response:str, duration:float) -> None

Log a successful API call.

methodopensearchpy.connection.connections.Connections.remove_connection(alias:str) -> None

Remove connection from the registry.

classopensearchpy.connection.http_requests.RequestsHttpConnection

Connection using the `requests` library.

methodopensearchpy.connection.http_requests.RequestsHttpConnection.close() -> None

Explicitly closes connections

methodopensearchpy.connection_pool.ConnectionPool.close() -> Any

Explicitly closes connections

methodopensearchpy.connection_pool.ConnectionPool.mark_dead(connection:Any, now:Optional[float]=None) -> None

Mark the connection as dead (failed).

methodopensearchpy.connection_pool.ConnectionPool.mark_live(connection:Any) -> None

Mark connection as healthy after a resurrection.

methodopensearchpy.connection_pool.ConnectionPool.resurrect(force:bool=False) -> Any

Attempt to resurrect a connection from the dead pool.

classopensearchpy.connection_pool.EmptyConnectionPool

A connection pool that is empty.

classopensearchpy.connection_pool.RandomSelector

Select a connection at random

classopensearchpy.connection_pool.RoundRobinSelector

Selector using round-robin.

classopensearchpy.exceptions.AuthenticationException

Exception representing a 401 status code.

classopensearchpy.exceptions.AuthorizationException

Exception representing a 403 status code.

classopensearchpy.exceptions.ConflictError

Exception representing a 409 status code.

classopensearchpy.exceptions.ConnectionTimeout

A network timeout.

classopensearchpy.exceptions.IllegalOperation

Exception representing IllegalOperation

classopensearchpy.exceptions.NotFoundError

Exception representing a 404 status code.

classopensearchpy.exceptions.OpenSearchDslException

Base class for all OpenSearchDsl exceptions

classopensearchpy.exceptions.RequestError

Exception representing a 400 status code.

classopensearchpy.exceptions.SSLError

Error raised when encountering SSL errors.

methodopensearchpy.exceptions.TransportError.error() -> str

A string error message.

classopensearchpy.exceptions.UnknownDslObject

Exception representing UnknownDSLObject

classopensearchpy.exceptions.ValidationException

Exception representing Validation Error

classopensearchpy.helpers.asyncsigner.AWSV4SignerAsyncAuth

AWS V4 Request Signer for Async Requests.

methodopensearchpy.helpers.document.Document.delete(using:Any=None, index:Any=None, **kwargs:Any) -> Any

Delete the instance in opensearch.

methodopensearchpy.helpers.document.Document.init(index:Any=None, using:Any=None) -> None

Create the index and populate the mappings in opensearch.

method

opensearchpy.helpers.document.Document.save(using:Any=None, index:Any=None, validate:bool=True, skip_empty:bool=True, return_doc_meta:bool=False, **kwargs:Any) -> Any

Save the document into opensearch.

classopensearchpy.helpers.faceted_search.Facet

A facet on faceted search.

methodopensearchpy.helpers.faceted_search.Facet.add_filter(filter_values:Any) -> Any

Construct a filter.

methodopensearchpy.helpers.faceted_search.Facet.get_aggregation() -> Any

Return the aggregation object.

methodopensearchpy.helpers.faceted_search.Facet.get_metric(bucket:Any) -> Any

Return a metric, by default doc_count for a bucket.

methodopensearchpy.helpers.faceted_search.Facet.get_value(bucket:Any) -> Any

return a value representing a bucket.

methodopensearchpy.helpers.faceted_search.Facet.is_filtered(key:Any, filter_values:Any) -> bool

Is a filter active on the given key.

methodopensearchpy.helpers.index.Index.analyzer(*args:Any, **kwargs:Any) -> Any

Explicitly add an analyzer to an index.

methodopensearchpy.helpers.index.Index.close(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Closes the index in opensearch.

methodopensearchpy.helpers.index.Index.create(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Creates the index in opensearch.

methodopensearchpy.helpers.index.Index.delete(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Deletes the index in opensearch.

methodopensearchpy.helpers.index.Index.delete_alias(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Delete specific alias.

methodopensearchpy.helpers.index.Index.flush(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Performs a flush operation on the index.

methodopensearchpy.helpers.index.Index.get_alias(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Retrieve a specified alias.

methodopensearchpy.helpers.index.Index.get_field_mapping(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Retrieve mapping definition of a specific field.

methodopensearchpy.helpers.index.Index.get_settings(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Retrieve settings for the index.

methodopensearchpy.helpers.index.Index.get_upgrade(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Monitor how much of the index is upgraded.

methodopensearchpy.helpers.index.Index.open(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Opens the index in opensearch.

methodopensearchpy.helpers.index.Index.put_alias(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Create an alias for the index.

methodopensearchpy.helpers.index.Index.put_settings(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Change specific index level settings in real time.

methodopensearchpy.helpers.index.Index.refresh(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Performs a refresh operation on the index.

methodopensearchpy.helpers.index.Index.upgrade(using:Optional[OpenSearch]=None, **kwargs:Any) -> Any

Upgrade the index to the latest format.

methodopensearchpy.helpers.search.Request.doc_type(*doc_type:Any, **kwargs:Any) -> Any

Set the type to search through.

methodopensearchpy.helpers.search.Request.extra(**kwargs:Any) -> Any

Add extra keys to the request body.

methodopensearchpy.helpers.search.Request.index(*index:Any) -> Any

Set the index for the search.

methodopensearchpy.helpers.search.Request.params(**kwargs:Any) -> Any

Specify query params to be used when executing the search.

methodopensearchpy.helpers.search.Request.using(client:Any) -> Any

Associate the search request with an opensearch client.

methodopensearchpy.helpers.search.Search.highlight(*fields:Any, **kwargs:Any) -> Any

Request highlighting of some fields.

methodopensearchpy.helpers.search.Search.response_class(cls:Any) -> Any

Override the default wrapper used for the response.

methodopensearchpy.helpers.search.Search.script_fields(**kwargs:Any) -> Any

Define script fields to be calculated on hits.

methodopensearchpy.helpers.search.Search.sort(*keys:Any) -> Any

Add sorting information to the search request.

methodopensearchpy.helpers.search.Search.source(fields:Any=None, **kwargs:Any) -> Any

Selectively control how the _source field is returned.

methodopensearchpy.helpers.search.Search.suggest(name:Any, text:Any, **kwargs:Any) -> Any

Add a suggestions request to the search.

classopensearchpy.helpers.signer.AWSV4Signer

Generic AWS V4 Request Signer.

classopensearchpy.helpers.signer.RequestsAWSV4SignerAuth

AWS V4 Request Signer for Requests.

classopensearchpy.metrics.metrics_none.MetricsNone

Default metrics class.

classopensearchpy.transport.Transport

Encapsulation of transport-related to logic.

methodopensearchpy.transport.Transport.close() -> Any

Explicitly closes connections

methodopensearchpy.transport.Transport.mark_dead(connection:Connection) -> None

Mark a connection as dead (failed) in the connection pool.

functest_opensearchpy.utils.wipe_cluster(client:Any) -> None

Wipes a cluster clean between test cases

functest_opensearchpy.utils.wipe_snapshots(client:Any) -> None

Deletes all the snapshots and repositories from the cluster

methodutils.generate_api.API.body() -> Any

:return: body of the API spec

methodutils.generate_api.API.params() -> Any

:return: itertools.chain of required parts of the API

methodutils.generate_api.API.path() -> Any

:return: the first lexically ordered path in url.paths

methodutils.generate_api.API.to_python() -> Any

:return: rendered Jinja template

methodutils.generate_api.Module.add(api:Any) -> None

add an API to the list of modules :param api: an API object

methodutils.generate_api.Module.dump() -> None

writes the module out to disk

methodutils.generate_api.Module.filepath() -> Any

:return: absolute path to the module

methodutils.generate_api.Module.sort() -> None

sorts the list of APIs by the Module._position key

funcutils.generate_api.clean_description(text:str) -> str

Cleans and flattens multiline description strings.

funcutils.generate_api.resolve_ref(ref:str) -> Optional[Dict[str, Any]]

Resolves a local $ref path within the root JSON schema.

About this data

These signatures were extracted from the public source of opensearch-project/opensearch-py using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries