This class represents all settings that can be configured for how astrapy interacts with the API (both Data API and DevOps API). Each object

An immutable 'map-like' class that preserves the order and can employ non-hashable keys (which must support __eq__). Not designed for perform

r""" A class wrapping a list of float numbers to be treated as a "vector" within the Data API. This class has the same functionalities as the

Represents and describes a column in a Table, of scalar type, i.e. which contains a single simple value. See the docstring for class `Cr

The group of settings for the API Options concerning serialization and deserialization of values to and from the Data API. Write-path setting

This class encodes standardized "enriched information" attached to a timeout value to obey. This makes it possible, in case the timeout is ra

The Data API response is malformed in that it does not have expected field(s), or they are of the wrong type. Attributes: text:

An immutable 'set-like' class that preserves the order and can store non-hashable entries (entries must support __eq__). Not designed for per

A client for using the Data API. This is the entry point, sitting at the top of the conceptual "client -> database -> collection" hierarchy

A structure expressing the options of a collection. See the Data API specifications for detailed specification and allowed values. Insta

A "duration" value, suitable for working with the "duration" table column type. Durations are an abstract notion: as such, they cannot be ma

The top-level object describing a table index on a column. The hierarchical arrangement of `TableIndexDescriptor`, which contains a `Tab

A structure expressing the definition ("schema") of a table to be created through the Data API. This object is passed as the `definition` par

A Data API database. This is the object for doing database-level DML, such as creating/deleting collections, and for obtaining Collection

Represents the part of a table definition that describes the primary key. See the docstring for class `CreateTableDefinition` for in-context

A `dict` subclass acting as a marker for wrapping user-defined type (UDT) data. This object behaves entirely as a regular Python `dict`.

An exception specific to issuing requests to the DevOps API.

An object describing the options for a table regular (non-vector) index. Both when creating indexes and retrieving index metadata from the A

Represents and describes a column in a Table, of a 'valued' type that stores multiple values. This means either a list or a set of homogeneou

Represents and describes a column in a Table, of vector type, i.e. which contains a list of `dimension` floats that is treated specially as a

An object describing a regular (non-vector) index definition, including the name of the indexed column and the index options. Attributes

A helper class to keep track of timing and timeouts in a multi-call method context. Args: overall_timeout_ms: an optional max du

A "pass-through" provider that wraps a supplied literal token. Args: token: an access token for subsequent use in the client. E

A Data API database. This is the object for doing database-level DML, such as creating/deleting collections, and for obtaining Collection

Represents and describes a column in a Table, of a 'key-value' type, that stores an associative map (essentially a dict) between keys of a ce

The "vector.service" component of the collection options. See the Data API specifications for allowed values. Attributes: provid

An operation was attempted, that is not available on the specified environment. For example, trying to get an AstraDBAdmin from a client

The cursor operation cannot be invoked if a cursor is not in its pristine state (i.e. is already being consumed or is exhausted altogether).

Represents a database definition for database creation operations (excluding the DB name). Attributes: cloud_provider: the cloud pro

An object describing the options for a table vector index, which is the index that enables vector (ANN) search on a column. Both when cr

The "vector" component of the collection options. See the Data API specifications for allowed values. Attributes: dimension: an

A Data API collection, the object to interact with the Data API for unstructured (schemaless) data, especially for DDL operations. This c

A Data API collection, the object to interact with the Data API for unstructured (schemaless) data, especially for DDL operations. This c

A value expressing a time, composed of hours, minutes, seconds and nanoseconds, suitable for working with the "time" table column type.

The "lexical" component of the collection options. See the Data API specifications for allowed values. Attributes: enabled: use

A counterpart of the Player model class (see), but whose each field can be omitted and defaults to None.

The "rerank.service" component of the collection options. See the Data API specifications for allowed values. Attributes: provid

An object describing a text index definition, including the name of the indexed column and the index options. Attributes: column

An object describing the options for a table text index, which is the index that enables lexicographical matching on a text column. Both

An object describing a vector index definition, including the name of the indexed column and the index options. Attributes: colu

A token provider encoding username/password-based authentication, as used e.g. for DSE and HCD. These are base64-encoded and concatenated

An "admin" object, able to perform administrative tasks at the keyspaces level (i.e. within a certain database), such as creating/listing/dro

The "defaultId" component of the collection options. See the Data API specifications for allowed values. Attributes: default_id_

A structure expressing the definition of a user-defined type( UDT) to be created through the Data API. This object is passed as the `definiti

A value expressing a unambiguous timestamp, accurate to down millisecond precision, suitable for working with the "timestamp" table column ty

The group of settings for the API Options concerning the configured timeouts for various kinds of API operations. All timeout values are

The "rerank" component of the collection options. See the Data API specifications for allowed values. Attributes: enabled: use t

An "admin" object for non-Astra Data API environments, to perform administrative tasks at the keyspaces level such as creating/listing/droppi

An object representing the alter-type operation of adding field(s), for use in the argument to the database's `alter_type()` method. Att

Represents and describes a column in a Table, of a user-defined type (UDT) type, i.e. a previously-defined set of named fields, each with its

An "admin" object, able to perform administrative tasks at the databases level, such as creating, listing or dropping databases. This cl

Class that represents the result of any update operation on a collection. Attributes: raw_results: responses from the Data API calls

An object representing a single error, as returned from the Data API, typically with an error code, a text message and other properties.

The group of settings for the API Options that determines the URL used to reach the DevOps API. This class is used to override default s

An object representing the alter-type operation of renaming field(s), for use in the argument to the database's `alter_type()` method. A

An example dataclass which may be used to represent a user-defined type (UDT) such as one would define, and create on the database, with this

An example dataclass which may be used to represent a user-defined type (UDT) such as one would define, and create on the database, with this

An object representing the alter-table operation of dropping column(s), for use as argument to the table's `alter()` method. Attributes:

Class that represents the result of delete operations on a collection. Attributes: deleted_count: number of deleted documents

The group of settings for the API Options that determines the URL used to reach the Data API. This class is used to override default set

A "pass-through" header provider representing the single-header (typically "X-Embedding-Api-Key") auth scheme, in use by most of the embe

A "pass-through" header provider representing the single-header (typically "Reranking-Api-Key") auth scheme, for use with the (single-header)

A Data API table, the object to interact with the Data API for structured data, especially for DDL operations. This class has a synchronous i

An asynchronous cursor over documents, as returned by a `find` invocation on an AsyncCollection. A cursor can be iterated over, materialized

A Data API table, the object to interact with the Data API for structured data, especially for DDL operations. This class has an asynchro

A synchronous cursor over rows, as returned by a `find` invocation on an AsyncTable. A cursor can be iterated over, materialized into a list,

A synchronous cursor over documents, as returned by a `find` invocation on a Collection. A cursor can be iterated over, materialized into a l

A value expressing a date, composed of a year, a month and a day, suitable for working with the "date" table column type. This class is

Represents the additional information returned by the Data API when describing an index that has 'unsupported' status. Unsupported indexes ma

A synchronous cursor over rows, as returned by a `find` invocation on a Table. A cursor can be iterated over, materialized into a list, a

An object describing the definition of an unsupported index found on a table, including the name of the indexed column and the index support

An object representing the alter-table operation of adding column(s), for use as argument to the table's `alter()` method. Attributes:

An object representing the alter-table operation of removing the vectorize service (i.e. the server-side embedding computation) from one or m

An asynchronous cursor over documents, as returned by a `find_and_rerank` invocation on an AsyncCollection. A cursor can be iterated over, ma

A synchronous cursor over documents, as returned by a `find_and_rerank` invocation on a Collection. A cursor can be iterated over, materializ

An exception occurring within an insert_many (an operation that can span several requests). As such, it represents both the root error(s) tha

Class that represents the result of insert_many operations on a collection. Attributes: raw_results: responses from the Data API cal

An object representing a single warning, as returned from the Data API, typically with a code, a text message and other properties. This

A whole pageful of results from a find operation. This object represents the form taken by the returned items when using the pagination inter

An event representing a response received by the Data API, whose body is captured exactly as is sent by the Data API. Attributes:

The results of successfully parsing an Astra DB API endpoint, for internal by database metadata-related functions. Attributes: d

An exception occurring within an insert_many (an operation that can span several requests). As such, it represents both the root error(s) tha

Class that represents the result of insert_many operations on a collection. Attributes: raw_results: responses from the Data API cal

A `count_documents()` operation on a collection failed because the resulting number of documents exceeded either the upper bound set by the c

A `count_documents()` operation on a table failed because of the excessive amount of rows to count. Attributes: text: a text mes

An example dataclass which may be used to represent a user-defined type (UDT) such as one would define, and create on the database, with this

A counterpart of the Player model class (see), but: 1. whose each field admit None, while still being mandatory; 2. with a field whose "f

A header provider representing the two-header auth scheme in use by the Amazon Web Services (e.g. AWS Bedrock) when using header-based au

The group of settings for the API Options that determines the URL used to reach the DevOps API. This is the "full" version of the class,

An event representing a request being sent, captured with its payload exactly as will be sent to the API. Attributes: event_type

Represents the descriptor for a PCU (Provisioned Capacity Unit) group, such as the ones returned when querying the DevOps API for PCU groups.

Represents a PCU (Provisioned Capacity Unit) group type descriptor, describing a specific PCU configuration available in a region. Attri

Represents the details of a PCU (Provisioned Capacity Unit) group type, describing the hardware specifications for a particular PCU configura

An object representing the alter-table operation of enabling the vectorize service (i.e. server-side embedding computation) on one or more co

A class representing the information of an Astra DB database, including region details. This is the type of the response from the Database `i

An exception occurring during a delete_many (an operation that can span several requests). As such, besides information on the root-cause err

Represents the identifying information for a collection, including the information about the database the collection belongs to. Attribu

Class that represents the result of insert_one operations on a collection. Attributes: raw_results: one-item list with the response