Create a keyspace (C#)

Creates a new keyspace in a database.

Keyspaces are used to store collections and tables in Hyper-Converged Database (HCD).

Result

Creates the specified keyspace.

Does not return anything.

Parameters

Use the CreateKeyspaceAsync method, which belongs to the DatabaseAdminDataAPI class. You can also use CreateKeyspace, which is the synchronous version of the method.

Method signature

Task CreateKeyspaceAsync(
  string keyspace,
  CreateKeyspaceOptions options = null
);

Task CreateKeyspaceAsync(
  string keyspace,
  IDictionary<string, object> replicationOptions,
  CreateKeyspaceOptions options
);

Name Type Summary

keyspace

string

The name of the keyspace to create.

If a keyspace with the name already exists, a new keyspace isn’t created, and the command succeeds.

options

CreateKeyspaceOptions

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

replicationOptions

IDictionary<string, object>

Optional. Specifies the options for data replication across database nodes.

For an example, see Create a keyspace and specify replication options.

Method-specific properties of the `CreateKeyspaceOptions` class
Name	Type	Summary
`updateDBKeyspace`	`bool`	Optional. Whether to set the working keyspace of the `Database` object that created the current `IDatabaseAdmin` object to the new keyspace. Default: false

Examples

The following examples demonstrate how to create a keyspace.

Create a keyspace

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

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing database
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      )
    );

    var databaseAdmin = database.GetAdmin();

    await databaseAdmin.CreateKeyspaceAsync("KEYSPACE_NAME");
  }
}

Create a keyspace and set it as the working keyspace for the database

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

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing database
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      )
    );

    var databaseAdmin = database.GetAdmin();

    await databaseAdmin.CreateKeyspaceAsync(
      "KEYSPACE_NAME",
      new() { updateDBKeyspace = true }
    );
  }
}

Create a keyspace and specify replication options

For more information about data replication, see Data replication.

Example using SimpleStrategy:

To access the overload to specify replication options, you must specify the DatabaseAdminDataAPI type for GetAdmin as demonstrated in this example.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Admin;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing database
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      )
    );

    var databaseAdmin = database.GetAdmin<DatabaseAdminDataAPI>();

    await databaseAdmin.CreateKeyspaceAsync(
      "KEYSPACE_NAME",
      new Dictionary<string, object>
      {
        ["class"] = "SimpleStrategy",
        ["replication_factor"] = 3,
      }
    );
  }
}

Example using NetworkTopologyStrategy:

To access the overload to specify replication options, you must specify the DatabaseAdminDataAPI type for GetAdmin as demonstrated in this example.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Admin;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing database
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      )
    );

    var databaseAdmin = database.GetAdmin<DatabaseAdminDataAPI>();

    await databaseAdmin.CreateKeyspaceAsync(
      "KEYSPACE_NAME",
      new Dictionary<string, object>
      {
        ["class"] = "NetworkTopologyStrategy",
        ["datacenter1"] = 3,
        ["datacenter2"] = 2,
      }
    );
  }
}

Client reference

For more information, see the client reference.

Was this helpful?