List keyspaces (Python)

Lists all keyspaces in a database.

Result

Returns the keyspace names as an unordered list of strings.

Parameters

Use the list_keyspaces method, which belongs to the astrapy.DataAPIDatabaseAdmin class.

Method signature

list_keyspaces(
  *,
  keyspace_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> None

Name Type Summary

Name	Type	Summary
`keyspace_admin_timeout_ms`	`int`	Optional. A timeout, in milliseconds, to impose on the underlying API request. If not provided, the `DataAPIDatabaseAdmin` defaults apply. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

keyspace_admin_timeout_ms

int

Optional. A timeout, in milliseconds, to impose on the underlying API request. If not provided, the DataAPIDatabaseAdmin defaults apply.

This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

Examples

The following examples demonstrate how to list keyspaces.

List keyspaces

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get a database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)

# Get an admin object
admin = database.get_database_admin()

# List keyspaces
keyspaces = admin.list_keyspaces()

print(keyspaces)

Client reference

For more information, see the client reference.