Class RowSet (2.32.0)
Stay organized with collections
Save and categorize content based on your preferences.
Convenience wrapper of google.bigtable.v2.RowSet
Useful for creating a set of row keys and row ranges, which can
be passed to read_rows method of class: .Table.read_rows
.
Methods
add_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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Class RowSet (2.32.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.32.0 (latest)](/python/docs/reference/bigtable/latest/google.cloud.bigtable.row_set.RowSet)\n- [2.31.0](/python/docs/reference/bigtable/2.31.0/google.cloud.bigtable.row_set.RowSet)\n- [2.30.1](/python/docs/reference/bigtable/2.30.1/google.cloud.bigtable.row_set.RowSet)\n- [2.29.0](/python/docs/reference/bigtable/2.29.0/google.cloud.bigtable.row_set.RowSet)\n- [2.28.1](/python/docs/reference/bigtable/2.28.1/google.cloud.bigtable.row_set.RowSet)\n- [2.26.0](/python/docs/reference/bigtable/2.26.0/google.cloud.bigtable.row_set.RowSet)\n- [2.25.0](/python/docs/reference/bigtable/2.25.0/google.cloud.bigtable.row_set.RowSet)\n- [2.24.0](/python/docs/reference/bigtable/2.24.0/google.cloud.bigtable.row_set.RowSet)\n- [2.23.1](/python/docs/reference/bigtable/2.23.1/google.cloud.bigtable.row_set.RowSet)\n- [2.22.0](/python/docs/reference/bigtable/2.22.0/google.cloud.bigtable.row_set.RowSet)\n- [2.21.0](/python/docs/reference/bigtable/2.21.0/google.cloud.bigtable.row_set.RowSet)\n- [2.20.0](/python/docs/reference/bigtable/2.20.0/google.cloud.bigtable.row_set.RowSet)\n- [2.19.0](/python/docs/reference/bigtable/2.19.0/google.cloud.bigtable.row_set.RowSet)\n- [2.18.1](/python/docs/reference/bigtable/2.18.1/google.cloud.bigtable.row_set.RowSet)\n- [2.17.0](/python/docs/reference/bigtable/2.17.0/google.cloud.bigtable.row_set.RowSet)\n- [2.16.0](/python/docs/reference/bigtable/2.16.0/google.cloud.bigtable.row_set.RowSet)\n- [2.15.0](/python/docs/reference/bigtable/2.15.0/google.cloud.bigtable.row_set.RowSet)\n- [2.14.1](/python/docs/reference/bigtable/2.14.1/google.cloud.bigtable.row_set.RowSet)\n- [2.13.2](/python/docs/reference/bigtable/2.13.2/google.cloud.bigtable.row_set.RowSet)\n- [2.12.0](/python/docs/reference/bigtable/2.12.0/google.cloud.bigtable.row_set.RowSet)\n- [2.11.3](/python/docs/reference/bigtable/2.11.3/google.cloud.bigtable.row_set.RowSet)\n- [2.10.1](/python/docs/reference/bigtable/2.10.1/google.cloud.bigtable.row_set.RowSet)\n- [2.9.0](/python/docs/reference/bigtable/2.9.0/google.cloud.bigtable.row_set.RowSet)\n- [2.8.1](/python/docs/reference/bigtable/2.8.1/google.cloud.bigtable.row_set.RowSet)\n- [2.7.1](/python/docs/reference/bigtable/2.7.1/google.cloud.bigtable.row_set.RowSet)\n- [2.6.0](/python/docs/reference/bigtable/2.6.0/google.cloud.bigtable.row_set.RowSet)\n- [2.5.2](/python/docs/reference/bigtable/2.5.2/google.cloud.bigtable.row_set.RowSet)\n- [2.4.0](/python/docs/reference/bigtable/2.4.0/google.cloud.bigtable.row_set.RowSet)\n- [2.3.3](/python/docs/reference/bigtable/2.3.3/google.cloud.bigtable.row_set.RowSet)\n- [2.2.0](/python/docs/reference/bigtable/2.2.0/google.cloud.bigtable.row_set.RowSet)\n- [2.1.0](/python/docs/reference/bigtable/2.1.0/google.cloud.bigtable.row_set.RowSet)\n- [2.0.0](/python/docs/reference/bigtable/2.0.0/google.cloud.bigtable.row_set.RowSet)\n- [1.7.3](/python/docs/reference/bigtable/1.7.3/google.cloud.bigtable.row_set.RowSet)\n- [1.6.1](/python/docs/reference/bigtable/1.6.1/google.cloud.bigtable.row_set.RowSet)\n- [1.5.1](/python/docs/reference/bigtable/1.5.1/google.cloud.bigtable.row_set.RowSet)\n- [1.4.0](/python/docs/reference/bigtable/1.4.0/google.cloud.bigtable.row_set.RowSet)\n- [1.3.0](/python/docs/reference/bigtable/1.3.0/google.cloud.bigtable.row_set.RowSet)\n- [1.2.1](/python/docs/reference/bigtable/1.2.1/google.cloud.bigtable.row_set.RowSet)\n- [1.1.0](/python/docs/reference/bigtable/1.1.0/google.cloud.bigtable.row_set.RowSet)\n- [1.0.0](/python/docs/reference/bigtable/1.0.0/google.cloud.bigtable.row_set.RowSet)\n- [0.34.0](/python/docs/reference/bigtable/0.34.0/google.cloud.bigtable.row_set.RowSet) \n\n RowSet()\n\nConvenience wrapper of google.bigtable.v2.RowSet\n\nUseful for creating a set of row keys and row ranges, which can\nbe passed to read_rows method of class:`.Table.read_rows`.\n\nMethods\n-------\n\n### add_row_key\n\n add_row_key(row_key)\n\nAdd row key to row_keys list.\n\nFor example:\n\n.. literalinclude:: snippets_table.py\n:start-after: \\[START bigtable_api_add_row_key\\]\n:end-before: \\[END bigtable_api_add_row_key\\]\n:dedent: 4\n\n### add_row_range\n\n add_row_range(row_range)\n\nAdd row_range to row_ranges list.\n\nFor example:\n\n.. literalinclude:: snippets_table.py\n:start-after: \\[START bigtable_api_add_row_range\\]\n:end-before: \\[END bigtable_api_add_row_range\\]\n:dedent: 4\n\n### add_row_range_from_keys\n\n add_row_range_from_keys(\n start_key=None, end_key=None, start_inclusive=True, end_inclusive=False\n )\n\nAdd row range to row_ranges list from the row keys\n\nFor example:\n\n.. literalinclude:: snippets_table.py\n:start-after: \\[START bigtable_api_row_range_from_keys\\]\n:end-before: \\[END bigtable_api_row_range_from_keys\\]\n:dedent: 4\n\n### add_row_range_with_prefix\n\n add_row_range_with_prefix(row_key_prefix)\n\nAdd row range to row_ranges list that start with the row_key_prefix from the row keys\n\nFor example:\n\n.. literalinclude:: snippets_table.py\n:start-after: \\[START bigtable_api_add_row_range_with_prefix\\]\n:end-before: \\[END bigtable_api_add_row_range_with_prefix\\]"]]
