Class RowSet (2.14.1)
Stay organized with collections
Save and categorize content based on your preferences.
RowSet()Convenience wrapper of google.bigtable.v2.RowSet
Useful for creating a set of row keys and row ranges, which can
be passed to yield_rows method of class:.Table.yield_rows.
Methods
add_row_key
add_row_key(row_key)Add row key to row_keys list.
For example:
.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_add_row_key] :end-before: [END bigtable_api_add_row_key] :dedent: 4
row_key
bytes
The key of a row to read
add_row_range
add_row_range(row_range)Add row_range to row_ranges list.
For example:
.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_add_row_range] :end-before: [END bigtable_api_add_row_range] :dedent: 4
row_range
class:RowRange
The row range object having start and end key
add_row_range_from_keys
add_row_range_from_keys(
start_key=None, end_key=None, start_inclusive=True, end_inclusive=False
)Add row range to row_ranges list from the row keys
For example:
.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_row_range_from_keys] :end-before: [END bigtable_api_row_range_from_keys] :dedent: 4
start_key
bytes
(Optional) Start key of the row range. If left empty, will be interpreted as the empty string.
end_key
bytes
(Optional) End key of the row range. If left empty, will be interpreted as the empty string and range will be unbounded on the high end.
start_inclusive
bool
(Optional) Whether the start_key should be considered inclusive. The default is True (inclusive).
end_inclusive
bool
(Optional) Whether the end_key should be considered inclusive. The default is False (exclusive).
add_row_range_with_prefix
add_row_range_with_prefix(row_key_prefix)Add row range to row_ranges list that start with the row_key_prefix from the row keys
For example:
.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_add_row_range_with_prefix] :end-before: [END bigtable_api_add_row_range_with_prefix]
row_key_prefix
str
To retrieve all rows that start with this row key prefix. Prefix cannot be zero length.