Reference documentation and code samples for the Cloud Spanner V1 Client class Statement.
A single DML statement.
Generated from protobuf message google.spanner.v1.ExecuteBatchDmlRequest.Statement
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ sql |
string
Required. The DML string. |
↳ params |
Google\Protobuf\Struct
Parameter names and values that bind to placeholders in the DML 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 |
getSql
Required. The DML string.
Generated from protobuf field string sql = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setSql
Required. The DML string.
Generated from protobuf field string sql = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParams
Parameter names and values that bind to placeholders in the DML 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.
Generated from protobuf field .google.protobuf.Struct params = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasParams
clearParams
setParams
Parameter names and values that bind to placeholders in the DML 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.
Generated from protobuf field .google.protobuf.Struct params = 2;
| 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 statement parameters. See the
definition of Type for more information
about SQL types.
Generated from protobuf field map<string, .google.spanner.v1.Type> param_types = 3;
| 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 statement parameters. See the
definition of Type for more information
about SQL types.
Generated from protobuf field map<string, .google.spanner.v1.Type> param_types = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |