v2

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.

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

Labels applied to the cell by a RowFilter.

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.

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.

This object should have the same structure as StringValue

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.

This object should have the same structure as BytesValue

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

Labels applied to the cell by a RowFilter. Labels are only set on the first CellChunk per cell.

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.

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.

Indicates that the client should drop all previous chunks for row_key, as it will be re-read from the beginning.

Indicates that the client can safely process all previous chunks for row_key, as its data has been fully read.

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.

This object should have the same structure as RowFilter

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

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

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

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.

This object should have the same structure as RowFilter

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.

This object should have the same structure as 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.

This object should have the same structure as Mutation

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

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.

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

This object should have the same structure as Cell

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

Used when giving an inclusive lower bound for the range.

Used when giving an exclusive lower bound for the range.

Used when giving an inclusive upper bound for the range.

Used when giving an exclusive upper bound for the range.

If predicate_filter outputs any cells, then true_filter will be evaluated on the input row. Otherwise, false_filter will be evaluated.

This object should have the same structure as RowFilter

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.

This object should have the same structure as RowFilter

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.

This object should have the same structure as RowFilter

The name of the family from which cells should be deleted. Must match [-_.a-zA-Z0-9]+

The qualifier of the column from which cells should be deleted. Can be any byte string, including the empty string.

The range of timestamps within which cells should be deleted.

This object should have the same structure as TimestampRange

The name of the family from which cells should be deleted. Must match [-_.a-zA-Z0-9]+

The key of the row to which the mutations should be applied.

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.

This object should have the same structure as Mutation

The index into the original request's entries list of the Entry for which a result is being reported.

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.

This object should have the same structure as Status

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.

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

This object should have the same structure as Column

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.

This object should have the same structure as RowFilter

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

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

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

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.

This object should have the same structure as Mutation

The unique name of the table to which the mutations should be applied.

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

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.

This object should have the same structure as Entry

One or more results for Entries from the batch request.

This object should have the same structure as Entry

Set a cell's value.

This object should have the same structure as SetCell

Deletes cells from a column.

This object should have the same structure as DeleteFromColumn

Deletes cells from a column family.

This object should have the same structure as DeleteFromFamily

Deletes cells from the entire row.

This object should have the same structure as DeleteFromRow

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

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

The key of the row to which the read/modify/write rules should be applied.

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.

This object should have the same structure as ReadModifyWriteRule

A Row containing the new contents of all cells modified by the request.

This object should have the same structure as Row

The name of the family to which the read/modify/write should be applied. Must match [-_.a-zA-Z0-9]+

The qualifier of the column to which the read/modify/write should be applied. Can be any byte string, including the empty string.

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.

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.

The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

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

The row keys and/or ranges to read. If not specified, reads from all rows.

This object should have the same structure as RowSet

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

This object should have the same structure as RowFilter

The read will terminate after committing to N rows' worth of results. The default (zero) is to return all results.

This object should have the same structure as CellChunk

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.

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.

May be empty, but only if the entire row is empty. The mutual ordering of column families is not specified.

This object should have the same structure as Family

Applies several RowFilters to the data in sequence, progressively narrowing the results.

This object should have the same structure as Chain

Applies several RowFilters to the data in parallel and combines the results.

This object should have the same structure as Interleave

Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.

This object should have the same structure as Condition

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

Matches all cells, regardless of input. Functionally equivalent to leaving filter unset, but included for completeness.

Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.

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.

Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.

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.

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.

Matches only cells from columns within the given range.

This object should have the same structure as ColumnRange

Matches only cells with timestamps within the given range.

This object should have the same structure as TimestampRange

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.

Matches only cells with values that fall within the given range.

This object should have the same structure as ValueRange

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.

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.

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.

Replaces each cell's value with the empty string.

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.

Used when giving an inclusive lower bound for the range.

Used when giving an exclusive lower bound for the range.

Used when giving an exclusive upper bound for the range.

Used when giving an inclusive upper bound for the range.

Single rows included in the set.

Contiguous row ranges included in the set.

This object should have the same structure as RowRange

The unique name of the table from which to sample row keys. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

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

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.

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.

The name of the family into which new data should be written. Must match [-_.a-zA-Z0-9]+

The qualifier of the column into which new data should be written. Can be any byte string, including the empty string.

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

The value to be written into the specified cell.

Inclusive lower bound. If left empty, interpreted as 0.

Exclusive upper bound. If left empty, interpreted as infinity.

Used when giving an inclusive lower bound for the range.

Used when giving an exclusive lower bound for the range.

Used when giving an inclusive upper bound for the range.

Used when giving an exclusive upper bound for the range.