Package com.google.cloud.spanner

Class Statement

java.lang.Object

com.google.cloud.spanner.Statement

All Implemented Interfaces:

Serializable

public final class Statement
extends Object
implements Serializable

A SQL statement and optional bound parameters that can be executed in a ReadContext.

The SQL query string can contain parameter placeholders. A parameter placeholder consists of @ followed by the parameter name. Parameter names consist of any combination of 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 an SQL query with placeholders for unbound parameters.

Statements are constructed using a builder. Parameter values are specified by calling Statement.Builder.bind(String). For example, code to build a query using the clause above and bind a value to id might look like the following:

 Statement statement = Statement
     .newBuilder("SELECT name WHERE id > @msg_id AND id < @msg_id + 100")
     .bind("msg_id").to(500)
     .build();
 

Statement instances are immutable.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Statement.Builder	Builder for Statement.

Method Summary

Modifier and Type	Method	Description
ResultSet	analyzeQuery(ReadContext context, ReadContext.QueryAnalyzeMode queryMode)	Analyzes the query in context.
boolean	equals(Object o)
ResultSet	executeQuery(ReadContext context, Options.QueryOption... options)	Executes the query in context.
Map<String,Value>	getParameters()	Returns the parameters bound to this Statement.
ExecuteSqlRequest.QueryOptions	getQueryOptions()	Returns the ExecuteSqlRequest.QueryOptions that will be used with this Statement.
String	getSql()	Returns the current SQL statement text.
boolean	hasBinding(String parameter)	Returns true if a binding exists for parameter.
int	hashCode()
static Statement.Builder	newBuilder(String sql)	Creates a new statement builder with the SQL text sql.
static Statement	of(String sql)	Creates a Statement with the given SQL text sql.
Statement.Builder	toBuilder()
String	toString()
Statement	withReplacedSql(String sql)	Returns a copy of this statement with the SQL string replaced by the given SQL string.

Methods inherited from class java.lang.Object

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

Method Details

of

public static Statement of(String sql)

Creates a Statement with the given SQL text sql.

newBuilder

public static Statement.Builder newBuilder(String sql)

Creates a new statement builder with the SQL text sql.

hasBinding

public boolean hasBinding(String parameter)

Returns true if a binding exists for parameter.

executeQuery

public ResultSet executeQuery(ReadContext context,
 Options.QueryOption... options)

Executes the query in context. statement.executeQuery(context) is exactly equivalent to context.executeQuery(statement).

See Also:

• ReadContext.executeQuery(Statement, Options.QueryOption...)

analyzeQuery

public ResultSet analyzeQuery(ReadContext context,
 ReadContext.QueryAnalyzeMode queryMode)

Analyzes the query in context. statement.analyzeQuery(context, queryMode) is exactly equivalent to context.analyzeQuery(statement, queryMode).

See Also:

• ReadContext.analyzeQuery(Statement, com.google.cloud.spanner.ReadContext.QueryAnalyzeMode)

getSql

public String getSql()

Returns the current SQL statement text.

withReplacedSql

public Statement withReplacedSql(String sql)

Returns a copy of this statement with the SQL string replaced by the given SQL string.

getQueryOptions

public ExecuteSqlRequest.QueryOptions getQueryOptions()

Returns the ExecuteSqlRequest.QueryOptions that will be used with this Statement.

getParameters

public Map<String,Value> getParameters()

Returns the parameters bound to this Statement.

toBuilder

public Statement.Builder toBuilder()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object