List keyspaces (TypeScript)
Lists all keyspaces in a database.
Result
Returns a promise that resolves to the keyspace names as an unordered list of strings.
Parameters
Use the listKeyspaces method, which belongs to the DataAPIDbAdmin class.
Method signature
async listKeyspaces(
options?: {
timeout?: number | TimeoutDescriptor,
}
): void| Name | Type | Summary |
|---|---|---|
|
|
Optional.
The options for this operation. See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. The timeout(s) to apply to this method.
You can specify For more information about the |
Examples
The following examples demonstrate how to list keyspaces.
List keyspaces
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
// Get an admin object
const admin = database.admin({ environment: "hcd" });
// List keyspaces
(async function () {
const keyspaces = await admin.listKeyspaces();
console.log(keyspaces);
})();Client reference
For more information, see the client reference.
