Module data.client (2.23.1)

API documentation for bigtable.data._async.client module.

Classes

BigtableDataClientAsync

BigtableDataClientAsync(
    *,
    project: str | None = None,
    pool_size: int = 3,
    credentials: google.auth.credentials.Credentials | None = None,
    client_options: (
        dict[str, Any] | "google.api_core.client_options.ClientOptions" | None
    ) = None
)

Create a client instance for the Bigtable Data API

Client should be created within an async context (running event loop)

Parameter
NameDescription
client_options Optional[Union[dict, google.api_core.client_options.ClientOptions]]

Client options used to set user options on the client. API Endpoint should be set through client_options.

Exceptions
TypeDescription
RuntimeError if called outside of an async context (no running event loop):
ValueError if pool_size is less than 1:

TableAsync

TableAsync(client: google.cloud.bigtable.data._async.client.BigtableDataClientAsync, instance_id: str, table_id: str, app_profile_id: typing.Optional[str] = None, *, default_read_rows_operation_timeout: float = 600, default_read_rows_attempt_timeout: float | None = 20, default_mutate_rows_operation_timeout: float = 600, default_mutate_rows_attempt_timeout: float | None = 60, default_operation_timeout: float = 60, default_attempt_timeout: float | None = 20, default_read_rows_retryable_errors: typing.Sequence[type[Exception]] = (<class 'google.api_core.exceptions.DeadlineExceeded'>, <class 'google.api_core.exceptions.ServiceUnavailable'>, <class 'google.api_core.exceptions.Aborted'>), default_mutate_rows_retryable_errors: typing.Sequence[type[Exception]] = (<class 'google.api_core.exceptions.DeadlineExceeded'>, <class 'google.api_core.exceptions.ServiceUnavailable'>), default_retryable_errors: typing.Sequence[type[Exception]] = (<class 'google.api_core.exceptions.DeadlineExceeded'>, <class 'google.api_core.exceptions.ServiceUnavailable'>))

Main Data API surface

Table object maintains table_id, and app_profile_id context, and passes them with each call