Create a database (Python)

Creates a database.

To replicate a database to additional datacenters, see Deploy an Astra DB Serverless database to multiple regions.

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

Creates a database and returns an AstraDBDatabaseAdmin object that can perform administrative actions on the newly-created database.

Parameters

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

Method signature

create_database(
  name: str,
  *,
  definition: DatabaseDefinition,
  wait_until_active: bool,
  database_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
  token: str | TokenProvider,
  spawn_api_options: APIOptions,
) -> AstraDBDatabaseAdmin

create_database(
  name: str,
  *,
  cloud_provider: str,
  region: str,
  keyspace: str,
  wait_until_active: bool,
  database_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
  token: str | TokenProvider,
  spawn_api_options: APIOptions,
) -> AstraDBDatabaseAdmin

Name Type Summary

Name	Type	Summary
`name`	`str`	The name for the database. Database names must follow these rules: Must start and end with a letter or number Can contain letters, numbers, and the special characters `& + - _ ( ) < > . , @` Cannot exceed 50 characters
`definition`	`DatabaseDefinition`	The configuration for the database. If specified, you cannot separately specify `cloud_provider`, `region`, or `keyspace`. See Attributes of `DatabaseDefinition` for more details.
`cloud_provider`	`str`	Required unless you specify `definition`. You can’t specify both `cloud_provider` and `definition`. The cloud provider that should host the database. Can be one of: `aws`, `gcp`, `azure`.
`region`	`str`	Required unless you specify `definition`. You can’t specify both `region` and `definition`. The cloud provider region in which to create the database. The available regions depend on your Astra plan and the database type. To find available regions, see Find available regions (Python).
`keyspace`	`str`	Optional. You can’t specify both `keyspace` and `definition`. The name for the database’s initial keyspace. Default: default_keyspace
`wait_until_active`	`bool`	Optional. Whether to wait for the database to become active before returning. If false, the method returns immediately after issuing the creation request, but you cannot work with the database until it becomes active. Default: true
`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.
`token`	`str` \| `TokenProvider`	Optional. The token used by the resulting `AstraDBDatabaseAdmin` object. The token should have sufficient permissions to perform the desired downstream operations. Default: The token used by the `AstraDBAdmin` object that called this method.
`spawn_api_options`	`APIOptions`	Optional. A complete or partial specification of the `APIOptions` to override the defaults inherited from the `AstraDBAdmin`. Use this to customize the interaction of the Python client with the database admin. 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.

name

str

The name for the database.

Database names must follow these rules:

Must start and end with a letter or number
Can contain letters, numbers, and the special characters & + - _ ( ) < > . , @
Cannot exceed 50 characters

definition

DatabaseDefinition

The configuration for the database.

If specified, you cannot separately specify cloud_provider, region, or keyspace.

See Attributes of DatabaseDefinition for more details.

cloud_provider

str

Required unless you specify definition. You can’t specify both cloud_provider and definition.

The cloud provider that should host the database. Can be one of: aws, gcp, azure.

region

str

Required unless you specify definition. You can’t specify both region and definition.

The cloud provider region in which to create the database.

The available regions depend on your Astra plan and the database type. To find available regions, see Find available regions (Python).

keyspace

str

Optional. You can’t specify both keyspace and definition.

The name for the database’s initial keyspace.

Default: default_keyspace

wait_until_active

bool

Optional. Whether to wait for the database to become active before returning. If false, the method returns immediately after issuing the creation request, but you cannot work with the database until it becomes active.

Default: true

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.

token

str | TokenProvider

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

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

spawn_api_options

APIOptions

Optional. A complete or partial specification of the APIOptions to override the defaults inherited from the AstraDBAdmin. Use this to customize the interaction of the Python client with the database admin. 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.

Name Type Summary

cloud_provider

str

The cloud provider that should host the database. Can be one of: aws, gcp, azure.

region

str

The cloud provider region in which to create the database.

The available regions depend on your Astra plan and the database type. To find available regions, see Find available regions (Python).

keyspace

str

Optional. The name for the database’s initial keyspace.

Default: default_keyspace

pcu_group_id

str

Optional. The ID of the PCU group to use for provisioning the database. The specified PCU group must have the same cloud provider and region as the database. Only applicable for organizations that use PCU groups.

Default: No PCU group

db_type

str

Optional. Whether the database is a Serverless (vector) database or a Serverless (non-vector) database.

To create a Serverless (vector) database, set this parameter to vector.

To create a Serverless (non-vector) database, set it to nonvector.

The Data API is supported for Serverless (vector) and Serverless (non-vector) databases generally. However, vector and reranking functionalities aren’t compatible with all databases, tables, or collections.

Default: vector

tier

str

Optional. The database tier.

If specified, must be serverless.

Default: serverless

capacity_units

int

Optional. The number of capacity units for the database. This is unrelated to PCU group capacity.

If specified, must be 1.

Default: 1

Examples

The following examples demonstrate how to create a database.

from astrapy import DataAPIClient
from astrapy.info import DatabaseDefinition

client = DataAPIClient("APPLICATION_TOKEN")

admin = client.get_admin()

admin.create_database(
    "DATABASE_NAME",
    definition=DatabaseDefinition(
        cloud_provider="gcp", region="us-east1"
    ),
)

Client reference

For more information, see the client reference.

Create a database (Python)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback