Package org.apache.derby.impl.jdbc

Class EmbedStatement

    • Constructor Summary

      Constructors 
      Constructor Description
      EmbedStatement​(EmbedConnection connection, boolean forMetaData, int resultSetType, int resultSetConcurrency, int resultSetHoldability)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addBatch​(java.lang.String sql)
      JDBC 2.0 Adds a SQL command to the current batch of commmands for the statement.
      (package private) void addWarning​(java.sql.SQLWarning sw)
      Add a SQLWarning to this Statement object.
      void cancel()
      Cancel can be used by one thread to cancel a statement that is being executed by another thread.
      (package private) void checkExecStatus()
      A heavier weight version of checkStatus() that ensures the application's Connection object is still open.
      (package private) void checkIfInMiddleOfBatch()  
      (package private) void checkRequiresCallableStatement​(Activation activation)
      Check to see if a statement requires to be executed via a callable statement.
      (package private) void checkStatus()
      Throw an exception if this Statement has been closed explictly or it has noticed it has been closed implicitly.
      void clearBatch()
      JDBC 2.0 Make the set of commands in the current batch empty.
      (package private) void clearResultSets()
      Close and clear all result sets associated with this statement from the last execution.
      private void clearResultSetsMinion()  
      void clearWarnings()
      After this call getWarnings returns null until a new warning is reported for this Statement.
      void close()
      In many cases, it is desirable to immediately release a Statements's database and JDBC resources instead of waiting for this to happen when it is automatically closed; the close method provides this immediate release.
      (package private) void closeActions()  
      (package private) void closeMeOnCompletion()  
      void closeOnCompletion()  
      boolean execute​(java.lang.String sql)
      Execute a SQL statement that may return multiple results.
      private boolean execute​(java.lang.String sql, boolean executeQuery, boolean executeUpdate, int autoGeneratedKeys, int[] columnIndexes, java.lang.String[] columnNames)
      Execute a SQL statement that may return multiple results.
      boolean execute​(java.lang.String sql, int autoGeneratedKeys)
      JDBC 3.0 Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval.
      boolean execute​(java.lang.String sql, int[] columnIndexes)
      JDBC 3.0 Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
      boolean execute​(java.lang.String sql, java.lang.String[] columnNames)
      JDBC 3.0 Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
      int[] executeBatch()
      JDBC 2.0 Submit a batch of commands to the database for execution.
      (package private) boolean executeBatchElement​(java.lang.Object batchElement)
      Execute a single element of the batch.
      long[] executeLargeBatch()
      JDBC 4.2 Submit a batch of commands to the database for execution.
      long executeLargeUpdate​(java.lang.String sql)
      JDBC 4.2 Execute a SQL INSERT, UPDATE or DELETE statement.
      long executeLargeUpdate​(java.lang.String sql, int autoGeneratedKeys)
      JDBC 4.2 Execute the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement object should be made available for retrieval.
      long executeLargeUpdate​(java.lang.String sql, int[] columnIndexes)
      JDBC 4.2 Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
      long executeLargeUpdate​(java.lang.String sql, java.lang.String[] columnNames)
      JDBC 4.2 Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
      java.sql.ResultSet executeQuery​(java.lang.String sql)
      Execute a SQL statement that returns a single ResultSet.
      (package private) boolean executeStatement​(Activation a, boolean executeQuery, boolean executeUpdate)
      Execute the current statement.
      int executeUpdate​(java.lang.String sql)
      Execute a SQL INSERT, UPDATE or DELETE statement.
      int executeUpdate​(java.lang.String sql, int autoGeneratedKeys)
      JDBC 3.0 Execute the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement object should be made available for retrieval.
      int executeUpdate​(java.lang.String sql, int[] columnIndexes)
      JDBC 3.0 Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
      int executeUpdate​(java.lang.String sql, java.lang.String[] columnNames)
      JDBC 3.0 Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
      protected void finalize()
      Mark the statement and its single-use activation as unused.
      java.sql.Connection getConnection()
      JDBC 2.0 Return the Connection that produced the Statement.
      private boolean getExecuteHoldable()
      Get the execute time holdability for the Statement.
      int getFetchDirection()
      JDBC 2.0 Determine the fetch direction.
      int getFetchSize()
      JDBC 2.0 Determine the default fetch size.
      java.sql.ResultSet getGeneratedKeys()
      JDBC 3.0 Retrieves any auto-generated keys created as a result of executing this Statement object.
      long getLargeMaxRows()
      JDBC 4.2 The maxRows limit is the maximum number of rows that a ResultSet can contain.
      long getLargeUpdateCount()
      JDBC 4.2 getLargeUpdateCount returns the current result as an update count; if the result is a ResultSet or there are no more results -1 is returned.
      int getMaxFieldSize()
      The maxFieldSize limit (in bytes) is the maximum amount of data returned for any column value; it only applies to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns.
      int getMaxRows()
      The maxRows limit is the maximum number of rows that a ResultSet can contain.
      boolean getMoreResults()
      getMoreResults moves to a Statement's next result.
      boolean getMoreResults​(int current)
      JDBC 3.0 Moves to this Statement obect's next result, deals with any current ResultSet object(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object
      ParameterValueSet getParameterValueSet()  
      int getQueryTimeout()
      The queryTimeout limit is the number of seconds the driver will wait for a Statement to execute.
      java.sql.ResultSet getResultSet()
      getResultSet returns the current result as a ResultSet.
      int getResultSetConcurrency()
      JDBC 2.0 Determine the result set concurrency.
      int getResultSetHoldability()
      JDBC 3.0 Retrieves the result set holdability for ResultSet objects generated by this Statement object.
      int getResultSetType()
      JDBC 2.0 Determine the result set type.
      java.lang.String getSQLText()  
      int getUpdateCount()
      getUpdateCount returns the current result as an update count; if the result is a ResultSet or there are no more results -1 is returned.
      java.sql.SQLWarning getWarnings()
      The first warning reported by calls on this Statement is returned.
      boolean isClosed()
      Tell whether this statment has been closed or not.
      boolean isCloseOnCompletion()  
      private boolean isOpen​(EmbedResultSet rs)  
      boolean isPoolable()
      Returns the value of the EmbedStatement's poolable hint, indicating whether pooling is requested.
      boolean isWrapperFor​(java.lang.Class<?> interfaces)
      Returns false unless interfaces is implemented.
      (package private) static EmbedResultSet processDynamicResult​(EmbedConnection conn, java.sql.ResultSet resultSet, EmbedStatement callStatement)
      Process a ResultSet created in a Java procedure as a dynamic result.
      private int processDynamicResults​(java.sql.ResultSet[][] holder, int maxDynamicResultSets)
      Go through a holder of dynamic result sets, remove those that should not be returned, and sort the result sets according to their creation.
      (package private) void resultSetClosing​(EmbedResultSet closingLRS)
      Callback on the statement when one of its result sets is closed.
      void setApplicationStatement​(EngineStatement s)
      Set the application statement for this Statement.
      void setCursorName​(java.lang.String name)
      setCursorName defines the SQL cursor name that will be used by subsequent Statement execute methods.
      void setEscapeProcessing​(boolean enable)
      If escape scanning is on (the default) the driver will do escape substitution before sending the SQL to the database.
      void setFetchDirection​(int direction)
      JDBC 2.0 Give a hint as to the direction in which the rows in a result set will be processed.
      void setFetchSize​(int rows)
      JDBC 2.0 Give the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed.
      void setLargeMaxRows​(long max)
      The maxRows limit is set to limit the number of rows that any ResultSet can contain.
      void setMaxFieldSize​(int max)
      The maxFieldSize limit (in bytes) is set to limit the size of data that can be returned for any column value; it only applies to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR fields.
      void setMaxRows​(int max)
      The maxRows limit is set to limit the number of rows that any ResultSet can contain.
      void setPoolable​(boolean poolable)
      Requests that an EmbedStatement be pooled or not.
      void setQueryTimeout​(int seconds)
      The queryTimeout limit is the number of seconds the driver will wait for a Statement to execute.
      void transferBatch​(EmbedStatement other)
      Transfer my batch of Statements to a newly created Statement.
      <T> T unwrap​(java.lang.Class<T> interfaces)
      Returns this if this class implements the interface.

      • Methods inherited from class java.lang.Object

        clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.sql.Statement

        enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, isSimpleIdentifier

    • Field Detail

      • applicationConnection

        private final java.sql.Connection applicationConnection

      • applicationStatement

        protected EngineStatement applicationStatement
        Statement reference the application is using to execute this Statement. Normally set to this, but if this was created by a Connection from an XAConnection then this will be a reference to the BrokeredStatement. Making it protected to allow access from EmbedPreparedStatement40 to be used for StatementEvents

      • updateCount

        long updateCount

      • autoGeneratedKeysResultSet

        private java.sql.ResultSet autoGeneratedKeysResultSet

      • cursorName

        private java.lang.String cursorName

      • forMetaData

        private final boolean forMetaData

      • resultSetType

        final int resultSetType

      • resultSetConcurrency

        final int resultSetConcurrency

      • resultSetHoldability

        private final int resultSetHoldability

      • warnings

        private java.sql.SQLWarning warnings

      • SQLText

        java.lang.String SQLText

      • fetchSize

        private int fetchSize

      • fetchDirection

        private int fetchDirection

      • MaxFieldSize

        int MaxFieldSize

      • timeoutMillis

        long timeoutMillis
        Query timeout in milliseconds. By default, no statements time out. Timeout is set explicitly with setQueryTimeout().

      • active

        private boolean active

      • batchStatements

        java.util.Vector<java.lang.Object> batchStatements

      • maxRows

        long maxRows

      • isPoolable

        protected boolean isPoolable

      • closeOnCompletion

        private boolean closeOnCompletion

      • closingResultSets

        private boolean closingResultSets

      • currentDynamicResultSet

        private int currentDynamicResultSet

    • Constructor Detail

      • EmbedStatement

        public EmbedStatement​(EmbedConnection connection,
                      boolean forMetaData,
                      int resultSetType,
                      int resultSetConcurrency,
                      int resultSetHoldability)

    • Method Detail

      • executeQuery

        public java.sql.ResultSet executeQuery​(java.lang.String sql)
                                throws java.sql.SQLException
        Execute a SQL statement that returns a single ResultSet.
        Specified by:
        executeQuery in interface java.sql.Statement
        Parameters:
        sql - typically this is a static SQL SELECT statement
        Returns:
        a ResultSet that contains the data produced by the query; never null
        Throws:
        java.sql.SQLException - thrown on failure.

      • executeUpdate

        public int executeUpdate​(java.lang.String sql)
                  throws java.sql.SQLException
        Execute a SQL INSERT, UPDATE or DELETE statement. In addition, SQL statements that return nothing such as SQL DDL statements can be executed.
        Specified by:
        executeUpdate in interface java.sql.Statement
        Parameters:
        sql - a SQL INSERT, UPDATE or DELETE statement or a SQL statement that returns nothing
        Returns:
        either the row count for INSERT, UPDATE or DELETE; or 0 for SQL statements that return nothing
        Throws:
        java.sql.SQLException - thrown on failure.

      • executeLargeUpdate

        public long executeLargeUpdate​(java.lang.String sql)
                        throws java.sql.SQLException
        JDBC 4.2 Execute a SQL INSERT, UPDATE or DELETE statement. For use with statements which may touch more than Integer.MAX_VALUE rows.
        Specified by:
        executeLargeUpdate in interface EngineStatement
        Specified by:
        executeLargeUpdate in interface java.sql.Statement
        Throws:
        java.sql.SQLException

      • executeUpdate

        public int executeUpdate​(java.lang.String sql,
                         int autoGeneratedKeys)
                  throws java.sql.SQLException
        JDBC 3.0 Execute the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement object should be made available for retrieval.
        Specified by:
        executeUpdate in interface java.sql.Statement
        Parameters:
        sql - a SQL INSERT, UPDATE or DELETE statement or a SQL statement that returns nothing
        autoGeneratedKeys - - a flag indicating whether auto-generated keys should be made available for retrieval; one of the following constants: Statement.RETURN_GENERATED_KEYS Statement.NO_GENERATED_KEYS
        Returns:
        either the row count for INSERT, UPDATE or DELETE; or 0 for SQL statements that return nothing
        Throws:
        java.sql.SQLException - if a database access error occurs

      • executeLargeUpdate

        public long executeLargeUpdate​(java.lang.String sql,
                               int autoGeneratedKeys)
                        throws java.sql.SQLException
        JDBC 4.2 Execute the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement object should be made available for retrieval. For use with statements which may touch more than Integer.MAX_VALUE rows.
        Specified by:
        executeLargeUpdate in interface EngineStatement
        Specified by:
        executeLargeUpdate in interface java.sql.Statement
        Throws:
        java.sql.SQLException

      • executeUpdate

        public int executeUpdate​(java.lang.String sql,
                         int[] columnIndexes)
                  throws java.sql.SQLException
        JDBC 3.0 Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. The driver will ignore the array if the SQL statement is not an INSERT statement
        Specified by:
        executeUpdate in interface java.sql.Statement
        Parameters:
        sql - a SQL INSERT, UPDATE or DELETE statement or a SQL statement that returns nothing
        columnIndexes - - an array of column indexes indicating the columns that should be returned from the inserted row
        Returns:
        either the row count for INSERT, UPDATE or DELETE; or 0 for SQL statements that return nothing
        Throws:
        java.sql.SQLException - if a database access error occurs

      • executeLargeUpdate

        public long executeLargeUpdate​(java.lang.String sql,
                               int[] columnIndexes)
                        throws java.sql.SQLException
        JDBC 4.2 Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. The driver will ignore the array if the SQL statement is not an INSERT/UPDATE statement. For use with statements which may touch more than Integer.MAX_VALUE rows.
        Specified by:
        executeLargeUpdate in interface EngineStatement
        Specified by:
        executeLargeUpdate in interface java.sql.Statement
        Throws:
        java.sql.SQLException

      • executeUpdate

        public int executeUpdate​(java.lang.String sql,
                         java.lang.String[] columnNames)
                  throws java.sql.SQLException
        JDBC 3.0 Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. The driver will ignore the array if the SQL statement is not an INSERT statement
        Specified by:
        executeUpdate in interface java.sql.Statement
        Parameters:
        sql - a SQL INSERT, UPDATE or DELETE statement or a SQL statement that returns nothing
        columnNames - - an array of the names of the columns that should be returned from the inserted row
        Returns:
        either the row count for INSERT, UPDATE or DELETE; or 0 for SQL statements that return nothing
        Throws:
        java.sql.SQLException - if a database access error occurs

      • executeLargeUpdate

        public long executeLargeUpdate​(java.lang.String sql,
                               java.lang.String[] columnNames)
                        throws java.sql.SQLException
        JDBC 4.2 Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. The driver will ignore the array if the SQL statement is not an INSERT/UPDATE statement. For use with statements which may touch more than Integer.MAX_VALUE rows.
        Specified by:
        executeLargeUpdate in interface EngineStatement
        Specified by:
        executeLargeUpdate in interface java.sql.Statement
        Throws:
        java.sql.SQLException

      • checkIfInMiddleOfBatch

        final void checkIfInMiddleOfBatch()
                           throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • isClosed

        public boolean isClosed()
                 throws java.sql.SQLException
        Tell whether this statment has been closed or not.
        Specified by:
        isClosed in interface java.sql.Statement
        Returns:
        true is closed, false otherwise.
        Throws:
        java.sql.SQLException - if a database access error occurs.

      • close

        public final void close()
                 throws java.sql.SQLException
        In many cases, it is desirable to immediately release a Statements's database and JDBC resources instead of waiting for this to happen when it is automatically closed; the close method provides this immediate release.

        Note: A Statement is automatically closed when it is garbage collected. When a Statement is closed its current ResultSet, if one exists, is also closed.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.sql.Statement
        Throws:
        java.sql.SQLException - thrown on failure.

      • finalize

        protected void finalize()
                 throws java.lang.Throwable
        Mark the statement and its single-use activation as unused. This method should be called from EmbedPreparedStatement's finalizer as well, even though prepared statements reuse activations, since getGeneratedKeys() uses a single-use activation regardless of statement type.
        Dynamic result sets (those in dynamicResults array) need not be handled here as they will be handled by the statement object that created them. In some cases results will point to a ResultSet in dynamicResults but all that will happen is that the activation will get marked as unused twice.
        Overrides:
        finalize in class java.lang.Object
        Throws:
        java.lang.Throwable

      • closeActions

        void closeActions()
           throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getMaxFieldSize

        public int getMaxFieldSize()
                    throws java.sql.SQLException
        The maxFieldSize limit (in bytes) is the maximum amount of data returned for any column value; it only applies to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.
        Specified by:
        getMaxFieldSize in interface java.sql.Statement
        Returns:
        the current max column size limit; zero means unlimited
        Throws:
        java.sql.SQLException - thrown on failure.

      • setMaxFieldSize

        public void setMaxFieldSize​(int max)
                     throws java.sql.SQLException
        The maxFieldSize limit (in bytes) is set to limit the size of data that can be returned for any column value; it only applies to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR fields. If the limit is exceeded, the excess data is silently discarded.
        Specified by:
        setMaxFieldSize in interface java.sql.Statement
        Parameters:
        max - the new max column size limit; zero means unlimited
        Throws:
        java.sql.SQLException - thrown on failure.

      • getMaxRows

        public int getMaxRows()
               throws java.sql.SQLException
        The maxRows limit is the maximum number of rows that a ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped.
        Specified by:
        getMaxRows in interface java.sql.Statement
        Returns:
        the current max row limit; zero means unlimited
        Throws:
        java.sql.SQLException - thrown on failure.

      • getLargeMaxRows

        public long getLargeMaxRows()
                     throws java.sql.SQLException
        JDBC 4.2 The maxRows limit is the maximum number of rows that a ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped. For use with statements which may touch more than Integer.MAX_VALUE rows.
        Specified by:
        getLargeMaxRows in interface EngineStatement
        Specified by:
        getLargeMaxRows in interface java.sql.Statement
        Returns:
        the current max row limit; zero means unlimited
        Throws:
        java.sql.SQLException - thrown on failure.

      • setMaxRows

        public void setMaxRows​(int max)
                throws java.sql.SQLException
        The maxRows limit is set to limit the number of rows that any ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped.
        Specified by:
        setMaxRows in interface java.sql.Statement
        Parameters:
        max - the new max rows limit; zero means unlimited
        Throws:
        java.sql.SQLException - thrown on failure.

      • setLargeMaxRows

        public void setLargeMaxRows​(long max)
                     throws java.sql.SQLException
        The maxRows limit is set to limit the number of rows that any ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped.
        Specified by:
        setLargeMaxRows in interface EngineStatement
        Specified by:
        setLargeMaxRows in interface java.sql.Statement
        Parameters:
        max - the new max rows limit; zero means unlimited
        Throws:
        java.sql.SQLException - thrown on failure.

      • setEscapeProcessing

        public void setEscapeProcessing​(boolean enable)
                         throws java.sql.SQLException
        If escape scanning is on (the default) the driver will do escape substitution before sending the SQL to the database.
        Specified by:
        setEscapeProcessing in interface java.sql.Statement
        Parameters:
        enable - true to enable; false to disable
        Throws:
        java.sql.SQLException - thrown on failure.

      • getQueryTimeout

        public final int getQueryTimeout()
                          throws java.sql.SQLException
        The queryTimeout limit is the number of seconds the driver will wait for a Statement to execute. If the limit is exceeded a SQLException is thrown.
        Specified by:
        getQueryTimeout in interface java.sql.Statement
        Returns:
        the current query timeout limit in seconds; zero means unlimited
        Throws:
        java.sql.SQLException - thrown on failure.

      • setQueryTimeout

        public final void setQueryTimeout​(int seconds)
                           throws java.sql.SQLException
        The queryTimeout limit is the number of seconds the driver will wait for a Statement to execute. If the limit is exceeded a SQLException is thrown.
        Specified by:
        setQueryTimeout in interface java.sql.Statement
        Parameters:
        seconds - the new query timeout limit in seconds; zero means unlimited
        Throws:
        java.sql.SQLException - thrown on failure.

      • cancel

        public void cancel()
            throws java.sql.SQLException
        Cancel can be used by one thread to cancel a statement that is being executed by another thread.
        Specified by:
        cancel in interface java.sql.Statement
        Throws:
        java.sql.SQLException - thrown on failure.

      • getWarnings

        public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException
        The first warning reported by calls on this Statement is returned. A Statment's execute methods clear its SQLWarning chain. Subsequent Statement warnings will be chained to this SQLWarning.

        The warning chain is automatically cleared each time a statement is (re)executed.

        Note: If you are processing a ResultSet then any warnings associated with ResultSet reads will be chained on the ResultSet object.

        Specified by:
        getWarnings in interface java.sql.Statement
        Returns:
        the first SQLWarning or null
        Throws:
        java.sql.SQLException - thrown on failure.

      • clearWarnings

        public void clearWarnings()
                   throws java.sql.SQLException
        After this call getWarnings returns null until a new warning is reported for this Statement.
        Specified by:
        clearWarnings in interface java.sql.Statement
        Throws:
        java.sql.SQLException - thrown on failure.

      • setCursorName

        public void setCursorName​(java.lang.String name)
                   throws java.sql.SQLException
        setCursorName defines the SQL cursor name that will be used by subsequent Statement execute methods. This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database doesn't support positioned update/delete, this method is a noop.

        Note: By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, cursor names must be unique within a Connection.

        Specified by:
        setCursorName in interface java.sql.Statement
        Parameters:
        name - the new cursor name.
        Throws:
        java.sql.SQLException

      • execute

        public boolean execute​(java.lang.String sql)
                throws java.sql.SQLException
        Execute a SQL statement that may return multiple results. Under some (uncommon) situations a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this, unless you're executing a stored procedure that you know may return multiple results, or unless you're dynamically executing an unknown SQL string. The "execute", "getMoreResults", "getResultSet" and "getUpdateCount" methods let you navigate through multiple results. The "execute" method executes a SQL statement and indicates the form of the first result. You can then use getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s).
        Specified by:
        execute in interface java.sql.Statement
        Parameters:
        sql - any SQL statement
        Returns:
        true if the first result is a ResultSet; false if it is an integer
        Throws:
        java.sql.SQLException - thrown on failure
        See Also:
        getResultSet(), getUpdateCount(), getMoreResults()

      • execute

        private boolean execute​(java.lang.String sql,
                        boolean executeQuery,
                        boolean executeUpdate,
                        int autoGeneratedKeys,
                        int[] columnIndexes,
                        java.lang.String[] columnNames)
                 throws java.sql.SQLException
        Execute a SQL statement that may return multiple results. Under some (uncommon) situations a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this, unless you're executing a stored procedure that you know may return multiple results, or unless you're dynamically executing an unknown SQL string. The "execute", "getMoreResults", "getResultSet" and "getUpdateCount" methods let you navigate through multiple results. The "execute" method executes a SQL statement and indicates the form of the first result. You can then use getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s).
        Parameters:
        sql - any SQL statement
        executeQuery - caller is executeQuery()
        executeUpdate - caller is executeUpdate()
        autoGeneratedKeys -
        columnIndexes -
        columnNames -
        Returns:
        true if the first result is a ResultSet; false if it is an integer
        Throws:
        java.sql.SQLException - thrown on failure
        See Also:
        getResultSet(), getUpdateCount(), getMoreResults()

      • execute

        public boolean execute​(java.lang.String sql,
                       int autoGeneratedKeys)
                throws java.sql.SQLException
        JDBC 3.0 Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval. The driver will ignore this signal if the SQL statement is not an INSERT/UPDATE statement.
        Specified by:
        execute in interface java.sql.Statement
        Parameters:
        sql - any SQL statement
        autoGeneratedKeys - - a constant indicating whether auto-generated keys should be made available for retrieval using the method getGeneratedKeys; one of the following constants: Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS
        Returns:
        rue if the first result is a ResultSet object; false if it is an update count or there are no results
        Throws:
        java.sql.SQLException - if a database access error occurs

      • execute

        public boolean execute​(java.lang.String sql,
                       int[] columnIndexes)
                throws java.sql.SQLException
        JDBC 3.0 Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the given SQL statement is not an INSERT/UPDATE statement.
        Specified by:
        execute in interface java.sql.Statement
        Parameters:
        sql - any SQL statement
        columnIndexes - - an array of the indexes of the columns in the inserted/updated row that should be made available for retrieval by a call to the method getGeneratedKeys
        Returns:
        rue if the first result is a ResultSet object; false if it is an update count or there are no results
        Throws:
        java.sql.SQLException - if a database access error occurs

      • execute

        public boolean execute​(java.lang.String sql,
                       java.lang.String[] columnNames)
                throws java.sql.SQLException
        JDBC 3.0 Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the names of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the given SQL statement is not an INSERT/UPDATE statement.
        Specified by:
        execute in interface java.sql.Statement
        Parameters:
        sql - any SQL statement
        columnNames - - an array of the names of the columns in the inserted/updated row that should be made available for retrieval by a call to the method getGeneratedKeys
        Returns:
        rue if the first result is a ResultSet object; false if it is an update count or there are no results
        Throws:
        java.sql.SQLException - if a database access error occurs

      • getResultSet

        public final java.sql.ResultSet getResultSet()
                                      throws java.sql.SQLException
        getResultSet returns the current result as a ResultSet. It should only be called once per result.
        Specified by:
        getResultSet in interface java.sql.Statement
        Returns:
        the current result as a ResultSet; null if the result is an update count or there are no more results or the statement was closed.
        Throws:
        java.sql.SQLException
        See Also:
        execute(java.lang.String)

      • getUpdateCount

        public final int getUpdateCount()
                         throws java.sql.SQLException
        getUpdateCount returns the current result as an update count; if the result is a ResultSet or there are no more results -1 is returned. It should only be called once per result.

        The only way to tell for sure that the result is an update count is to first test to see if it is a ResultSet. If it is not a ResultSet it is either an update count or there are no more results.

        Specified by:
        getUpdateCount in interface java.sql.Statement
        Returns:
        the current result as an update count; -1 if it is a ResultSet or there are no more results
        Throws:
        java.sql.SQLException
        See Also:
        execute(java.lang.String)

      • getLargeUpdateCount

        public final long getLargeUpdateCount()
                               throws java.sql.SQLException
        JDBC 4.2 getLargeUpdateCount returns the current result as an update count; if the result is a ResultSet or there are no more results -1 is returned. It should only be called once per result. For use with statements which may touch more than Integer.MAX_VALUE rows.
        Specified by:
        getLargeUpdateCount in interface EngineStatement
        Specified by:
        getLargeUpdateCount in interface java.sql.Statement
        Throws:
        java.sql.SQLException

      • getMoreResults

        public final boolean getMoreResults()
                             throws java.sql.SQLException
        getMoreResults moves to a Statement's next result. It returns true if this result is a ResultSet. getMoreResults also implicitly closes any current ResultSet obtained with getResultSet. There are no more results when (!getMoreResults() && (getUpdateCount() == -1)
        Specified by:
        getMoreResults in interface java.sql.Statement
        Returns:
        true if the next result is a ResultSet; false if it is an update count or there are no more results
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        execute(java.lang.String)

      • getResultSetType

        public final int getResultSetType()
                           throws java.sql.SQLException
        JDBC 2.0 Determine the result set type.
        Specified by:
        getResultSetType in interface java.sql.Statement
        Throws:
        java.sql.SQLException - Feature not implemented for now.

      • setFetchDirection

        public void setFetchDirection​(int direction)
                       throws java.sql.SQLException
        JDBC 2.0 Give a hint as to the direction in which the rows in a result set will be processed. The hint applies only to result sets created using this Statement object. The default value is ResultSet.FETCH_FORWARD.
        Specified by:
        setFetchDirection in interface java.sql.Statement
        Parameters:
        direction - the initial direction for processing rows
        Throws:
        java.sql.SQLException - if a database-access error occurs or direction is not one of ResultSet.FETCH_FORWARD, ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWN

      • getFetchDirection

        public int getFetchDirection()
                      throws java.sql.SQLException
        JDBC 2.0 Determine the fetch direction.
        Specified by:
        getFetchDirection in interface java.sql.Statement
        Returns:
        the default fetch direction
        Throws:
        java.sql.SQLException - if a database-access error occurs

      • setFetchSize

        public void setFetchSize​(int rows)
                  throws java.sql.SQLException
        JDBC 2.0 Give the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. The number of rows specified only affects result sets created using this statement. If the value specified is zero, then the hint is ignored. The default value is zero.
        Specified by:
        setFetchSize in interface java.sql.Statement
        Parameters:
        rows - the number of rows to fetch
        Throws:
        java.sql.SQLException - if a database-access error occurs, or the condition 0 <= rows <= this.getMaxRows() is not satisfied.

      • getFetchSize

        public int getFetchSize()
                 throws java.sql.SQLException
        JDBC 2.0 Determine the default fetch size.
        Specified by:
        getFetchSize in interface java.sql.Statement
        Throws:
        java.sql.SQLException - if a database-access error occurs

      • getResultSetConcurrency

        public int getResultSetConcurrency()
                            throws java.sql.SQLException
        JDBC 2.0 Determine the result set concurrency.
        Specified by:
        getResultSetConcurrency in interface java.sql.Statement
        Throws:
        java.sql.SQLException - Feature not implemented for now.

      • getResultSetHoldability

        public final int getResultSetHoldability()
                                  throws java.sql.SQLException
        JDBC 3.0 Retrieves the result set holdability for ResultSet objects generated by this Statement object.
        Specified by:
        getResultSetHoldability in interface java.sql.Statement
        Returns:
        either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
        Throws:
        java.sql.SQLException - Feature not implemented for now.

      • addBatch

        public void addBatch​(java.lang.String sql)
              throws java.sql.SQLException
        JDBC 2.0 Adds a SQL command to the current batch of commmands for the statement. This method is optional.
        Specified by:
        addBatch in interface java.sql.Statement
        Parameters:
        sql - typically this is a static SQL INSERT or UPDATE statement
        Throws:
        java.sql.SQLException - if a database-access error occurs, or the driver does not support batch statements

      • clearBatch

        public final void clearBatch()
                      throws java.sql.SQLException
        JDBC 2.0 Make the set of commands in the current batch empty. This method is optional.
        Specified by:
        clearBatch in interface java.sql.Statement
        Throws:
        java.sql.SQLException - if a database-access error occurs, or the driver does not support batch statements

      • executeBatch

        public int[] executeBatch()
                   throws java.sql.SQLException
        JDBC 2.0 Submit a batch of commands to the database for execution. This method is optional. Moving jdbc2.0 batch related code in this class because callableStatement in jdbc 20 needs this code too and it doesn't derive from prepared statement in jdbc 20 in our implementation. BatchUpdateException is the only new class from jdbc 20 which is being referenced here and in order to avoid any jdk11x problems, using reflection code to make an instance of that class.
        Specified by:
        executeBatch in interface java.sql.Statement
        Returns:
        an array of update counts containing one element for each command in the batch. The array is ordered according to the order in which commands were inserted into the batch
        Throws:
        java.sql.SQLException - if a database-access error occurs, or the driver does not support batch statements

      • executeLargeBatch

        public long[] executeLargeBatch()
                         throws java.sql.SQLException
        JDBC 4.2 Submit a batch of commands to the database for execution. This method is optional. For use with statements which may touch more than Integer.MAX_VALUE rows.
        Specified by:
        executeLargeBatch in interface EngineStatement
        Specified by:
        executeLargeBatch in interface java.sql.Statement
        Throws:
        java.sql.SQLException

      • executeBatchElement

        boolean executeBatchElement​(java.lang.Object batchElement)
                     throws java.sql.SQLException,
                            StandardException
        Execute a single element of the batch. Overridden by EmbedPreparedStatement
        Throws:
        java.sql.SQLException
        StandardException

      • getConnection

        public final java.sql.Connection getConnection()
                                        throws java.sql.SQLException
        JDBC 2.0 Return the Connection that produced the Statement.
        Specified by:
        getConnection in interface java.sql.Statement
        Throws:
        java.sql.SQLException - Exception if it cannot find the connection associated to this statement.

      • getMoreResults

        public final boolean getMoreResults​(int current)
                             throws java.sql.SQLException
        JDBC 3.0 Moves to this Statement obect's next result, deals with any current ResultSet object(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object
        Specified by:
        getMoreResults in interface java.sql.Statement
        Parameters:
        current - - one of the following Statement constants indicating what should happen to current ResultSet objects obtained using the method getResultSetCLOSE_CURRENT_RESULT, KEEP_CURRENT_RESULT, or CLOSE_ALL_RESULTS
        Returns:
        true if the next result is a ResultSet; false if it is an update count or there are no more results
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        execute(java.lang.String)

      • getGeneratedKeys

        public final java.sql.ResultSet getGeneratedKeys()
                                          throws java.sql.SQLException
        JDBC 3.0 Retrieves any auto-generated keys created as a result of executing this Statement object. If this Statement is a non-insert statement, a null ResultSet object is returned.
        Specified by:
        getGeneratedKeys in interface java.sql.Statement
        Returns:
        a ResultSet object containing the auto-generated key(s) generated by the execution of this Statement object
        Throws:
        java.sql.SQLException - if a database access error occurs

      • executeStatement

        boolean executeStatement​(Activation a,
                         boolean executeQuery,
                         boolean executeUpdate)
                  throws java.sql.SQLException
        Execute the current statement.
        Throws:
        java.sql.SQLException - thrown on failure.

      • addWarning

        final void addWarning​(java.sql.SQLWarning sw)
        Add a SQLWarning to this Statement object. If the Statement already has a SQLWarning then it is added to the end of the chain.
        See Also:
        getWarnings()

      • getSQLText

        public java.lang.String getSQLText()

      • checkStatus

        final void checkStatus()
                throws java.sql.SQLException
        Throw an exception if this Statement has been closed explictly or it has noticed it has been closed implicitly. JDBC specifications require nearly all methods throw a SQLException if the Statement has been closed, thus most methods call this method or checkExecStatus first.
        Throws:
        java.sql.SQLException - Thrown if the statement is marked as closed.
        See Also:
        checkExecStatus()

      • checkExecStatus

        final void checkExecStatus()
                    throws java.sql.SQLException
        A heavier weight version of checkStatus() that ensures the application's Connection object is still open. This is to stop errors or unexpected behaviour when a [Prepared]Statement object is used after the application has been closed. In particular to ensure that a Statement obtained from a PooledConnection cannot be used after the application has closed its connection (as the underlying Connection is still active). To avoid this heavier weight check on every method of [Prepared]Statement it is only used on those methods that would end up using the database's connection to read or modify data. E.g. execute*(), but not setXXX, etc.
        If this Statement's Connection is closed an exception will be thrown and the active field will be set to false, completely marking the Statement as closed.
        If the Statement is not currently connected to an active transaction, i.e. a suspended global transaction, then this method will throw a SQLException but the Statement will remain open. The Statement is open but unable to process any new requests until its global transaction is resumed.
        Upon return from the method, with or without a SQLException the field active will correctly represent the open state of the Statement.
        Throws:
        java.sql.SQLException - Thrown if the statement is marked as closed or the Statement's transaction is suspended.
        See Also:
        checkStatus()

      • clearResultSets

        void clearResultSets()
              throws java.sql.SQLException
        Close and clear all result sets associated with this statement from the last execution.
        Throws:
        java.sql.SQLException

      • clearResultSetsMinion

        private void clearResultSetsMinion()
                            throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • checkRequiresCallableStatement

        void checkRequiresCallableStatement​(Activation activation)
                             throws java.sql.SQLException
        Check to see if a statement requires to be executed via a callable statement.
        Throws:
        java.sql.SQLException

      • transferBatch

        public void transferBatch​(EmbedStatement other)
                   throws java.sql.SQLException
        Transfer my batch of Statements to a newly created Statement.
        Throws:
        java.sql.SQLException

      • setApplicationStatement

        public final void setApplicationStatement​(EngineStatement s)
        Set the application statement for this Statement.

      • processDynamicResults

        private int processDynamicResults​(java.sql.ResultSet[][] holder,
                                  int maxDynamicResultSets)
                           throws java.sql.SQLException
        Go through a holder of dynamic result sets, remove those that should not be returned, and sort the result sets according to their creation.
        Parameters:
        holder - a holder of dynamic result sets
        maxDynamicResultSets - the maximum number of result sets to be returned
        Returns:
        the actual number of result sets
        Throws:
        java.sql.SQLException - if an error occurs

      • processDynamicResult

        static EmbedResultSet processDynamicResult​(EmbedConnection conn,
                                           java.sql.ResultSet resultSet,
                                           EmbedStatement callStatement)
        Process a ResultSet created in a Java procedure as a dynamic result. To be a valid dynamic result the ResultSet must be:
        • From a Derby system
        • From a nested connection of connection passed in or from the connection itself.
        • Open
        Any invalid ResultSet is ignored.
        Parameters:
        conn - Connection ResultSet needs to belong to
        resultSet - ResultSet to be tested
        callStatement - Statement that executed the CALL, null if
        Returns:
        The result set cast down to EmbedResultSet, null if not a valid dynamic result.

      • resultSetClosing

        void resultSetClosing​(EmbedResultSet closingLRS)
               throws java.sql.SQLException
        Callback on the statement when one of its result sets is closed. This allows the statement to control when it completes and hence when it commits in auto commit mode. Must have connection synchronization and setupContextStack(), this is required for the call to commitIfNeeded().
        Throws:
        java.sql.SQLException

      • getExecuteHoldable

        private boolean getExecuteHoldable()
                            throws java.sql.SQLException
        Get the execute time holdability for the Statement. When in a global transaction holdabilty defaults to false.
        Throws:
        java.sql.SQLException - Error from getResultSetHoldability.

      • isPoolable

        public boolean isPoolable()
                   throws java.sql.SQLException
        Returns the value of the EmbedStatement's poolable hint, indicating whether pooling is requested.
        Specified by:
        isPoolable in interface java.sql.Statement
        Returns:
        The value of the poolable hint.
        Throws:
        java.sql.SQLException - if the Statement has been closed.

      • setPoolable

        public void setPoolable​(boolean poolable)
                 throws java.sql.SQLException
        Requests that an EmbedStatement be pooled or not.
        Specified by:
        setPoolable in interface java.sql.Statement
        Parameters:
        poolable - requests that the EmbedStatement be pooled if true and not be pooled if false.
        Throws:
        java.sql.SQLException - if the EmbedStatement has been closed.

      • isWrapperFor

        public final boolean isWrapperFor​(java.lang.Class<?> interfaces)
                           throws java.sql.SQLException
        Returns false unless interfaces is implemented.
        Specified by:
        isWrapperFor in interface java.sql.Wrapper
        Parameters:
        interfaces - a Class defining an interface.
        Returns:
        true if this implements the interface or directly or indirectly wraps an object that does.
        Throws:
        java.sql.SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.

      • unwrap

        public final <T> T unwrap​(java.lang.Class<T> interfaces)
                   throws java.sql.SQLException
        Returns this if this class implements the interface.
        Specified by:
        unwrap in interface java.sql.Wrapper
        Parameters:
        interfaces - a Class defining an interface
        Returns:
        an object that implements the interface
        Throws:
        java.sql.SQLException - if no object if found that implements the interface

      • closeOnCompletion

        public void closeOnCompletion()
                       throws java.sql.SQLException
        Specified by:
        closeOnCompletion in interface EngineStatement
        Specified by:
        closeOnCompletion in interface java.sql.Statement
        Throws:
        java.sql.SQLException

      • isCloseOnCompletion

        public boolean isCloseOnCompletion()
                            throws java.sql.SQLException
        Specified by:
        isCloseOnCompletion in interface EngineStatement
        Specified by:
        isCloseOnCompletion in interface java.sql.Statement
        Throws:
        java.sql.SQLException

      • closeMeOnCompletion

        void closeMeOnCompletion()

      • isOpen

        private boolean isOpen​(EmbedResultSet rs)
                throws java.sql.SQLException
        Throws:
        java.sql.SQLException