Type alias CreateKeyspaceOptions

Represents the common options for creating a keyspace through the astra-db-ts client.

See AdminBlockingOptions for more options about blocking behavior.

If updateDbKeyspace is set to true, the underlying Db instance used to create the DbAdmin will have its current working keyspace set to the newly created keyspace immediately (even if the keyspace isn't technically yet created).

Example

// If using non-astra, this may be a common idiom:
const client = new DataAPIClient({ environment: 'dse' });
const db = client.db('<endpoint>', { token: '<token>' });

// Will internally call `db.useKeyspace('new_keyspace')`
await db.admin().createKeyspace('new_keyspace', {
  updateDbKeyspace: true,
});

// Creates collection in keyspace `new_keyspace` by default now
const coll = db.createCollection('my_coll');
Copy

See

DbAdmin.createKeyspace