Create a table (C#)

Creates a new table in a keyspace in a database.

After you create a table, index columns that you want to sort or filter. This optimizes your queries and avoids resource intensive, long running allow filtering operations.

You can also modify the table columns later. To add data to your table, insert rows.

Ready to write code? See the examples for this method to get started. If you are new to the Data API, check out the quickstart.

Result

Creates a table with the specified parameters.

Returns a Table object. You can use this object to work with rows in the table.

By default, the Table object is typed as Table<Row>, where Row is Dictionary<string, object>. You can enable stronger typing by specifying a type when you create the table. For more information and examples, see Custom typing for tables.

Parameters

Use the CreateTableAsync method, which belongs to the Database class. You can also use CreateTable, which is the synchronous version of the method.

Method signature

public Task<Table<TRow>> CreateTableAsync<TRow>(
  TableDefinition definition, CreateTableOptions options = null
) where TRow : class, new();

public Task<Table<TRow>> CreateTableAsync<TRow>(
  string tableName,
  TableDefinition definition,
  CreateTableOptions options = null
) where TRow : class;

public Task<Table<TRow>> CreateTableAsync<TRow>(
  string tableName, CreateTableOptions options = null
) where TRow : class, new();

public Task<Table<Row>> CreateTableAsync(
  string tableName,
  TableDefinition definition,
  CreateTableOptions options = null
);

public Task<Table<TRow>> CreateTableAsync<TRow>(
  CreateTableOptions options = null
) where TRow : class, new();

Name Type Summary

Name	Type	Summary
`tableName`	`string`	The name of the table. Table names must follow these rules: Can contain letters, numbers, and underscores Cannot exceed 48 characters Must be unique within the keyspace If not specified, the client attempts to extract it from the `TableName` attribute on the custom row class if one is used. For more information and examples, see Custom typing for tables.
`definition`	`TableDefinition`	The full schema for the table, including column names, column data types, and the primary key. See the examples for usage. All column names used in the schema must be unique within the table.
`options`	`CreateTableOptions`	Optional. Options for this operation. For more information and examples for general options such as timeout and keyspace, see Customize API interaction. For options specific to this method, see Method-specific properties of the `CreateTableOptions` class.

tableName

string

The name of the table.

Table names must follow these rules:

Can contain letters, numbers, and underscores
Cannot exceed 48 characters
Must be unique within the keyspace

If not specified, the client attempts to extract it from the TableName attribute on the custom row class if one is used. For more information and examples, see Custom typing for tables.

definition

TableDefinition

The full schema for the table, including column names, column data types, and the primary key.

See the examples for usage.

All column names used in the schema must be unique within the table.

options

CreateTableOptions

Optional. Options for this operation. For more information and examples for general options such as timeout and keyspace, see Customize API interaction. For options specific to this method, see Method-specific properties of the CreateTableOptions class.

Method-specific properties of the `CreateTableOptions` class
Name	Type	Summary
`EmbeddingAPIKey`	`string`	Optional. This only applies to tables that have a vector column with a vectorize embedding provider integration. Use this option to provide the embedding provider API key directly with headers instead of using an API key in the Astra DB KMS. The API key is sent to the Data API for every operation on the table. It is useful when a vectorize integration is configured but no credentials are stored, or when you want to override the stored credentials. For more information, see Manage embedding provider integrations for vectorize. You can use this authentication method only if all affected columns use the same embedding provider. If you use an AWS embedding provider, you must use the `AWSEmbeddingAPIKey` property instead of the `EmbeddingAPIKey` property to pass your access ID and secret ID.
`AWSEmbeddingAPIKey`	`AWSEmbeddingAPIKeyDescriptor`	If you use an AWS embedding provider, you must use the `AWSEmbeddingAPIKey` property instead of the `EmbeddingAPIKey` property to pass your access ID and secret ID.

Examples

The following examples demonstrate how to create a table.

Create a table with a single-column primary key

A single-column primary key is a primary key consisting of one column. For more information, see Primary keys in tables (C#).

Typed tables
Untyped tables

You can manually define a client-side type for your table to help statically catch errors. For more information and examples, see Custom typing for tables.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

// Define the type for the row
[TableName("TABLE_NAME")]
public class Book
{
  [ColumnPrimaryKey]
  [ColumnName("title")]
  public string Title { get; set; } = null!;

  [ColumnName("number_of_pages")]
  public int? NumberOfPages { get; set; }

  [ColumnName("rating")]
  public float? Rating { get; set; }

  [ColumnName("genres")]
  public string[]? Genres { get; set; }

  [ColumnName("metadata")]
  public Dictionary<string, string>? Metadata { get; set; }

  [ColumnName("is_checked_out")]
  public bool? IsCheckedOut { get; set; }

  [ColumnName("due_date")]
  public DateOnly? DueDate { get; set; }
}

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<Book>();
  }
}

If you don’t pass a type parameter, the collection or table remains untyped. This is a more flexible but less type-safe option.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var definition = new TableDefinition()
      .AddColumn("title", DataAPIType.Text())
      .AddColumn("number_of_pages", DataAPIType.Int())
      .AddColumn("rating", DataAPIType.Float())
      .AddColumn("genres", DataAPIType.Set(DataAPIType.Text()))
      .AddColumn(
        "metadata",
        DataAPIType.Map(DataAPIType.Text(), DataAPIType.Text())
      )
      .AddColumn("is_checked_out", DataAPIType.Boolean())
      .AddColumn("due_date", DataAPIType.Date())
      // Define the primary key for the table.
      // In this case, the table uses a single-column primary key.
      .AddSinglePrimaryKey("title");

    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      definition
    );
  }
}

Create a table with a composite primary key

A composite primary key is a primary key consisting of multiple columns. For more information, see Primary keys in tables (C#).

Typed tables
Untyped tables

You can manually define a client-side type for your table to help statically catch errors. For more information and examples, see Custom typing for tables.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

// Define the type for the row
[TableName("TABLE_NAME")]
public class Book
{
  [ColumnPrimaryKey(1)]
  [ColumnName("title")]
  public string Title { get; set; } = null!;

  [ColumnName("number_of_pages")]
  public int? NumberOfPages { get; set; }

  [ColumnPrimaryKey(2)]
  [ColumnName("rating")]
  public float Rating { get; set; }

  [ColumnName("genres")]
  public string[]? Genres { get; set; }

  [ColumnName("metadata")]
  public Dictionary<string, string>? Metadata { get; set; }

  [ColumnName("is_checked_out")]
  public bool? IsCheckedOut { get; set; }

  [ColumnName("due_date")]
  public DateOnly? DueDate { get; set; }
}

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<Book>();
  }
}

If you don’t pass a type parameter, the collection or table remains untyped. This is a more flexible but less type-safe option.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var definition = new TableDefinition()
      .AddColumn("title", DataAPIType.Text())
      .AddColumn("number_of_pages", DataAPIType.Int())
      .AddColumn("rating", DataAPIType.Float())
      .AddColumn("genres", DataAPIType.Set(DataAPIType.Text()))
      .AddColumn(
        "metadata",
        DataAPIType.Map(DataAPIType.Text(), DataAPIType.Text())
      )
      .AddColumn("is_checked_out", DataAPIType.Boolean())
      .AddColumn("due_date", DataAPIType.Date())
      // Define the primary key for the table.
      // In this case, the table uses a composite primary key.
      .AddCompositePrimaryKey(new[] { "title", "rating" });

    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      definition
    );
  }
}

Create a table with a compound primary key

A compound primary key is a primary key consisting of partition (grouping) columns and clustering (sorting) columns. For more information, see Primary keys in tables (C#).

Typed tables
Untyped tables

You can manually define a client-side type for your table to help statically catch errors. For more information and examples, see Custom typing for tables.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

// Define the type for the row
[TableName("TABLE_NAME")]
public class Book
{
  [ColumnPrimaryKey(1)]
  [ColumnName("title")]
  public string Title { get; set; } = null!;

  [ColumnPrimaryKeySort(1, SortDirection.Ascending)]
  [ColumnName("number_of_pages")]
  public int NumberOfPages { get; set; }

  [ColumnPrimaryKey(2)]
  [ColumnName("rating")]
  public float Rating { get; set; }

  [ColumnName("genres")]
  public string[]? Genres { get; set; }

  [ColumnName("metadata")]
  public Dictionary<string, string>? Metadata { get; set; }

  [ColumnPrimaryKeySort(2, SortDirection.Descending)]
  [ColumnName("is_checked_out")]
  public bool IsCheckedOut { get; set; }

  [ColumnName("due_date")]
  public DateOnly? DueDate { get; set; }
}

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<Book>();
  }
}

If you don’t pass a type parameter, the collection or table remains untyped. This is a more flexible but less type-safe option.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var definition = new TableDefinition()
      .AddColumn("title", DataAPIType.Text())
      .AddColumn("number_of_pages", DataAPIType.Int())
      .AddColumn("rating", DataAPIType.Float())
      .AddColumn("genres", DataAPIType.Set(DataAPIType.Text()))
      .AddColumn(
        "metadata",
        DataAPIType.Map(DataAPIType.Text(), DataAPIType.Text())
      )
      .AddColumn("is_checked_out", DataAPIType.Boolean())
      .AddColumn("due_date", DataAPIType.Date())
      // Define the primary key for the table.
      // In this case, the table uses a compound primary key.
      .AddCompoundPrimaryKey(
        new[] { "title", "rating" },
        new[]
        {
          new PrimaryKeySort("number_of_pages", SortDirection.Ascending),
          new PrimaryKeySort("is_checked_out", SortDirection.Descending),
        }
      );

    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      definition
    );
  }
}

Create a table with a column to store vector embeddings

If you want to store pre-generated vector embeddings in a table, create a table with a vector column. A table can include more than one vector column.

Typed tables
Untyped tables

You can manually define a client-side type for your table to help statically catch errors. For more information and examples, see Custom typing for tables.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

// Define the type for the row
[TableName("TABLE_NAME")]
public class ExampleRow
{
  [ColumnPrimaryKey]
  [ColumnName("example_non_vector")]
  public string ExampleNonVector { get; set; } = null!;

  [ColumnVector(1024)]
  [ColumnName("example_vector")]
  public float[]? ExampleVector { get; set; }
}

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

If you don’t pass a type parameter, the collection or table remains untyped. This is a more flexible but less type-safe option.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var definition = new TableDefinition()
      .AddColumn("example_vector", DataAPIType.Vector(1024))
      .AddColumn("example_non_vector", DataAPIType.Text())
      // Define the primary key for the table.
      // In this case, the table uses a single-column primary key.
      .AddSinglePrimaryKey("example_non_vector");

    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      definition
    );
  }
}

Create a table with a column to automatically generate vector embeddings

If you want to automatically generate vector embeddings, create a table with a vector column and configure an embedding provider integration for the column.

The configuration depends on the embedding provider.

You can also configure an embedding provider integration after table creation. For more information, see Alter a table (C#).

If you want to store the original text in addition to the vector embeddings that were generated from the text, then you need to create a separate column to store the text.

You can configure a different embedding provider for each vector column in the table. If you want to use the same embedding provider for all vector columns in the table, you must still configure the embedding provider for each vector column.

Configure Azure OpenAI as the embedding provider

For more detailed instructions, see Integrate Azure OpenAI as an embedding provider.

Typed tables
Untyped tables

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

[TableName("TABLE_NAME")]
public class ExampleRow
{
  // This column will store vector embeddings.
  // The Azure OpenAI integration
  // will automatically generate vector embeddings
  // for any text inserted to this column.
  [ColumnVectorize(
    provider: "azureOpenAI",
    modelName: "MODEL_NAME",
    dimension: MODEL_DIMENSIONS,
    authenticationPairs: new string[]
    {
      "providerKey", "API_KEY_NAME",
    },
    parameterPairs: new object[]
    {
      "resourceName",
      "RESOURCE_NAME",
      "deploymentId",
      "DEPLOYMENT_ID",
    }
  )]
  [ColumnName("VECTOR_COLUMN_NAME")]
  public object? ExampleVectorize { get; set; }

  // If you want to store the original text
  // in addition to the generated embeddings
  // you must create a separate column.
  // You should change the primary key definition to meet the needs of your data.
  [ColumnPrimaryKey(1)]
  [ColumnName("TEXT_COLUMN_NAME")]
  public string ExampleOriginalString { get; set; } = null!;
}
public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Define the columns and primary key for the table
    var tableDefinition = new TableDefinition()
      // This column will store vector embeddings.
      // The Azure OpenAI integration
      // will automatically generate vector embeddings
      // for any text inserted to this column.
      .AddColumn(
        "VECTOR_COLUMN_NAME",
        DataAPIType.Vectorize(
          MODEL_DIMENSIONS,
          new VectorServiceOptions
          {
            Provider = "azureOpenAI",
            ModelName = "MODEL_NAME",
            Authentication = new Dictionary<string, string>()
            {
              { "providerKey", "API_KEY_NAME" },
            },
            Parameters = new Dictionary<string, object>()
            {
              { "resourceName", "RESOURCE_NAME" },
              { "deploymentId", "DEPLOYMENT_ID" },
            },
          }
        )
      )
      // If you want to store the original text
      // in addition to the generated embeddings
      // you must create a separate column.
      .AddColumn("TEXT_COLUMN_NAME", DataAPIType.Text())
      // You should change the primary key definition to meet the needs of your data.
      .AddSinglePrimaryKey("TEXT_COLUMN_NAME");

    // Create the table
    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      tableDefinition
    );
  }
}

Replace the following:

TABLE_NAME: The name for your table.
VECTOR_COLUMN_NAME: The name for your vector column.
TEXT_COLUMN_NAME: The name for the text column that will store the original text. Omit this column if you won’t store the original text in addition to the generated embeddings.
SIMILARITY_METRIC: The method you want to use to calculate vector similarity scores. The available metrics are Cosine (default), Dot Product, and Euclidean.
API_KEY_NAME: The name of the Azure OpenAI API key that you want to use. Must be the name of an existing Azure OpenAI API key in the Astra Portal. For more information, see Embedding provider authentication.

Alternatively, you can omit this parameter and instead provide the authentication key in the EmbeddingAPIKey property of CreateTableOptions or GetTableOptions when you instantiate a Table object with the commands to create a table or get a table. The client will send the x-embedding-api-key header with the specified key to any underlying HTTP request that requires vectorize authentication. Header authentication overrides the API_KEY_NAME parameter if you set both. If you use the header instead of specifying the API_KEY_NAME parameter, you must include the header in every command that uses vectorize, including writes and vector search. You can use this authentication method only if all affected columns use the same embedding provider.
MODEL_NAME: The model that you want to use to generate embeddings. The available models are: text-embedding-3-small, text-embedding-3-large, text-embedding-ada-002.

For Azure OpenAI, you must select the model that matches the one deployed to your DEPLOYMENT_ID in Azure.
MODEL_DIMENSIONS: The number of dimensions that you want the generated vectors to have. Your chosen embedding model must support the specified number of dimensions.

If you omit the dimension, Astra DB can use a default dimension value. However, some models don’t have default dimensions. You can use the Data API to find supported embedding providers and their configuration parameters, including dimensions ranges and default dimensions.
RESOURCE_NAME: The name of your Azure OpenAI Service resource, as defined in the resource’s Instance details. For more information, see the Azure OpenAI documentation.
DEPLOYMENT_ID: Your Azure OpenAI resource’s Deployment name. For more information, see the Azure OpenAI documentation.

Configure Hugging Face (Dedicated) as the embedding provider

For more detailed instructions, see Integrate Hugging Face Dedicated as an embedding provider.

Typed tables
Untyped tables

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

[TableName("TABLE_NAME")]
public class ExampleRow
{
  // This column will store vector embeddings.
  // The Hugging Face Dedicated integration
  // will automatically generate vector embeddings
  // for any text inserted to this column.
  [ColumnVectorize(
    provider: "huggingfaceDedicated",
    modelName: "endpoint-defined-model",
    dimension: MODEL_DIMENSIONS,
    authenticationPairs: new string[]
    {
      "providerKey", "API_KEY_NAME",
    },
    parameterPairs: new object[]
    {
      "endpointName",
      "ENDPOINT_NAME",
      "regionName",
      "REGION_NAME",
      "cloudName",
      "CLOUD_NAME",
    }
  )]
  [ColumnName("VECTOR_COLUMN_NAME")]
  public object? ExampleVectorize { get; set; }

  // If you want to store the original text
  // in addition to the generated embeddings
  // you must create a separate column.
  // You should change the primary key definition to meet the needs of your data.
  [ColumnPrimaryKey(1)]
  [ColumnName("TEXT_COLUMN_NAME")]
  public string ExampleOriginalString { get; set; } = null!;
}
public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Define the columns and primary key for the table
    var tableDefinition = new TableDefinition()
      // This column will store vector embeddings.
      // The Hugging Face Dedicated integration
      // will automatically generate vector embeddings
      // for any text inserted to this column.
      .AddColumn(
        "VECTOR_COLUMN_NAME",
        DataAPIType.Vectorize(
          MODEL_DIMENSIONS,
          new VectorServiceOptions
          {
            Provider = "huggingfaceDedicated",
            ModelName = "endpoint-defined-model",
            Authentication = new Dictionary<string, string>()
            {
              { "providerKey", "API_KEY_NAME" },
            },
            Parameters = new Dictionary<string, object>()
            {
                { "endpointName", "ENDPOINT_NAME" },
                { "regionName", "REGION_NAME" },
                { "cloudName", "CLOUD_NAME" },
            },
          }
        )
      )
      // If you want to store the original text
      // in addition to the generated embeddings
      // you must create a separate column.
      .AddColumn("TEXT_COLUMN_NAME", DataAPIType.Text())
      // You should change the primary key definition to meet the needs of your data.
      .AddSinglePrimaryKey("TEXT_COLUMN_NAME");

    // Create the table
    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      tableDefinition
    );
  }
}

Replace the following:

TABLE_NAME: The name for your table.
VECTOR_COLUMN_NAME: The name for your vector column.
TEXT_COLUMN_NAME: The name for the text column that will store the original text. Omit this column if you won’t store the original text in addition to the generated embeddings.
SIMILARITY_METRIC: The method you want to use to calculate vector similarity scores. The available metrics are Cosine (default), Dot Product, and Euclidean.
API_KEY_NAME: The name of the Hugging Face Dedicated user access token that you want to use. Must be the name of an existing Hugging Face Dedicated user access token in the Astra Portal. For more information, see Embedding provider authentication.

Alternatively, you can omit this parameter and instead provide the authentication key in the EmbeddingAPIKey property of CreateTableOptions or GetTableOptions when you instantiate a Table object with the commands to create a table or get a table. The client will send the x-embedding-api-key header with the specified key to any underlying HTTP request that requires vectorize authentication. Header authentication overrides the API_KEY_NAME parameter if you set both. If you use the header instead of specifying the API_KEY_NAME parameter, you must include the header in every command that uses vectorize, including writes and vector search. You can use this authentication method only if all affected columns use the same embedding provider.
MODEL_NAME: The model that you want to use to generate embeddings. The available models are: endpoint-defined-model.

For Hugging Face Dedicated, you must deploy the model as a text embeddings inference (TEI) container.

You must set MODEL_NAME to endpoint-defined-model because this integration uses the model specified in your dedicated endpoint configuration.
MODEL_DIMENSIONS: The number of dimensions that you want the generated vectors to have. Your chosen embedding model must support the specified number of dimensions.

If you omit the dimension, Astra DB can use a default dimension value. However, some models don’t have default dimensions. You can use the Data API to find supported embedding providers and their configuration parameters, including dimensions ranges and default dimensions.
ENDPOINT_NAME: The programmatically-generated name of your Hugging Face Dedicated endpoint. This is the first part of the endpoint URL. For example, if your endpoint URL is https://mtp1x7muf6qyn3yh.us-east-2.aws.endpoints.huggingface.cloud, the endpoint name is mtp1x7muf6qyn3yh.
REGION: The cloud provider region your Hugging Face Dedicated endpoint is deployed to. For example, us-east-2.
CLOUD_PROVIDER: The cloud provider your Hugging Face Dedicated endpoint is deployed to. For example, aws.

Configure Hugging Face (Serverless) as the embedding provider

For more detailed instructions, see Integrate Hugging Face Serverless as an embedding provider.

Typed tables
Untyped tables

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

[TableName("TABLE_NAME")]
public class ExampleRow
{
  // This column will store vector embeddings.
  // The Hugging Face Serverless integration
  // will automatically generate vector embeddings
  // for any text inserted to this column.
  [ColumnVectorize(
    provider: "huggingface",
    modelName: "MODEL_NAME",
    dimension: MODEL_DIMENSIONS,
    authenticationPairs: new string[]
    {
      "providerKey", "API_KEY_NAME",
    }
  )]
  [ColumnName("VECTOR_COLUMN_NAME")]
  public object? ExampleVectorize { get; set; }

  // If you want to store the original text
  // in addition to the generated embeddings
  // you must create a separate column.
  // You should change the primary key definition to meet the needs of your data.
  [ColumnPrimaryKey(1)]
  [ColumnName("TEXT_COLUMN_NAME")]
  public string ExampleOriginalString { get; set; } = null!;
}
public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Define the columns and primary key for the table
    var tableDefinition = new TableDefinition()
      // This column will store vector embeddings.
      // The Hugging Face Serverless integration
      // will automatically generate vector embeddings
      // for any text inserted to this column.
      .AddColumn(
        "VECTOR_COLUMN_NAME",
        DataAPIType.Vectorize(
          MODEL_DIMENSIONS,
          new VectorServiceOptions
          {
            Provider = "huggingface",
            ModelName = "MODEL_NAME",
            Authentication = new Dictionary<string, string>()
            {
              { "providerKey", "API_KEY_NAME" },
            },
          }
        )
      )
      // If you want to store the original text
      // in addition to the generated embeddings
      // you must create a separate column.
      .AddColumn("TEXT_COLUMN_NAME", DataAPIType.Text())
      // You should change the primary key definition to meet the needs of your data.
      .AddSinglePrimaryKey("TEXT_COLUMN_NAME");

    // Create the table
    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      tableDefinition
    );
  }
}

Replace the following:

TABLE_NAME: The name for your table.
VECTOR_COLUMN_NAME: The name for your vector column.
TEXT_COLUMN_NAME: The name for the text column that will store the original text. Omit this column if you won’t store the original text in addition to the generated embeddings.
SIMILARITY_METRIC: The method you want to use to calculate vector similarity scores. The available metrics are Cosine (default), Dot Product, and Euclidean.
API_KEY_NAME: The name of the Hugging Face Serverless user access token that you want to use. Must be the name of an existing Hugging Face Serverless user access token in the Astra Portal. For more information, see Embedding provider authentication.

Alternatively, you can omit this parameter and instead provide the authentication key in the EmbeddingAPIKey property of CreateTableOptions or GetTableOptions when you instantiate a Table object with the commands to create a table or get a table. The client will send the x-embedding-api-key header with the specified key to any underlying HTTP request that requires vectorize authentication. Header authentication overrides the API_KEY_NAME parameter if you set both. If you use the header instead of specifying the API_KEY_NAME parameter, you must include the header in every command that uses vectorize, including writes and vector search. You can use this authentication method only if all affected columns use the same embedding provider.
MODEL_NAME: The model that you want to use to generate embeddings. The available models are: sentence-transformers/all-MiniLM-L6-v2, intfloat/multilingual-e5-large, intfloat/multilingual-e5-large-instruct, BAAI/bge-small-en-v1.5, BAAI/bge-base-en-v1.5, BAAI/bge-large-en-v1.5.
MODEL_DIMENSIONS: The number of dimensions that you want the generated vectors to have. Your chosen embedding model must support the specified number of dimensions.

If you omit the dimension, Astra DB can use a default dimension value. However, some models don’t have default dimensions. You can use the Data API to find supported embedding providers and their configuration parameters, including dimensions ranges and default dimensions.

Configure Jina AI as the embedding provider

For more detailed instructions, see Integrate Jina AI as an embedding provider.

Typed tables
Untyped tables

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

[TableName("TABLE_NAME")]
public class ExampleRow
{
  // This column will store vector embeddings.
  // The Jina AI integration
  // will automatically generate vector embeddings
  // for any text inserted to this column.
  [ColumnVectorize(
    provider: "jinaAI",
    modelName: "MODEL_NAME",
    dimension: MODEL_DIMENSIONS,
    authenticationPairs: new string[]
    {
      "providerKey", "API_KEY_NAME",
    }
  )]
  [ColumnName("VECTOR_COLUMN_NAME")]
  public object? ExampleVectorize { get; set; }

  // If you want to store the original text
  // in addition to the generated embeddings
  // you must create a separate column.
  // You should change the primary key definition to meet the needs of your data.
  [ColumnPrimaryKey(1)]
  [ColumnName("TEXT_COLUMN_NAME")]
  public string ExampleOriginalString { get; set; } = null!;
}
public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Define the columns and primary key for the table
    var tableDefinition = new TableDefinition()
      // This column will store vector embeddings.
      // The Jina AI integration
      // will automatically generate vector embeddings
      // for any text inserted to this column.
      .AddColumn(
        "VECTOR_COLUMN_NAME",
        DataAPIType.Vectorize(
          MODEL_DIMENSIONS,
          new VectorServiceOptions
          {
            Provider = "jinaAI",
            ModelName = "MODEL_NAME",
            Authentication = new Dictionary<string, string>()
            {
              { "providerKey", "API_KEY_NAME" },
            },
          }
        )
      )
      // If you want to store the original text
      // in addition to the generated embeddings
      // you must create a separate column.
      .AddColumn("TEXT_COLUMN_NAME", DataAPIType.Text())
      // You should change the primary key definition to meet the needs of your data.
      .AddSinglePrimaryKey("TEXT_COLUMN_NAME");

    // Create the table
    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      tableDefinition
    );
  }
}

Replace the following:

TABLE_NAME: The name for your table.
VECTOR_COLUMN_NAME: The name for your vector column.
TEXT_COLUMN_NAME: The name for the text column that will store the original text. Omit this column if you won’t store the original text in addition to the generated embeddings.
SIMILARITY_METRIC: The method you want to use to calculate vector similarity scores. The available metrics are Cosine (default), Dot Product, and Euclidean.
API_KEY_NAME: The name of the Jina AI API key that you want to use. Must be the name of an existing Jina AI API key in the Astra Portal. For more information, see Embedding provider authentication.

Alternatively, you can omit this parameter and instead provide the authentication key in the EmbeddingAPIKey property of CreateTableOptions or GetTableOptions when you instantiate a Table object with the commands to create a table or get a table. The client will send the x-embedding-api-key header with the specified key to any underlying HTTP request that requires vectorize authentication. Header authentication overrides the API_KEY_NAME parameter if you set both. If you use the header instead of specifying the API_KEY_NAME parameter, you must include the header in every command that uses vectorize, including writes and vector search. You can use this authentication method only if all affected columns use the same embedding provider.
MODEL_NAME: The model that you want to use to generate embeddings. The available models are: jina-embeddings-v2-base-en, jina-embeddings-v2-base-de, jina-embeddings-v2-base-es, jina-embeddings-v2-base-code, jina-embeddings-v2-base-zh.
MODEL_DIMENSIONS: The number of dimensions that you want the generated vectors to have. Your chosen embedding model must support the specified number of dimensions.

If you omit the dimension, Astra DB can use a default dimension value. However, some models don’t have default dimensions. You can use the Data API to find supported embedding providers and their configuration parameters, including dimensions ranges and default dimensions.

Configure Mistral AI as the embedding provider

For more detailed instructions, see Integrate Mistral AI as an embedding provider.

Typed tables
Untyped tables

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

[TableName("TABLE_NAME")]
public class ExampleRow
{
  // This column will store vector embeddings.
  // The Mistral AI integration
  // will automatically generate vector embeddings
  // for any text inserted to this column.
  [ColumnVectorize(
    provider: "mistral",
    modelName: "MODEL_NAME",
    dimension: MODEL_DIMENSIONS,
    authenticationPairs: new string[]
    {
      "providerKey", "API_KEY_NAME",
    }
  )]
  [ColumnName("VECTOR_COLUMN_NAME")]
  public object? ExampleVectorize { get; set; }

  // If you want to store the original text
  // in addition to the generated embeddings
  // you must create a separate column.
  // You should change the primary key definition to meet the needs of your data.
  [ColumnPrimaryKey(1)]
  [ColumnName("TEXT_COLUMN_NAME")]
  public string ExampleOriginalString { get; set; } = null!;
}
public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Define the columns and primary key for the table
    var tableDefinition = new TableDefinition()
      // This column will store vector embeddings.
      // The Mistral AI integration
      // will automatically generate vector embeddings
      // for any text inserted to this column.
      .AddColumn(
        "VECTOR_COLUMN_NAME",
        DataAPIType.Vectorize(
          MODEL_DIMENSIONS,
          new VectorServiceOptions
          {
            Provider = "mistral",
            ModelName = "MODEL_NAME",
            Authentication = new Dictionary<string, string>()
            {
              { "providerKey", "API_KEY_NAME" },
            },
          }
        )
      )
      // If you want to store the original text
      // in addition to the generated embeddings
      // you must create a separate column.
      .AddColumn("TEXT_COLUMN_NAME", DataAPIType.Text())
      // You should change the primary key definition to meet the needs of your data.
      .AddSinglePrimaryKey("TEXT_COLUMN_NAME");

    // Create the table
    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      tableDefinition
    );
  }
}

Replace the following:

TABLE_NAME: The name for your table.
VECTOR_COLUMN_NAME: The name for your vector column.
TEXT_COLUMN_NAME: The name for the text column that will store the original text. Omit this column if you won’t store the original text in addition to the generated embeddings.
SIMILARITY_METRIC: The method you want to use to calculate vector similarity scores. The available metrics are Cosine (default), Dot Product, and Euclidean.
API_KEY_NAME: The name of the Mistral AI API key that you want to use. Must be the name of an existing Mistral AI API key in the Astra Portal. For more information, see Embedding provider authentication.

Alternatively, you can omit this parameter and instead provide the authentication key in the EmbeddingAPIKey property of CreateTableOptions or GetTableOptions when you instantiate a Table object with the commands to create a table or get a table. The client will send the x-embedding-api-key header with the specified key to any underlying HTTP request that requires vectorize authentication. Header authentication overrides the API_KEY_NAME parameter if you set both. If you use the header instead of specifying the API_KEY_NAME parameter, you must include the header in every command that uses vectorize, including writes and vector search. You can use this authentication method only if all affected columns use the same embedding provider.
MODEL_NAME: The model that you want to use to generate embeddings. The available models are: mistral-embed.
MODEL_DIMENSIONS: The number of dimensions that you want the generated vectors to have. Your chosen embedding model must support the specified number of dimensions.

If you omit the dimension, Astra DB can use a default dimension value. However, some models don’t have default dimensions. You can use the Data API to find supported embedding providers and their configuration parameters, including dimensions ranges and default dimensions.

Configure NVIDIA as the embedding provider

For more detailed instructions, see Integrate NVIDIA as an embedding provider. Your database must be in a supported region.

Typed tables
Untyped tables

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

[TableName("TABLE_NAME")]
public class ExampleRow
{
  // This column will store vector embeddings.
  // The NVIDIA integration
  // will automatically generate vector embeddings
  // for any text inserted to this column.
  [ColumnVectorize(
    provider: "nvidia",
    modelName: "nvidia/nv-embedqa-e5-v5"
  )]
  [ColumnName("VECTOR_COLUMN_NAME")]
  public object? ExampleVectorize { get; set; }

  // If you want to store the original text
  // in addition to the generated embeddings
  // you must create a separate column.
  // You should change the primary key definition to meet the needs of your data.
  [ColumnPrimaryKey(1)]
  [ColumnName("TEXT_COLUMN_NAME")]
  public string ExampleOriginalString { get; set; } = null!;
}
public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Define the columns and primary key for the table
    var tableDefinition = new TableDefinition()
      // This column will store vector embeddings.
      // The NVIDIA integration
      // will automatically generate vector embeddings
      // for any text inserted to this column.
      .AddColumn(
        "VECTOR_COLUMN_NAME",
        DataAPIType.Vectorize(
          new VectorServiceOptions
          {
            Provider = "nvidia",
            ModelName = "nvidia/nv-embedqa-e5-v5",
          }
        )
      )
      // If you want to store the original text
      // in addition to the generated embeddings
      // you must create a separate column.
      .AddColumn("TEXT_COLUMN_NAME", DataAPIType.Text())
      // You should change the primary key definition to meet the needs of your data.
      .AddSinglePrimaryKey("TEXT_COLUMN_NAME");

    // Create the table
    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      tableDefinition
    );
  }
}

Configure OpenAI as the embedding provider

For more detailed instructions, see Integrate OpenAI as an embedding provider.

Typed tables
Untyped tables

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

[TableName("TABLE_NAME")]
public class ExampleRow
{
  // This column will store vector embeddings.
  // The OpenAI integration
  // will automatically generate vector embeddings
  // for any text inserted to this column.
  [ColumnVectorize(
    provider: "openai",
    modelName: "MODEL_NAME",
    dimension: MODEL_DIMENSIONS,
    authenticationPairs: new string[]
    {
      "providerKey", "API_KEY_NAME",
    },
    parameterPairs: new object[]
    {
      "organizationId",
      "ORGANIZATION_ID",
      "projectId",
      "PROJECT_ID",
    }
  )]
  [ColumnName("VECTOR_COLUMN_NAME")]
  public object? ExampleVectorize { get; set; }

  // If you want to store the original text
  // in addition to the generated embeddings
  // you must create a separate column.
  // You should change the primary key definition to meet the needs of your data.
  [ColumnPrimaryKey(1)]
  [ColumnName("TEXT_COLUMN_NAME")]
  public string ExampleOriginalString { get; set; } = null!;
}
public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Define the columns and primary key for the table
    var tableDefinition = new TableDefinition()
      // This column will store vector embeddings.
      // The OpenAI integration
      // will automatically generate vector embeddings
      // for any text inserted to this column.
      .AddColumn(
        "VECTOR_COLUMN_NAME",
        DataAPIType.Vectorize(
          MODEL_DIMENSIONS,
          new VectorServiceOptions
          {
            Provider = "openai",
            ModelName = "MODEL_NAME",
            Authentication = new Dictionary<string, string>()
            {
              { "providerKey", "API_KEY_NAME" },
            },
            Parameters = new Dictionary<string, object>()
            {
              { "organizationId", "ORGANIZATION_ID" },
              { "projectId", "PROJECT_ID" },
            },
          }
        )
      )
      // If you want to store the original text
      // in addition to the generated embeddings
      // you must create a separate column.
      .AddColumn("TEXT_COLUMN_NAME", DataAPIType.Text())
      // You should change the primary key definition to meet the needs of your data.
      .AddSinglePrimaryKey("TEXT_COLUMN_NAME");

    // Create the table
    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      tableDefinition
    );
  }
}

Replace the following:

TABLE_NAME: The name for your table.
VECTOR_COLUMN_NAME: The name for your vector column.
TEXT_COLUMN_NAME: The name for the text column that will store the original text. Omit this column if you won’t store the original text in addition to the generated embeddings.
SIMILARITY_METRIC: The method you want to use to calculate vector similarity scores. The available metrics are Cosine (default), Dot Product, and Euclidean.
API_KEY_NAME: The name of the OpenAI API key that you want to use. Must be the name of an existing OpenAI API key in the Astra Portal. For more information, see Embedding provider authentication.

Alternatively, you can omit this parameter and instead provide the authentication key in the EmbeddingAPIKey property of CreateTableOptions or GetTableOptions when you instantiate a Table object with the commands to create a table or get a table. The client will send the x-embedding-api-key header with the specified key to any underlying HTTP request that requires vectorize authentication. Header authentication overrides the API_KEY_NAME parameter if you set both. If you use the header instead of specifying the API_KEY_NAME parameter, you must include the header in every command that uses vectorize, including writes and vector search. You can use this authentication method only if all affected columns use the same embedding provider.
MODEL_NAME: The model that you want to use to generate embeddings. The available models are: text-embedding-3-small, text-embedding-3-large, text-embedding-ada-002.
MODEL_DIMENSIONS: The number of dimensions that you want the generated vectors to have. Your chosen embedding model must support the specified number of dimensions.

If you omit the dimension, Astra DB can use a default dimension value. However, some models don’t have default dimensions. You can use the Data API to find supported embedding providers and their configuration parameters, including dimensions ranges and default dimensions.
ORGANIZATION_ID: Optional. The ID of the OpenAI organization that owns the API key. Only required if your OpenAI account belongs to multiple organizations or if you are using a legacy user API key to access projects. For more information about organization IDs, see the OpenAI API reference.
PROJECT_ID: Optional. The ID of the OpenAI project that owns the API key. This cannot use the default project. Only required if your OpenAI account belongs to multiple organizations or if you are using a legacy user API key to access projects. For more information about project IDs, see the OpenAI API reference.

Configure Upstage as the embedding provider

For more detailed instructions, see Integrate Upstage as an embedding provider.

Typed tables
Untyped tables

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

[TableName("TABLE_NAME")]
public class ExampleRow
{
  // This column will store vector embeddings.
  // The Upstage integration
  // will automatically generate vector embeddings
  // for any text inserted to this column.
  [ColumnVectorize(
    provider: "upstageAI",
    modelName: "MODEL_NAME",
    dimension: MODEL_DIMENSIONS,
    authenticationPairs: new string[]
    {
      "providerKey", "API_KEY_NAME",
    }
  )]
  [ColumnName("VECTOR_COLUMN_NAME")]
  public object? ExampleVectorize { get; set; }

  // If you want to store the original text
  // in addition to the generated embeddings
  // you must create a separate column.
  // You should change the primary key definition to meet the needs of your data.
  [ColumnPrimaryKey(1)]
  [ColumnName("TEXT_COLUMN_NAME")]
  public string ExampleOriginalString { get; set; } = null!;
}
public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Define the columns and primary key for the table
    var tableDefinition = new TableDefinition()
      // This column will store vector embeddings.
      // The Upstage integration
      // will automatically generate vector embeddings
      // for any text inserted to this column.
      .AddColumn(
        "VECTOR_COLUMN_NAME",
        DataAPIType.Vectorize(
          MODEL_DIMENSIONS,
          new VectorServiceOptions
          {
            Provider = "upstageAI",
            ModelName = "MODEL_NAME",
            Authentication = new Dictionary<string, string>()
            {
              { "providerKey", "API_KEY_NAME" },
            },
          }
        )
      )
      // If you want to store the original text
      // in addition to the generated embeddings
      // you must create a separate column.
      .AddColumn("TEXT_COLUMN_NAME", DataAPIType.Text())
      // You should change the primary key definition to meet the needs of your data.
      .AddSinglePrimaryKey("TEXT_COLUMN_NAME");

    // Create the table
    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      tableDefinition
    );
  }
}

Replace the following:

TABLE_NAME: The name for your table.
VECTOR_COLUMN_NAME: The name for your vector column.
TEXT_COLUMN_NAME: The name for the text column that will store the original text. Omit this column if you won’t store the original text in addition to the generated embeddings.
SIMILARITY_METRIC: The method you want to use to calculate vector similarity scores. The available metrics are Cosine (default), Dot Product, and Euclidean.
API_KEY_NAME: The name of the Upstage API key that you want to use. Must be the name of an existing Upstage API key in the Astra Portal. For more information, see Embedding provider authentication.

Alternatively, you can omit this parameter and instead provide the authentication key in the EmbeddingAPIKey property of CreateTableOptions or GetTableOptions when you instantiate a Table object with the commands to create a table or get a table. The client will send the x-embedding-api-key header with the specified key to any underlying HTTP request that requires vectorize authentication. Header authentication overrides the API_KEY_NAME parameter if you set both. If you use the header instead of specifying the API_KEY_NAME parameter, you must include the header in every command that uses vectorize, including writes and vector search. You can use this authentication method only if all affected columns use the same embedding provider.
MODEL_NAME: The model that you want to use to generate embeddings. The available models are: solar-embedding-1-large.
MODEL_DIMENSIONS: The number of dimensions that you want the generated vectors to have. Your chosen embedding model must support the specified number of dimensions.

If you omit the dimension, Astra DB can use a default dimension value. However, some models don’t have default dimensions. You can use the Data API to find supported embedding providers and their configuration parameters, including dimensions ranges and default dimensions.

Configure Voyage AI as the embedding provider

For more detailed instructions, see Integrate Voyage AI as an embedding provider.

Typed tables
Untyped tables

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

[TableName("TABLE_NAME")]
public class ExampleRow
{
  // This column will store vector embeddings.
  // The Voyage AI integration
  // will automatically generate vector embeddings
  // for any text inserted to this column.
  [ColumnVectorize(
    provider: "voyageAI",
    modelName: "MODEL_NAME",
    dimension: MODEL_DIMENSIONS,
    authenticationPairs: new string[]
    {
      "providerKey", "API_KEY_NAME",
    }
  )]
  [ColumnName("VECTOR_COLUMN_NAME")]
  public object? ExampleVectorize { get; set; }

  // If you want to store the original text
  // in addition to the generated embeddings
  // you must create a separate column.
  // You should change the primary key definition to meet the needs of your data.
  [ColumnPrimaryKey(1)]
  [ColumnName("TEXT_COLUMN_NAME")]
  public string ExampleOriginalString { get; set; } = null!;
}
public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Define the columns and primary key for the table
    var tableDefinition = new TableDefinition()
      // This column will store vector embeddings.
      // The Voyage AI integration
      // will automatically generate vector embeddings
      // for any text inserted to this column.
      .AddColumn(
        "VECTOR_COLUMN_NAME",
        DataAPIType.Vectorize(
          MODEL_DIMENSIONS,
          new VectorServiceOptions
          {
            Provider = "voyageAI",
            ModelName = "MODEL_NAME",
            Authentication = new Dictionary<string, string>()
            {
              { "providerKey", "API_KEY_NAME" },
            },
          }
        )
      )
      // If you want to store the original text
      // in addition to the generated embeddings
      // you must create a separate column.
      .AddColumn("TEXT_COLUMN_NAME", DataAPIType.Text())
      // You should change the primary key definition to meet the needs of your data.
      .AddSinglePrimaryKey("TEXT_COLUMN_NAME");

    // Create the table
    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      tableDefinition
    );
  }
}

Replace the following:

TABLE_NAME: The name for your table.
VECTOR_COLUMN_NAME: The name for your vector column.
TEXT_COLUMN_NAME: The name for the text column that will store the original text. Omit this column if you won’t store the original text in addition to the generated embeddings.
SIMILARITY_METRIC: The method you want to use to calculate vector similarity scores. The available metrics are Cosine (default), Dot Product, and Euclidean.
API_KEY_NAME: The name of the Voyage AI API key that you want to use. Must be the name of an existing Voyage AI API key in the Astra Portal. For more information, see Embedding provider authentication.

Alternatively, you can omit this parameter and instead provide the authentication key in the EmbeddingAPIKey property of CreateTableOptions or GetTableOptions when you instantiate a Table object with the commands to create a table or get a table. The client will send the x-embedding-api-key header with the specified key to any underlying HTTP request that requires vectorize authentication. Header authentication overrides the API_KEY_NAME parameter if you set both. If you use the header instead of specifying the API_KEY_NAME parameter, you must include the header in every command that uses vectorize, including writes and vector search. You can use this authentication method only if all affected columns use the same embedding provider.
MODEL_NAME: The model that you want to use to generate embeddings. The available models are: voyage-2, voyage-code-2, voyage-finance-2, voyage-large-2, voyage-large-2-instruct, voyage-law-2, voyage-multilingual-2.
MODEL_DIMENSIONS: The number of dimensions that you want the generated vectors to have. Your chosen embedding model must support the specified number of dimensions.

If you omit the dimension, Astra DB can use a default dimension value. However, some models don’t have default dimensions. You can use the Data API to find supported embedding providers and their configuration parameters, including dimensions ranges and default dimensions.

Create a table that uses a user-defined type (UDT)

In addition to the supported types, you can create a user-defined type to use in your table.

You can use a user-defined type as the type of a column or as the value type of a map, list, or set column. You can’t use a user-defined type as the key type of a map column or as a partitionKey or clustering key.

The following examples demonstrate how to use a user-defined type called person for the group_leader column, value type in the group_members set column, and value type in the group_roles map column.

Typed tables
Untyped tables

You can manually define a client-side type for your table to help statically catch errors. For more information and examples, see Custom typing for tables.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

// Define the user-defined type
// The type will be created if a type
// with the same name does not already exist
[UserDefinedType("person")]
public class Person
{
  [ColumnName("name")]
  public string? Name { get; set; }

  [ColumnName("level")]
  public int? Level { get; set; }
};

// Define the type for the row
[TableName("TABLE_NAME")]
public class ExampleRow
{
  [ColumnPrimaryKey]
  [ColumnName("id")]
  public Guid Id { get; set; }

  [ColumnName("group_leader")]
  public Person? GroupLeader { get; set; }

  [ColumnName("group_members")]
  public Person[]? GroupMembers { get; set; }

  [ColumnName("group_roles")]
  public Dictionary<string, Person>? GroupRoles { get; set; }
}

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<ExampleRow>();
  }
}

If you don’t pass a type parameter, the collection or table remains untyped. This is a more flexible but less type-safe option.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var definition = new TableDefinition()
      .AddColumn("id", DataAPIType.Uuid())
      .AddColumn("group_leader", DataAPIType.UserDefined("person"))
      .AddColumn(
        "group_members",
        DataAPIType.Set(DataAPIType.UserDefined("person"))
      )
      .AddColumn(
        "group_roles",
        DataAPIType.Map(
          DataAPIType.Text(),
          DataAPIType.UserDefined("person")
        )
      )
      .AddSinglePrimaryKey("id");

    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      definition
    );
  }
}

Create a table and specify the keyspace

Typed tables
Untyped tables

You can manually define a client-side type for your table to help statically catch errors. For more information and examples, see Custom typing for tables.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

// Define the type for the row
[TableName("TABLE_NAME")]
public class Book
{
  [ColumnPrimaryKey]
  [ColumnName("title")]
  public string Title { get; set; } = null!;

  [ColumnName("number_of_pages")]
  public int? NumberOfPages { get; set; }

  [ColumnName("rating")]
  public float? Rating { get; set; }

  [ColumnName("genres")]
  public string[]? Genres { get; set; }

  [ColumnName("metadata")]
  public Dictionary<string, string>? Metadata { get; set; }

  [ColumnName("is_checked_out")]
  public bool? IsCheckedOut { get; set; }

  [ColumnName("due_date")]
  public DateOnly? DueDate { get; set; }
}

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var table = await database.CreateTableAsync<Book>(
      new CreateTableOptions() { Keyspace = "KEYSPACE_NAME" }
    );
  }
}

If you don’t pass a type parameter, the collection or table remains untyped. This is a more flexible but less type-safe option.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Instantiate the client
    var client = new DataAPIClient();

    // Connect to a database
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // Create a table
    var definition = new TableDefinition()
      .AddColumn("title", DataAPIType.Text())
      .AddColumn("number_of_pages", DataAPIType.Int())
      .AddColumn("rating", DataAPIType.Float())
      .AddColumn("genres", DataAPIType.Set(DataAPIType.Text()))
      .AddColumn(
        "metadata",
        DataAPIType.Map(DataAPIType.Text(), DataAPIType.Text())
      )
      .AddColumn("is_checked_out", DataAPIType.Boolean())
      .AddColumn("due_date", DataAPIType.Date())
      // Define the primary key for the table.
      // In this case, the table uses a single-column primary key.
      .AddSinglePrimaryKey("title");

    var table = await database.CreateTableAsync(
      "TABLE_NAME",
      definition,
      new CreateTableOptions() { Keyspace = "KEYSPACE_NAME" }
    );
  }
}

Client reference

For more information, see the client reference.

Create a table (C#)

Result

Parameters

Examples

Create a table with a single-column primary key

Create a table with a composite primary key

Create a table with a compound primary key

Create a table with a column to store vector embeddings

Create a table with a column to automatically generate vector embeddings

Configure Azure OpenAI as the embedding provider

Configure Hugging Face (Dedicated) as the embedding provider

Configure Hugging Face (Serverless) as the embedding provider

Configure Jina AI as the embedding provider

Configure Mistral AI as the embedding provider

Configure NVIDIA as the embedding provider

Configure OpenAI as the embedding provider

Configure Upstage as the embedding provider

Configure Voyage AI as the embedding provider

Create a table that uses a user-defined type (UDT)

Create a table and specify the keyspace

Client reference

Was this helpful?

Give Feedback