Module read_rows_query (2.26.0)

Version latest

• 2.26.0 (latest)
• 2.25.0
• 2.24.0
• 2.23.1
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.1
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.1
• 2.13.2
• 2.12.0
• 2.11.3
• 2.10.1
• 2.9.0
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.2
• 2.4.0
• 2.3.3
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.3
• 1.6.1
• 1.5.1
• 1.4.0
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.34.0

API documentation for bigtable.data.read_rows_query module.

Classes

ReadRowsQuery

ReadRowsQuery(
    row_keys: typing.Optional[typing.Union[list[str | bytes], str, bytes]] = None,
    row_ranges: typing.Optional[
        typing.Union[
            list[google.cloud.bigtable.data.read_rows_query.RowRange],
            google.cloud.bigtable.data.read_rows_query.RowRange,
        ]
    ] = None,
    limit: typing.Optional[int] = None,
    row_filter: typing.Optional[
        google.cloud.bigtable.data.row_filters.RowFilter
    ] = None,
)

Class to encapsulate details of a read row request

RowRange

RowRange(
    start_key: typing.Optional[typing.Union[str, bytes]] = None,
    end_key: typing.Optional[typing.Union[str, bytes]] = None,
    start_is_inclusive: typing.Optional[bool] = None,
    end_is_inclusive: typing.Optional[bool] = None,
)

Represents a range of keys in a ReadRowsQuery

Exceptions
Type	Description
ValueError	if start_key is greater than end_key, or start_is_inclusive
ValueError	if end_is_inclusive is set when the corresponding key is None
ValueError	if start_key or end_key is not a string or bytes.