Package org.h2.command

Interface CommandInterface

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
Command, CommandContainer, CommandRemote
public interface CommandInterface extends AutoCloseable
Represents a SQL statement.

  • Field Details

    • UNKNOWN

      static final int UNKNOWN
      The type for unknown statement.
      See Also:

    • ALTER_INDEX_RENAME

      static final int ALTER_INDEX_RENAME
      The type of ALTER INDEX RENAME statement.
      See Also:

    • ALTER_SCHEMA_RENAME

      static final int ALTER_SCHEMA_RENAME
      The type of ALTER SCHEMA RENAME statement.
      See Also:

    • ALTER_TABLE_ADD_CONSTRAINT_CHECK

      static final int ALTER_TABLE_ADD_CONSTRAINT_CHECK
      The type of ALTER TABLE ADD CHECK statement.
      See Also:

    • ALTER_TABLE_ADD_CONSTRAINT_UNIQUE

      static final int ALTER_TABLE_ADD_CONSTRAINT_UNIQUE
      The type of ALTER TABLE ADD UNIQUE statement.
      See Also:

    • ALTER_TABLE_ADD_CONSTRAINT_REFERENTIAL

      static final int ALTER_TABLE_ADD_CONSTRAINT_REFERENTIAL
      The type of ALTER TABLE ADD FOREIGN KEY statement.
      See Also:

    • ALTER_TABLE_ADD_CONSTRAINT_PRIMARY_KEY

      static final int ALTER_TABLE_ADD_CONSTRAINT_PRIMARY_KEY
      The type of ALTER TABLE ADD PRIMARY KEY statement.
      See Also:

    • ALTER_TABLE_ADD_COLUMN

      static final int ALTER_TABLE_ADD_COLUMN
      The type of ALTER TABLE ADD statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_NOT_NULL

      static final int ALTER_TABLE_ALTER_COLUMN_NOT_NULL
      The type of ALTER TABLE ALTER COLUMN SET NOT NULL statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_DROP_NOT_NULL

      static final int ALTER_TABLE_ALTER_COLUMN_DROP_NOT_NULL
      The type of ALTER TABLE ALTER COLUMN DROP NOT NULL statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_DEFAULT

      static final int ALTER_TABLE_ALTER_COLUMN_DEFAULT
      The type of ALTER TABLE ALTER COLUMN SET DEFAULT and ALTER TABLE ALTER COLUMN DROP DEFAULT statements.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_CHANGE_TYPE

      static final int ALTER_TABLE_ALTER_COLUMN_CHANGE_TYPE
      The type of ALTER TABLE ALTER COLUMN statement that changes the column data type.
      See Also:

    • ALTER_TABLE_DROP_COLUMN

      static final int ALTER_TABLE_DROP_COLUMN
      The type of ALTER TABLE DROP COLUMN statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_SELECTIVITY

      static final int ALTER_TABLE_ALTER_COLUMN_SELECTIVITY
      The type of ALTER TABLE ALTER COLUMN SELECTIVITY statement.
      See Also:

    • ALTER_TABLE_DROP_CONSTRAINT

      static final int ALTER_TABLE_DROP_CONSTRAINT
      The type of ALTER TABLE DROP CONSTRAINT statement.
      See Also:

    • ALTER_TABLE_RENAME

      static final int ALTER_TABLE_RENAME
      The type of ALTER TABLE RENAME statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_RENAME

      static final int ALTER_TABLE_ALTER_COLUMN_RENAME
      The type of ALTER TABLE ALTER COLUMN RENAME statement.
      See Also:

    • ALTER_USER_ADMIN

      static final int ALTER_USER_ADMIN
      The type of ALTER USER ADMIN statement.
      See Also:

    • ALTER_USER_RENAME

      static final int ALTER_USER_RENAME
      The type of ALTER USER RENAME statement.
      See Also:

    • ALTER_USER_SET_PASSWORD

      static final int ALTER_USER_SET_PASSWORD
      The type of ALTER USER SET PASSWORD statement.
      See Also:

    • ALTER_VIEW

      static final int ALTER_VIEW
      The type of ALTER VIEW statement.
      See Also:

    • ANALYZE

      static final int ANALYZE
      The type of ANALYZE statement.
      See Also:

    • CREATE_AGGREGATE

      static final int CREATE_AGGREGATE
      The type of CREATE AGGREGATE statement.
      See Also:

    • CREATE_CONSTANT

      static final int CREATE_CONSTANT
      The type of CREATE CONSTANT statement.
      See Also:

    • CREATE_ALIAS

      static final int CREATE_ALIAS
      The type of CREATE ALIAS statement.
      See Also:

    • CREATE_INDEX

      static final int CREATE_INDEX
      The type of CREATE INDEX statement.
      See Also:

    • CREATE_LINKED_TABLE

      static final int CREATE_LINKED_TABLE
      The type of CREATE LINKED TABLE statement.
      See Also:

    • CREATE_ROLE

      static final int CREATE_ROLE
      The type of CREATE ROLE statement.
      See Also:

    • CREATE_SCHEMA

      static final int CREATE_SCHEMA
      The type of CREATE SCHEMA statement.
      See Also:

    • CREATE_SEQUENCE

      static final int CREATE_SEQUENCE
      The type of CREATE SEQUENCE statement.
      See Also:

    • CREATE_TABLE

      static final int CREATE_TABLE
      The type of CREATE TABLE statement.
      See Also:

    • CREATE_TRIGGER

      static final int CREATE_TRIGGER
      The type of CREATE TRIGGER statement.
      See Also:

    • CREATE_USER

      static final int CREATE_USER
      The type of CREATE USER statement.
      See Also:

    • CREATE_DOMAIN

      static final int CREATE_DOMAIN
      The type of CREATE DOMAIN statement.
      See Also:

    • CREATE_VIEW

      static final int CREATE_VIEW
      The type of CREATE VIEW statement.
      See Also:

    • DEALLOCATE

      static final int DEALLOCATE
      The type of DEALLOCATE statement.
      See Also:

    • DROP_AGGREGATE

      static final int DROP_AGGREGATE
      The type of DROP AGGREGATE statement.
      See Also:

    • DROP_CONSTANT

      static final int DROP_CONSTANT
      The type of DROP CONSTANT statement.
      See Also:

    • DROP_ALL_OBJECTS

      static final int DROP_ALL_OBJECTS
      The type of DROP ALL OBJECTS statement.
      See Also:

    • DROP_ALIAS

      static final int DROP_ALIAS
      The type of DROP ALIAS statement.
      See Also:

    • DROP_INDEX

      static final int DROP_INDEX
      The type of DROP INDEX statement.
      See Also:

    • DROP_ROLE

      static final int DROP_ROLE
      The type of DROP ROLE statement.
      See Also:

    • DROP_SCHEMA

      static final int DROP_SCHEMA
      The type of DROP SCHEMA statement.
      See Also:

    • DROP_SEQUENCE

      static final int DROP_SEQUENCE
      The type of DROP SEQUENCE statement.
      See Also:

    • DROP_TABLE

      static final int DROP_TABLE
      The type of DROP TABLE statement.
      See Also:

    • DROP_TRIGGER

      static final int DROP_TRIGGER
      The type of DROP TRIGGER statement.
      See Also:

    • DROP_USER

      static final int DROP_USER
      The type of DROP USER statement.
      See Also:

    • DROP_DOMAIN

      static final int DROP_DOMAIN
      The type of DROP DOMAIN statement.
      See Also:

    • DROP_VIEW

      static final int DROP_VIEW
      The type of DROP VIEW statement.
      See Also:

    • GRANT

      static final int GRANT
      The type of GRANT statement.
      See Also:

    • REVOKE

      static final int REVOKE
      The type of REVOKE statement.
      See Also:

    • PREPARE

      static final int PREPARE
      The type of PREPARE statement.
      See Also:

    • COMMENT

      static final int COMMENT
      The type of COMMENT statement.
      See Also:

    • TRUNCATE_TABLE

      static final int TRUNCATE_TABLE
      The type of TRUNCATE TABLE statement.
      See Also:

    • ALTER_SEQUENCE

      static final int ALTER_SEQUENCE
      The type of ALTER SEQUENCE statement.
      See Also:

    • ALTER_TABLE_SET_REFERENTIAL_INTEGRITY

      static final int ALTER_TABLE_SET_REFERENTIAL_INTEGRITY
      The type of ALTER TABLE SET REFERENTIAL_INTEGRITY statement.
      See Also:

    • BACKUP

      static final int BACKUP
      The type of BACKUP statement.
      See Also:

    • CALL

      static final int CALL
      The type of CALL statement.
      See Also:

    • DELETE

      static final int DELETE
      The type of DELETE statement.
      See Also:

    • EXECUTE

      static final int EXECUTE
      The type of EXECUTE statement.
      See Also:

    • EXPLAIN

      static final int EXPLAIN
      The type of EXPLAIN statement.
      See Also:

    • INSERT

      static final int INSERT
      The type of INSERT statement.
      See Also:

    • MERGE

      static final int MERGE
      The type of MERGE statement.
      See Also:

    • REPLACE

      static final int REPLACE
      The type of REPLACE statement.
      See Also:

    • NO_OPERATION

      static final int NO_OPERATION
      The type of no operation statement.
      See Also:

    • RUNSCRIPT

      static final int RUNSCRIPT
      The type of RUNSCRIPT statement.
      See Also:

    • SCRIPT

      static final int SCRIPT
      The type of SCRIPT statement.
      See Also:

    • SELECT

      static final int SELECT
      The type of SELECT statement.
      See Also:

    • SET

      static final int SET
      The type of SET statement.
      See Also:

    • UPDATE

      static final int UPDATE
      The type of UPDATE statement.
      See Also:

    • SET_AUTOCOMMIT_TRUE

      static final int SET_AUTOCOMMIT_TRUE
      The type of SET AUTOCOMMIT statement.
      See Also:

    • SET_AUTOCOMMIT_FALSE

      static final int SET_AUTOCOMMIT_FALSE
      The type of SET AUTOCOMMIT statement.
      See Also:

    • COMMIT

      static final int COMMIT
      The type of COMMIT statement.
      See Also:

    • ROLLBACK

      static final int ROLLBACK
      The type of ROLLBACK statement.
      See Also:

    • CHECKPOINT

      static final int CHECKPOINT
      The type of CHECKPOINT statement.
      See Also:

    • SAVEPOINT

      static final int SAVEPOINT
      The type of SAVEPOINT statement.
      See Also:

    • ROLLBACK_TO_SAVEPOINT

      static final int ROLLBACK_TO_SAVEPOINT
      The type of ROLLBACK TO SAVEPOINT statement.
      See Also:

    • CHECKPOINT_SYNC

      static final int CHECKPOINT_SYNC
      The type of CHECKPOINT SYNC statement.
      See Also:

    • PREPARE_COMMIT

      static final int PREPARE_COMMIT
      The type of PREPARE COMMIT statement.
      See Also:

    • COMMIT_TRANSACTION

      static final int COMMIT_TRANSACTION
      The type of COMMIT TRANSACTION statement.
      See Also:

    • ROLLBACK_TRANSACTION

      static final int ROLLBACK_TRANSACTION
      The type of ROLLBACK TRANSACTION statement.
      See Also:

    • SHUTDOWN

      static final int SHUTDOWN
      The type of SHUTDOWN statement.
      See Also:

    • SHUTDOWN_IMMEDIATELY

      static final int SHUTDOWN_IMMEDIATELY
      The type of SHUTDOWN IMMEDIATELY statement.
      See Also:

    • SHUTDOWN_COMPACT

      static final int SHUTDOWN_COMPACT
      The type of SHUTDOWN COMPACT statement.
      See Also:

    • BEGIN

      static final int BEGIN
      The type of BEGIN {WORK|TRANSACTION} statement.
      See Also:

    • SHUTDOWN_DEFRAG

      static final int SHUTDOWN_DEFRAG
      The type of SHUTDOWN DEFRAG statement.
      See Also:

    • ALTER_TABLE_RENAME_CONSTRAINT

      static final int ALTER_TABLE_RENAME_CONSTRAINT
      The type of ALTER TABLE RENAME CONSTRAINT statement.
      See Also:

    • EXPLAIN_ANALYZE

      static final int EXPLAIN_ANALYZE
      The type of EXPLAIN ANALYZE statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_VISIBILITY

      static final int ALTER_TABLE_ALTER_COLUMN_VISIBILITY
      The type of ALTER TABLE ALTER COLUMN SET INVISIBLE statement.
      See Also:

    • CREATE_SYNONYM

      static final int CREATE_SYNONYM
      The type of CREATE SYNONYM statement.
      See Also:

    • DROP_SYNONYM

      static final int DROP_SYNONYM
      The type of DROP SYNONYM statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_ON_UPDATE

      static final int ALTER_TABLE_ALTER_COLUMN_ON_UPDATE
      The type of ALTER TABLE ALTER COLUMN SET ON UPDATE statement.
      See Also:

    • EXECUTE_IMMEDIATELY

      static final int EXECUTE_IMMEDIATELY
      The type of EXECUTE IMMEDIATELY statement.
      See Also:

    • ALTER_DOMAIN_ADD_CONSTRAINT

      static final int ALTER_DOMAIN_ADD_CONSTRAINT
      The type of ALTER DOMAIN ADD CONSTRAINT statement.
      See Also:

    • ALTER_DOMAIN_DROP_CONSTRAINT

      static final int ALTER_DOMAIN_DROP_CONSTRAINT
      The type of ALTER DOMAIN DROP CONSTRAINT statement.
      See Also:

    • ALTER_DOMAIN_DEFAULT

      static final int ALTER_DOMAIN_DEFAULT
      The type of ALTER DOMAIN SET DEFAULT and ALTER DOMAIN DROP DEFAULT statements.
      See Also:

    • ALTER_DOMAIN_ON_UPDATE

      static final int ALTER_DOMAIN_ON_UPDATE
      The type of ALTER DOMAIN SET ON UPDATE and ALTER DOMAIN DROP ON UPDATE statements.
      See Also:

    • ALTER_DOMAIN_RENAME

      static final int ALTER_DOMAIN_RENAME
      The type of ALTER DOMAIN RENAME statement.
      See Also:

    • HELP

      static final int HELP
      The type of HELP statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_DROP_EXPRESSION

      static final int ALTER_TABLE_ALTER_COLUMN_DROP_EXPRESSION
      The type of ALTER TABLE ALTER COLUMN DROP EXPRESSION statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_DROP_IDENTITY

      static final int ALTER_TABLE_ALTER_COLUMN_DROP_IDENTITY
      The type of ALTER TABLE ALTER COLUMN DROP IDENTITY statement.
      See Also:

    • ALTER_TABLE_ALTER_COLUMN_DEFAULT_ON_NULL

      static final int ALTER_TABLE_ALTER_COLUMN_DEFAULT_ON_NULL
      The type of ALTER TABLE ALTER COLUMN SET DEFAULT ON NULL and ALTER TABLE ALTER COLUMN DROP DEFAULT ON NULL statements.
      See Also:

    • ALTER_DOMAIN_RENAME_CONSTRAINT

      static final int ALTER_DOMAIN_RENAME_CONSTRAINT
      The type of ALTER DOMAIN RENAME CONSTRAINT statement.
      See Also:

    • CREATE_MATERIALIZED_VIEW

      static final int CREATE_MATERIALIZED_VIEW
      The type of CREATE MATERIALIZED VIEW statement.
      See Also:

    • REFRESH_MATERIALIZED_VIEW

      static final int REFRESH_MATERIALIZED_VIEW
      The type of REFRESH MATERIALIZED VIEW statement.
      See Also:

    • DROP_MATERIALIZED_VIEW

      static final int DROP_MATERIALIZED_VIEW
      The type of DROP MATERIALIZED VIEW statement.
      See Also:

    • ALTER_TYPE

      static final int ALTER_TYPE
      The type of ALTER TYPE statement.
      See Also:

  • Method Details

    • getCommandType

      int getCommandType()
      Get command type.
      Returns:
      one of the constants above

    • isQuery

      boolean isQuery()
      Check if this is a query.
      Returns:
      true if it is a query

    • getParameters

      ArrayList<? extends ParameterInterface> getParameters()
      Get the parameters (if any).
      Returns:
      the parameters

    • executeQuery

      ResultInterface executeQuery(long maxRows, int fetchSize, boolean scrollable)
      Execute the query.
      Parameters:
      maxRows - the maximum number of rows returned
      fetchSize - the number of rows to fetch (for remote commands only)
      scrollable - if the result set must be scrollable
      Returns:
      the result

    • executeUpdate

      ResultWithGeneratedKeys executeUpdate(Object generatedKeysRequest)
      Execute the statement
      Parameters:
      generatedKeysRequest - null or false if generated keys are not needed, true if generated keys should be configured automatically, int[] to specify column indices to return generated keys from, or String[] to specify column names to return generated keys from
      Returns:
      the update count and generated keys, if any

    • executeBatchUpdate

      BatchResult executeBatchUpdate(ArrayList<Value[]> batchParameters, Object generatedKeysRequest)
      Executes the statement with multiple sets of parameters.
      Parameters:
      batchParameters - batch parameters
      generatedKeysRequest - null or false if generated keys are not needed, true if generated keys should be configured automatically, int[] to specify column indices to return generated keys from, or String[] to specify column names to return generated keys from
      Returns:
      result of batch execution

    • stop

      void stop(boolean commitIfAutoCommit)
      Stop the command execution, release all locks and resources.
      Parameters:
      commitIfAutoCommit - commit the session if auto-commit is enabled

    • close

      void close()
      Close the statement.
      Specified by:
      close in interface AutoCloseable

    • cancel

      void cancel()
      Cancel the statement if it is still processing.

    • getMetaData

      ResultInterface getMetaData()
      Get an empty result set containing the meta data of the result.
      Returns:
      the empty result