Drop a keyspace (Java)

Drops a keyspace from a database and deletes all data in that keyspace.

You need an application token with permission to interact with the target database, such as the Database Administrator role.

For more information, see Get endpoint and token.

Result

Drops the specified keyspace.

Does not return anything.

Signature

Use the dropKeyspace method, which belongs to the com.datastax.astra.client.admin.DatabaseAdmin class.

void dropKeyspace(String keyspace)

void dropKeyspace(
  String keyspace,
  DropKeyspaceOptions options
)

Parameters

Name Type Summary

Name	Type	Summary
`keyspace`	`String`	The name of the keyspace to drop.
`options`	`DropKeyspaceOptions`	Optional. The options for this operation. See Methods of `DropKeyspaceOptions` for more details.

keyspace

String

The name of the keyspace to drop.

options

DropKeyspaceOptions

Optional. The options for this operation. See Methods of DropKeyspaceOptions for more details.

Methods of `DropKeyspaceOptions`
Method	Parameters	Summary
`ifExists()`	`boolean`	Optional. Whether the command should silently succeed even if a keyspace with the given name does not exist. Default: true

Examples

The following examples demonstrate how to drop a keyspace.

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.admin.DatabaseAdmin;
import com.datastax.astra.client.databases.Database;

public class Example {

  public static void main(String[] args) {
    // Get a database
    Database database = new DataAPIClient("APPLICATION_TOKEN").getDatabase("API_ENDPOINT");

    // Get an admin object
    DatabaseAdmin admin = database.getDatabaseAdmin();

    // Drop a keyspace
    admin.dropKeyspace("KEYSPACE_NAME");
  }
}

Client reference

For more information, see the client reference.