Interface ExecuteBatchDmlRequest.StatementOrBuilder (6.55.0)

public static interface ExecuteBatchDmlRequest.StatementOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsParamTypes(String key)

public abstract boolean containsParamTypes(String key)

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.

map<string, .google.spanner.v1.Type> param_types = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getParamTypes()

public abstract Map<String,Type> getParamTypes()

Use #getParamTypesMap() instead.

Returns
TypeDescription
Map<String,Type>

getParamTypesCount()

public abstract int getParamTypesCount()

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.

map<string, .google.spanner.v1.Type> param_types = 3;

Returns
TypeDescription
int

getParamTypesMap()

public abstract Map<String,Type> getParamTypesMap()

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.

map<string, .google.spanner.v1.Type> param_types = 3;

Returns
TypeDescription
Map<String,Type>

getParamTypesOrDefault(String key, Type defaultValue)

public abstract Type getParamTypesOrDefault(String key, Type defaultValue)

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.

map<string, .google.spanner.v1.Type> param_types = 3;

Parameters
NameDescription
keyString
defaultValueType
Returns
TypeDescription
Type

getParamTypesOrThrow(String key)

public abstract Type getParamTypesOrThrow(String key)

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.

map<string, .google.spanner.v1.Type> param_types = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
Type

getParams()

public abstract Struct 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.

.google.protobuf.Struct params = 2;

Returns
TypeDescription
Struct

The params.

getParamsOrBuilder()

public abstract StructOrBuilder getParamsOrBuilder()

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.

.google.protobuf.Struct params = 2;

Returns
TypeDescription
StructOrBuilder

getSql()

public abstract String getSql()

Required. The DML string.

string sql = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The sql.

getSqlBytes()

public abstract ByteString getSqlBytes()

Required. The DML string.

string sql = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for sql.

hasParams()

public abstract boolean hasParams()

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.

.google.protobuf.Struct params = 2;

Returns
TypeDescription
boolean

Whether the params field is set.