List keyspaces (Java)

Lists all keyspaces in a database.

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

Returns the keyspace names as a Set of strings.

Parameters

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

Method signature

Set<String> listKeyspaceNames()

This method does not accept any parameters.

Examples

The following examples demonstrate how to list keyspaces.

List keyspaces

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();

    // List keyspaces
    admin.listKeyspaceNames();
  }
}

Client reference

For more information, see the client reference.