Class AstraDbAdmin

An administrative class for managing Astra databases, including creating, listing, and deleting keyspaces.

Shouldn't be instantiated directly; use Db.admin or AstraDbAdmin.dbAdmin to obtain an instance of this class.

To manage databases as a whole, see AstraAdmin.

Example

const client = new DataAPIClient('*TOKEN*');

// Create an admin instance through a Db
const db = client.db('*ENDPOINT*');
const dbAdmin1 = db.admin();
const dbAdmin2 = db.admin({ adminToken: 'stronger-token' });

// Create an admin instance through an AstraAdmin
const admin = client.admin();
const dbAdmin3 = admin.dbAdmin('*ENDPOINT*');
const dbAdmin4 = admin.dbAdmin('*DB_ID*', '*REGION*');

const keyspaces = await admin1.listKeyspaces();
console.log(keyspaces);

const dbInfo = await admin1.info();
console.log(dbInfo);

See

  • Db.admin
  • AstraDbAdmin.dbAdmin

Hierarchy (view full)

Constructors

constructor

Properties

#dataApiHttpClient #db #environment #httpClient createNamespace dropNamespace internal listNamespaces

Accessors

_httpClient id

Methods

#info _getDataAPIHttpClient createKeyspace db drop dropKeyspace findEmbeddingProviders findRerankingProviders info listKeyspaces off on once removeAllListeners updateLoggingConfig

Constructors

constructor

Properties

Private Readonly #dataApiHttpClient

#dataApiHttpClient: DataAPIHttpClient<"admin">

Private Readonly #db

#db: Db

Private Readonly #environment

#environment: "dev" | "prod" | "test"

Private Readonly #httpClient

#httpClient: DevOpsAPIHttpClient

createNamespace

createNamespace: "ERROR: The `namespace` terminology has been removed, and replaced with `keyspace` throughout the client"

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

  • The namespace terminology has been removed, and replaced with keyspace throughout the client.

dropNamespace

dropNamespace: "ERROR: The `namespace` terminology has been removed, and replaced with `keyspace` throughout the client"

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

  • The namespace terminology has been removed, and replaced with keyspace throughout the client.

Internal internal

internal: InternalLogger<AdminCommandEventMap>

listNamespaces

listNamespaces: "ERROR: The `namespace` terminology has been removed, and replaced with `keyspace` throughout the client"

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

  • The namespace terminology has been removed, and replaced with keyspace throughout the client.

Accessors

_httpClient

id

Methods

Private #info

Protected _getDataAPIHttpClient

createKeyspace

  • createKeyspace(keyspace, options?): Promise<void>

  • Creates a new, additional, keyspace for this database.

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

    Parameters

    • keyspace: string

      The name of the new keyspace.

    • Optional options: CreateAstraKeyspaceOptions

      The options for the blocking behavior of the operation.

    Returns Promise<void>

    A promise that resolves when the operation completes.

    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());

    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.

db

  • db(): Db

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

    Returns Db

    The underlying Db object.

    Example

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

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

drop

  • drop(options?): Promise<void>

  • Drops the database.

    NB. this is a long-running operation. See AstraAdminBlockingOptions 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.

    Parameters

    Returns Promise<void>

    A promise that resolves when the operation completes.

    Example

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

    Remarks

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

dropKeyspace

  • dropKeyspace(keyspace, options?): Promise<void>

  • Drops a keyspace from this database.

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

    Parameters

    • keyspace: string

      The name of the keyspace to drop.

    • Optional options: DropAstraKeyspaceOptions

      The options for the blocking behavior of the operation.

    Returns Promise<void>

    A promise that resolves when the operation completes.

    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());

    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.

findEmbeddingProviders

  • findEmbeddingProviders(options?): Promise<FindEmbeddingProvidersResult>

  • 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).

    Parameters

    • Optional options: WithTimeout<"databaseAdminTimeoutMs">

      The options for the timeout of the operation.

    Returns Promise<FindEmbeddingProvidersResult>

    The available embedding providers.

    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));

findRerankingProviders

  • findRerankingProviders(options?): Promise<FindRerankingProvidersResult>

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

    Parameters

    • Optional options: WithTimeout<"databaseAdminTimeoutMs">

      The options for the timeout of the operation.

    Returns Promise<FindRerankingProvidersResult>

    The available reranking providers.

    Example

    const { rerankingProviders } = await dbAdmin.findRerankingProviders();

    // ['nvidia/llama-3.2-nv-rerankqa-1b-v2']
    console.log(rerankingProviders['nvidia'].models.map(m => m.name));

info

  • info(options?): Promise<AstraFullDatabaseInfo>

  • 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 collections validation by the application.

    Parameters

    • Optional options: WithTimeout<"databaseAdminTimeoutMs">

    Returns Promise<AstraFullDatabaseInfo>

    A promise that resolves to the complete database information.

    Example

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

listKeyspaces

  • listKeyspaces(options?): Promise<string[]>

  • 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.

    Parameters

    • Optional options: WithTimeout<"keyspaceAdminTimeoutMs">

    Returns Promise<string[]>

    A promise that resolves to list of all the keyspaces in the database.

    Example

    const keyspaces = await dbAdmin.listKeyspaces();

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

off

on

once

  • once<E>(eventName, listener): (() => void)

  • Subscribe to an event once.

    The listener will be automatically unsubscribed after the first time it is called.

    Note that the listener will be unsubscribed BEFORE the actual listener callback is invoked.

    Type Parameters

    Parameters

    • eventName: E

      The event to listen for.

    • listener: ((event) => void)

      The callback to invoke when the event is emitted.

    Returns (() => void)

    A function to prematurely unsubscribe the listener.

      • (): void

      • Returns void

removeAllListeners

updateLoggingConfig

Settings

Member Visibility

Theme

On This Page

constructor#dataApiHttpClient#db#environment#httpClientcreateNamespacedropNamespaceinternallistNamespaces_httpClientid#info_getDataAPIHttpClientcreateKeyspacedbdropdropKeyspacefindEmbeddingProvidersfindRerankingProvidersinfolistKeyspacesoffononceremoveAllListenersupdateLoggingConfig