com.google.api.services.spanner.v1.model

Class Statement

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.Statement

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Statement
extends com.google.api.client.json.GenericJson

A single DML statement.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Statement()

Method Summary

Modifier and Type	Method and Description
Statement	clone()
Map<String,Object>	getParams() Parameter names and values that bind to placeholders in the DML string.
Map<String,Type>	getParamTypes() It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value.
String	getSql() Required.
Statement	set(String fieldName, Object value)
Statement	setParams(Map<String,Object> params) Parameter names and values that bind to placeholders in the DML string.
Statement	setParamTypes(Map<String,Type> paramTypes) It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Statement	setSql(String sql) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Statement

public Statement()

Method Detail

getParamTypes

public Map<String,Type> 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 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.

Returns:

value or null for none

setParamTypes

public Statement setParamTypes(Map<String,Type> paramTypes)

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 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.

Parameters:

paramTypes - paramTypes or null for none

getParams

public Map<String,Object> 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:

value or null for none

setParams

public Statement setParams(Map<String,Object> params)

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.

Parameters:

params - params or null for none

getSql

public String getSql()

Required. The DML string.

Returns:

value or null for none

setSql

public Statement setSql(String sql)

Required. The DML string.

Parameters:

sql - sql or null for none

set

public Statement set(String fieldName,
                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Statement clone()

Overrides:

clone in class com.google.api.client.json.GenericJson