Keyset API

Wrap representation of Spanner keys / ranges.

class google.cloud.spanner_v1.keyset.KeyRange(start_open=None, start_closed=None, end_open=None, end_closed=None)

Bases: object

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

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

  • Raises

    ValueError – if no keys are specified

_eq_(other)

Compare by serialized state.

class google.cloud.spanner_v1.keyset.KeySet(keys=(), ranges=(), all_=False)

Bases: object

Identify table rows via keys / ranges.

  • Parameters

    • 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

_eq_(other)

Compare by serialized state.

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年12月16日 UTC.