Drop a collection (TypeScript)

Deletes a collection from a database and erases all data stored in the collection.

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

Deletes the specified collection from the database and erases all data stored in the collection.

Returns a promise that resolves once the operation completes.

Parameters

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

Method signature

async dropCollection(
  name: string,
  options?: {
    keyspace?: string,
    timeout?: number | TimeoutDescriptor,
  }
): void

Name Type Summary

Name	Type	Summary
`name`	`string`	The name of the collection to drop.
`options`	`DropCollectionOptions`	Optional. The options for this operation. See Properties of `options` for more details.

name

string

The name of the collection to drop.

options

DropCollectionOptions

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

Properties of `options`
Name	Type	Summary
`keyspace`	`string`	Optional. The keyspace containing the collection. 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 drop a collection.

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

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

// Drop a collection
(async function () {
  await database.dropCollection("COLLECTION_NAME");
})();

Client reference

For more information, see the client reference.

Drop a collection (TypeScript)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback