Get a database admin (Python)

The Data API clients use the Database Admin class to perform administrative operations, like managing keyspaces, within a specific database.

To perform administrative actions outside of a specific database, see Get an Astra DB admin (Python) instead.

The Database Admin class name varies by client. The Python client uses AstraDBDatabaseAdmin.

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 an AstraDBDatabaseAdmin object that can perform administrative actions on the specified database.

Parameters

Use the get_database_admin method from the Database class.

Method signature

get_database_admin(
  *,
  token: str | TokenProvider,
  spawn_api_options: APIOptions,
) -> DatabaseAdmin

Name Type Summary

Name	Type	Summary
`token`	`str` \| `TokenProvider`	Optional. The token used by the resulting admin object. The token should have sufficient permissions to perform the desired downstream operations. Default: The token used by the object that called this method.
`spawn_api_options`	`APIOptions`	Optional. A complete or partial specification of ttimeouts. If `APIOptions` is passed together with a named parameter such as a timeout, the latter takes precedence over the corresponding `spawn_api_options` setting. For example, you can change the default timeouts. If `APIOptions` is passed together with a named parameter such as a timeout, the latter takes precedence over the corresponding `spawn_api_options` setting.

token

str | TokenProvider

Optional. The token used by the resulting admin object. The token should have sufficient permissions to perform the desired downstream operations.

Default: The token used by the object that called this method.

spawn_api_options

APIOptions

Optional. A complete or partial specification of ttimeouts.

If APIOptions is passed together with a named parameter such as a timeout, the latter takes precedence over the corresponding spawn_api_options setting. For example, you can change the default timeouts. If APIOptions is passed together with a named parameter such as a timeout, the latter takes precedence over the corresponding spawn_api_options setting.

Alternatively, use the get_database_admin method from the AstraDBAdmin class.

Alternative method signature and parameters

get_database_admin(
  api_endpoint_or_id: str,
  *,
  api_endpoint: str,
  id: str,
  region: str,
  token: str | TokenProvider,
  spawn_api_options: APIOptions,
) -> AstraDBDatabaseAdmin

Name Type Summary

Name	Type	Summary
`api_endpoint_or_id`	`str`	An alternative to the `endpoint` or `id` parameters
`api_endpoint`	`str`	The database’s API endpoint, typically formatted as `\https://DATABASE_ID-REGION.apps.astra.datastax.com`. If specified, you cannot specify `id` and `region`.
`id`	`str`	The database’s ID. If specified, you must also specify `region` and cannot specify `api_endpoint`.
`region`	`str`	The database’s region. If specified, you must also specify `id` and cannot specify `api_endpoint`.
`token`	`str` \| `TokenProvider`	Optional. The token used by the resulting admin object. The token should have sufficient permissions to perform the desired downstream operations. Default: The token used by the object that called this method.
`spawn_api_options`	`APIOptions`	Optional. A complete or partial specification of ttimeouts. If `APIOptions` is passed together with a named parameter such as a timeout, the latter takes precedence over the corresponding `spawn_api_options` setting. For example, you can change the default timeouts. If `APIOptions` is passed together with a named parameter such as a timeout, the latter takes precedence over the corresponding `spawn_api_options` setting.

api_endpoint_or_id

str

An alternative to the endpoint or id parameters

api_endpoint

str

The database’s API endpoint, typically formatted as \https://DATABASE_ID-REGION.apps.astra.datastax.com.

If specified, you cannot specify id and region.

id

str

The database’s ID.

If specified, you must also specify region and cannot specify api_endpoint.

region

str

The database’s region.

If specified, you must also specify id and cannot specify api_endpoint.

token

str | TokenProvider

Optional. The token used by the resulting admin object. The token should have sufficient permissions to perform the desired downstream operations.

Default: The token used by the object that called this method.

spawn_api_options

APIOptions

Optional. A complete or partial specification of ttimeouts.

Examples

The following examples demonstrate how to get a database admin object.

Get a database admin from a database

from astrapy import DataAPIClient

# Get a database object
client = DataAPIClient()
database = client.get_database(
    "API_ENDPOINT", token="APPLICATION_TOKEN"
)

# Get a database admin object
database_admin = database.get_database_admin()

Get a database admin from an admin

from astrapy import DataAPIClient

# Get an admin object
client = DataAPIClient("APPLICATION_TOKEN")
admin = client.get_admin()

# Get a database admin object
database_admin = admin.get_database_admin(api_endpoint="API_ENDPOINT")

Client reference

For more information, see the client reference.

Get a database admin (Python)

Result

Parameters

Examples

Get a database admin from a database

Get a database admin from an admin

Client reference

Was this helpful?

Give Feedback