Reference documentation and code samples for the Cloud Spanner V1 Client class PartitionQueryRequest.
The request for PartitionQuery
Generated from protobuf message google.spanner.v1.PartitionQueryRequest
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. |
↳ sql |
string
Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. |
↳ params |
Google\Protobuf\Struct
Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the |
↳ param_types |
array|Google\Protobuf\Internal\MapField
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
string | |
setSession
Required. The session used to create the partitions.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTransaction
Read only snapshot transactions are supported, read/write and single use transactions are not.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\V1\TransactionSelector
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSql
Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results.
This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
| Returns | |
|---|---|
| Type | Description |
string | |
setSql
Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results.
This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParams
Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasParams
clearParams
setParams
Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParamTypes
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setParamTypes
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartitionOptions
Additional options that affect how many partitions are created.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\V1\PartitionOptions|null | |
hasPartitionOptions
clearPartitionOptions
setPartitionOptions
Additional options that affect how many partitions are created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\V1\PartitionOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |