Get a database object (Python)

When using a client, most Data API interactions require you to connect to a database through a DataAPIClient object.

Connecting to a database is an essential component of most Data API client scripts. For more information, see Get started with the Data API (Python).

For more information about the Data API client hierarchy, see Python client internals, TypeScript client internals, Go client internals, Java client internals, and C# client internals.

Result

Returns a Database object that you can use to perform CRUD operations on your database

Parameters

Use the get_database method, which belongs to the astrapy.DataAPIClient class.

Method signature

get_database(
    api_endpoint: str,
    *,
    token: str | TokenProvider,
    keyspace: str,
    spawn_api_options: APIOptions,
) -> Database

Name Type Summary

Name	Type	Summary
`api_endpoint`	`str`	A database API endpoint URL.
`token`	`str \| TokenProvider`	Optional. An application token, or an instance of `TokenProvider`. For more information about how to generate a token, see Get endpoint and token. The username and password used to generate the token must be tied to a role that has sufficient permissions to perform the desired operations. If you specified a token when instantiating the `DataAPIClient`, that token will be overridden.
`keyspace`	`str`	Optional. Specify the working keyspace. This keyspace is used for all downstream operations unless you later override it with a method such as `use_keyspace`, `get_collection`, `create_collection`, `get_table`, `create_table`. If you don’t set this, you must specify the keyspace in a downstream method before performing an operation that requires a keyspace.
`spawn_api_options`	`APIOptions`	Optional. A complete or partial specification of the APIOptions. This overrides the defaults inherited from the Data API client. This allows you to customize the interaction with the Data API. For example, you can use this parameter to change the timeout settings.

api_endpoint

str

A database API endpoint URL.

token

str | TokenProvider

Optional.

An application token, or an instance of TokenProvider. For more information about how to generate a token, see Get endpoint and token.

The username and password used to generate the token must be tied to a role that has sufficient permissions to perform the desired operations.

If you specified a token when instantiating the DataAPIClient, that token will be overridden.

keyspace

str

Optional. Specify the working keyspace. This keyspace is used for all downstream operations unless you later override it with a method such as use_keyspace, get_collection, create_collection, get_table, create_table.

If you don’t set this, you must specify the keyspace in a downstream method before performing an operation that requires a keyspace.

spawn_api_options

APIOptions

Optional. A complete or partial specification of the APIOptions.

This overrides the defaults inherited from the Data API client. This allows you to customize the interaction with the Data API. For example, you can use this parameter to change the timeout settings.

Examples

The following examples demonstrate how to connect to a database.

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

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

Client reference

For more information, see the client reference.

Get a database object (Python)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback