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.
| Parameters | |
|---|---|
| Name | Description |
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 |
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
The columns of table to be returned for each row matching this request. |
↳ key_set |
Google\Cloud\Spanner\V1\KeySet
Required. |
↳ 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) = {
| Returns | |
|---|---|
| Type | Description |
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) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\V1\TransactionSelector|null | |
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;
| 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.
Generated from protobuf field string table = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
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];
| 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.
Generated from protobuf field string index = 4;
| 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.
Generated from protobuf field string index = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getColumns
The columns of table to be returned for each row matching this request.
Generated from protobuf field repeated string columns = 5;
| Returns | |
|---|---|
| Type | Description |
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;
| 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.
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];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\V1\KeySet|null | |
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];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\V1\KeySet
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartitionOptions
Additional options that affect how many partitions are created.
Generated from protobuf field .google.spanner.v1.PartitionOptions partition_options = 9;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\V1\PartitionOptions|null | |
hasPartitionOptions
clearPartitionOptions
setPartitionOptions
Additional options that affect how many partitions are created.
Generated from protobuf field .google.spanner.v1.PartitionOptions partition_options = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\V1\PartitionOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |