Drop a table (Java)
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.
Does not return anything.
Parameters
Use the dropTable method, which belongs to the com.datastax.astra.client.databases.Database class.
Method signature
void dropTable(String tableName)void dropTable(
String tableName,
DropTableOptions dropTableOptions
)| Name | Type | Summary |
|---|---|---|
|
|
The name of the table to drop. |
|
Optional.
The options for this operation. See Methods of |
| Method | Parameters | 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 |
|
|
Optional. 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 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 table
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 com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.definition.rows.Row;
public class Example {
public static void main(String[] args) {
// Get an existing table
Table<Row> table =
DataAPIClients.clientHCD("USERNAME", "PASSWORD")
.getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
.getTable("TABLE_NAME");
// Drop the table
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 com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.commands.options.DropTableOptions;
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 table
DropTableOptions options = new DropTableOptions().ifExists(true);
database.dropTable("TABLE_NAME", options);
}
}Client reference
For more information, see the client reference.
