- 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 PartitionReadRequest.
The request for PartitionRead
Generated from protobuf message google.spanner.v1.PartitionReadRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ session
string
Required. The session used to create the partitions.
↳ transaction
Google\Cloud\Spanner\V1\TransactionSelector
Read only snapshot transactions are supported, read/write and single use transactions are not.
↳ table
string
Required. The name of the table in the database to be read.
↳ index
↳ columns
↳ 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
. 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\PartitionOptions
Additional options that affect how many partitions are created.
getSession
Required. The session used to create the partitions.
Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
string
setSession
Required. The session used to create the partitions.
Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
var
string
$this
getTransaction
Read only snapshot transactions are supported, read/write and single use transactions are not.
Generated from protobuf field .google.spanner.v1.TransactionSelector transaction = 2;
hasTransaction
clearTransaction
setTransaction
Read only snapshot transactions are supported, read/write and single use transactions are not.
Generated from protobuf field .google.spanner.v1.TransactionSelector transaction = 2;
$this
getTable
Required. The name of the table in the database to be read.
Generated from protobuf field string table = 3 [(.google.api.field_behavior) = REQUIRED];
string
setTable
Required. The name of the table in the database to be read.
Generated from protobuf field string table = 3 [(.google.api.field_behavior) = REQUIRED];
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.
Generated from protobuf field string index = 4;
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.
Generated from protobuf field string index = 4;
var
string
$this
getColumns
The columns of table to be returned for each row matching this request.
Generated from protobuf field repeated string columns = 5;
Google\Protobuf\Internal\RepeatedField
setColumns
The columns of table to be returned for each row matching this request.
Generated from protobuf field repeated string columns = 5;
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
.
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.
Generated from protobuf field .google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
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
.
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.
Generated from protobuf field .google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
$this
getPartitionOptions
Additional options that affect how many partitions are created.
Generated from protobuf field .google.spanner.v1.PartitionOptions partition_options = 9;
hasPartitionOptions
clearPartitionOptions
setPartitionOptions
Additional options that affect how many partitions are created.
Generated from protobuf field .google.spanner.v1.PartitionOptions partition_options = 9;
$this
