@google-cloud/bigtable 1.0.1 » Namespace: v2

Abstract types

Cell

static

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

Properties

Parameter
timestampMicros	number 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	string The value stored in the cell. May contain any byte string, including the empty string, up to 100MiB in length.
labels	Array of string Labels applied to the cell by a RowFilter.

Parameter

timestampMicros

number

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

string

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

labels

Array of string

Labels applied to the cell by a RowFilter.

See also: google.bigtable.v2.Cell definition in proto format

CellChunk

static

Specifies a piece of a row's contents returned as part of the read response stream.

Properties

Parameter
rowKey	string 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.
familyName	Object 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
qualifier	Object 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
timestampMicros	number 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 Timestamps are only set in the first CellChunk per cell (for cells split into multiple chunks).
labels	Array of string Labels applied to the cell by a RowFilter. Labels are only set on the first CellChunk per cell.
value	string 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.
valueSize	number 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.
resetRow	boolean Indicates that the client should drop all previous chunks for `row_key`, as it will be re-read from the beginning.
commitRow	boolean Indicates that the client can safely process all previous chunks for `row_key`, as its data has been fully read.

See also: google.bigtable.v2.ReadRowsResponse.CellChunk definition in proto format

Chain

static

A RowFilter which sends rows through several RowFilters in sequence.

Property

Parameter
filters	Array of Object 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

Parameter

filters

Array of Object

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

See also: google.bigtable.v2.RowFilter.Chain definition in proto format

CheckAndMutateRowRequest

static

Request message for Bigtable.CheckAndMutateRow.

Properties

Parameter
tableName	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>`.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
rowKey	string The key of the row to which the conditional mutation should be applied.
predicateFilter	Object 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
trueMutations	Array of Object 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
falseMutations	Array of Object 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

See also: google.bigtable.v2.CheckAndMutateRowRequest definition in proto format

CheckAndMutateRowResponse

static

Response message for Bigtable.CheckAndMutateRow.

Property

Parameter
predicateMatched	boolean Whether or not the request's `predicate_filter` yielded any results for the specified row.

Parameter

predicateMatched

boolean

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

See also: google.bigtable.v2.CheckAndMutateRowResponse definition in proto format

Column

static

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

Properties

Parameter
qualifier	string 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	Array of Object Must not be empty. Sorted in order of decreasing "timestamp_micros". This object should have the same structure as Cell

Parameter

qualifier

string

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

Array of Object

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

This object should have the same structure as Cell

See also: google.bigtable.v2.Column definition in proto format

ColumnRange

static

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.

Properties

Parameter
familyName	string The name of the column family within which this range falls.
startQualifierClosed	string Used when giving an inclusive lower bound for the range.
startQualifierOpen	string Used when giving an exclusive lower bound for the range.
endQualifierClosed	string Used when giving an inclusive upper bound for the range.
endQualifierOpen	string Used when giving an exclusive upper bound for the range.

See also: google.bigtable.v2.ColumnRange definition in proto format

Condition

static

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

Properties

Parameter
predicateFilter	Object 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
trueFilter	Object 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
falseFilter	Object 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

Parameter

predicateFilter

Object

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

trueFilter

Object

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

falseFilter

Object

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

See also: google.bigtable.v2.RowFilter.Condition definition in proto format

DeleteFromColumn

static

A Mutation which deletes cells from the specified column, optionally restricting the deletions to a given timestamp range.

Properties

Parameter
familyName	string The name of the family from which cells should be deleted. Must match `[-_.a-zA-Z0-9]+`
columnQualifier	string The qualifier of the column from which cells should be deleted. Can be any byte string, including the empty string.
timeRange	Object The range of timestamps within which cells should be deleted. This object should have the same structure as TimestampRange

Parameter

familyName

string

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

columnQualifier

string

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

timeRange

Object

The range of timestamps within which cells should be deleted.

This object should have the same structure as TimestampRange

See also: google.bigtable.v2.Mutation.DeleteFromColumn definition in proto format

DeleteFromFamily

static

A Mutation which deletes all cells from the specified column family.

Property

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

Parameter

familyName

string

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

See also: google.bigtable.v2.Mutation.DeleteFromFamily definition in proto format

DeleteFromRow

static

A Mutation which deletes all cells from the containing row.

See also: google.bigtable.v2.Mutation.DeleteFromRow definition in proto format

Entry

static

Properties

Parameter
rowKey	string The key of the row to which the `mutations` should be applied.
mutations	Array of Object 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

Parameter

rowKey

string

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

mutations

Array of Object

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

See also: google.bigtable.v2.MutateRowsRequest.Entry definition in proto format

Entry

static

Properties

Parameter
index	number The index into the original request's `entries` list of the Entry for which a result is being reported.
status	Object 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

Parameter

index

number

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

status

Object

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

See also: google.bigtable.v2.MutateRowsResponse.Entry definition in proto format

Family

static

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

Properties

Parameter
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	Array of Object Must not be empty. Sorted in order of increasing "qualifier". This object should have the same structure as Column

Parameter

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

Array of Object

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

This object should have the same structure as Column

See also: google.bigtable.v2.Family definition in proto format

Interleave

static

A RowFilter which sends each row to each of several component RowFilters and interleaves the results.

Property

Parameter
filters	Array of Object 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

Parameter

filters

Array of Object

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

See also: google.bigtable.v2.RowFilter.Interleave definition in proto format

MutateRowRequest

static

Request message for Bigtable.MutateRow.

Properties

Parameter
tableName	string The unique name of the table to which the mutation should be applied. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
rowKey	string The key of the row to which the mutation should be applied.
mutations	Array of Object 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

See also: google.bigtable.v2.MutateRowRequest definition in proto format

MutateRowResponse

static

Response message for Bigtable.MutateRow.

See also: google.bigtable.v2.MutateRowResponse definition in proto format

MutateRowsRequest

static

Request message for BigtableService.MutateRows.

Properties

Parameter
tableName	string The unique name of the table to which the mutations should be applied.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
entries	Array of Object 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

Parameter

tableName

string

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

appProfileId

string

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

entries

Array of Object

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

See also: google.bigtable.v2.MutateRowsRequest definition in proto format

MutateRowsResponse

static

Response message for BigtableService.MutateRows.

Property

Parameter
entries	Array of Object One or more results for Entries from the batch request. This object should have the same structure as Entry

Parameter

entries

Array of Object

One or more results for Entries from the batch request.

This object should have the same structure as Entry

See also: google.bigtable.v2.MutateRowsResponse definition in proto format

Mutation

static

Specifies a particular change to be made to the contents of a row.

Properties

Parameter
setCell	Object Set a cell's value. This object should have the same structure as SetCell
deleteFromColumn	Object Deletes cells from a column. This object should have the same structure as DeleteFromColumn
deleteFromFamily	Object Deletes cells from a column family. This object should have the same structure as DeleteFromFamily
deleteFromRow	Object Deletes cells from the entire row. This object should have the same structure as DeleteFromRow

See also: google.bigtable.v2.Mutation definition in proto format

ReadModifyWriteRowRequest

static

Request message for Bigtable.ReadModifyWriteRow.

Properties

Parameter
tableName	string 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>`.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
rowKey	string The key of the row to which the read/modify/write rules should be applied.
rules	Array of Object 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

See also: google.bigtable.v2.ReadModifyWriteRowRequest definition in proto format

ReadModifyWriteRowResponse

static

Response message for Bigtable.ReadModifyWriteRow.

Property

Parameter
row	Object A Row containing the new contents of all cells modified by the request. This object should have the same structure as Row

See also: google.bigtable.v2.ReadModifyWriteRowResponse definition in proto format

ReadModifyWriteRule

static

Specifies an atomic read/modify/write operation on the latest value of the specified column.

Properties

Parameter
familyName	string The name of the family to which the read/modify/write should be applied. Must match `[-_.a-zA-Z0-9]+`
columnQualifier	string The qualifier of the column to which the read/modify/write should be applied. Can be any byte string, including the empty string.
appendValue	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.
incrementAmount	number 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.

See also: google.bigtable.v2.ReadModifyWriteRule definition in proto format

ReadRowsRequest

static

Request message for Bigtable.ReadRows.

Properties

Parameter
tableName	string The unique name of the table from which to read. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
rows	Object The row keys and/or ranges to read. If not specified, reads from all rows. This object should have the same structure as RowSet
filter	Object 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
rowsLimit	number The read will terminate after committing to N rows' worth of results. The default (zero) is to return all results.

See also: google.bigtable.v2.ReadRowsRequest definition in proto format

ReadRowsResponse

static

Response message for Bigtable.ReadRows.

Properties

Parameter
chunks	Array of Object This object should have the same structure as CellChunk
lastScannedRowKey	string 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.

Parameter

chunks

Array of Object

This object should have the same structure as CellChunk

lastScannedRowKey

string

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.

See also: google.bigtable.v2.ReadRowsResponse definition in proto format

Row

static

Specifies the complete (requested) contents of a single row of a table. Rows which exceed 256MiB in size cannot be read in full.

Properties

Parameter
key	string 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.
families	Array of Object 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

Parameter

key

string

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.

families

Array of Object

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

See also: google.bigtable.v2.Row definition in proto format

RowFilter

static

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

Properties

Parameter
chain	Object Applies several RowFilters to the data in sequence, progressively narrowing the results. This object should have the same structure as Chain
interleave	Object Applies several RowFilters to the data in parallel and combines the results. This object should have the same structure as Interleave
condition	Object 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
sink	boolean 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.
passAllFilter	boolean Matches all cells, regardless of input. Functionally equivalent to leaving `filter` unset, but included for completeness.
blockAllFilter	boolean Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
rowKeyRegexFilter	string 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.
rowSampleFilter	number Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.
familyNameRegexFilter	string 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.
columnQualifierRegexFilter	string 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.
columnRangeFilter	Object Matches only cells from columns within the given range. This object should have the same structure as ColumnRange
timestampRangeFilter	Object Matches only cells with timestamps within the given range. This object should have the same structure as TimestampRange
valueRegexFilter	string 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.
valueRangeFilter	Object Matches only cells with values that fall within the given range. This object should have the same structure as ValueRange
cellsPerRowOffsetFilter	number 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.
cellsPerRowLimitFilter	number 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.
cellsPerColumnLimitFilter	number 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.
stripValueTransformer	boolean Replaces each cell's value with the empty string.
applyLabelTransformer	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.

See also: google.bigtable.v2.RowFilter definition in proto format

RowRange

static

Specifies a contiguous range of rows.

Properties

Parameter
startKeyClosed	string Used when giving an inclusive lower bound for the range.
startKeyOpen	string Used when giving an exclusive lower bound for the range.
endKeyOpen	string Used when giving an exclusive upper bound for the range.
endKeyClosed	string Used when giving an inclusive upper bound for the range.

See also: google.bigtable.v2.RowRange definition in proto format

RowSet

static

Specifies a non-contiguous set of rows.

Properties

Parameter
rowKeys	Array of string Single rows included in the set.
rowRanges	Array of Object Contiguous row ranges included in the set. This object should have the same structure as RowRange

Parameter

rowKeys

Array of string

Single rows included in the set.

rowRanges

Array of Object

Contiguous row ranges included in the set.

This object should have the same structure as RowRange

See also: google.bigtable.v2.RowSet definition in proto format

SampleRowKeysRequest

static

Request message for Bigtable.SampleRowKeys.

Properties

Parameter
tableName	string The unique name of the table from which to sample row keys. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.

Parameter

tableName

string

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

appProfileId

string

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

See also: google.bigtable.v2.SampleRowKeysRequest definition in proto format

SampleRowKeysResponse

static

Response message for Bigtable.SampleRowKeys.

Properties

Parameter
rowKey	string 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.
offsetBytes	number 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.

Parameter

rowKey

string

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.

offsetBytes

number

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.

See also: google.bigtable.v2.SampleRowKeysResponse definition in proto format

SetCell

static

A Mutation which sets the value of the specified cell.

Properties

Parameter
familyName	string The name of the family into which new data should be written. Must match `[-_.a-zA-Z0-9]+`
columnQualifier	string The qualifier of the column into which new data should be written. Can be any byte string, including the empty string.
timestampMicros	number 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).
value	string The value to be written into the specified cell.

See also: google.bigtable.v2.Mutation.SetCell definition in proto format

TimestampRange

static

Specified a contiguous range of microsecond timestamps.

Properties

Parameter
startTimestampMicros	number Inclusive lower bound. If left empty, interpreted as 0.
endTimestampMicros	number Exclusive upper bound. If left empty, interpreted as infinity.

Parameter

startTimestampMicros

number

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

endTimestampMicros

number

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

See also: google.bigtable.v2.TimestampRange definition in proto format

ValueRange

static

Specifies a contiguous range of raw byte values.

Properties

Parameter
startValueClosed	string Used when giving an inclusive lower bound for the range.
startValueOpen	string Used when giving an exclusive lower bound for the range.
endValueClosed	string Used when giving an inclusive upper bound for the range.
endValueOpen	string Used when giving an exclusive upper bound for the range.

See also: google.bigtable.v2.ValueRange definition in proto format