Package org.apache.openjpa.jdbc.sql

Class InformixDictionary

java.lang.Object
org.apache.openjpa.jdbc.sql.DBDictionary
org.apache.openjpa.jdbc.sql.InformixDictionary
All Implemented Interfaces:
JoinSyntaxes, Configurable, IdentifierConfiguration, ConnectionDecorator, LoggingConnectionDecorator.SQLWarningHandler
public class InformixDictionary extends DBDictionary
Dictionary for Informix database. Notable features:
  • Informix does not allow pessimistic locking on scrollable result sets.
  • SET LOCK MODE TO WAIT N statements are issued to wait on locks. See lockWaitSeconds and lockModeEnabled.
  • LOCK MODE ROW is used by default for table creation to allow the maximum concurrency.

  • Field Details

    • VENDOR_IBM

      public static final String VENDOR_IBM
      See Also:

    • lockModeEnabled

      public boolean lockModeEnabled
      If true, then we will issue a "SET LOCK MODE TO WAIT N" statement whenever we create a Connection, in order allow waiting on locks.

    • lockWaitSeconds

      public int lockWaitSeconds
      If lockModeEnabled is true, then this parameter specifies the number of seconds we will wait to obtain a lock for inserts and pessimistic locking.

    • swapSchemaAndCatalog

      public boolean swapSchemaAndCatalog
      Informix JDBC metadata for all known drivers returns with the table catalog and the table schema name swapped. A true value for this property indicates that they should be reversed.

    • useJCC

      protected boolean useJCC

    • disableRetainUpdateLocksSQL

      public boolean disableRetainUpdateLocksSQL

  • Constructor Details

    • InformixDictionary

      public InformixDictionary()

  • Method Details

    • connectedConfiguration

      public void connectedConfiguration(Connection conn) throws SQLException
      Description copied from class: DBDictionary
      This method is called when the dictionary first sees any connection. It is used to initialize dictionary metadata if needed. If you override this method, be sure to call super.connectedConfiguration.
      Overrides:
      connectedConfiguration in class DBDictionary
      Throws:
      SQLException

    • getColumns

      public Column[] getColumns(DatabaseMetaData meta, String catalog, String schemaName, String tableName, String columnName, Connection conn) throws SQLException
      Description copied from class: DBDictionary
      Reflect on the schema to find columns matching the given table and column patterns.
      Overrides:
      getColumns in class DBDictionary
      Throws:
      SQLException

    • getColumns

      public Column[] getColumns(DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, DBIdentifier columnName, Connection conn) throws SQLException
      Description copied from class: DBDictionary
      Reflect on the schema to find columns matching the given table and column patterns.
      Overrides:
      getColumns in class DBDictionary
      Throws:
      SQLException

    • newColumn

      public Column newColumn(ResultSet colMeta) throws SQLException
      Description copied from class: DBDictionary
      Create a new column from the information in the schema metadata.
      Overrides:
      newColumn in class DBDictionary
      Throws:
      SQLException

    • newPrimaryKey

      public PrimaryKey newPrimaryKey(ResultSet pkMeta) throws SQLException
      Description copied from class: DBDictionary
      Create a new primary key from the information in the schema metadata.
      Overrides:
      newPrimaryKey in class DBDictionary
      Throws:
      SQLException

    • newIndex

      public Index newIndex(ResultSet idxMeta) throws SQLException
      Description copied from class: DBDictionary
      Create a new index from the information in the schema metadata.
      Overrides:
      newIndex in class DBDictionary
      Throws:
      SQLException

    • setBoolean

      public void setBoolean(PreparedStatement stmnt, int idx, boolean val, Column col) throws SQLException
      Description copied from class: DBDictionary
      Set the given value as a parameter to the statement.
      Overrides:
      setBoolean in class DBDictionary
      Throws:
      SQLException

    • getCreateTableSQL

      public String[] getCreateTableSQL(Table table)
      Description copied from class: DBDictionary
      Return a series of SQL statements to create the given table, complete with columns. Indexes and constraints will be created separately.
      Overrides:
      getCreateTableSQL in class DBDictionary

    • getAddPrimaryKeySQL

      public String[] getAddPrimaryKeySQL(PrimaryKey pk)
      Description copied from class: DBDictionary
      Return a series of SQL statements to add the given primary key to its table. Return an empty array if operation not supported. Returns ALTER TABLE <table name> ADD <pk cons sql > by default.
      Overrides:
      getAddPrimaryKeySQL in class DBDictionary

    • getAddForeignKeySQL

      public String[] getAddForeignKeySQL(ForeignKey fk)
      Description copied from class: DBDictionary
      Return a series of SQL statements to add the given foreign key to its table. Return an empty array if operation not supported. Returns ALTER TABLE <table name> ADD <fk cons sql > by default.
      Overrides:
      getAddForeignKeySQL in class DBDictionary

    • supportsRandomAccessResultSet

      public boolean supportsRandomAccessResultSet(Select sel, boolean forUpdate)
      Description copied from class: DBDictionary
      Return false if the given select requires a forward-only result set.
      Overrides:
      supportsRandomAccessResultSet in class DBDictionary

    • decorate

      public Connection decorate(Connection conn) throws SQLException
      Description copied from class: DBDictionary
      Decorate the given connection if needed. Some databases require special handling for JDBC bugs. This implementation issues any DBDictionary.initializationSQL that has been set for the dictionary but does not decorate the connection.
      Specified by:
      decorate in interface ConnectionDecorator
      Overrides:
      decorate in class DBDictionary
      Throws:
      SQLException

    • indexOf

      public void indexOf(SQLBuffer buf, FilterValue str, FilterValue find, FilterValue start)
      Description copied from class: DBDictionary
      Invoke this database's indexOf function.
      Overrides:
      indexOf in class DBDictionary
      Parameters:
      buf - the SQL buffer to write the indexOf invocation to
      str - a query value representing the target string
      find - a query value representing the search string
      start - a query value representing the start index, or null to start at the beginning

    • needsToCreateIndex

      public boolean needsToCreateIndex(Index idx, Table table)
      Overrides:
      needsToCreateIndex in class DBDictionary

    • useJCC

      public boolean useJCC()

    • getSchemaCase

      public String getSchemaCase()
      Return DB specific schemaCase
      Specified by:
      getSchemaCase in interface IdentifierConfiguration
      Overrides:
      getSchemaCase in class DBDictionary
      Returns:
      upper, lower, or preserve

    • isFatalException

      public boolean isFatalException(int subtype, SQLException ex)
      Description copied from class: DBDictionary
      Determine if the given SQL Exception is fatal or recoverable (such as a timeout). This implementation always returns true (i.e. all exceptions are fatal). The current dictionary implementation can overwrite this method to mark certain exception conditions as recoverable error.
      Overrides:
      isFatalException in class DBDictionary
      Parameters:
      subtype - A constant indicating the category of error as defined in StoreException.
      ex - original SQL Exception as raised by the database driver.
      Returns:
      false if the error is fatal.

    • matchErrorState

      protected int matchErrorState(Map<Integer,Set<String>> errorStates, SQLException ex)
      Specialized matchErrorState method for Informix. Informix exceptions are typically nested multiple levels deep. Correct determination of the exception type requires inspection of nested exceptions to determine the root cause. A list of Informix (IDS v10) error codes can be found here: http://publib.boulder.ibm.com/infocenter/idshelp/v10/index.jsp?topic=/com.ibm.em.doc/errors_ids100.html
      Overrides:
      matchErrorState in class DBDictionary
      Parameters:
      errorStates - classification of SQL error states by their specific nature. The keys of the map represent one of the constants defined in StoreException. The value corresponding to a key represent the set of SQL Error States representing specific category of database error. This supplied map is sourced from sql-error-state-codes.xml and filtered the error states for the current database.
      ex - original SQL Exception as raised by the database driver.
      Returns:
      A constant indicating the category of error as defined in StoreException.