Drop a user-defined type (UDT) (Java)
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 dropType method, which belongs to the com.datastax.astra.client.databases.Database class.
Method signature
void dropType(String name)void dropType(
String name,
DropTypeOptions options
)| Name | Type | Summary |
|---|---|---|
|
|
The name of the user-defined type to drop. |
|
|
Optional.
The options for this operation. See Methods of the |
| Method | Parameters | 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 |
Examples
The following examples demonstrate how to drop a user-defined type.
Drop a user-defined type
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.databases.Database;
public class Example {
public static void main(String[] args) {
// Get a database
Database database =
DataAPIClients.clientHCD("USERNAME", "PASSWORD")
.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// Drop a user-defined type
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 com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.commands.options.DropTypeOptions;
public class Example {
public static void main(String[] args) {
// Get a database
Database database =
DataAPIClients.clientHCD("USERNAME", "PASSWORD")
.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// Drop a user-defined type
DropTypeOptions options = new DropTypeOptions().ifExists(true);
database.dropType("UDT_NAME", options);
}
}Client reference
For more information, see the client reference.
