Drop a user-defined type (UDT) (C#)
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.
Does not return anything.
Parameters
Use the DropTypeAsync method, which belongs to the Database class.
You can also use DropType, which is the synchronous version of the method.
Method signature
public Task DropTypeAsync<T>(DropTypeOptions options = null);public Task DropTypeAsync(string typeName, DropTypeOptions options = null);| Name | Type | Summary |
|---|---|---|
|
|
The name of the user-defined type to drop. If you use a custom user-defined type class and do not specify this parameter, the client attempts to extract it from first from the |
|
Optional.
Options for this operation.
For more information and examples for general options such as timeout, see Customize API interaction.
For options specific to this method, see Method-specific properties of the |
| 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 |
Examples
The following examples demonstrate how to drop a user-defined type.
Drop a user-defined type
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get an existing table
var client = new DataAPIClient(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
),
"KEYSPACE_NAME"
);
// Drop a user-defined type
await database.DropTypeAsync("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.
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get an existing table
var client = new DataAPIClient(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
),
"KEYSPACE_NAME"
);
// Drop a user-defined type
await database.DropTypeAsync(
"UDT_NAME",
new DropTypeOptions() { IfExists = true }
);
}
}Client reference
For more information, see the client reference.
