diff --git a/api-ref/clients/opensearch_client.html b/api-ref/clients/opensearch_client.html index 8a57cc44..aafcc043 100644 --- a/api-ref/clients/opensearch_client.html +++ b/api-ref/clients/opensearch_client.html @@ -106,7 +106,7 @@

OpenSearch Client
class opensearchpy.OpenSearch(hosts=None, transport_class=<class 'opensearchpy.transport.Transport'>, **kwargs)[source]
-

Bases: object

+

Bases: object

OpenSearch client. Provides a straightforward mapping from Python to OpenSearch REST endpoints.

The instance has attributes cat, cluster, indices, ingest, diff --git a/api-ref/connection.html b/api-ref/connection.html index 46f35eae..5b38e7a6 100644 --- a/api-ref/connection.html +++ b/api-ref/connection.html @@ -120,7 +120,7 @@

connection
class opensearchpy.Connection(host='localhost', port=None, use_ssl=False, url_prefix='', timeout=10, headers=None, http_compress=None, opaque_id=None, **kwargs)[source]
-

Bases: object

+

Bases: object

Class responsible for maintaining a connection to an OpenSearch node. It holds persistent connection pool to it and it’s main interface (perform_request) is thread-safe.

diff --git a/api-ref/connection_pool.html b/api-ref/connection_pool.html index 4af53f61..45f8a7a6 100644 --- a/api-ref/connection_pool.html +++ b/api-ref/connection_pool.html @@ -117,7 +117,7 @@

connection_pool
class opensearchpy.ConnectionPool(connections, dead_timeout=60, timeout_cutoff=5, selector_class=<class 'opensearchpy.connection_pool.RoundRobinSelector'>, randomize_hosts=True, **kwargs)[source]
-

Bases: object

+

Bases: object

Container holding the Connection instances, managing the selection process (via a ConnectionSelector) and dead connections.

@@ -217,7 +217,7 @@

connection_pool
class opensearchpy.ConnectionSelector(opts)[source]
-

Bases: object

+

Bases: object

Simple class used to select a connection from a list of currently live connection instances. In init time it is passed a dictionary containing all the connections’ options which it can then use during the selection diff --git a/api-ref/exceptions.html b/api-ref/exceptions.html index 6f644f96..955f7dec 100644 --- a/api-ref/exceptions.html +++ b/api-ref/exceptions.html @@ -179,7 +179,7 @@

exceptions
class opensearchpy.ImproperlyConfigured[source]
-

Bases: Exception

+

Bases: Exception

Exception raised when the config passed to the client is inconsistent or invalid.

@@ -199,7 +199,7 @@

exceptions
class opensearchpy.OpenSearchException[source]
-

Bases: Exception

+

Bases: Exception

Base class for all exceptions raised by this package’s operations (doesn’t apply to ImproperlyConfigured).

@@ -207,7 +207,7 @@

exceptions
class opensearchpy.OpenSearchWarning[source]
-

Bases: Warning

+

Bases: Warning

Warning that is raised when a deprecated option or incorrect usage is flagged via the ‘Warning’ HTTP header.

@@ -272,7 +272,7 @@

exceptions
class opensearchpy.OpenSearchDslException[source]
-

Bases: Exception

+

Bases: Exception

Base class for all OpenSearchDsl exceptions

@@ -293,7 +293,7 @@

exceptions
class opensearchpy.ValidationException[source]
-

Bases: ValueError, OpenSearchDslException

+

Bases: ValueError, OpenSearchDslException

Exception representing Validation Error

diff --git a/api-ref/helpers/faceted_search.html b/api-ref/helpers/faceted_search.html index 01781daf..f3f71727 100644 --- a/api-ref/helpers/faceted_search.html +++ b/api-ref/helpers/faceted_search.html @@ -116,7 +116,7 @@

faceted_search
class opensearchpy.helpers.faceted_search.FacetedSearch(query=None, filters={}, sort=())[source]
-

Bases: object

+

Bases: object

Abstraction for creating faceted navigation searches that takes care of composing the queries, aggregations and filters as needed as well as presenting the results in an easy-to-consume fashion:

diff --git a/api-ref/helpers/field.html b/api-ref/helpers/field.html index 06f9e48e..520c2422 100644 --- a/api-ref/helpers/field.html +++ b/api-ref/helpers/field.html @@ -120,8 +120,8 @@

field
Parameters:
    -

  • multi (bool) – specifies whether field can contain array of values

    • -

  • required (bool) – specifies whether field is required

    • +

  • multi (bool) – specifies whether field can contain array of values

    • +

  • required (bool) – specifies whether field is required

diff --git a/api-ref/helpers/index.html b/api-ref/helpers/index.html index dccf9ce1..55f6e251 100644 --- a/api-ref/helpers/index.html +++ b/api-ref/helpers/index.html @@ -116,7 +116,7 @@

index
class opensearchpy.helpers.index.Index(name, using='default')[source]
-

Bases: object

+

Bases: object

Parameters: