Class ReadRequest (3.41.0)

Version 3.41.0

• 3.51.0 (latest)
• 3.50.1
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.1
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.1
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.1
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.2
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.1
• 3.14.1
• 3.13.0
• 3.12.1
• 3.11.1
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.1.1
• 2.0.0
• 1.19.3
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0

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

The request for Read][google.spanner.v1.Spanner.Read] and StreamingRead][google.spanner.v1.Spanner.StreamingRead].

Attributes
Name	Description
session	str Required. The session in which the read should be performed.
transaction	google.cloud.spanner_v1.types.TransactionSelector The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
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.ReadRequest.table]. This index is used instead of the table primary key when interpreting key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See key_set][google.spanner.v1.ReadRequest.key_set] for further information.
columns	MutableSequence[str] Required. The columns of table][google.spanner.v1.ReadRequest.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.ReadRequest.table] to be yielded, unless index][google.spanner.v1.ReadRequest.index] is present. If index][google.spanner.v1.ReadRequest.index] is present, then key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in index][google.spanner.v1.ReadRequest.index]. If the partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if index][google.spanner.v1.ReadRequest.index] is non-empty). If the partition_token][google.spanner.v1.ReadRequest.partition_token] field is not empty, rows will be yielded in an unspecified order. 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.
limit	int If greater than zero, only the first limit rows are yielded. If limit is zero, the default is no limit. A limit cannot be specified if partition_token is set.
resume_token	bytes If this request is resuming a previously interrupted read, resume_token should be copied from the last PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.
partition_token	bytes If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.
request_options	google.cloud.spanner_v1.types.RequestOptions Common options for this request.
directed_read_options	google.cloud.spanner_v1.types.DirectedReadOptions Directed read options for this request.
data_boost_enabled	bool If this is for a partitioned read and this field is set to true, the request is executed with Spanner Data Boost independent compute resources. If the field is set to true but the request does not set partition_token, the API returns an INVALID_ARGUMENT error.