Drop a table (TypeScript)
Deletes a table from a database, including all data stored in the table.
|
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 table from the database, including all data stored in the table.
Returns a promise that resolves once the operation completes.
Parameters
Use the dropTable method, which belongs to the Db class.
Method signature
async dropTable(
name: string,
options?: {
ifExists?: boolean,
keyspace?: string,
timeout?: number | TimeoutDescriptor,
}
): void| Name | Type | Summary |
|---|---|---|
|
|
The name of the table to drop. |
|
|
The options for this operation. See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. Whether the command should silently succeed even if a table with the given name does not exist in the keyspace and no table was dropped. For an example, see Drop a table only if the table exists. Default: false |
|
|
Optional if you specified a working keyspace when you created the Default: The working keyspace set when you created the |
|
|
The timeout(s) to apply to HTTP request(s) originating from this method. |
Examples
The following examples demonstrate how to drop a table.
Drop a table by name
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",
});
// Drop a table
(async function () {
await database.dropTable("TABLE_NAME");
})();Drop a table through a Table object
If you get a Table object through one of the clients, you can drop the table through that object.
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get an existing table
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace: "KEYSPACE_NAME",
});
const table = database.table("TABLE_NAME");
// Drop the table
(async function () {
await table.drop();
})();Drop a table only if the table exists
Use this option to silently do nothing if a table with the specified name does not exist.
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",
});
// Drop a table
(async function () {
await database.dropTable("TABLE_NAME", {
ifExists: true,
});
})();Client reference
For more information, see the client reference.
