Package google.bigtable.v2

Index

Bigtable

Service for reading from and writing to existing Bigtable tables.

CheckAndMutateRow

rpc CheckAndMutateRow(CheckAndMutateRowRequest) returns (CheckAndMutateRowResponse)

Mutates a row atomically based on the output of a predicate Reader filter.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.data
  • https://www.googleapis.com/auth/cloud-bigtable.data
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

MutateRow

rpc MutateRow(MutateRowRequest) returns (MutateRowResponse)

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by mutation.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.data
  • https://www.googleapis.com/auth/cloud-bigtable.data
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

MutateRows

rpc MutateRows(MutateRowsRequest) returns (MutateRowsResponse)

Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.data
  • https://www.googleapis.com/auth/cloud-bigtable.data
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

ReadModifyWriteRow

rpc ReadModifyWriteRow(ReadModifyWriteRowRequest) returns (ReadModifyWriteRowResponse)

Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.data
  • https://www.googleapis.com/auth/cloud-bigtable.data
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

ReadRows

rpc ReadRows(ReadRowsRequest) returns (ReadRowsResponse)

Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each. Depending on their size, rows and cells may be broken up across multiple responses, but atomicity of each row will still be preserved. See the ReadRowsResponse documentation for details.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.data
  • https://www.googleapis.com/auth/bigtable.data.readonly
  • https://www.googleapis.com/auth/cloud-bigtable.data
  • https://www.googleapis.com/auth/cloud-bigtable.data.readonly
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Auth Guide.

SampleRowKeys

rpc SampleRowKeys(SampleRowKeysRequest) returns (SampleRowKeysResponse)

Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.data
  • https://www.googleapis.com/auth/bigtable.data.readonly
  • https://www.googleapis.com/auth/cloud-bigtable.data
  • https://www.googleapis.com/auth/cloud-bigtable.data.readonly
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Auth Guide.

Cell

Specifies (some of) the contents of a single row/column/timestamp of a table.

Fields
timestamp_micros

int64

The cell's stored timestamp, which also uniquely identifies it within its column. Values are always expressed in microseconds, but individual tables may set a coarser granularity to further restrict the allowed values. For example, a table which specifies millisecond granularity will only allow values of timestamp_micros which are multiples of 1000.

value

bytes

The value stored in the cell. May contain any byte string, including the empty string, up to 100MiB in length.

labels[]

string

Labels applied to the cell by a RowFilter.

CheckAndMutateRowRequest

Request message for Bigtable.CheckAndMutateRow.

Fields
table_name

string

The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

Authorization requires the following Google IAM permission on the specified resource table_name:

  • bigtable.tables.mutateRows

app_profile_id

string

This is a private alpha release of Cloud Bigtable replication. 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.

This value specifies routing for replication. If not specified, the "default" application profile will be used.

row_key

bytes

The key of the row to which the conditional mutation should be applied.

predicate_filter

RowFilter

The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.

true_mutations[]

Mutation

Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.

false_mutations[]

Mutation

Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.

CheckAndMutateRowResponse

Response message for Bigtable.CheckAndMutateRow.

Fields
predicate_matched

bool

Whether or not the request's predicate_filter yielded any results for the specified row.

Column

Specifies (some of) the contents of a single row/column intersection of a table.

Fields
qualifier

bytes

The unique key which identifies this column within its family. This is the same key that's used to identify the column in, for example, a RowFilter which sets its column_qualifier_regex_filter field. May contain any byte string, including the empty string, up to 16kiB in length.

cells[]

Cell

Must not be empty. Sorted in order of decreasing "timestamp_micros".

ColumnRange

Specifies a contiguous range of columns within a single column family. The range spans from <column_family>:<start_qualifier> to <column_family>:<end_qualifier>, where both bounds can be either inclusive or exclusive.

Fields
family_name

string

The name of the column family within which this range falls.

Union field start_qualifier. The column qualifier at which to start the range (within column_family). If neither field is set, interpreted as the empty string, inclusive. start_qualifier can be only one of the following:
start_qualifier_closed

bytes

Used when giving an inclusive lower bound for the range.

start_qualifier_open

bytes

Used when giving an exclusive lower bound for the range.

Union field end_qualifier. The column qualifier at which to end the range (within column_family). If neither field is set, interpreted as the infinite string, exclusive. end_qualifier can be only one of the following:
end_qualifier_closed

bytes

Used when giving an inclusive upper bound for the range.

end_qualifier_open

bytes

Used when giving an exclusive upper bound for the range.

Family

Specifies (some of) the contents of a single row/column family intersection of a table.

Fields
name

string

The unique key which identifies this family within its row. This is the same key that's used to identify the family in, for example, a RowFilter which sets its "family_name_regex_filter" field. Must match [-_.a-zA-Z0-9]+, except that AggregatingRowProcessors may produce cells in a sentinel family with an empty name. Must be no greater than 64 characters in length.

columns[]

Column

Must not be empty. Sorted in order of increasing "qualifier".

MutateRowRequest

Request message for Bigtable.MutateRow.

Fields
table_name