Package Classes (2.32.0)

Summary of entries of Classes for bigtable.

Classes

AppProfile

Representation of a Google Cloud Bigtable AppProfile.

We can use a AppProfile to:

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

Backup

Representation of a Google Cloud Bigtable Backup.

A :class: Backup can be used to:

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

MutationsBatchError

Error in the batch request

MutationsBatcher

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

Client for interacting with Google Cloud Bigtable API.

Cluster

Representation of a Google Cloud Bigtable Cluster.

We can use a Cluster to:

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

ColumnFamily

Representation of a Google Cloud Bigtable Column Family.

We can use a ColumnFamily to:

  • create itself
  • update itself
  • delete itself

GCRuleIntersection

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

GCRuleUnion

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

GarbageCollectionRule

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.

A string gc_expression can also be used with API requests, but that value would be superceded by a gc_rule. As a result, we don't support that feature and instead support via native classes.

MaxAgeGCRule

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

MaxVersionsGCRule

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

BigtableDataClient

Create a client instance for the Bigtable Data API

BigtableDataClientAsync

Create a client instance for the Bigtable Data API

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

Table

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

AuthorizedViewAsync

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

TableAsync

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

MutationsBatcherAsync

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

AuthorizedView

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

MutationsBatcher

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

EarlyMetadataCallError

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

FailedMutationEntryError

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

FailedQueryShardError

Represents an individual failed query in a sharded read rows operation

InvalidChunk

Exception raised to invalid chunk data from back-end.

InvalidExecuteQueryResponse

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

MutationsExceptionGroup

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

ParameterTypeInferenceFailed

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

RetryExceptionGroup

Represents one or more exceptions that occur during a retryable operation

ShardedReadRowsExceptionGroup

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

ExecuteQueryIterator

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.

ExecuteQueryIteratorAsync

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

Metadata class for the ExecuteQuery operation.

SqlType

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

Used in .Metadata.

Array

Array SQL type.

Bool

Bool SQL type.

Bytes

Bytes SQL type.

Date

Date SQL type.

Float32

Float32 SQL type.

Float64

Float64 SQL type.

Int64

Int64 SQL type.

Map

Map SQL type.

String

String SQL type.

Struct

Struct SQL type.

Timestamp

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.

QueryResultRow

Represents a single row of the result

Struct

Represents a struct value in the result

AddToCell

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.

DeleteAllFromFamily

Mutation to delete all cells from a column family.

DeleteAllFromRow

Mutation to delete all cells from a row.

DeleteRangeFromColumn

Mutation to delete a range of cells from a column.

Mutation

Abstract base class for mutations.

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

RowMutationEntry

A single entry in a MutateRows request.

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

SetCell

Mutation to set the value of a cell.

AppendValueRule

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

IncrementRule

Rule to increment a cell's value.

ReadModifyWriteRule

Abstract base class for read-modify-write rules.

ReadRowsQuery

Class to encapsulate details of a read row request

RowRange

Represents a range of keys in a ReadRowsQuery

Cell

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

Row

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"]

ApplyLabelFilter

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.

BlockAllFilter

Row filter that doesn't match any cells.

CellsColumnLimitFilter

Row filter to limit cells in a column.

CellsRowLimitFilter

Row filter to limit cells in a row.

CellsRowOffsetFilter

Row filter to skip cells in a row.

ColumnQualifierRegexFilter

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

ColumnRangeFilter

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.

ConditionalRowFilter

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.

FamilyNameRegexFilter

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

LiteralValueFilter

Row filter for an exact value.

PassAllFilter

Row filter equivalent to not filtering at all.

RowFilter

Basic filter to apply to cells in a row.

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

RowFilterChain

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.

RowFilterUnion

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.

RowKeyRegexFilter

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

RowSampleFilter

Matches all cells from a row with probability p.

SinkFilter

Advanced row filter to skip parent filters.

StripValueTransformerFilter

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

TimestampRange

Range of time with inclusive lower and exclusive upper bounds.

TimestampRangeFilter

Row filter that limits cells to a range of time.

ValueRangeFilter

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.

ValueRegexFilter

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

EncryptionInfo

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.

Instance

Representation of a Google Cloud Bigtable Instance.

We can use an Instance to:

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

AppendRow

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).

Cell

Representation of a Google Cloud Bigtable Cell.

ConditionalRow

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)

DirectRow

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')

InvalidChunk

Exception raised to invalid chunk data from back-end.

PartialRowData

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

Row

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

InvalidReadRowsResponse

Exception raised to invalid response data from back-end.

InvalidRetryRequest

Exception raised when retry request is invalid.

PartialCellData

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

PartialRowsData

Convenience wrapper for consuming a ReadRows streaming response.

ApplyLabelFilter

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.

BlockAllFilter

Row filter that doesn't match any cells.

CellsColumnLimitFilter

Row filter to limit cells in a column.

CellsRowLimitFilter

Row filter to limit cells in a row.

CellsRowOffsetFilter

Row filter to skip cells in a row.

ColumnQualifierRegexFilter

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

ColumnRangeFilter

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.

ConditionalRowFilter

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.

ExactValueFilter

Row filter for an exact value.

FamilyNameRegexFilter

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

PassAllFilter

Row filter equivalent to not filtering at all.

RowFilter

Basic filter to apply to cells in a row.

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

RowFilterChain

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.

RowFilterUnion

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.

RowKeyRegexFilter

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

RowSampleFilter

Matches all cells from a row with probability p.

SinkFilter

Advanced row filter to skip parent filters.

StripValueTransformerFilter

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

TimestampRange

Range of time with inclusive lower and exclusive upper bounds.

TimestampRangeFilter

Row filter that limits cells to a range of time.

ValueRangeFilter

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.

ValueRegexFilter

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

RowRange

Convenience wrapper of google.bigtable.v2.RowRange

RowSet

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.

ClusterState

Representation of a Cluster State.

Table

Representation of a Google Cloud Bigtable Table.

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

TableMismatchError

Row from another table.

TooManyMutationsError

The number of mutations for bulk request is too big.

BigtableTableAdminAsyncClient

Instantiates the Bigtable table admin async client.

BigtableTableAdminClient

Instantiates the Bigtable table admin client.

AsyncRestoreTableOperation

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.

RestoreTableOperation

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.

WaitForConsistencyRequest

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

BigtableInstanceAdminAsyncClient

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.

BigtableInstanceAdminClient

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.

ListAppProfilesAsyncPager

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.

ListAppProfilesPager

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.

ListHotTabletsAsyncPager

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.

ListHotTabletsPager

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.

ListLogicalViewsAsyncPager

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.

ListLogicalViewsPager

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.

ListMaterializedViewsAsyncPager

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.

ListMaterializedViewsPager

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.

ListAuthorizedViewsAsyncPager

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.

ListAuthorizedViewsPager

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.

ListBackupsAsyncPager

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.

ListBackupsPager

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.

ListSchemaBundlesAsyncPager

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.

ListSchemaBundlesPager

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.

ListSnapshotsAsyncPager

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.

ListSnapshotsPager

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.

ListTablesAsyncPager

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.

ListTablesPager

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.

AppProfile

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

DataBoostIsolationReadOnly

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

ComputeBillingOwner

Compute Billing Owner specifies how usage should be accounted when using Data Boost. Compute Billing Owner also configures which Cloud Project is charged for relevant quota.

MultiClusterRoutingUseAny

Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.

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

RowAffinity

If enabled, Bigtable will route the request based on the row key of the request, rather than randomly. Instead, each row key will be assigned to a cluster, and will stick to that cluster. If clusters are added or removed, then this may affect which row keys stick to which clusters. To avoid this, users can use a cluster group to specify which clusters are to be used. In this case, new clusters that are not a part of the cluster group will not be routed to, and routing will be unaffected by the new cluster. Moreover, clusters specified in the cluster group cannot be deleted unless removed from the cluster group.

Priority

Possible priorities for an app profile. Note that higher priority writes can sometimes queue behind lower priority writes to the same tablet, as writes must be strictly sequenced in the durability log.

SingleClusterRouting

Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.

StandardIsolation

Standard options for isolating this app profile's traffic from other use cases.

AuthorizedView

AuthorizedViews represent subsets of a particular Cloud Bigtable table. Users can configure access to each Authorized View independently from the table and use the existing Data APIs to access the subset of data.

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

FamilySubsets

Subsets of a column family that are included in this AuthorizedView.

ResponseView

Defines a subset of an AuthorizedView's fields.

SubsetView

Defines a simple AuthorizedView that is a subset of the underlying Table.

FamilySubsetsEntry

The abstract base class for a message.

AutoscalingLimits

Limits for the number of nodes a Cluster can autoscale up/down to.

AutoscalingTargets

The Autoscaling targets for a Cluster. These determine the recommended nodes.

Backup

A backup of a Cloud Bigtable table.

BackupType

The type of the backup.

State

Indicates the current state of the backup.

BackupInfo

Information about a backup.

ChangeStreamConfig

Change stream configuration.

CheckConsistencyRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]

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

CheckConsistencyResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]

Cluster

A resizable group of nodes in a particular cloud ___location, capable of serving all Tables][google.bigtable.admin.v2.Table] in the parent Instance][google.bigtable.admin.v2.Instance].

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

ClusterAutoscalingConfig

Autoscaling config for a cluster.

ClusterConfig

Configuration for a cluster.

EncryptionConfig

Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.

NodeScalingFactor

Possible node scaling factors of the clusters. Node scaling delivers better latency and more throughput by removing node boundaries.

State

Possible states of a cluster.

ColumnFamily

A set of columns within a table which share a common configuration.

CopyBackupMetadata

Metadata type for the google.longrunning.Operation returned by CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].

CopyBackupRequest

The request for CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].

CreateAppProfileRequest

Request message for BigtableInstanceAdmin.CreateAppProfile.

CreateAuthorizedViewMetadata

The metadata for the Operation returned by CreateAuthorizedView.

CreateAuthorizedViewRequest

The request for CreateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.CreateAuthorizedView]

CreateBackupMetadata

Metadata type for the operation returned by CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].

CreateBackupRequest

The request for CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].

CreateClusterMetadata

The metadata for the Operation returned by CreateCluster.

TableProgress

Progress info for copying a table's data to the new cluster.

State

TablesEntry

The abstract base class for a message.

CreateClusterRequest

Request message for BigtableInstanceAdmin.CreateCluster.

CreateInstanceMetadata

The metadata for the Operation returned by CreateInstance.

CreateInstanceRequest

Request message for BigtableInstanceAdmin.CreateInstance.

ClustersEntry

The abstract base class for a message.

CreateLogicalViewMetadata

The metadata for the Operation returned by CreateLogicalView.

CreateLogicalViewRequest

Request message for BigtableInstanceAdmin.CreateLogicalView.

CreateMaterializedViewMetadata

The metadata for the Operation returned by CreateMaterializedView.

CreateMaterializedViewRequest

Request message for BigtableInstanceAdmin.CreateMaterializedView.

CreateSchemaBundleMetadata

The metadata for the Operation returned by CreateSchemaBundle][google.bigtable.admin.v2.BigtableTableAdmin.CreateSchemaBundle].

CreateSchemaBundleRequest

The request for CreateSchemaBundle][google.bigtable.admin.v2.BigtableTableAdmin.CreateSchemaBundle].

CreateTableFromSnapshotMetadata

The metadata for the Operation returned by CreateTableFromSnapshot. Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

CreateTableFromSnapshotRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

CreateTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable][google.bigtable.admin.v2.BigtableTableAdmin.CreateTable]

Split

An initial split point for a newly created table.

DataBoostReadLocalWrites

Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.

DeleteAppProfileRequest

Request message for BigtableInstanceAdmin.DeleteAppProfile.

DeleteAuthorizedViewRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView]

DeleteBackupRequest

The request for DeleteBackup][google.bigtable.admin.v2.BigtableTableAdmin.DeleteBackup].

DeleteClusterRequest

Request message for BigtableInstanceAdmin.DeleteCluster.

DeleteInstanceRequest

Request message for BigtableInstanceAdmin.DeleteInstance.

DeleteLogicalViewRequest

Request message for BigtableInstanceAdmin.DeleteLogicalView.

DeleteMaterializedViewRequest

Request message for BigtableInstanceAdmin.DeleteMaterializedView.

DeleteSchemaBundleRequest

The request for DeleteSchemaBundle][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSchemaBundle].

DeleteSnapshotRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

DeleteTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable]

DropRowRangeRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange][google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange]

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

EncryptionInfo

Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.

EncryptionType

Possible encryption types for a resource.

GcRule

Rule for determining which cells to delete during garbage collection.

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

Intersection

A GcRule which deletes cells matching all of the given rules.

Union

A GcRule which deletes cells matching any of the given rules.

GenerateConsistencyTokenRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]

GenerateConsistencyTokenResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]

GetAppProfileRequest

Request message for BigtableInstanceAdmin.GetAppProfile.

GetAuthorizedViewRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView]

GetBackupRequest

The request for GetBackup][google.bigtable.admin.v2.BigtableTableAdmin.GetBackup].

GetClusterRequest

Request message for BigtableInstanceAdmin.GetCluster.

GetInstanceRequest

Request message for BigtableInstanceAdmin.GetInstance.

GetLogicalViewRequest

Request message for BigtableInstanceAdmin.GetLogicalView.

GetMaterializedViewRequest

Request message for BigtableInstanceAdmin.GetMaterializedView.

GetSchemaBundleRequest

The request for GetSchemaBundle][google.bigtable.admin.v2.BigtableTableAdmin.GetSchemaBundle].

GetSnapshotRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

GetTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.GetTable][google.bigtable.admin.v2.BigtableTableAdmin.GetTable]

HotTablet

A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.

Instance

A collection of Bigtable Tables][google.bigtable.admin.v2.Table] and the resources that serve them. All tables in an instance are served from all Clusters][google.bigtable.admin.v2.Cluster] in the instance.

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

LabelsEntry

The abstract base class for a message.

State

Possible states of an instance.

Type

The type of the instance.

ListAppProfilesRequest

Request message for BigtableInstanceAdmin.ListAppProfiles.

ListAppProfilesResponse

Response message for BigtableInstanceAdmin.ListAppProfiles.

ListAuthorizedViewsRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews][google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews]

ListAuthorizedViewsResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews][google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews]

ListBackupsRequest

The request for ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].

ListBackupsResponse

The response for ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].

ListClustersRequest

Request message for BigtableInstanceAdmin.ListClusters.

ListClustersResponse

Response message for BigtableInstanceAdmin.ListClusters.

ListHotTabletsRequest

Request message for BigtableInstanceAdmin.ListHotTablets.

ListHotTabletsResponse

Response message for BigtableInstanceAdmin.ListHotTablets.

ListInstancesRequest

Request message for BigtableInstanceAdmin.ListInstances.

ListInstancesResponse

Response message for BigtableInstanceAdmin.ListInstances.

ListLogicalViewsRequest

Request message for BigtableInstanceAdmin.ListLogicalViews.

ListLogicalViewsResponse

Response message for BigtableInstanceAdmin.ListLogicalViews.

ListMaterializedViewsRequest

Request message for BigtableInstanceAdmin.ListMaterializedViews.

ListMaterializedViewsResponse

Response message for BigtableInstanceAdmin.ListMaterializedViews.

ListSchemaBundlesRequest

The request for ListSchemaBundles][google.bigtable.admin.v2.BigtableTableAdmin.ListSchemaBundles].

ListSchemaBundlesResponse

The response for ListSchemaBundles][google.bigtable.admin.v2.BigtableTableAdmin.ListSchemaBundles].

ListSnapshotsRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

ListSnapshotsResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

ListTablesRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]

ListTablesResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]

LogicalView

A SQL logical view object that can be referenced in SQL queries.

MaterializedView

A materialized view object that can be referenced in SQL queries.

ModifyColumnFamiliesRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies][google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies]

Modification

A create, update, or delete of a particular column family.

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

OperationProgress

Encapsulates progress related information for a Cloud Bigtable long running operation.

OptimizeRestoredTableMetadata

Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored table. This long-running operation is automatically created by the system after the successful completion of a table restore, and cannot be cancelled.

PartialUpdateClusterMetadata

The metadata for the Operation returned by PartialUpdateCluster.

PartialUpdateClusterRequest

Request message for BigtableInstanceAdmin.PartialUpdateCluster.

PartialUpdateInstanceRequest

Request message for BigtableInstanceAdmin.PartialUpdateInstance.

ProtoSchema

Represents a protobuf schema.

RestoreInfo

Information about a table restore.

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

RestoreSourceType

Indicates the type of the restore source.

RestoreTableMetadata

Metadata type for the long-running operation returned by RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].

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

RestoreTableRequest

The request for RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].

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

SchemaBundle

A named collection of related schemas.

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

Snapshot

A snapshot of a table at a particular time. A snapshot can be used as a checkpoint for data restoration or a data source for a new table.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

State

Possible states of a snapshot.

SnapshotTableMetadata

The metadata for the Operation returned by SnapshotTable.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

SnapshotTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

StandardReadRemoteWrites

Checks that all writes before the consistency token was generated are replicated in every cluster and readable.

StorageType

Storage media types for persisting Bigtable data.

Table

A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.

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

AutomatedBackupPolicy

Defines an automated backup policy for a table

ClusterState

The state of a table's data in a particular cluster.

ReplicationState

Table replication states.

ClusterStatesEntry

The abstract base class for a message.

ColumnFamiliesEntry

The abstract base class for a message.

TimestampGranularity

Possible timestamp granularities to use when keeping multiple versions of data in a table.

View

Defines a view over a table's fields.

Type

Type represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features.

For compatibility with Bigtable's existing untyped APIs, each Type includes an Encoding which describes how to convert to or from the underlying data.

Each encoding can operate in one of two modes:

  • Sorted: In this mode, Bigtable guarantees that Encode(X) <= Encode(Y) if and only if X <= Y. This is useful anywhere sort order is important, for example when encoding keys.
  • Distinct: In this mode, Bigtable guarantees that if X != Y then Encode(X) != Encode(Y). However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value.

The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001").

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

Aggregate

A value that combines incremental updates into a summarized value.

Data is never directly written or read using type Aggregate. Writes will provide either the input_type or state_type, and reads will always return the state_type .

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

HyperLogLogPlusPlusUniqueCount

Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: Int64 (the unique count estimate)

Max

Computes the max of the input values. Allowed input: Int64 State: same as input

Min

Computes the min of the input values. Allowed input: Int64 State: same as input

Sum

Computes the sum of the input values. Allowed input: Int64 State: same as input

Array

An ordered list of elements of a given type. Values of type Array are stored in Value.array_value.

Bool

bool Values of type Bool are stored in Value.bool_value.

Bytes

Bytes Values of type Bytes are stored in Value.bytes_value.

Encoding

Rules used to convert to or from lower level types.

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

Raw

Leaves the value as-is.

Sorted mode: all values are supported.

Distinct mode: all values are supported.

Date

Date Values of type Date are stored in Value.date_value.

Enum

A protobuf enum type. Values of type Enum are stored in Value.int_value.

Float32

Float32 Values of type Float32 are stored in Value.float_value.

Float64

Float64 Values of type Float64 are stored in Value.float_value.

Int64

Int64 Values of type Int64 are stored in Value.int_value.

Encoding

Rules used to convert to or from lower level types.

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

BigEndianBytes

Encodes the value as an 8-byte big-endian two's complement value.

Sorted mode: non-negative values are supported.

Distinct mode: all values are supported.

Compatible with:

  • BigQuery BINARY encoding
  • HBase Bytes.toBytes
  • Java ByteBuffer.putLong() with ByteOrder.BIG_ENDIAN

OrderedCodeBytes

Encodes the value in a variable length binary format of up to 10 bytes. Values that are closer to zero use fewer bytes.

Sorted mode: all values are supported.

Distinct mode: all values are supported.

Map

A mapping of keys to values of a given type. Values of type Map are stored in a Value.array_value where each entry is another Value.array_value with two elements (the key and the value, in that order). Normally encoded Map values won't have repeated keys, however, clients are expected to handle the case in which they do. If the same key appears multiple times, the last value takes precedence.

Proto

A protobuf message type. Values of type Proto are stored in Value.bytes_value.

String

String Values of type String are stored in Value.string_value.

Encoding

Rules used to convert to or from lower level types.

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

Utf8Bytes

UTF-8 encoding.

Sorted mode:

  • All values are supported.
  • Code point order is preserved.

Distinct mode: all values are supported.

Compatible with:

  • BigQuery TEXT encoding
  • HBase Bytes.toBytes
  • Java String#getBytes(StandardCharsets.UTF_8)

Utf8Raw

Deprecated: prefer the equivalent Utf8Bytes.

Struct

A structured data value, consisting of fields which map to dynamically typed values. Values of type Struct are stored in Value.array_value where entries are in the same order and number as field_types.

Encoding

Rules used to convert to or from lower level types.

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

DelimitedBytes

Fields are encoded independently and concatenated with a configurable delimiter in between.

A struct with no fields defined is encoded as a single delimiter.

Sorted mode:

  • Fields are encoded in sorted mode.
  • Encoded field values must not contain any bytes <= delimiter[0]
  • Element-wise order is preserved: A < B if A[0] < B[0], or if A[0] == B[0] && A[1] < B[1], etc. Strict prefixes sort first.

Distinct mode:

  • Fields are encoded in distinct mode.
  • Encoded field values must not contain delimiter[0].

OrderedCodeBytes

Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between.

Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}.

Fields that encode to the empty string "" have special handling:

  • If every field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}.
  • Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}.

Examples:

  • STRUCT() -> "\00\00"
  • STRUCT("") -> "\00\00"
  • STRUCT("", "") -> "\00\00"
  • STRUCT("", "B") -> "\00\00" + "\00\01" + "B"
  • STRUCT("A", "") -> "A"
  • STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B"
  • STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C"

Since null bytes are always escaped, this encoding can cause size blowup for encodings like Int64.BigEndianBytes that are likely to produce many such bytes.

Sorted mode:

  • Fields are encoded in sorted mode.
  • All values supported by the field encodings are allowed
  • Element-wise order is preserved: A < B if A[0] < B[0], or if A[0] == B[0] && A[1] < B[1], etc. Strict prefixes sort first.

Distinct mode:

  • Fields are encoded in distinct mode.
  • All values supported by the field encodings are allowed.

Singleton

Uses the encoding of fields[0].type as-is. Only valid if fields.size == 1.

Field

A struct field and its type.

Timestamp

Timestamp Values of type Timestamp are stored in Value.timestamp_value.

Encoding

Rules used to convert to or from lower level types.

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

UndeleteTableMetadata

Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable].

UndeleteTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable]

UpdateAppProfileMetadata

The metadata for the Operation returned by UpdateAppProfile.

UpdateAppProfileRequest

Request message for BigtableInstanceAdmin.UpdateAppProfile.

UpdateAuthorizedViewMetadata

Metadata for the google.longrunning.Operation returned by UpdateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].

UpdateAuthorizedViewRequest

The request for UpdateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].

UpdateBackupRequest

The request for UpdateBackup][google.bigtable.admin.v2.BigtableTableAdmin.UpdateBackup].

UpdateClusterMetadata

The metadata for the Operation returned by UpdateCluster.

UpdateInstanceMetadata

The metadata for the Operation returned by UpdateInstance.

UpdateLogicalViewMetadata

The metadata for the Operation returned by UpdateLogicalView.

UpdateLogicalViewRequest

Request message for BigtableInstanceAdmin.UpdateLogicalView.

UpdateMaterializedViewMetadata

The metadata for the Operation returned by UpdateMaterializedView.

UpdateMaterializedViewRequest

Request message for BigtableInstanceAdmin.UpdateMaterializedView.

UpdateSchemaBundleMetadata

The metadata for the Operation returned by UpdateSchemaBundle][google.bigtable.admin.v2.BigtableTableAdmin.UpdateSchemaBundle].

UpdateSchemaBundleRequest

The request for UpdateSchemaBundle][google.bigtable.admin.v2.BigtableTableAdmin.UpdateSchemaBundle].

UpdateTableMetadata

Metadata type for the operation returned by UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].

UpdateTableRequest

The request for UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].

Modules

app_profile

User-friendly container for Google Cloud Bigtable AppProfile.

backup

A user-friendly wrapper for a Google Cloud Bigtable Backup.

batcher

User friendly container for Google Cloud Bigtable MutationBatcher.

client

Parent client for calling the Google Cloud Bigtable API.

This is the base from which all interactions with the API occur.

In the hierarchy of API concepts

cluster

User friendly container for Google Cloud Bigtable Cluster.

column_family

User friendly container for Google Cloud Bigtable Column Family.

_async.mutations_batcher

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

_sync_autogen.mutations_batcher

API documentation for bigtable.data._sync_autogen.mutations_batcher module.

exceptions

API documentation for bigtable.data.exceptions module.

metadata

This module provides the SqlType class used for specifying types in ExecuteQuery and some utilities.

The SqlTypes are used in Metadata returned by the ExecuteQuery operation as well as for specifying query parameter types explicitly.

values

API documentation for bigtable.data.execute_query.values module.

mutations

API documentation for bigtable.data.mutations module.

read_modify_write_rules

API documentation for bigtable.data.read_modify_write_rules module.

read_rows_query

API documentation for bigtable.data.read_rows_query module.

data.row

API documentation for bigtable.data.row module.

data.row_filters

Filters for Google Cloud Bigtable Row classes.

encryption_info

Class for encryption info for tables and backups.

instance

User-friendly container for Google Cloud Bigtable Instance.

row

User-friendly container for Google Cloud Bigtable Row.

row_data

Container for Google Cloud Bigtable Cells and Streaming Row Contents.

row_filters

Filters for Google Cloud Bigtable Row classes.

row_set

User-friendly container for Google Cloud Bigtable RowSet

table

User-friendly container for Google Cloud Bigtable Table.

pagers

API documentation for bigtable_admin_v2.services.bigtable_instance_admin.pagers module.

pagers

API documentation for bigtable_admin_v2.services.bigtable_table_admin.pagers module.