Drop a user-defined type (UDT) (TypeScript)
Drops a user-defined type (UDT) from a keyspace.
You can’t drop a user-defined type that is currently used by a table. You must first use drop the columns that use the user-defined type.
|
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
Drops the specified user-defined type.
Returns a promise that resolves once the operation completes.
Parameters
Use the dropType method, which belongs to the Db class.
Method signature
async dropType(
name: string,
options?: {
ifExists?: boolean,
timeout?: number | TimeoutDescriptor,
keyspace?: string,
}
): void| Name | Type | Summary |
|---|---|---|
|
|
The name of the user-defined type to drop. |
|
|
Optional.
The options for this operation.
See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. Whether the command should silently succeed even if a user-defined type with the given name does not exist in the keyspace and a user-defined type wasn’t dropped. Default: false |
|
|
Optional if you specified a working keyspace when you created the Default: The working keyspace set when you created the |
|
|
Optional. A timeout to impose on the underlying API request. |
Examples
The following examples demonstrate how to drop a user-defined type.
Drop a user-defined type
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 user-defined type
(async function () {
await database.dropType("UDT_NAME");
})();Drop a user-defined type only if the type exists
Use this option to silently do nothing if a user-defined type 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 user-defined type
(async function () {
await database.dropType("UDT_NAME", {
ifExists: true,
});
})();Client reference
For more information, see the client reference.
