Run a search according to the given filtering and sorting criteria and return the top row matching it, or nothing if there are none.

Insert a single row in the table, with implied overwrite in case of primary key collision. Inserting a row whose primary key

Materialize all rows that remain to be consumed from a cursor into a list. Calling this method on a CLOSED cursor results in an erro

Insert a number of rows into the table, with implied overwrite in case of primary key collision. Inserting rows whose primar

Parse a string, expressed according to the Data API format, into a DataAPITime. If the format is not recognized, a ValueError is rais

Delete all rows matching a provided filter condition. This operation can target from a single row to the entirety of the table.

Return the query vector used in the vector (ANN) search that originated this cursor, if applicable. If this is not an ANN search, or

Count the row in the table matching the specified filter. Args: filter: a predicate expressed as a dictionary according

Given an "overriding" set of options, possibly not defined in all its attributes, apply the override logic and return a new full opti

Create a clone of this table with some changed attributes. Args: embedding_api_key: optional API key(s) for interacting

Recast this object into a dictionary.

Query the DevOps API for the full info on this database. Args: database_admin_timeout_ms: a timeout, in milliseconds, to

Return a copy of this cursor with a mapping function to transform the returned items. Calling this method on a cursor with a mapping

Return a list of the unique values of `key` across the rows in the table that match the provided filter. Args: k

Update a single document on the table, changing some or all of the columns, with the implicit behaviour of inserting a new row if no

Return information on the table. This should not be confused with the table definition (i.e. the schema). Args:

Information on the collection (name, location, database), in the form of a CollectionInfo object. Not to be confused with th

Accepts either a string or an instance of the Enum itself. If a string is passed, it converts it to the corresponding Enum va

Create an instance of RerankingProvider from a dictionary such as one from the Data API.

Additional information on the database as an AstraDBDatabaseInfo instance. Some of the returned properties are dynamic throughout th

The final step in the fluent (builder) interface. Calling this method finalizes the definition that has been built so far and makes i

Find a document on the collection and update it as requested, optionally inserting a new one if no match is found. Args:

Get a Database object from this client, for doing data-related work. Args: api_endpoint: the API Endpoint for the target

Normalize a payload for API calls. This includes e.g. ensuring values for "$vector" key are made into plain lists of floats. Args:

Create an AsyncTable from this one. Save for the arguments explicitly provided as overrides, everything else is kept identical

Return the default APIOptions object for a given environment, based on 'grand defaults' hardcoded in astrapy.

Ensure the deadline, if any, is not yet in the past. If it is, raise an appropriate timeout error. If not, return either None

Retrieve a single, whole page of results from the Data API and return it at once, together with associated "out-of-band" information.

Find a document on the collection and replace it entirely with a new one, optionally inserting a new one if no match is found.

Consume the remaining rows in the cursor, invoking a provided callback function on each of them. Calling this method on a CL

Parse a string, expressed according to the Data API "Apache Cassandra(R) notation", into a DataAPIDuration. If the format is

Rewind the cursor, bringing it back to its pristine state of no items retrieved/consumed yet, regardless of its current state.

Create an index on a non-vector column of the table. This is a blocking operation: the method returns once the index is crea

Return a DatabaseAdmin object corresponding to this database, for use in admin tasks such as managing keyspaces. This method

Apply the logic for determining and labeling the timeout for (non-admin) single-request methods. If no int args are passed, pick (and co

Return a copy of this cursor with a new projection setting. This operation is allowed only if the cursor state is still IDLE and if

Delete a row, matching the provided value of the primary key. If no row is found with that primary key, the method does nothing.

Create an "empty" builder for constructing a collection definition through a fluent interface. The resulting object has no defined pr

Consume (return) up to the requested number of buffered items (rows/documents). The returned items are marked as consumed, meaning th

Close the cursor, regardless of its state. A cursor can be closed at any time, possibly discarding the portion of results that has no

Create a vector index on a vector column of the table, enabling vector similarity search operations on it. This is a blockin

A strong equality that checks the class in each value is exactly the same.

List the names of all collections in a given keyspace of this database. Args: keyspace: the keyspace to be inspected. If

Apply the logic for determining and labeling the timeout for (table-admin) single-request methods. If no int args are passed, pick (and

Drops (deletes) an index (of any kind) from the table it is associated to. This is a blocking operation: the method returns once the

Whether the cursor actually has more documents to return. `has_next` can be called on any cursor, but on a CLOSED cursor wil

Return a copy of this cursor with a new limit setting. This operation is allowed only if the cursor state is still IDLE. Ins

Create a text index on a vector column of the table, enabling lexicographical matching operations on it. This is a blocking

Return a copy of this cursor with a new filter setting. This operation is allowed only if the cursor state is still IDLE. In

Apply an update operation to all documents matching a condition, optionally inserting one documents in absence of matches. A

Drop a collection from the database, along with all documents therein. Args: name: the name of the collection to drop.

Create a copy of this cursor with: - the same parameters (timeouts, filter, projection, etc) - and the cursor is rewound to i

Send a POST request to the Data API for this table with an arbitrary, caller-provided payload. No transformations or type con

Get an AsyncDatabase object from this client, for doing data-related work. Args: api_endpoint: the API Endpoint for the

Convert the DataAPITime to a string according to the Data API specification. Returns: a string expressing the time value

Mutably copy the internal state of this cursor onto another one.

Return a copy of this cursor with a new include_sort_vector setting. This operation is allowed only if the cursor state is still IDLE

Replace a single document on the collection with a new one, optionally inserting a new one if no match is found. Args:

Return a copy of this cursor with a new sort setting. This operation is allowed only if the cursor state is still IDLE. Inst

Drop the table, i.e. delete it from the database along with all the rows stored therein. Args: if_exists: if pas

Drop a table from the database, along with all rows therein and related indexes. Args: name: the name of the table to dr

Convert a standard-library `datetime.datetime` into a DataAPITimestamp. The conversion correctly takes timezone information into acc

Return a new table definition object with an added column of 'map' type. This method is for use within the fluent interface f

Produce a string for direct use as token in a subsequent API request, or None for no token.

Parse an API Endpoint into a ParsedAPIEndpoint structure. Args: api_endpoint: a full API endpoint for the Data API. Returns:

Get an AstraDBAdmin instance corresponding to this client, for admin work such as managing databases. Args: toke

Find a document in the collection and delete it. The deleted document, however, is the return value of the method. Args:

Return a copy of this cursor with a new skip setting. This operation is allowed only if the cursor state is still IDLE. Inst

Create an instance of TableUDTColumnDescriptor from a dictionary such as one from the Data API.

Return a new collection definition object with a new setting for the collection's vector dimension. This method is for use within the

Return a new collection definition object with a new setting for the collection's vector similarity metric. This method is for use wi

Return a copy of this cursor with a new include_similarity setting. This operation is allowed only if the cursor state is still IDLE

Create a Table from this one. Save for the arguments explicitly provided as overrides, everything else is kept identical to t

Return a new collection definition object with a modified 'lexical' setting. This method is for use within the fluent interface for

Create a clone of this AstraDBAdmin with some changed attributes. Args: token: an Access Token to the database. Example: