# Cloud Spanner V1 Client - Class Statement (2.9.0)

2.9.0 (latest) 2.8.1 2.7.0 2.6.1 2.5.1 2.4.1 2.3.0 2.2.0 2.1.0 2.0.1-RC1 1.106.0 1.105.1 1.104.1 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 Statement.

A single DML statement.

Generated from protobuf message `google.spanner.v1.ExecuteBatchDmlRequest.Statement`

## Namespace

Google \\ Cloud \\ Spanner \\ V1 \\ ExecuteBatchDmlRequest

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ sql` | `string` Required. The DML string. |
| `↳ params` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Struct` 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's an error to execute a SQL statement with unbound parameters. |
| `↳ param_types` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` It isn't 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](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.ExecuteBatchDmlRequest.Statement#_Google_Cloud_Spanner_V1_ExecuteBatchDmlRequest_Statement__getParams__) 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](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Type) for more information about SQL types. |

### getSql

Required. The DML string.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setSql

Required. The DML string.

| **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's an error to execute a SQL statement with unbound parameters.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/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's an error to execute a SQL statement with unbound parameters.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Struct` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getParamTypes

It isn't 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](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.ExecuteBatchDmlRequest.Statement#_Google_Cloud_Spanner_V1_ExecuteBatchDmlRequest_Statement__getParams__) 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](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Type) for more information
about SQL types.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setParamTypes

It isn't 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](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.ExecuteBatchDmlRequest.Statement#_Google_Cloud_Spanner_V1_ExecuteBatchDmlRequest_Statement__getParams__) 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](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Type) for more information
about SQL types.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |