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 |
|---|---|---|
|
Optional.
The options for this operation.
See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Must be |
|
|
Optional if you specified a working keyspace when you created the Default: The working keyspace set when you created the |
|
|
Optional. The timeout(s) to apply to this method.
You can specify For more information about the |
Examples
The following examples demonstrate how to get collection metadata.
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"),
keyspace: "KEYSPACE_NAME",
});
// List collections
(async function () {
await database.listCollections({
nameOnly: false,
});
})();Client reference
For more information, see the client reference.
