Class AstraDbAdmin

Use Db.admin or AstraAdmin.dbAdmin to obtain an instance of this class.

Gets the ID of the Astra DB instance this object is managing.

Creates a new, additional, keyspace for this database.

NB. this is a "long-running" operation. See AdminBlockingOptions about such blocking operations. The default polling interval is 1 second. Expect it to take roughly 8-10 seconds to complete.

Example

await dbAdmin.createKeyspace('my_other_keyspace1');

// ['default_keyspace', 'my_other_keyspace1']
console.log(await dbAdmin.listKeyspaces());

await dbAdmin.createKeyspace('my_other_keyspace2', {
  blocking: false,
});

// Will not include 'my_other_keyspace2' until the operation completes
console.log(await dbAdmin.listKeyspaces());
Copy

Remarks

Note that if you choose not to block, the created keyspace will not be able to be used until the operation completes, which is up to the caller to determine.

Creates a new, additional, keyspace for this database.

This is now a deprecated alias for the strictly equivalent AstraDbAdmin.createKeyspace, and will be removed in an upcoming major version.

https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5

Deprecated

• Prefer AstraDbAdmin.createKeyspace instead.

Gets the underlying Db object. The options for the db were set when the AstraDbAdmin instance, or whatever spawned it, was created.

Example

const dbAdmin = client.admin().dbAdmin('<endpoint>', {
  keyspace: 'my-keyspace',
  useHttp2: false,
});

const db = dbAdmin.db();
console.log(db.id);
Copy

Drops the database.

NB. this is a long-running operation. See AdminBlockingOptions about such blocking operations. The default polling interval is 10 seconds. Expect it to take roughly 6-7 min to complete.

The database info will still be accessible by ID, or by using the AstraAdmin.listDatabases method with the filter set to 'ALL' or 'TERMINATED'. However, all of its data will very much be lost.

Example

const db = client.db('https://<db_id>-<region>.apps.astra.datastax.com');
await db.admin().drop();
Copy

Remarks

Use with caution. Use a surge protector. Don't say I didn't warn you.

Drops a keyspace from this database.

NB. this is a "long-running" operation. See AdminBlockingOptions about such blocking operations. The default polling interval is 1 second. Expect it to take roughly 8-10 seconds to complete.

Example

await dbAdmin.dropKeyspace('my_other_keyspace1');

// ['default_keyspace', 'my_other_keyspace2']
console.log(await dbAdmin.listKeyspaces());

await dbAdmin.dropKeyspace('my_other_keyspace2', {
  blocking: false,
});

// Will still include 'my_other_keyspace2' until the operation completes
// ['default_keyspace', 'my_other_keyspace2']
console.log(await dbAdmin.listKeyspaces());
Copy

Remarks

Note that if you choose not to block, the keyspace will still be able to be used until the operation completes, which is up to the caller to determine.

Drops a keyspace from this database. *

• This is now a deprecated alias for the strictly equivalent AstraDbAdmin.dropKeyspace, and will be removed
• in an upcoming major version.
• https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5

Deprecated

• Prefer AstraDbAdmin.dropKeyspace instead.

Returns detailed information about the availability and usage of the vectorize embedding providers available on the current database (may vary based on cloud provider & region).

Example

const { embeddingProviders } = await dbAdmin.findEmbeddingProviders();

// ['text-embedding-3-small', 'text-embedding-3-large', 'text-embedding-ada-002']
console.log(embeddingProviders['openai'].models.map(m => m.name));
Copy

Fetches the complete information about the database, such as the database name, IDs, region, status, actions, and other metadata.

The method issues a request to the DevOps API each time it is invoked, without caching mechanisms; this ensures up-to-date information for usages such as real-time collection validation by the application.

Example

const info = await dbAdmin.info();
console.log(info.info.name, info.creationTime);
Copy

Lists the keyspaces in the database.

The first element in the returned array is the default keyspace of the database, and the rest are additional keyspaces in no particular order.

Example

const keyspaces = await dbAdmin.listKeyspaces();

// ['default_keyspace', 'my_other_keyspace']
console.log(keyspaces);
Copy

Lists the keyspaces in the database.

This is now a deprecated alias for the strictly equivalent AstraDbAdmin.listKeyspaces, and will be removed in an upcoming major version.

Deprecated

• Prefer AstraDbAdmin.listKeyspaces instead.