Package org.firebirdsql.jdbc

Class FBStatement

java.lang.Object

org.firebirdsql.jdbc.FBStatement

All Implemented Interfaces:

AutoCloseable, Statement, Wrapper, FirebirdStatement, Synchronizable

Direct Known Subclasses:

AbstractPreparedStatement

public class FBStatement
extends Object
implements FirebirdStatement, Synchronizable

Implementation of Statement.

Author:

David Jencks, Mark Rotteveel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	FBStatement.StatementResult	The current result of a statement.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	completed
protected final FBConnection	connection
protected FBStatement.StatementResult	currentStatementResult
protected FbStatement	fbStatement
protected int	fetchSize
protected SQLWarning	firstWarning
protected final GDSHelper	gdsHelper
protected boolean	isSingletonResult
protected static final JdbcVersionSupport	jdbcVersionSupport
protected int	maxRows
protected final List<RowValue>	specialResult
protected final FBObjectListener.StatementListener	statementListener

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FBStatement(GDSHelper c, int rsType, int rsConcurrency, int rsHoldability, FBObjectListener.StatementListener statementListener)

Method Summary

Modifier and Type	Method	Description
void	addBatch(String sql)
protected void	addWarning(SQLWarning warning)
void	cancel()
protected void	checkValidity()	Check if this statement is valid.
void	clearBatch()
void	clearWarnings()
void	close()
void	closeOnCompletion()
void	completeStatement()
void	completeStatement(CompletionReason reason)
protected StatementListener	createStatementListener()	Creates the StatementListener to be associated with the instance of FbStatement created for this FBStatement or subclasses.
String	enquoteIdentifier(String identifier, boolean alwaysQuote)	Returns a SQL identifier.
String	enquoteLiteral(String val)	Returns a String enclosed in single quotes.
String	enquoteNCharLiteral(String val)
final boolean	equals(Object other)
boolean	execute(String sql)
boolean	execute(String sql, int autoGeneratedKeys)
boolean	execute(String sql, int[] columnIndexes)
boolean	execute(String sql, String[] columnNames)
final int[]	executeBatch()
protected List<Long>	executeBatchInternal()
protected boolean	executeImpl(String sql)	Internal implementation of execute(String), so it can be used for normal queries and for queries returning generated keys.
final long[]	executeLargeBatch()
final long	executeLargeUpdate(String sql)
final long	executeLargeUpdate(String sql, int autoGeneratedKeys)
final long	executeLargeUpdate(String sql, int[] columnIndexes)
final long	executeLargeUpdate(String sql, String[] columnNames)
ResultSet	executeQuery(String sql)
int	executeUpdate(String sql)
int	executeUpdate(String sql, int autoGeneratedKeys)
int	executeUpdate(String sql, int[] columnIndexes)
int	executeUpdate(String sql, String[] columnNames)
protected void	finalize()
void	forgetResultSet()
Connection	getConnection()
ResultSet	getCurrentResultSet()	Get current result set.
int	getDeletedRowsCount()	Get number of deleted rows.
int	getFetchDirection()
int	getFetchSize()
ResultSet	getGeneratedKeys()
int	getInsertedRowsCount()	Get number of inserted rows.
long	getLargeMaxRows()
long	getLargeUpdateCount()
String	getLastExecutionPlan()	Get execution plan for the last executed statement.
String	getLastExplainedExecutionPlan()	Get detailed execution plan for the last executed statement.
final int	getLocalStatementId()	The local statement id is intended to identify the statement for internal implementation purposes.
int	getMaxFieldSize()
int	getMaxRows()
boolean	getMoreResults()
boolean	getMoreResults(int mode)
int	getQueryTimeout()
ResultSet	getResultSet()
ResultSet	getResultSet(boolean metaDataQuery)
int	getResultSetConcurrency()
int	getResultSetHoldability()
int	getResultSetType()
final Object	getSynchronizationObject()	Get synchronization object.
int	getUpdateCount()
int	getUpdatedRowsCount()	Get number of updated rows.
SQLWarning	getWarnings()
final int	hashCode()
boolean	hasOpenResultSet()	Check if this statement has open result set.
protected boolean	internalExecute(String sql)
boolean	isClosed()
boolean	isCloseOnCompletion()
protected boolean	isExecuteProcedureStatement(String sql)	This method checks if supplied statement is executing procedure or it is generic statement.
protected boolean	isGeneratedKeyQuery()
boolean	isPoolable()
boolean	isSimpleIdentifier(String identifier)
boolean	isValid()	Check if this statement is valid.
boolean	isWrapperFor(Class<?> iface)
protected String	nativeSQL(String sql)
protected void	notifyStatementCompleted()
protected void	notifyStatementCompleted(boolean success)
protected void	notifyStatementStarted()
protected void	notifyStatementStarted(boolean closeResultSet)
protected void	prepareFixedStatement(String sql)
protected FbStatement	requireStatement()
void	setCursorName(String name)
void	setEscapeProcessing(boolean enable)
void	setFetchDirection(int direction)
void	setFetchSize(int rows)
void	setLargeMaxRows(long max)
void	setMaxFieldSize(int max)
void	setMaxRows(int max)
void	setPoolable(boolean poolable)
void	setQueryTimeout(int seconds)
protected int[]	toArray(Collection<Long> updateCounts)	Convert collection of Long update counts into array of int.
protected long[]	toLargeArray(Collection<Long> updateCounts)	Convert collection of Integer update counts into array of int.
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

jdbcVersionSupport

protected static final JdbcVersionSupport jdbcVersionSupport

gdsHelper

protected final GDSHelper gdsHelper

statementListener

protected final FBObjectListener.StatementListener statementListener

fbStatement

protected FbStatement fbStatement

completed

protected boolean completed

firstWarning

protected SQLWarning firstWarning

currentStatementResult

protected FBStatement.StatementResult currentStatementResult

isSingletonResult

protected boolean isSingletonResult

specialResult

protected final List<RowValue> specialResult

maxRows

protected int maxRows

fetchSize

protected int fetchSize

connection

protected final FBConnection connection

Constructor Details

FBStatement

protected FBStatement(GDSHelper c,
 int rsType,
 int rsConcurrency,
 int rsHoldability,
 FBObjectListener.StatementListener statementListener)
               throws SQLException

Throws:

SQLException

Method Details

isValid

public boolean isValid()

Description copied from interface: FirebirdStatement

Check if this statement is valid.

Specified by:

isValid in interface FirebirdStatement

Returns:

true if statement is valid and can be used to execute SQL.

getSynchronizationObject

public final Object getSynchronizationObject()

Description copied from interface: Synchronizable

Get synchronization object.

Specified by:

getSynchronizationObject in interface Synchronizable

Returns:

object, cannot be null.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

completeStatement

public void completeStatement()
                       throws SQLException

Throws:

SQLException

completeStatement

public void completeStatement(CompletionReason reason)
                       throws SQLException

Throws:

SQLException

executeQuery

public ResultSet executeQuery(String sql)
                       throws SQLException

Specified by:

executeQuery in interface Statement

Throws:

SQLException

notifyStatementStarted

protected void notifyStatementStarted()
                               throws SQLException

Throws:

SQLException

notifyStatementStarted

protected void notifyStatementStarted(boolean closeResultSet)
                               throws SQLException

Throws:

SQLException

notifyStatementCompleted

protected void notifyStatementCompleted()
                                 throws SQLException

Throws:

SQLException

notifyStatementCompleted

protected void notifyStatementCompleted(boolean success)
                                 throws SQLException

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql,
 int autoGeneratedKeys)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql,
 int[] columnIndexes)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql,
 String[] columnNames)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql,
 int autoGeneratedKeys)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql,
 int[] columnIndexes)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql,
 String[] columnNames)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

getGeneratedKeys

public ResultSet getGeneratedKeys()
                           throws SQLException

Specified by:

getGeneratedKeys in interface Statement

Throws:

SQLException

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Statement

Throws:

SQLException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Statement

getMaxFieldSize

public int getMaxFieldSize()
                    throws SQLException

Specified by:

getMaxFieldSize in interface Statement

Throws:

SQLException

setMaxFieldSize

public void setMaxFieldSize(int max)
                     throws SQLException

Specified by:

setMaxFieldSize in interface Statement

Throws:

SQLException

getMaxRows

public int getMaxRows()
               throws SQLException

Specified by:

getMaxRows in interface Statement

Throws:

SQLException

setMaxRows

public void setMaxRows(int max)
                throws SQLException

Specified by:

setMaxRows in interface Statement

Throws:

SQLException

setEscapeProcessing

public void setEscapeProcessing(boolean enable)
                         throws SQLException

Specified by:

setEscapeProcessing in interface Statement

Throws:

SQLException

getQueryTimeout

public int getQueryTimeout()
                    throws SQLException

Firebird 4 and higher also support attachment level and global statement timeouts. This method only reports the value explicitly configured for this statement. In practice, a more stringent timeout might be applied by this attachment level or global statement timeout.

Specified by:

getQueryTimeout in interface Statement

Throws:

SQLException

See Also:

• setQueryTimeout(int)

setQueryTimeout

public void setQueryTimeout(int seconds)
                     throws SQLException

Query timeout is only supported on Firebird 4 and higher, and only for the pure-java wire protocol implementation. For earlier versions or native/embedded connections, the timeout is ignored. The maximum timeout for Firebird 4 is 4294967 seconds, higher values will be handled as if 0 was set. Firebird 4 also has attachment level and global statement timeouts. This configuration governs the statement level statement timeout only. In practice, a more stringent timeout might be applied by this attachment level or global statement timeout.

Important: Query timeouts in Firebird 4 and higher have an important caveat: for result set producing statements, the timeout covers the time from execution start until the cursor is closed. This includes the time that Firebird waits for your application to fetch more rows. This means that if you execute a SELECT and take your time processing the results, the statement may be cancelled even when Firebird itself returns rows quickly.

A query timeout is not applied for execution of DDL.

Specified by:

setQueryTimeout in interface Statement

Throws:

SQLException

cancel

public void cancel()
            throws SQLException

Specified by:

cancel in interface Statement

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Specified by:

getWarnings in interface Statement

Throws:

SQLException

clearWarnings

public void clearWarnings()
                   throws SQLException

Specified by:

clearWarnings in interface Statement

Throws:

SQLException

setCursorName

public void setCursorName(String name)
                   throws SQLException

Specified by:

setCursorName in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

executeImpl

protected boolean executeImpl(String sql)
                       throws SQLException

Internal implementation of execute(String), so it can be used for normal queries and for queries returning generated keys.

Throws:

SQLException

See Also:

• execute(String)

getResultSet

public ResultSet getResultSet()
                       throws SQLException

Specified by:

getResultSet in interface Statement

Throws:

SQLException

getResultSet

public ResultSet getResultSet(boolean metaDataQuery)
                       throws SQLException

Throws:

SQLException

hasOpenResultSet

public boolean hasOpenResultSet()

Description copied from interface: FirebirdStatement

Check if this statement has open result set. Note, this method works correctly if auto-commit is disabled. In auto-commit mode it will always return false because from the statement's point of view result set is not open (in auto-commit mode complete result set is fetched and cached in wrapping object before returning from the Statement.getResultSet() method).

Specified by:

hasOpenResultSet in interface FirebirdStatement

Returns:

true if there's already open result set associated with this statement, otherwise false.

getUpdateCount

public int getUpdateCount()
                   throws SQLException

Specified by:

getUpdateCount in interface Statement

Throws:

SQLException

getDeletedRowsCount

public int getDeletedRowsCount()
                        throws SQLException

Description copied from interface: FirebirdStatement

Get number of deleted rows. You can call this method multiple times, it does not affect the JDBC result number.

Specified by:

getDeletedRowsCount in interface FirebirdStatement

Returns:

number of deleted rows or -1 if current result is result set.

Throws:

SQLException - if database error occurs.

getInsertedRowsCount

public int getInsertedRowsCount()
                         throws SQLException

Description copied from interface: FirebirdStatement

Get number of inserted rows. You can call this method multiple times, it does not affect the JDBC result number.

Specified by:

getInsertedRowsCount in interface FirebirdStatement

Returns:

number of inserted rows or -1 if current result is result set.

Throws:

SQLException - if database error occurs.

getUpdatedRowsCount

public int getUpdatedRowsCount()
                        throws SQLException

Description copied from interface: FirebirdStatement

Get number of updated rows. You can call this method multiple times, it does not affect the JDBC result number.

Specified by:

getUpdatedRowsCount in interface FirebirdStatement

Returns:

number of updated rows or -1 if current result is result set.

Throws:

SQLException - if database error occurs.

getMoreResults

public boolean getMoreResults()
                       throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

getMoreResults

public boolean getMoreResults(int mode)
                       throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

setFetchDirection

public void setFetchDirection(int direction)
                       throws SQLException

Specified by:

setFetchDirection in interface Statement

Throws:

SQLException

getFetchDirection

public int getFetchDirection()
                      throws SQLException

Specified by:

getFetchDirection in interface Statement

Throws:

SQLException

setFetchSize

public void setFetchSize(int rows)
                  throws SQLException

Specified by:

setFetchSize in interface Statement

Throws:

SQLException

getFetchSize

public int getFetchSize()
                 throws SQLException

Specified by:

getFetchSize in interface Statement

Throws:

SQLException

getResultSetConcurrency

public int getResultSetConcurrency()
                            throws SQLException

Specified by:

getResultSetConcurrency in interface Statement

Throws:

SQLException

getResultSetType

public int getResultSetType()
                     throws SQLException

Specified by:

getResultSetType in interface Statement

Throws:

SQLException

getResultSetHoldability

public int getResultSetHoldability()
                            throws SQLException

Specified by:

getResultSetHoldability in interface Statement

Throws:

SQLException

addBatch

public void addBatch(String sql)
              throws SQLException

Specified by:

addBatch in interface Statement

Throws:

SQLException

clearBatch

public void clearBatch()
                throws SQLException

Specified by:

clearBatch in interface Statement

Throws:

SQLException

executeBatch

public final int[] executeBatch()
                         throws SQLException

Specified by:

executeBatch in interface Statement

Throws:

SQLException

executeBatchInternal

protected List<Long> executeBatchInternal()
                                   throws SQLException

Throws:

SQLException

toArray

protected int[] toArray(Collection<Long> updateCounts)

Convert collection of Long update counts into array of int.

Parameters:

updateCounts - collection of integer elements.

Returns:

array of int.

toLargeArray

protected long[] toLargeArray(Collection<Long> updateCounts)

Convert collection of Integer update counts into array of int.

Parameters:

updateCounts - collection of integer elements.

Returns:

array of int.

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface Statement

Throws:

SQLException

forgetResultSet

public void forgetResultSet()

getCurrentResultSet

public ResultSet getCurrentResultSet()
                              throws SQLException

Description copied from interface: FirebirdStatement

Get current result set. Behaviour of this method is similar to the behavior of the Statement.getResultSet(), except that this method can be called as much as you like.

Specified by:

getCurrentResultSet in interface FirebirdStatement

Returns:

instance of ResultSet representing current result set or null if it is not available.

Throws:

SQLException - if database access error happened.

isPoolable

public boolean isPoolable()
                   throws SQLException

Specified by:

isPoolable in interface Statement

Throws:

SQLException

setPoolable

public void setPoolable(boolean poolable)
                 throws SQLException

Specified by:

setPoolable in interface Statement

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

closeOnCompletion

public void closeOnCompletion()

Specified by:

closeOnCompletion in interface Statement

isCloseOnCompletion

public boolean isCloseOnCompletion()

Specified by:

isCloseOnCompletion in interface Statement

isExecuteProcedureStatement

protected boolean isExecuteProcedureStatement(String sql)
                                       throws SQLException

This method checks if supplied statement is executing procedure or it is generic statement. This check is needed to handle correctly parameters that are returned from non-selectable procedures.

Parameters:

sql - SQL statement to check

Returns:

true if supplied statement is EXECUTE PROCEDURE type of statement.

Throws:

SQLException - if translating statement into native code failed.

internalExecute

protected boolean internalExecute(String sql)
                           throws SQLException

Throws:

SQLException

prepareFixedStatement

protected void prepareFixedStatement(String sql)
                              throws SQLException

Throws:

SQLException

requireStatement

protected FbStatement requireStatement()
                                throws SQLException

Throws:

SQLException

addWarning

protected void addWarning(SQLWarning warning)

nativeSQL

protected String nativeSQL(String sql)
                    throws SQLException

Throws:

SQLException

isGeneratedKeyQuery

protected boolean isGeneratedKeyQuery()

Returns:

true when the current statement is expected to return generated keys, false otherwise.

getLastExecutionPlan

public String getLastExecutionPlan()
                            throws SQLException

Description copied from interface: FirebirdStatement

Get execution plan for the last executed statement. Unlike the FirebirdPreparedStatement.getExecutionPlan(), this method can be called only after executing a query or update statement.

Specified by:

getLastExecutionPlan in interface FirebirdStatement

Returns:

execution plan returned by the server.

Throws:

SQLException - if no statement was executed before calling this method, statement is not valid, or there was an error when obtaining the execution plan.

getLastExplainedExecutionPlan

public String getLastExplainedExecutionPlan()
                                     throws SQLException

Description copied from interface: FirebirdStatement

Get detailed execution plan for the last executed statement. More structured and comprehensible form. Can be called only after executing a query or update statement.

Specified by:

getLastExplainedExecutionPlan in interface FirebirdStatement

Returns:

detailed execution plan returned by the server.

Throws:

SQLException - if no statement was executed before calling this method, statement is not valid, or there was an error when obtaining the execution plan.

checkValidity

protected void checkValidity()
                      throws SQLException

Check if this statement is valid. This method should be invoked before executing any action which requires a valid connection.

Throws:

SQLException - if this Statement has been closed and cannot be used anymore.

getLargeUpdateCount

public long getLargeUpdateCount()
                         throws SQLException

Specified by:

getLargeUpdateCount in interface Statement

Throws:

SQLException

setLargeMaxRows

public void setLargeMaxRows(long max)
                     throws SQLException

Jaybird does not support maxRows exceeding Integer.MAX_VALUE, if a larger value is set, Jaybird will add a warning to the statement and reset the maximum to 0.

Specified by:

setLargeMaxRows in interface Statement

Throws:

SQLException

getLargeMaxRows

public long getLargeMaxRows()
                     throws SQLException

Jaybird does not support maxRows exceeding Integer.MAX_VALUE, the return value of this method is the same as getMaxRows().

Specified by:

getLargeMaxRows in interface Statement

Throws:

SQLException

executeLargeBatch

public final long[] executeLargeBatch()
                               throws SQLException

Specified by:

executeLargeBatch in interface Statement

Throws:

SQLException

executeLargeUpdate

public final long executeLargeUpdate(String sql)
                              throws SQLException

Specified by:

executeLargeUpdate in interface Statement

Throws:

SQLException

executeLargeUpdate

public final long executeLargeUpdate(String sql,
 int autoGeneratedKeys)
                              throws SQLException

Specified by:

executeLargeUpdate in interface Statement

Throws:

SQLException

executeLargeUpdate

public final long executeLargeUpdate(String sql,
 int[] columnIndexes)
                              throws SQLException

Specified by:

executeLargeUpdate in interface Statement

Throws:

SQLException

executeLargeUpdate

public final long executeLargeUpdate(String sql,
 String[] columnNames)
                              throws SQLException

Specified by:

executeLargeUpdate in interface Statement

Throws:

SQLException

enquoteLiteral

public String enquoteLiteral(String val)
                      throws SQLException

Returns a String enclosed in single quotes. Any occurrence of a single quote within the string will be replaced by two single quotes.

For a dialect 3 database, this will behave exactly like the JDBC 4.3 default implementation. For a dialect 1 database this will quote literals with double quotes and escape double quotes by doubling.

Specified by:

enquoteLiteral in interface Statement

Parameters:

val - a character string

Returns:

A string enclosed by single quotes with every single quote converted to two single quotes

Throws:

NullPointerException - if val is null

SQLException - if a database access error occurs

enquoteNCharLiteral

public String enquoteNCharLiteral(String val)
                           throws SQLException

Specified by:

enquoteNCharLiteral in interface Statement

Throws:

SQLException

See Also:

• enquoteLiteral(String)

enquoteIdentifier

public String enquoteIdentifier(String identifier,
 boolean alwaysQuote)
                         throws SQLException

Returns a SQL identifier. If identifier is a simple SQL identifier:

• Return the original value if alwaysQuote is false
• Return a delimited identifier if alwaysQuote is true

Specified by:

enquoteIdentifier in interface Statement

Parameters:

identifier - a SQL identifier

alwaysQuote - indicates if a simple SQL identifier should be returned as a quoted identifier

Returns:

A simple SQL identifier or a delimited identifier

Throws:

SQLException - if identifier is not a valid identifier

SQLFeatureNotSupportedException - if the datasource does not support delimited identifiers (ie: a dialect 1 database)

NullPointerException - if identifier is null

isSimpleIdentifier

public boolean isSimpleIdentifier(String identifier)
                           throws SQLException

Specified by:

isSimpleIdentifier in interface Statement

Throws:

SQLException

getLocalStatementId

public final int getLocalStatementId()

Description copied from interface: FirebirdStatement

The local statement id is intended to identify the statement for internal implementation purposes.

NOTE: This method is only included in this interface to try and avoid problems with proxied and bytecode enhanced classes in certain libraries, you should normally have no reason to call this method directly.

The id is expected - but not guaranteed - to be unique for a single connection, and - preferably - for the entire JVM run time as well.

Specified by:

getLocalStatementId in interface FirebirdStatement

Returns:

The local statement id.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

createStatementListener

protected StatementListener createStatementListener()

Creates the StatementListener to be associated with the instance of FbStatement created for this FBStatement or subclasses.

Returns:

instance of StatementListener