Get a database admin (TypeScript)
The Data API clients use the Database Admin class to perform administrative operations, like managing keyspaces, within a specific database.
The Database Admin class name varies by client.
The TypeScript client uses DataAPIDbAdmin.
Result
Returns a DataAPIDbAdmin object that can perform administrative actions on the specified database.
Parameters
Use the admin method, which belongs to the Db class.
Method signature
admin(
options?: AdminOptions & {
environment?: string
}
): DataAPIDbAdmin| Name | Type | Summary |
|---|---|---|
|
|
Only for the The database’s environment.
Can be one of: |
|
Optional. A specification of options to override the inherited defaults. Use this to customize the interaction of the client with the database admin. For example, you can change the default timeouts or token. |
Examples
The following examples demonstrate how to get a database admin object.
Get a database admin from a database
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database object
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
// Get a database admin object
const databaseAdmin = database.admin({ environment: "hcd" });Client reference
For more information, see the client reference.
