Class RowRange (2.23.1)

Version latest

• 2.23.1 (latest)
• 2.23.0
• 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

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

Properties

end_is_inclusive

Returns whether the range is inclusive of the end key. Returns True if the range is unbounded on the right.

end_key

Returns the end key of the range. If None, the range is unbounded on the right.

start_is_inclusive

Returns whether the range is inclusive of the start key. Returns True if the range is unbounded on the left.

start_key

Returns the start key of the range. If None, the range is unbounded on the left.

Methods

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

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

__bool__

__bool__() -> bool

Empty RowRanges (representing a full table scan) are falsy, because they can be substituted with None. Non-empty RowRanges are truthy.

__str__

__str__() -> str

Represent range as a string, e.g. "[b'a', b'z)" Unbounded start or end keys are represented as "-inf" or "+inf"