Class PartitionReadRequest (3.14.0)

PartitionReadRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request for PartitionRead][google.spanner.v1.Spanner.PartitionRead]

Attributes

Name	Description
session	`str` Required. The session used to create the partitions.
transaction	`google.cloud.spanner_v1.types.TransactionSelector` Read only snapshot transactions are supported, read/write and single use transactions are not.
table	`str` Required. The name of the table in the database to be read.
index	`str` If non-empty, the name of an index on `table][google.spanner.v1.PartitionReadRequest.table]`. This index is used instead of the table primary key when interpreting `key_set][google.spanner.v1.PartitionReadRequest.key_set]` and sorting result rows. See `key_set][google.spanner.v1.PartitionReadRequest.key_set]` for further information.
columns	`Sequence[str]` The columns of `table][google.spanner.v1.PartitionReadRequest.table]` to be returned for each row matching this request.
key_set	`google.cloud.spanner_v1.types.KeySet` Required. ``key_set`` identifies the rows to be yielded. ``key_set`` names the primary keys of the rows in `table][google.spanner.v1.PartitionReadRequest.table]` to be yielded, unless `index][google.spanner.v1.PartitionReadRequest.index]` is present. If `index][google.spanner.v1.PartitionReadRequest.index]` is present, then `key_set][google.spanner.v1.PartitionReadRequest.key_set]` instead names index keys in `index][google.spanner.v1.PartitionReadRequest.index]`. It is not an error for the ``key_set`` to name rows that do not exist in the database. Read yields nothing for nonexistent rows.
partition_options	`google.cloud.spanner_v1.types.PartitionOptions` Additional options that affect how many partitions are created.

Inheritance

builtins.object > proto.message.Message > PartitionReadRequest