Package Classes (2.34.0)

Representation of a Google Cloud Bigtable AppProfile.

We can use a AppProfile to:

• reload itself
• create itself
• update itself
• delete itself

Representation of a Google Cloud Bigtable Backup.

A :class: Backup can be used to:

• create the backup
• update the backup
• delete the backup

Error in the batch request

A MutationsBatcher is used in batch cases where the number of mutations is large or unknown. It will store DirectRow in memory until one of the size limits is reached, or an explicit call to flush() is performed. When a flush event occurs, the DirectRow in memory will be sent to Cloud Bigtable. Batching mutations is more efficient than sending individual request.

This class is not suited for usage in systems where each mutation must be guaranteed to be sent, since calling mutate may only result in an in-memory change. In a case of a system crash, any DirectRow remaining in memory will not necessarily be sent to the service, even after the completion of the mutate() method.

Note on thread safety: The same MutationBatcher cannot be shared by multiple end-user threads.

Client for interacting with Google Cloud Bigtable API.

Representation of a Google Cloud Bigtable Cluster.

We can use a Cluster to:

• reload itself
• create itself
• update itself
• delete itself
• disable_autoscaling itself

Representation of a Google Cloud Bigtable Column Family.

We can use a ColumnFamily to:

• create itself
• update itself
• delete itself

Intersection of garbage collection rules.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_create_family_gc_intersection] :end-before: [END bigtable_api_create_family_gc_intersection] :dedent: 4

Union of garbage collection rules.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_create_family_gc_union] :end-before: [END bigtable_api_create_family_gc_union] :dedent: 4

Garbage collection rule for column families within a table.

Cells in the column family (within a table) fitting the rule will be deleted during garbage collection.

Garbage collection limiting the age of a cell.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_create_family_gc_max_age] :end-before: [END bigtable_api_create_family_gc_max_age] :dedent: 4

Garbage collection limiting the number of versions of a cell.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_create_family_gc_max_versions] :end-before: [END bigtable_api_create_family_gc_max_versions] :dedent: 4

Create a client instance for the Bigtable Data API

Create a client instance for the Bigtable Data API

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

Main Data API surface for interacting with a Bigtable table.

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

Provides access to an authorized view of a table.

An authorized view is a subset of a table that you configure to include specific table data. Then you grant access to the authorized view separately from access to the table.

AuthorizedView object maintains table_id, app_profile_id, and authorized_view_id context, and passed them with each call

Main Data API surface for interacting with a Bigtable table.

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

Allows users to send batches using context manager API.

Runs mutate_row, mutate_rows, and check_and_mutate_row internally, combining to use as few network requests as required

Will automatically flush the batcher:

• every flush_interval seconds
• after queue size reaches flush_limit_mutation_count
• after queue reaches flush_limit_bytes
• when batcher is closed or destroyed

Provides access to an authorized view of a table.

An authorized view is a subset of a table that you configure to include specific table data. Then you grant access to the authorized view separately from access to the table.

AuthorizedView object maintains table_id, app_profile_id, and authorized_view_id context, and passed them with each call

Allows users to send batches using context manager API.

Runs mutate_row, mutate_rows, and check_and_mutate_row internally, combining to use as few network requests as required

Will automatically flush the batcher:

• every flush_interval seconds
• after queue size reaches flush_limit_mutation_count
• after queue reaches flush_limit_bytes
• when batcher is closed or destroyed

Execption raised when metadata is request from an ExecuteQueryIterator before the first row has been read, or the query has completed

Represents a single failed RowMutationEntry in a bulk_mutate_rows request. A collection of FailedMutationEntryErrors will be raised in a MutationsExceptionGroup

Represents an individual failed query in a sharded read rows operation

Exception raised to invalid chunk data from back-end.

Exception raised to invalid query response data from back-end.

Represents one or more exceptions that occur during a bulk mutation operation

Exceptions will typically be of type FailedMutationEntryError, but other exceptions may be included if they are raised during the mutation operation

Exception raised when query parameter types were not provided and cannot be inferred.

Represents one or more exceptions that occur during a retryable operation

Represents one or more exceptions that occur during a sharded read rows operation

Collects responses from ExecuteQuery requests and parses them into QueryResultRows.

Please Note this is not meant to be constructed directly by applications. It should always be created via the client. The constructor is subject to change.

It is not thread-safe. It should not be used by multiple threads.

Collects responses from ExecuteQuery requests and parses them into QueryResultRows.

Please Note this is not meant to be constructed directly by applications. It should always be created via the client. The constructor is subject to change.

It is not thread-safe. It should not be used by multiple asyncio Tasks.

Metadata class for the ExecuteQuery operation.

Classes denoting types of values returned by Bigtable's ExecuteQuery operation.

Used in .Metadata.

Array SQL type.

Bool SQL type.

Bytes SQL type.

Date SQL type.

Enum SQL type.

Float32 SQL type.

Float64 SQL type.

Int64 SQL type.

Map SQL type.

Proto SQL type.

String SQL type.

Struct SQL type.

Timestamp SQL type.

Timestamp supports DatetimeWithNanoseconds but Bigtable SQL does not currently support nanoseconds precision. We support this for potential compatibility in the future. Nanoseconds are currently ignored.

Represents a single row of the result

Represents a struct value in the result

Adds an int64 value to an aggregate cell. The column family must be an aggregate family and have an "int64" input type or this mutation will be rejected.

Note: The timestamp values are in microseconds but must match the granularity of the table (defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Mutation to delete all cells from a column family.

Mutation to delete all cells from a row.

Mutation to delete a range of cells from a column.

Abstract base class for mutations.

This class defines the interface for different types of mutations that can be applied to Bigtable rows.

A single entry in a MutateRows request.

This class represents a set of mutations to apply to a specific row in a Bigtable table.

Mutation to set the value of a cell.

Rule to append a value to a cell's value.

Rule to increment a cell's value.

Abstract base class for read-modify-write rules.

Class to encapsulate details of a read row request

Represents a range of keys in a ReadRowsQuery

Model class for cell data

Does not represent all data contained in the cell, only data returned by a query. Expected to be read-only to users, and written by backend

Model class for row data returned from server

Does not represent all data contained in the row, only data returned by a query. Expected to be read-only to users, and written by backend

Can be indexed by family and qualifier to get cells in the row::

cells = row["family", "qualifier"]

Filter to apply labels to cells.

Intended to be used as an intermediate filter on a pre-existing filtered result set. This way if two sets are combined, the label can tell where the cell(s) originated.This allows the client to determine which results were produced from which part of the filter.

Row filter that doesn't match any cells.

Row filter to limit cells in a column.

Row filter to limit cells in a row.

Row filter to skip cells in a row.

Row filter for a column qualifier regular expression.

The regex must be valid RE2 patterns. See Google's RE2 reference_ for the accepted syntax.

.. _RE2 reference: https://github.com/google/re2/wiki/Syntax

A row filter to restrict to a range of columns.

Both the start and end column can be included or excluded in the range. By default, we include them both, but this can be changed with optional flags.

Conditional row filter which exhibits ternary behavior.

Executes one of two filters based on another filter. If the predicate_filter returns any cells in the row, then true_filter is executed. If not, then false_filter is executed.

Row filter for a family name regular expression.

The regex must be valid RE2 patterns. See Google's RE2 reference_ for the accepted syntax.

.. _RE2 reference: https://github.com/google/re2/wiki/Syntax

Row filter for an exact value.

Row filter equivalent to not filtering at all.

Basic filter to apply to cells in a row.

These values can be combined via RowFilterChain, RowFilterUnion and ConditionalRowFilter.

Chain of row filters.

Sends rows through several filters in sequence. The filters are "chained" together to process a row. After the first filter is applied, the second is applied to the filtered output and so on for subsequent filters.

Union of row filters.

Sends rows through several filters simultaneously, then merges / interleaves all the filtered results together.

If multiple cells are produced with the same column and timestamp, they will all appear in the output row in an unspecified mutual order.

Row filter for a row key regular expression.

The regex must be valid RE2 patterns. See Google's RE2 reference_ for the accepted syntax.

.. _RE2 reference: https://github.com/google/re2/wiki/Syntax

Matches all cells from a row with probability p.

Advanced row filter to skip parent filters.

Row filter that transforms cells into empty string (0 bytes).

Range of time with inclusive lower and exclusive upper bounds.

Row filter that limits cells to a range of time.

A range of values to restrict to in a row filter.

Will only match cells that have values in this range.

Both the start and end value can be included or excluded in the range. By default, we include them both, but this can be changed with optional flags.

Row filter for a value regular expression.

The regex must be valid RE2 patterns. See Google's RE2 reference_ for the accepted syntax.

.. _RE2 reference: https://github.com/google/re2/wiki/Syntax

Encryption information for a given resource.

If this resource is protected with customer managed encryption, the in-use Google Cloud Key Management Service (KMS) key versions will be specified along with their status.

Representation of a Google Cloud Bigtable Instance.

We can use an Instance to:

• reload itself
• create itself
• update itself
• delete itself

Google Cloud Bigtable Row for sending append mutations.

These mutations are intended to augment the value of an existing cell and uses the methods:

• append_cell_value
• increment_cell_value

The first works by appending bytes and the second by incrementing an integer (stored in the cell as 8 bytes). In either case, if the cell is empty, assumes the default empty value (empty string for bytes or 0 for integer).

Representation of a Google Cloud Bigtable Cell.

Google Cloud Bigtable Row for sending mutations conditionally.

Each mutation has an associated state: :data:True or :data:False. When commit-ed, the mutations for the :data:True state will be applied if the filter matches any cells in the row, otherwise the :data:False state will be applied.

A ConditionalRow accumulates mutations in the same way a DirectRow does:

• set_cell
• delete
• delete_cell
• delete_cells

with the only change the extra state parameter::

row_cond = table.row(b'row-key2', filter_=row_filter) row_cond.set_cell(u'fam', b'col', b'cell-val', state=True) row_cond.delete_cell(u'fam', b'col', state=False)

Google Cloud Bigtable Row for sending "direct" mutations.

These mutations directly set or delete cell contents:

• set_cell
• delete
• delete_cell
• delete_cells

These methods can be used directly::

row = table.row(b'row-key1') row.set_cell(u'fam', b'col1', b'cell-val') row.delete_cell(u'fam', b'col2')

Exception raised to invalid chunk data from back-end.

Representation of partial row in a Google Cloud Bigtable Table.

These are expected to be updated directly from a ._generated.bigtable_service_messages_pb2.ReadRowsResponse

Base representation of a Google Cloud Bigtable Row.

This class has three subclasses corresponding to the three RPC methods for sending row mutations:

• DirectRow for MutateRow
• ConditionalRow for CheckAndMutateRow
• AppendRow for ReadModifyWriteRow

Exception raised to invalid response data from back-end.

Exception raised when retry request is invalid.

This class is no longer used and will be removed in the future

Convenience wrapper for consuming a ReadRows streaming response.

Filter to apply labels to cells.

Intended to be used as an intermediate filter on a pre-existing filtered result set. This way if two sets are combined, the label can tell where the cell(s) originated.This allows the client to determine which results were produced from which part of the filter.

Row filter that doesn't match any cells.

Row filter to limit cells in a column.

Row filter to limit cells in a row.

Row filter to skip cells in a row.

Row filter for a column qualifier regular expression.

The regex must be valid RE2 patterns. See Google's RE2 reference_ for the accepted syntax.

.. _RE2 reference: https://github.com/google/re2/wiki/Syntax

A row filter to restrict to a range of columns.

Both the start and end column can be included or excluded in the range. By default, we include them both, but this can be changed with optional flags.

Conditional row filter which exhibits ternary behavior.

Executes one of two filters based on another filter. If the base_filter returns any cells in the row, then true_filter is executed. If not, then false_filter is executed.

Row filter for an exact value.

Row filter for a family name regular expression.

The regex must be valid RE2 patterns. See Google's RE2 reference_ for the accepted syntax.

.. _RE2 reference: https://github.com/google/re2/wiki/Syntax

Row filter equivalent to not filtering at all.

Basic filter to apply to cells in a row.

These values can be combined via RowFilterChain, RowFilterUnion and ConditionalRowFilter.

Chain of row filters.

Sends rows through several filters in sequence. The filters are "chained" together to process a row. After the first filter is applied, the second is applied to the filtered output and so on for subsequent filters.

Union of row filters.

Sends rows through several filters simultaneously, then merges / interleaves all the filtered results together.

If multiple cells are produced with the same column and timestamp, they will all appear in the output row in an unspecified mutual order.

Row filter for a row key regular expression.

The regex must be valid RE2 patterns. See Google's RE2 reference_ for the accepted syntax.

.. _RE2 reference: https://github.com/google/re2/wiki/Syntax

Matches all cells from a row with probability p.

Advanced row filter to skip parent filters.

Row filter that transforms cells into empty string (0 bytes).

Range of time with inclusive lower and exclusive upper bounds.

Row filter that limits cells to a range of time.

A range of values to restrict to in a row filter.

Will only match cells that have values in this range.

Both the start and end value can be included or excluded in the range. By default, we include them both, but this can be changed with optional flags.

Row filter for a value regular expression.

The regex must be valid RE2 patterns. See Google's RE2 reference_ for the accepted syntax.

.. _RE2 reference: https://github.com/google/re2/wiki/Syntax

Convenience wrapper of google.bigtable.v2.RowRange

Convenience wrapper of google.bigtable.v2.RowSet

Useful for creating a set of row keys and row ranges, which can be passed to read_rows method of class:.Table.read_rows.

Representation of a Cluster State.

Representation of a Google Cloud Bigtable Table.

• create the table
• delete the table
• list_column_families in the table

Row from another table.

The number of mutations for bulk request is too big.

Instantiates the Bigtable table admin async client.

Instantiates the Bigtable table admin client.

A Future for interacting with Bigtable Admin's RestoreTable Long-Running Operation.

This is needed to expose a potential long-running operation that might run after this operation finishes, OptimizeRestoreTable. This is exposed via the the optimize_restore_table_operation method.

This class should not be instantiated by users and should only be instantiated by the admin client's :meth:restore_table <<xref uid="google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.restore_table">google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.restore_table</xref>> method.

A Future for interacting with Bigtable Admin's RestoreTable Long-Running Operation.

This is needed to expose a potential long-running operation that might run after this operation finishes, OptimizeRestoreTable. This is exposed via the the optimize_restore_table_operation method.

This class should not be instantiated by users and should only be instantiated by the admin client's :meth:restore_table <<xref uid="google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.restore_table">google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.restore_table</xref>> method.

Wrapper class for encapsulating parameters for the wait_for_consistency method in both BigtableTableAdminClient and BigtableTableAdmiAsyncClient.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.

A pager for iterating through list_app_profiles requests.

This class thinly wraps an initial ListAppProfilesResponse object, and provides an __aiter__ method to iterate through its app_profiles field.

If there are more pages, the __aiter__ method will make additional ListAppProfiles requests and continue to iterate through the app_profiles field on the corresponding responses.

All the usual ListAppProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_app_profiles requests.

This class thinly wraps an initial ListAppProfilesResponse object, and provides an __iter__ method to iterate through its app_profiles field.

If there are more pages, the __iter__ method will make additional ListAppProfiles requests and continue to iterate through the app_profiles field on the corresponding responses.

All the usual ListAppProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_hot_tablets requests.

This class thinly wraps an initial ListHotTabletsResponse object, and provides an __aiter__ method to iterate through its hot_tablets field.

If there are more pages, the __aiter__ method will make additional ListHotTablets requests and continue to iterate through the hot_tablets field on the corresponding responses.

All the usual ListHotTabletsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_hot_tablets requests.

This class thinly wraps an initial ListHotTabletsResponse object, and provides an __iter__ method to iterate through its hot_tablets field.

If there are more pages, the __iter__ method will make additional ListHotTablets requests and continue to iterate through the hot_tablets field on the corresponding responses.

All the usual ListHotTabletsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_logical_views requests.

This class thinly wraps an initial ListLogicalViewsResponse object, and provides an __aiter__ method to iterate through its logical_views field.

If there are more pages, the __aiter__ method will make additional ListLogicalViews requests and continue to iterate through the logical_views field on the corresponding responses.

All the usual ListLogicalViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_logical_views requests.

This class thinly wraps an initial ListLogicalViewsResponse object, and provides an __iter__ method to iterate through its logical_views field.

If there are more pages, the __iter__ method will make additional ListLogicalViews requests and continue to iterate through the logical_views field on the corresponding responses.

All the usual ListLogicalViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_materialized_views requests.

This class thinly wraps an initial ListMaterializedViewsResponse object, and provides an __aiter__ method to iterate through its materialized_views field.

If there are more pages, the __aiter__ method will make additional ListMaterializedViews requests and continue to iterate through the materialized_views field on the corresponding responses.

All the usual ListMaterializedViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_materialized_views requests.

This class thinly wraps an initial ListMaterializedViewsResponse object, and provides an __iter__ method to iterate through its materialized_views field.

If there are more pages, the __iter__ method will make additional ListMaterializedViews requests and continue to iterate through the materialized_views field on the corresponding responses.

All the usual ListMaterializedViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_authorized_views requests.

This class thinly wraps an initial ListAuthorizedViewsResponse object, and provides an __aiter__ method to iterate through its authorized_views field.

If there are more pages, the __aiter__ method will make additional ListAuthorizedViews requests and continue to iterate through the authorized_views field on the corresponding responses.

All the usual ListAuthorizedViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_authorized_views requests.

This class thinly wraps an initial ListAuthorizedViewsResponse object, and provides an __iter__ method to iterate through its authorized_views field.

If there are more pages, the __iter__ method will make additional ListAuthorizedViews requests and continue to iterate through the authorized_views field on the corresponding responses.

All the usual ListAuthorizedViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __aiter__ method to iterate through its backups field.

If there are more pages, the __aiter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __iter__ method to iterate through its backups field.

If there are more pages, the __iter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_schema_bundles requests.

This class thinly wraps an initial ListSchemaBundlesResponse object, and provides an __aiter__ method to iterate through its schema_bundles field.

If there are more pages, the __aiter__ method will make additional ListSchemaBundles requests and continue to iterate through the schema_bundles field on the corresponding responses.

All the usual ListSchemaBundlesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_schema_bundles requests.

This class thinly wraps an initial ListSchemaBundlesResponse object, and provides an __iter__ method to iterate through its schema_bundles field.

If there are more pages, the __iter__ method will make additional ListSchemaBundles requests and continue to iterate through the schema_bundles field on the corresponding responses.

All the usual ListSchemaBundlesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_snapshots requests.

This class thinly wraps an initial ListSnapshotsResponse object, and provides an __aiter__ method to iterate through its snapshots field.

If there are more pages, the __aiter__ method will make additional ListSnapshots requests and continue to iterate through the snapshots field on the corresponding responses.

All the usual ListSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_snapshots requests.

This class thinly wraps an initial ListSnapshotsResponse object, and provides an __iter__ method to iterate through its snapshots field.

If there are more pages, the __iter__ method will make additional ListSnapshots requests and continue to iterate through the snapshots field on the corresponding responses.

All the usual ListSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tables requests.

This class thinly wraps an initial ListTablesResponse object, and provides an __aiter__ method to iterate through its tables field.

If there are more pages, the __aiter__ method will make additional ListTables requests and continue to iterate through the tables field on the corresponding responses.

All the usual ListTablesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tables requests.

This class thinly wraps an initial ListTablesResponse object, and provides an __iter__ method to iterate through its tables field.

If there are more pages, the __iter__ method will make additional ListTables requests and continue to iterate through the tables field on the corresponding responses.

All the usual ListTablesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Data Boost is a serverless compute capability that lets you run high-throughput read jobs and queries on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Data Boost supports read-only use cases with single-cluster routing.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields