List keyspaces (C#)

Lists all keyspaces in a database.

Result

Returns the keyspace names as an unordered list of strings.

Parameters

Use the ListKeyspacesAsync method, which belongs to the IDatabaseAdmin class. You can also use ListKeyspaces, which is the synchronous version of the method.

Method signature
Task<IEnumerable<string>> ListKeyspacesAsync(
  ListKeyspacesOptions options = null
);

Parameters:

Name Type Summary

options

ListKeyspacesOptions

General API options for this operation, including the timeout. For more information and examples, see Customize API interaction.

Examples

The following examples demonstrate how to list keyspaces.

List keyspaces

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing database
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      )
    );

    var databaseAdmin = database.GetAdmin();

    await databaseAdmin.ListKeyspacesAsync();
  }
}

Client reference

For more information, see the client reference.

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2026 | Privacy policy | Terms of use Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM