Cloud Spanner V1 Client - Class ReadRequest (1.60.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class ReadRequest.

Generated from protobuf message google.spanner.v1.ReadRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ session`	`string` Required. The session in which the read should be performed.
`↳ transaction`	`Google\Cloud\Spanner\V1\TransactionSelector` The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
`↳ table`	`string` Required. The name of the table in the database to be read.
`↳ index`	`string` If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.
`↳ columns`	`array` Required. The columns of table to be returned for each row matching this request.
`↳ key_set`	`Google\Cloud\Spanner\V1\KeySet` Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the 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\|string` 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`	`string` If this request is resuming a previously interrupted read, `resume_token` should be copied from the last 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`	`string` 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\RequestOptions` Common options for this request.
`↳ data_boost_enabled`	`bool` If this is for a partitioned read and this field is set to `true`, the request will be executed via Spanner independent compute resources. If the field is set to `true` but the request does not set `partition_token`, the API will return an `INVALID_ARGUMENT` error.

getSession

Required. The session in which the read should be performed.

Returns
Type	Description
`string`

setSession

Required. The session in which the read should be performed.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTransaction

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

Returns
Type	Description
`Google\Cloud\Spanner\V1\TransactionSelector\|null`

hasTransaction

clearTransaction

setTransaction

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

Parameter
Name	Description
`var`	`Google\Cloud\Spanner\V1\TransactionSelector`

Returns
Type	Description
`$this`

getTable

Required. The name of the table in the database to be read.

Returns
Type	Description
`string`

setTable

Required. The name of the table in the database to be read.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIndex

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

Returns
Type	Description
`string`

setIndex

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getColumns

Required. The columns of table to be returned for each row matching this request.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setColumns

Required. The columns of table to be returned for each row matching this request.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getKeySet

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the 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.

Returns
Type	Description
`Google\Cloud\Spanner\V1\KeySet\|null`

hasKeySet

clearKeySet

setKeySet

Parameter
Name	Description
`var`	`Google\Cloud\Spanner\V1\KeySet`

Returns
Type	Description
`$this`

getLimit

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.

Returns
Type	Description
`int\|string`

setLimit

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.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getResumeToken

If this request is resuming a previously interrupted read, resume_token should be copied from the last 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.

Returns
Type	Description
`string`

setResumeToken

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPartitionToken

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.

Returns
Type	Description
`string`

setPartitionToken

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRequestOptions

Common options for this request.

Returns
Type	Description
`Google\Cloud\Spanner\V1\RequestOptions\|null`

hasRequestOptions

clearRequestOptions

setRequestOptions

Common options for this request.

Parameter
Name	Description
`var`	`Google\Cloud\Spanner\V1\RequestOptions`

Returns
Type	Description
`$this`

getDataBoostEnabled

If this is for a partitioned read and this field is set to true, the request will be executed via Spanner independent compute resources.

If the field is set to true but the request does not set partition_token, the API will return an INVALID_ARGUMENT error.

Returns
Type	Description
`bool`

setDataBoostEnabled

If this is for a partitioned read and this field is set to true, the request will be executed via Spanner independent compute resources.

If the field is set to true but the request does not set partition_token, the API will return an INVALID_ARGUMENT error.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`