- 1.104.0 (latest)
- 1.103.0
- 1.102.0
- 1.101.0
- 1.100.0
- 1.98.0
- 1.97.0
- 1.96.0
- 1.95.0
- 1.94.0
- 1.93.1
- 1.92.1
- 1.91.0
- 1.90.0
- 1.89.0
- 1.88.0
- 1.87.0
- 1.86.0
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.81.0
- 1.80.0
- 1.79.0
- 1.78.0
- 1.77.0
- 1.76.1
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.2
- 1.62.1
- 1.61.0
- 1.60.0
- 1.59.0
- 1.58.4
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.2
Reference documentation and code samples for the Cloud Spanner V1 Client class ReadRequest.
The request for Read and StreamingRead .
Generated from protobuf message google.spanner.v1.ReadRequest
Namespace
Google \ Cloud \ Spanner \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ session
string
Required. The session in which the read should be performed.
↳ transaction
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
↳ columns
↳ key_set
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
↳ directed_read_options
↳ 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.
↳ order_by
int
Optional. Order for the returned rows. By default, Spanner will return result rows in primary key order except for PartitionRead requests. For applications that do not require rows to be returned in primary key ( ORDER_BY_PRIMARY_KEY
) order, setting ORDER_BY_NO_ORDER
option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (e.g. bulk point lookups).
↳ lock_hint
int
Optional. Lock Hint for the request, it can only be used with read-write transactions.
getSession
Required. The session in which the read should be performed.
string
setSession
Required. The session in which the read should be performed.
var
string
$this
getTransaction
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
hasTransaction
clearTransaction
setTransaction
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
$this
getTable
Required. The name of the table in the database to be read.
string
setTable
Required. The name of the table in the database to be read.
var
string
$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.
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.
var
string
$this
getColumns
Required. The columns of table to be returned for each row matching this request.
setColumns
Required. The columns of table to be returned for each row matching this request.
var
string[]
$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.
hasKeySet
clearKeySet
setKeySet
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.
$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.
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.
var
int|string
$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.
string
setResumeToken
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.
var
string
$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.
string
setPartitionToken
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.
var
string
$this
getRequestOptions
Common options for this request.
hasRequestOptions
clearRequestOptions
setRequestOptions
Common options for this request.
$this
getDirectedReadOptions
Directed read options for this request.
hasDirectedReadOptions
clearDirectedReadOptions
setDirectedReadOptions
Directed read options for this request.
$this
getDataBoostEnabled
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.
bool
setDataBoostEnabled
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.
var
bool
$this
getOrderBy
Optional. Order for the returned rows.
By default, Spanner will return result rows in primary key order except for
PartitionRead requests. For applications that do not require rows to be
returned in primary key ( ORDER_BY_PRIMARY_KEY
) order, setting ORDER_BY_NO_ORDER
option allows Spanner to optimize row retrieval,
resulting in lower latencies in certain cases (e.g. bulk point lookups).
int
setOrderBy
Optional. Order for the returned rows.
By default, Spanner will return result rows in primary key order except for
PartitionRead requests. For applications that do not require rows to be
returned in primary key ( ORDER_BY_PRIMARY_KEY
) order, setting ORDER_BY_NO_ORDER
option allows Spanner to optimize row retrieval,
resulting in lower latencies in certain cases (e.g. bulk point lookups).
var
int
$this
getLockHint
Optional. Lock Hint for the request, it can only be used with read-write transactions.
int
setLockHint
Optional. Lock Hint for the request, it can only be used with read-write transactions.
var
int
$this
