Find a database (TypeScript)

Gets information about a database.

You need an application token with permission to create and configure databases, such as the Organization Administrator role.

For more information, see Get endpoint and token.

Result

Returns a promise that resolves to a FullDatabaseInfo object that contains information about the requested database, including the database ID, name, keyspaces, and status.

Parameters

Use the dbInfo method, which belongs to the AstraAdmin class.

Method signature

async dbInfo(
  id: string,
  options?: {
    timeout: number | TimeoutDescriptor,
  }
): AstraFullDatabaseInfo;

Name Type Summary

Name	Type	Summary
`id`	`string`	The ID of the target database.
`options.timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout to impose on the underlying API request.

id

string

The ID of the target database.

options.timeout

number | TimeoutDescriptor

Optional. A timeout to impose on the underlying API request.

Examples

The following examples demonstrate how to find a database.

import { DataAPIClient } from "@datastax/astra-db-ts";

const client = new DataAPIClient("APPLICATION_TOKEN");

const admin = client.admin();

(async function () {
  const databaseInfo = await admin.dbInfo("DATABASE_ID");

  console.log(databaseInfo);
})();

Client reference

For more information, see the client reference.

Find a database (TypeScript)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback