public class IntermediateStatement
Data type to store simple SQL statement with designated metadata. Allows manipulation of
statement, such as execution, termination, etc. Represented as an intermediate representation for
statements which does not belong directly to Postgres, Spanner, etc.
Static Fields
protected static final PostgreSQLStatementParser PARSER
Constructors
protected IntermediateStatement(ConnectionHandler connectionHandler, OptionsMetadata options, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement)
public IntermediateStatement(OptionsMetadata options, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement, ConnectionHandler connectionHandler)
Fields
protected final String command
Field Value |
---|
Type | Description |
String | |
protected String commandTag
Field Value |
---|
Type | Description |
String | |
protected final Connection connection
protected final ConnectionHandler connectionHandler
protected boolean described
protected PGException exception
protected boolean executed
protected Future<StatementResult> futureStatementResult
protected boolean hasMoreData
protected final OptionsMetadata options
protected final Statement originalStatement
Field Value |
---|
Type | Description |
com.google.cloud.spanner.Statement | |
protected final DataOutputStream outputStream
protected final AbstractStatementParser.ParsedStatement parsedStatement
protected StatementResult statementResult
Methods
Cleanly close the statement. Does nothing if the statement has not been executed or has no
result.
Exceptions |
---|
Type | Description |
Exception | if closing fails server-side.
|
public boolean containsResultSet()
Returns |
---|
Type | Description |
boolean | True if this is a select statement, false otherwise.
|
public WireOutput createDataRowResponse(Converter converter)
public WireOutput[] createResultPrefix(ResultSet resultSet)
Parameter |
---|
Name | Description |
resultSet | com.google.cloud.spanner.ResultSet
|
public WireOutput[] createResultSuffix()
public DescribeResult describe()
Moreso meant for inherited classes, allows one to call describe on a statement. Since raw
statements cannot be described, throw an error.
public Future<StatementResult> describeAsync(BackendConnection backendConnection)
public void executeAsync(BackendConnection backendConnection)
public String getCommand()
Returns |
---|
Type | Description |
String | the extracted command (first word) from the SQL statement.
|
public String getCommandTag()
Returns |
---|
Type | Description |
String | the extracted command (first word) from the really executed SQL statement.
|
public Connection getConnection()
public ConnectionHandler getConnectionHandler()
public PGException getException()
Returns any execution exception registered for this statement.
public short getResultFormatCode(int index)
Moreso intended for inherited classes (prepared statements et al) which allow the setting of
result format codes. Here we dafault to string.
Parameter |
---|
Name | Description |
index | int
|
Returns |
---|
Type | Description |
short | |
public String getStatement()
public StatementResult getStatementResult()
Returns the result of this statement as a StatementResult. Fails if the result is not
yet available.
public AbstractStatementParser.StatementType getStatementType()
public long getUpdateCount()
Returns |
---|
Type | Description |
long | The number of items that were modified by this execution for DML. 0 for DDL and -1 for
QUERY. Fails if the result is not yet available.
|
public long getUpdateCount(IntermediateStatement.ResultNotReadyBehavior resultNotReadyBehavior)
Returns |
---|
Type | Description |
long | The number of items that were modified by this execution for DML. 0 for DDL and -1 for
QUERY. Will block or fail depending on the given ResultNotReadyBehavior if the
result is not yet available.
|
public void handleExecutionException(PGException exception)
Clean up and save metadata when an exception occurs.
Parameter |
---|
Name | Description |
exception | PGException
The exception to store.
|
public boolean hasException()
Returns |
---|
Type | Description |
boolean | True if at some point in execution an exception was thrown. Fails if execution has not
yet finished.
|
public boolean hasException(IntermediateStatement.ResultNotReadyBehavior resultNotReadyBehavior)
Returns |
---|
Type | Description |
boolean | True if at some point in execution an exception was thrown. Fails or blocks depending
on the given ResultNotReadyBehavior if execution has not yet finished.
|
Whether this is a bound statement (i.e.: ready to execute)
Returns |
---|
Type | Description |
boolean | True if bound, false otherwise.
|
public boolean isDescribed()
public boolean isExecuted()
Returns |
---|
Type | Description |
boolean | True if this statement was executed, False otherwise.
|
public boolean isHasMoreData()
Returns |
---|
Type | Description |
boolean | True if only a subset of the available data has been returned.
|
protected void setFutureStatementResult(Future<StatementResult> result)
public void setHasMoreData(boolean hasMoreData)
Parameter |
---|
Name | Description |
hasMoreData | boolean
|
public void setStatementResult(StatementResult statementResult)