package google.bigtable.v2
Get desktop application:
View/edit binary Protocol Buffers messages
service Bigtable
bigtable.proto:32Service for reading from and writing to existing Bigtable tables.
rpc ReadRows (, stream )
bigtable.proto:38Streams 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.
message
bigtable.proto:99Request message for Bigtable.ReadRows.
string table_name = 1
The unique name of the table from which to read. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
string app_profile_id = 5
This value specifies routing for replication. If not specified, the "default" application profile will be used.
optional rows = 2
The row keys and/or ranges to read. If not specified, reads from all rows.
optional filter = 3
The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.
int64 rows_limit = 4
The read will terminate after committing to N rows' worth of results. The default (zero) is to return all results.
message
bigtable.proto:122Response message for Bigtable.ReadRows.
repeated chunks = 1
bytes last_scanned_row_key = 2
Optionally the server might return the row key of the last row it has scanned. The client can use this to construct a more efficient retry request if needed: any row keys or portions of ranges less than this row key can be dropped from the request. This is primarily useful for cases where the server has read a lot of data that was filtered out since the last committed row key, allowing the client to skip that work on a retry.
rpc SampleRowKeys (, stream )
bigtable.proto:49Returns 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.
message
bigtable.proto:199Request message for Bigtable.SampleRowKeys.
string table_name = 1
The unique name of the table from which to sample row keys. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
string app_profile_id = 2
This value specifies routing for replication. If not specified, the "default" application profile will be used.
message
bigtable.proto:211Response message for Bigtable.SampleRowKeys.
bytes row_key = 1
Sorted streamed sequence of sample row keys in the table. The table might have contents before the first row key in the list and after the last one, but a key containing the empty string indicates "end of table" and will be the last response given, if present. Note that row keys in this list may not have ever been written to or read from, and users should therefore not make any assumptions about the row key structure that are specific to their use case.
int64 offset_bytes = 2
Approximate total storage space used by all rows in the table which precede `row_key`. Buffering the contents of all rows between two subsequent samples would require space roughly equal to the difference in their `offset_bytes` fields.
rpc MutateRow (, )
bigtable.proto:58Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by `mutation`.
message
bigtable.proto:229Request message for Bigtable.MutateRow.
string table_name = 1
The unique name of the table to which the mutation should be applied. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
string app_profile_id = 4
This value specifies routing for replication. If not specified, the "default" application profile will be used.
bytes row_key = 2
The key of the row to which the mutation should be applied.
repeated mutations = 3
Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
message
bigtable.proto:249Response message for Bigtable.MutateRow.
(message has no fields)
rpc MutateRows (, stream )
bigtable.proto:68Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.
message
bigtable.proto:252Request message for BigtableService.MutateRows.
string table_name = 1
The unique name of the table to which the mutations should be applied.
string app_profile_id = 3
This value specifies routing for replication. If not specified, the "default" application profile will be used.
repeated entries = 2
The row keys and corresponding mutations to be applied in bulk. Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.
message
bigtable.proto:280Response message for BigtableService.MutateRows.
repeated entries = 1
One or more results for Entries from the batch request.
rpc CheckAndMutateRow (, )
bigtable.proto:76Mutates a row atomically based on the output of a predicate Reader filter.
message
bigtable.proto:298Request message for Bigtable.CheckAndMutateRow.
string table_name = 1
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>`.
string app_profile_id = 7
This value specifies routing for replication. If not specified, the "default" application profile will be used.
bytes row_key = 2
The key of the row to which the conditional mutation should be applied.
optional predicate_filter = 6
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.
repeated true_mutations = 4
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.
repeated false_mutations = 5
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.
message
bigtable.proto:334Response message for Bigtable.CheckAndMutateRow.
bool predicate_matched = 1
Whether or not the request's `predicate_filter` yielded any results for the specified row.
rpc ReadModifyWriteRow (, )
bigtable.proto:89Modifies 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.
message
bigtable.proto:341Request message for Bigtable.ReadModifyWriteRow.
string table_name = 1
The unique name of the table to which the read/modify/write rules should be applied. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
string app_profile_id = 4
This value specifies routing for replication. If not specified, the "default" application profile will be used.
bytes row_key = 2
The key of the row to which the read/modify/write rules should be applied.
repeated rules = 3
Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
message
bigtable.proto:362Response message for Bigtable.ReadModifyWriteRow.
optional row = 1
A Row containing the new contents of all cells modified by the request.
message
data.proto:69Specifies (some of) the contents of a single row/column/timestamp of a table.
Used in:
int64 timestamp_micros = 1
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.
bytes value = 2
The value stored in the cell. May contain any byte string, including the empty string, up to 100MiB in length.
repeated string labels = 3
Labels applied to the cell by a [RowFilter][google.bigtable.v2.RowFilter].
message
data.proto:56Specifies (some of) the contents of a single row/column intersection of a table.
Used in:
bytes qualifier = 1
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.
repeated cells = 2
Must not be empty. Sorted in order of decreasing "timestamp_micros".
message
data.proto:123Specifies 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.
Used in:
string family_name = 1
The name of the column family within which this range falls.
oneof 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.
bytes start_qualifier_closed = 2
Used when giving an inclusive lower bound for the range.
bytes start_qualifier_open = 3
Used when giving an exclusive lower bound for the range.
oneof 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.
bytes end_qualifier_closed = 4
Used when giving an inclusive upper bound for the range.
bytes end_qualifier_open = 5
Used when giving an exclusive upper bound for the range.
message
data.proto:41Specifies (some of) the contents of a single row/column family intersection of a table.
Used in:
string name = 1
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.
repeated columns = 2
Must not be empty. Sorted in order of increasing "qualifier".
message
bigtable.proto:253Used in:
bytes row_key = 1
The key of the row to which the `mutations` should be applied.
repeated mutations = 2
Changes to be atomically applied to the specified row. Mutations are applied in order, meaning that earlier mutations can be masked by later ones. You must specify at least one mutation.
message
bigtable.proto:281Used in:
int64 index = 1
The index into the original request's `entries` list of the Entry for which a result is being reported.
optional status = 2
The result of the request Entry identified by `index`. Depending on how requests are batched during execution, it is possible for one Entry to fail due to an error with another Entry. In the event that this occurs, the same error will be reported for both entries.
message
data.proto:443Specifies a particular change to be made to the contents of a row.
Used in: , ,
oneof mutation
Which of the possible Mutation types to apply.
set_cell = 1
Set a cell's value.
delete_from_column = 2
Deletes cells from a column.
delete_from_family = 3
Deletes cells from a column family.
delete_from_row = 4
Deletes cells from the entire row.
message
data.proto:467A Mutation which deletes cells from the specified column, optionally restricting the deletions to a given timestamp range.
Used in:
string family_name = 1
The name of the family from which cells should be deleted. Must match `[-_.a-zA-Z0-9]+`
bytes column_qualifier = 2
The qualifier of the column from which cells should be deleted. Can be any byte string, including the empty string.
optional time_range = 3
The range of timestamps within which cells should be deleted.
message
data.proto:481A Mutation which deletes all cells from the specified column family.
Used in:
string family_name = 1
The name of the family from which cells should be deleted. Must match `[-_.a-zA-Z0-9]+`
message
data.proto:488A Mutation which deletes all cells from the containing row.
Used in:
(message has no fields)
message
data.proto:445A Mutation which sets the value of the specified cell.
Used in:
string family_name = 1
The name of the family into which new data should be written. Must match `[-_.a-zA-Z0-9]+`
bytes column_qualifier = 2
The qualifier of the column into which new data should be written. Can be any byte string, including the empty string.
int64 timestamp_micros = 3
The timestamp of the cell into which new data should be written. Use -1 for current Bigtable server time. Otherwise, the client should set this value itself, noting that the default value is a timestamp of zero if the field is left unspecified. Values must match the granularity of the table (e.g. micros, millis).
bytes value = 4
The value to be written into the specified cell.
message
data.proto:508Specifies an atomic read/modify/write operation on the latest value of the specified column.
Used in:
string family_name = 1
The name of the family to which the read/modify/write should be applied. Must match `[-_.a-zA-Z0-9]+`
bytes column_qualifier = 2
The qualifier of the column to which the read/modify/write should be applied. Can be any byte string, including the empty string.
oneof rule
The rule used to determine the column's new latest value from its current latest value.
bytes append_value = 3
Rule specifying that `append_value` be appended to the existing value. If the targeted cell is unset, it will be treated as containing the empty string.
int64 increment_amount = 4
Rule specifying that `increment_amount` be added to the existing value. If the targeted cell is unset, it will be treated as containing a zero. Otherwise, the targeted cell must contain an 8-byte value (interpreted as a 64-bit big-endian signed integer), or the entire request will fail.
message
bigtable.proto:125Specifies a piece of a row's contents returned as part of the read response stream.
Used in:
bytes row_key = 1
The row key for this chunk of data. If the row key is empty, this CellChunk is a continuation of the same row as the previous CellChunk in the response stream, even if that CellChunk was in a previous ReadRowsResponse message.
optional family_name = 2
The column family name for this chunk of data. If this message is not present this CellChunk is a continuation of the same column family as the previous CellChunk. The empty string can occur as a column family name in a response so clients must check explicitly for the presence of this message, not just for `family_name.value` being non-empty.
optional qualifier = 3
The column qualifier for this chunk of data. If this message is not present, this CellChunk is a continuation of the same column as the previous CellChunk. Column qualifiers may be empty so clients must check for the presence of this message, not just for `qualifier.value` being non-empty.
int64 timestamp_micros = 4
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. Timestamps are only set in the first CellChunk per cell (for cells split into multiple chunks).
repeated string labels = 5
Labels applied to the cell by a [RowFilter][google.bigtable.v2.RowFilter]. Labels are only set on the first CellChunk per cell.
bytes value = 6
The value stored in the cell. Cell values can be split across multiple CellChunks. In that case only the value field will be set in CellChunks after the first: the timestamp and labels will only be present in the first CellChunk, even if the first CellChunk came in a previous ReadRowsResponse.
int32 value_size = 7
If this CellChunk is part of a chunked cell value and this is not the final chunk of that cell, value_size will be set to the total length of the cell value. The client can use this size to pre-allocate memory to hold the full cell value.
oneof row_status
bool reset_row = 8
Indicates that the client should drop all previous chunks for `row_key`, as it will be re-read from the beginning.
bool commit_row = 9
Indicates that the client can safely process all previous chunks for `row_key`, as its data has been fully read.
message
data.proto:28Specifies the complete (requested) contents of a single row of a table. Rows which exceed 256MiB in size cannot be read in full.
Used in:
bytes key = 1
The unique key which identifies this row within its table. This is the same key that's used to identify the row in, for example, a MutateRowRequest. May contain any non-empty byte string up to 4KiB in length.
repeated families = 2
May be empty, but only if the entire row is empty. The mutual ordering of column families is not specified.
message
data.proto:213Takes a row as input and produces an alternate view of the row based on specified rules. For example, a RowFilter might trim down a row to include just the cells from columns matching a given regular expression, or might return all the cells of a row but not their values. More complicated filters can be composed out of these components to express requests such as, "within every column of a particular family, give just the two most recent cells which are older than timestamp X." There are two broad categories of RowFilters (true filters and transformers), as well as two ways to compose simple filters into more complex ones (chains and interleaves). They work as follows: * True filters alter the input row by excluding some of its cells wholesale from the output row. An example of a true filter is the `value_regex_filter`, which excludes cells whose values don't match the specified pattern. All regex true filters use RE2 syntax (https://github.com/google/re2/wiki/Syntax) in raw byte mode (RE2::Latin1), and are evaluated as full matches. An important point to keep in mind is that `RE2(.)` is equivalent by default to `RE2([^\n])`, meaning that it does not match newlines. When attempting to match an arbitrary byte, you should therefore use the escape sequence `\C`, which may need to be further escaped as `\\C` in your client language. * Transformers alter the input row by changing the values of some of its cells in the output, without excluding them completely. Currently, the only supported transformer is the `strip_value_transformer`, which replaces every cell's value with the empty string. * Chains and interleaves are described in more detail in the RowFilter.Chain and RowFilter.Interleave documentation. The total serialized size of a RowFilter message must not exceed 4096 bytes, and RowFilters may not be nested within each other (in Chains or Interleaves) to a depth of more than 20.
Used in: , , , ,
oneof filter
Which of the possible RowFilter types to apply. If none are set, this RowFilter returns all cells in the input row.
chain = 1
Applies several RowFilters to the data in sequence, progressively narrowing the results.
interleave = 2
Applies several RowFilters to the data in parallel and combines the results.
condition = 3
Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
bool sink = 16
ADVANCED USE ONLY. Hook for introspection into the RowFilter. Outputs all cells directly to the output of the read rather than to any parent filter. Consider the following example: Chain( FamilyRegex("A"), Interleave( All(), Chain(Label("foo"), Sink()) ), QualifierRegex("B") ) A,A,1,w A,B,2,x B,B,4,z | FamilyRegex("A") | A,A,1,w A,B,2,x | +------------+-------------+ | | All() Label(foo) | | A,A,1,w A,A,1,w,labels:[foo] A,B,2,x A,B,2,x,labels:[foo] | | | Sink() --------------+ | | | +------------+ x------+ A,A,1,w,labels:[foo] | A,B,2,x,labels:[foo] A,A,1,w | A,B,2,x | | | QualifierRegex("B") | | | A,B,2,x | | | +--------------------------------+ | A,A,1,w,labels:[foo] A,B,2,x,labels:[foo] // could be switched A,B,2,x // could be switched Despite being excluded by the qualifier filter, a copy of every cell that reaches the sink is present in the final result. As with an [Interleave][google.bigtable.v2.RowFilter.Interleave], duplicate cells are possible, and appear in an unspecified mutual order. In this case we have a duplicate with column "A:B" and timestamp 2, because one copy passed through the all filter while the other was passed through the label and sink. Note that one copy has label "foo", while the other does not. Cannot be used within the `predicate_filter`, `true_filter`, or `false_filter` of a [Condition][google.bigtable.v2.RowFilter.Condition].
bool pass_all_filter = 17
Matches all cells, regardless of input. Functionally equivalent to leaving `filter` unset, but included for completeness.
bool block_all_filter = 18
Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
bytes row_key_regex_filter = 4
Matches only cells from rows whose keys satisfy the given RE2 regex. In other words, passes through the entire row when the key matches, and otherwise produces an empty row. Note that, since row keys can contain arbitrary bytes, the `\C` escape sequence must be used if a true wildcard is desired. The `.` character will not match the new line character `\n`, which may be present in a binary key.
double row_sample_filter = 14
Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.
string family_name_regex_filter = 5
Matches only cells from columns whose families satisfy the given RE2 regex. For technical reasons, the regex must not contain the `:` character, even if it is not being used as a literal. Note that, since column families cannot contain the new line character `\n`, it is sufficient to use `.` as a full wildcard when matching column family names.
bytes column_qualifier_regex_filter = 6
Matches only cells from columns whose qualifiers satisfy the given RE2 regex. Note that, since column qualifiers can contain arbitrary bytes, the `\C` escape sequence must be used if a true wildcard is desired. The `.` character will not match the new line character `\n`, which may be present in a binary qualifier.
column_range_filter = 7
Matches only cells from columns within the given range.
timestamp_range_filter = 8
Matches only cells with timestamps within the given range.
bytes value_regex_filter = 9
Matches only cells with values that satisfy the given regular expression. Note that, since cell values can contain arbitrary bytes, the `\C` escape sequence must be used if a true wildcard is desired. The `.` character will not match the new line character `\n`, which may be present in a binary value.
value_range_filter = 15
Matches only cells with values that fall within the given range.
int32 cells_per_row_offset_filter = 10
Skips the first N cells of each row, matching all subsequent cells. If duplicate cells are present, as is possible when using an Interleave, each copy of the cell is counted separately.
int32 cells_per_row_limit_filter = 11
Matches only the first N cells of each row. If duplicate cells are present, as is possible when using an Interleave, each copy of the cell is counted separately.
int32 cells_per_column_limit_filter = 12
Matches only the most recent N cells within each column. For example, if N=2, this filter would match column `foo:bar` at timestamps 10 and 9, skip all earlier cells in `foo:bar`, and then begin matching again in column `foo:bar2`. If duplicate cells are present, as is possible when using an Interleave, each copy of the cell is counted separately.
bool strip_value_transformer = 13
Replaces each cell's value with the empty string.
string apply_label_transformer = 19
Applies the given label to all cells in the output row. This allows the client to determine which results were produced from which part of the filter. Values must be at most 15 characters in length, and match the RE2 pattern `[a-z0-9\\-]+` Due to a technical limitation, it is not currently possible to apply multiple labels to a cell. As a result, a Chain may have no more than one sub-filter which contains a `apply_label_transformer`. It is okay for an Interleave to contain multiple `apply_label_transformers`, as they will be applied to separate copies of the input. This may be relaxed in the future.
message
data.proto:215A RowFilter which sends rows through several RowFilters in sequence.
Used in:
repeated filters = 1
The elements of "filters" are chained together to process the input row: in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row The full chain is executed atomically.
message
data.proto:260A RowFilter which evaluates one of two possible RowFilters, depending on whether or not a predicate RowFilter outputs any cells from the input row. IMPORTANT NOTE: The predicate filter does not execute atomically with the true and false filters, which may lead to inconsistent or unexpected results. Additionally, Condition filters have poor performance, especially when filters are set for the false condition.
Used in:
optional predicate_filter = 1
If `predicate_filter` outputs any cells, then `true_filter` will be evaluated on the input row. Otherwise, `false_filter` will be evaluated.
optional true_filter = 2
The filter to apply to the input row if `predicate_filter` returns any results. If not provided, no results will be returned in the true case.
optional false_filter = 3
The filter to apply to the input row if `predicate_filter` does not return any results. If not provided, no results will be returned in the false case.
message
data.proto:224A RowFilter which sends each row to each of several component RowFilters and interleaves the results.
Used in:
repeated filters = 1
The elements of "filters" all process a copy of the input row, and the results are pooled, sorted, and combined into a single output row. If multiple cells are produced with the same column and timestamp, they will all appear in the output row in an unspecified mutual order. Consider the following example, with three filters: input row | ----------------------------------------------------- | | | f(0) f(1) f(2) | | | 1: foo,bar,10,x foo,bar,10,z far,bar,7,a 2: foo,blah,11,z far,blah,5,x far,blah,5,x | | | ----------------------------------------------------- | 1: foo,bar,10,z // could have switched with #2 2: foo,bar,10,x // could have switched with #1 3: foo,blah,11,z 4: far,bar,7,a 5: far,blah,5,x // identical to #6 6: far,blah,5,x // identical to #5 All interleaved filters are executed atomically.
message
data.proto:88Specifies a contiguous range of rows.
Used in:
oneof start_key
The row key at which to start the range. If neither field is set, interpreted as the empty string, inclusive.
bytes start_key_closed = 1
Used when giving an inclusive lower bound for the range.
bytes start_key_open = 2
Used when giving an exclusive lower bound for the range.
oneof end_key
The row key at which to end the range. If neither field is set, interpreted as the infinite row key, exclusive.
bytes end_key_open = 3
Used when giving an exclusive upper bound for the range.
bytes end_key_closed = 4
Used when giving an inclusive upper bound for the range.
message
data.proto:111Specifies a non-contiguous set of rows.
Used in:
repeated bytes row_keys = 1
Single rows included in the set.
repeated row_ranges = 2
Contiguous row ranges included in the set.
message
data.proto:149Specified a contiguous range of microsecond timestamps.
Used in: ,
int64 start_timestamp_micros = 1
Inclusive lower bound. If left empty, interpreted as 0.
int64 end_timestamp_micros = 2
Exclusive upper bound. If left empty, interpreted as infinity.
message
data.proto:158Specifies a contiguous range of raw byte values.
Used in:
oneof start_value
The value at which to start the range. If neither field is set, interpreted as the empty string, inclusive.
bytes start_value_closed = 1
Used when giving an inclusive lower bound for the range.
bytes start_value_open = 2
Used when giving an exclusive lower bound for the range.
oneof end_value
The value at which to end the range. If neither field is set, interpreted as the infinite string, exclusive.
bytes end_value_closed = 3
Used when giving an inclusive upper bound for the range.
bytes end_value_open = 4
Used when giving an exclusive upper bound for the range.