Module keyset (3.51.0)

Wrap representation of Spanner keys / ranges.

Classes

KeyRange

KeyRange(start_open=None, start_closed=None, end_open=None, end_closed=None)

Identify range of table rows via start / end points.

Specify either a start_open or start_closed key, or defaults to start_closed = []. Specify either an end_open or end_closed key, or defaults to end_closed = []. However, at least one key has to be specified. If no keys are specified, ValueError is raised.

Parameters
Name Description
start_open list of scalars

keys identifying start of range (this key excluded)

start_closed list of scalars

keys identifying start of range (this key included)

end_open list of scalars

keys identifying end of range (this key excluded)

end_closed list of scalars

keys identifying end of range (this key included)

Exceptions
Type Description
ValueError if no keys are specified

KeySet

KeySet(keys=(), ranges=(), all_=False)

Identify table rows via keys / ranges.

Parameters
Name Description
keys list of list of scalars

keys identifying individual rows within a table.

ranges list of KeyRange

ranges identifying rows within a table.

all_ boolean

if True, identify all rows within a table