Table of Contents

Namespace DataStax.AstraDB.DataApi.Tables

Classes

AlterTableAddColumns

Represents an operation to add new columns to a table.

AlterTableAddVectorColumns

Represents an operation to add vector columns to a table.

AlterTableAddVectorize

Represents an operation to add vectorization services to specific columns.

AlterTableColumnDefinition

Describes the definition of a single column in an alter operation.

AlterTableDropColumns

Represents an operation to drop columns from a table.

AlterTableDropVectorize

Represents an operation to remove vectorization from specific columns.

AlterTableOptions

Options for altering a table.

AlterTableVectorColumnDefinition

Describes the definition of a vector column.

AlterTypeAddFields

Represents an operation to add new fields to a User Defined Type.

AlterTypeRenameFields

Represents an operation to rename fields in a User Defined Type.

ColumnIgnoreAttribute

Marks a property or field to be ignored when mapping to or from a table column.

ColumnJsonStringAttribute

Marks a column to be serialized and deserialized as a JSON string.

ColumnNameAttribute

Overrides the column name used when mapping a property or field to a table column.

ColumnPrimaryKeyAttribute

Marks a property or field as part of the table's partition key.

ColumnPrimaryKeySortAttribute

Marks a property or field as a clustering key in the table's primary key, with a specified sort order.

ColumnVectorAttribute

Marks a column as a vector column with a specified number of dimensions.

ColumnVectorizeAttribute

Marks a column to use automatic vectorization (embedding generation) via a configured embedding service.

CreateIndexCommandOptions

Options for creating a generic table index.

CreateIndexOptions

Options for creating a table regular index.

CreateTextIndexOptions

Options for creating a table text index.

CreateVectorIndexOptions

Options for creating a table vector index.

DropTableIndexOptions

Options for dropping a table index.

FieldTypeInfo

DataAPI Type for a specific field

ListIndexNamesOptions

Options for the Database.ListIndexNames command.

ListIndexesOptions

Options for the Database.ListIndexes command.

PrimaryKeyDefinition

Defines the primary key structure of a table, including partition keys and clustering keys with their sort orders.

PrimaryKeyExtensions

Extension methods for validating primary key ordering sequences.

PrimaryKeySchema

Describes the schema of a single primary key component, as returned by the Data API.

PrimaryKeySort

Defines the sort order for a single clustering key column.

Row

Represents a row in a table as a dictionary of column names and their corresponding values (as untyped objects object).

TableBaseIndexDefinition

Configuration used to create an index on a table column

TableDefinition

Definition for creating a table

TableDefinitionExtensions

Extension methods for building table definitions

TableIndexBuilder

An index builder for tables.

TableIndexDefinition

Configuration used to create an index on a table column

TableIndexMetadata

Metadata about an existing table index, as returned by the Data API.

TableIndexOptions

Options for creating an index on a table column

TableInfo

Metadata describing a Table.

TableInsertManyResult

Represents the result of inserting multiple rows into a table.

TableInsertOneResult

Represents the result of inserting a single row into a table.

TableMapIndexDefinition

Configuration used to create a text index on a table column

TableNameAttribute

Overrides the table name used when mapping a class to a database table.

TableTextIndexDefinition

Configuration used to create a text index on a table column

TableTextIndexOptions

Options for creating a text index on a table column

TableUnknownIndexAPISupport

API capability details returned for a table index type that does not map to a known SDK definition.

TableUnknownIndexDefinition

Metadata for a table index definition returned by the Data API when the SDK does not recognize the index type.

TableVectorIndexDefinition

Definition of a vector index on a table

TableVectorIndexOptions

Options for creating a vector index on a table column

Table<T>

This is the main entry point for interacting with a table in the Astra DB Data API.

TypeAPISupportInfo

Information regarding API support for a User Defined Type

TypeDefinitionInfo

List of Fields for a User Defined Type

UserDefinedTypeAttribute

Attribute to annotate a class as being a User Defined Type

UserDefinedTypeDefinition

Options for creating a User Defined Type

UserDefinedTypeInfo

Description of an existing User Defined Type

Interfaces

IAlterTableOperation

Represents operations that can be applied to an existing table.

IAlterTypeOperation

Represents operations that can be applied to an existing User Defined Type.

Enums

MapIndexType

Specifies which piece of a map to index for a table column.