Create a keyspace (C#)
Creates a new keyspace in a database.
Keyspaces are used to store collections and tables in Astra DB Serverless.
|
You need an application token with permission to interact with the target database, such as the Database Administrator role. For more information, see Get endpoint and token. |
Result
Creates the specified keyspace.
Does not return anything.
Parameters
Use the CreateKeyspaceAsync method, which belongs to the DatabaseAdminAstra class.
You can also use CreateKeyspace, which is the synchronous version of the method.
Method signature
Task CreateKeyspaceAsync(
string keyspace,
CreateKeyspaceOptions options = null
);| Name | Type | Summary |
|---|---|---|
|
|
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. |
|
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 |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. Whether to wait for the database to become active again before returning. If false, the method returns immediately after issuing the creation request, but you cannot work with the database until it becomes active again. Default: true |
|
|
Optional.
Whether to set the working keyspace of the Default: false |
Examples
The following examples demonstrate how to create a keyspace.
Create a keyspace
using DataStax.AstraDB.DataApi;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get an existing database
var client = new DataAPIClient();
var database = client.GetDatabase(
"API_ENDPOINT",
"APPLICATION_TOKEN"
);
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();
var database = client.GetDatabase(
"API_ENDPOINT",
"APPLICATION_TOKEN"
);
var databaseAdmin = database.GetAdmin();
await databaseAdmin.CreateKeyspaceAsync(
"KEYSPACE_NAME",
new() { updateDBKeyspace = true }
);
}
}Client reference
For more information, see the client reference.
