Find a database (Python)

Gets information about a database.

You need an application token with permission to create and configure databases, such as the Organization Administrator role.

For more information, see Get endpoint and token.

Result

Returns an AstraDBAdminDatabaseInfo object that contains information about the requested database, including the database ID, name, keyspaces, and status.

Parameters

Use the database_info method, which belongs to the AstraDBAdmin class.

Method signature

database_info(
  id: str,
  *,
  database_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> AstraDBAdminDatabaseInfo

Name Type Summary

Name	Type	Summary
`id`	`str`	The ID of the target database.
`database_admin_timeout_ms`	`int`	Optional. A timeout, in milliseconds, to impose on the underlying API request. If not provided, the `AstraDBAdmin` defaults apply. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

id

str

The ID of the target database.

database_admin_timeout_ms

int

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

This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

Examples

The following examples demonstrate how to find a database.

from astrapy import DataAPIClient

client = DataAPIClient("APPLICATION_TOKEN")

admin = client.get_admin()

database_info = admin.database_info("DATABASE_ID")

print(database_info)

Client reference

For more information, see the client reference.

Find a database (Python)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback