Namespace DataStax.AstraDB.DataApi.Core
Classes
- APICaller
A single layer of 'caller information' for self-identifying when issuing API requests.
- APIError
Represents an error returned by the API.
- AlterTypeOptions
Options for altering a type definition on a database, e.g. with AlterTypeAsync<T>(IAlterTypeOperation, AlterTypeOptions).
- AnalyzerOptions
Configuration for the analyzer
- AstraDatabaseRegionInfo
Regional deployment information for an Astra database.
- BaseDeleteManyOptions
Base class for delete-many operation options.
- BaseDeleteOneOptions
Base class for delete-one operation options.
- BaseInsertManyOptions
Base class for insert-many operation options.
- BaseInsertOneOptions
Base class for insert-one operation options.
- BaseReplaceOneOptions<T, TSort>
Base class for replace-one operation options.
- BaseVectorizeAttribute
Base class for vectorization attributes, providing common properties.
- BlockingCommandOptions
Options for long-running admin commands that may be launched in a blocking fashion.
- Builders
A collection of builders for interacting with tables and collections Builders<T>
- Builders<T>
A collection of builders for creating filter, projection, sort, and update definitions
- CollectionCountDocumentsOptions
Options for counting documents in a collection.
- CollectionDefinition
Options for a collection's behavior
- CollectionDeleteManyOptions
Options for deleting multiple documents from a collection.
- CollectionDeleteOneOptions<T>
Options for deleting a document from a collection.
- CollectionEstimateDocumentCountOptions
Options for estimating document count in a collection.
- CollectionFindOneAndDeleteOptions<T>
Options for finding and deleting a single document from a collection.
- CollectionFindOneAndReplaceOptions<T>
Options for finding and replacing a single document in a collection.
- CollectionInsertManyOptions
Options for inserting multiple documents into a collection.
- CollectionInsertOneOptions
Options for inserting a single document into a collection.
- CollectionReplaceOneOptions<T>
Options for replacing a document in a collection.
- CollectionVectorAttribute
Specifies vector options for a collection.
- CollectionVectorizeAttribute
Specifies vectorize options for a collection.
- CommandOptions
This class provides a set of low-level options to control the interactions with the underlying data store.
These options can be provided at any level of the SDK hierarchy: DataAPIClient Database Collection
as well as directly to each of the methods. You can provide different options objects at each level, the options specified at the most granular level will take precedence.
- CreateCollectionOptions
Command options specific to the CreateCollection database method.
- CreateKeyspaceOptions
Options specific to the database admin command to create a keyspace.
- CreateTableOptions
Additional command options for the database CreateTable method.
- CreateTypeOptions
Additional command options for the Database.CreateType commands.
- Database
Entrypoint for the interactions with a specific database such as creating/deleting collections/tables, connecting to collections/tables, and executing arbitrary commands.
Note that creating an instance of a Database doesn't trigger actual database creation; the database must have already existed beforehand. If you need to create a new database, use the AstraAdmin class.
- DatabaseCommandOptions
Command options specific to the database level.
- DatabaseInfo
The metadata information for a database.
- DefaultIdOptions
Options for automatically generated ids.
- DoesCollectionExistOptions
Additional command options for the Database.DoesCollectionExist commands.
- DoesKeyspaceExistOptions
Command options specific to the database admin's DoesKeyspaceExist methods.
- DoesTableExistOptions
Additional command options for the Database.DoesTableExist commands.
- DropCollectionOptions
Additional command options for the Database.DropCollection commands.
- DropKeyspaceOptions
Options specific to the database admin command to drop a keyspace.
- DropTableOptions
Additional command options for the Database.DropTable commands.
- DropTypeOptions
Additional command options for the DropType<T>(DropTypeOptions) method.
- FindEmbeddingProvidersOptions
Options for Find Embedding Providers command.
- FindRerankingProvidersOptions
Options for Find Reranking Providers command.
- GetAdminOptions
Additional command options for the Database.GetAdmin commands.
- GetCollectionOptions
Command options specific to collections.
- GetTableOptions
Command options specific to the database GetTable methods.
- HttpClientOptions
Options for the HTTP client used by the Data API.
- IndexingOptions
Options for indexing the documents in a collection. Please read the Data API documentation before setting specific indexing options.
- LexicalOptions
Lexical analysis configuration
- LexicalOptionsAttribute
Specifies lexical analysis options for a collection.
- ListCollectionNamesOptions
Additional command options for the Database.ListCollectionNames commands.
- ListCollectionsOptions
Additional command options for the Database.ListCollections commands.
- ListKeyspacesOptions
Command options specific to the database admin's ListKeyspaces methods.
- ListTableNamesOptions
Additional command options for the Database.ListTableNames commands.
- ListTablesOptions
Additional command options for the Database.ListTables commands.
- ListTypeNamesOptions
Additional command options for the Database.ListTypeNames commands.
- ListTypesOptions
Additional command options for the Database.ListTypes commands.
- RegionInfo
The metadata information for a region.
- RerankOptions
Options for configuring document reranking in the collection
- RerankServiceOptions
Configuration for the reranking service
- ReturnDocumentDirectiveExtensions
Extension methods for ReturnDocumentDirective.
- TableDeleteManyOptions
Options for deleting multiple rows from a table.
- TableDeleteOneOptions
Options for deleting a row from a table.
- TableDeleteOptions<T>
Options for deleting a row from a table
- TableInsertManyOptions
Options for inserting multiple rows into a table.
- TableInsertOneOptions
Options for inserting a single row into a table.
- TimeoutOptions
An options class that allows you to override the timeouts for the interactions with the Data API. Timeout options can be set at any level of the SDK hierarchy (DataAPIClient, Database, Collection) or on a per-request basis. The most specific value set wins.
- TokenizerOptions
Tokenizer configuration
- UpdateBuilder<T>
Use an UpdateBuilder to specify the changes to make to document(s) in an update operation.
- UserDefinedTypeField
Represents a field in a user-defined type (UDT), consisting of a name and a CQL type.
- VectorOptions
Vector options for a collection definition
- VectorServiceOptions
Configuration options for a vector embedding service used to automatically generate embeddings.
Structs
- Duration
Represents a duration. A duration stores separately months, days, and seconds due to the fact that the number of days in a month varies, and a day can have 23 or 25 hours if a daylight saving is involved.
- TimeUuid
Convenience class for dealing with TimeUuids (UUID v1)
Enums
- APIVersion
The version of the backend API to connect to
- AstraDatabaseCloudProvider
The cloud provider where an Astra database is deployed.
- AstraDatabaseStatus
The lifecycle status of an Astra database.
- DataAPIDestination
The data source to connect to.
- DefaultIdType
Autogenerated id types
- ModelLifecycleStatus
Status filter for reranking providers or embedding providers.
- ReturnDocumentDirective
Whether to return the document before or after the replacement.
- RunMode
The execution mode for database operations.
- SimilarityMetric
The vector similarity metric used to compare embeddings during vector search.
- SortDirection
Specifies the direction of a sort operation.
- TextAnalyzer
Standard text analyzers