List collection metadata (TypeScript)

Gets information about the collections in a keyspace.

Ready to write code? See the examples for this method to get started. If you are new to the Data API, check out the quickstart.

Result

Returns a promise that resolves to an array of CollectionDescriptor objects that describe each collection.

Parameters

Use the listCollections method, which belongs to the Db class.

Method signature

async listCollections(
  options: {
    nameOnly?: false,
    keyspace?: string,
    timeout?: number | TimeoutDescriptor,
  }
): CollectionDescriptor[]

Name Type Summary

Name	Type	Summary
`options`	`ListCollectionsOptions`	Optional. The options for this operation. See Properties of `options` for more details.

options

ListCollectionsOptions

Optional. The options for this operation. See Properties of options for more details.

Properties of `options`
Name	Type	Summary
`nameOnly`	`false`	Must be `false` or undefined to return metadata about the collections. Otherwise, only the collection names are returned.
`keyspace`	`string`	Optional. The keyspace to inspect. Default: The working keyspace for the database. This is `default_keyspace` unless you set a different working keyspace when you created the `Db` object.
`timeout`	`number` \| `TimeoutDescriptor`	Optional. The timeout(s) to apply to this method. You can specify `requestTimeoutMs` and `collectionAdminTimeoutMs`. For more information about the `TimeoutDescriptor`, see TypeScript client internals: TimeoutDescriptor. If you specify a number instead of a `TimeoutDescriptor` object, that number will be applied to both `requestTimeoutMs` and `collectionAdminTimeoutMs`.

Examples

The following examples demonstrate how to get collection metadata.

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

// Get a database
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});

// List collections
(async function () {
  await database.listCollections({ nameOnly: false });
})();

Client reference

For more information, see the client reference.

List collection metadata (TypeScript)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback