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
lockWaitSecondsandlockModeEnabled. - LOCK MODE ROW is used by default for table creation to allow the maximum concurrency.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
DBDictionary.DateMillisecondBehaviors, DBDictionary.SerializedData
-
-
Field Summary
Fields Modifier and Type Field Description booleandisableRetainUpdateLocksSQLbooleanlockModeEnabledIf true, then we will issue a "SET LOCK MODE TO WAIT N" statement whenever we create aConnection, in order allow waiting on locks.intlockWaitSecondsIflockModeEnabledistrue, then this parameter specifies the number of seconds we will wait to obtain a lock for inserts and pessimistic locking.booleanswapSchemaAndCatalogInformix JDBC metadata for all known drivers returns with the table catalog and the table schema name swapped.protected booleanuseJCCstatic java.lang.StringVENDOR_IBM-
Fields inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
_procs, _proxyManager, allowQueryTimeoutOnFindUpdate, allowsAliasInBulkClause, arrayTypeName, autoAssignClause, autoAssignTypeName, batchLimit, bigintTypeName, binaryTypeName, bitLengthFunction, bitTypeName, blobBufferSize, blobTypeName, booleanRepresentation, booleanTypeName, castFunction, catalogSeparator, CENTI, characterColumnSize, charTypeName, clobBufferSize, clobTypeName, closePoolSQL, concatenateDelimiter, concatenateFunction, conf, connected, CONS_NAME_AFTER, CONS_NAME_BEFORE, CONS_NAME_MID, constraintNameMode, createPrimaryKeys, crossJoinClause, currentDateFunction, currentTimeFunction, currentTimestampFunction, databaseProductName, databaseProductVersion, dateFractionDigits, datePrecision, dateTypeName, DECI, decimalTypeName, defaultSchemaName, delimitedCase, disableAlterSeqenceIncrementBy, disableSchemaFactoryColumnTypeErrors, distinctCountColumnSeparator, distinctTypeName, doubleTypeName, driverVendor, dropTableSQL, fixedSizeTypeNames, fixedSizeTypeNameSet, floatTypeName, forUpdateClause, fractionalTypeNameSet, fullResultCollectionInOrderByRelation, getStringVal, inClauseLimit, indexPhysicalForeignKeys, initializationSQL, innerJoinClause, integerTypeName, invalidColumnWordSet, isJDBC3, isJDBC4, javaObjectTypeName, javaToDbColumnNameProcessing, joinSyntax, lastGeneratedKeyQuery, leadingDelimiter, log, longVarbinaryTypeName, longVarcharTypeName, maxAutoAssignNameLength, maxColumnNameLength, maxConstraintNameLength, maxEmbeddedBlobSize, maxEmbeddedClobSize, maxIndexesPerTable, maxIndexNameLength, maxTableNameLength, MICRO, MILLI, NAME_ANY, NAME_SEQUENCE, NAME_TABLE, nameConcatenator, NANO, nativeSequenceType, nextSequenceQuery, NO_BATCH, nullTypeName, numericTypeName, otherTypeName, outerJoinClause, platform, RANGE_POST_DISTINCT, RANGE_POST_LOCK, RANGE_POST_SELECT, RANGE_PRE_DISTINCT, rangePosition, realTypeName, refTypeName, reportsSuccessNoInfoOnBatchUpdates, requiresAliasForSubselect, requiresAutoCommitForMetaData, requiresCastForComparisons, requiresCastForMathFunctions, requiresConditionForCrossJoin, requiresSearchStringEscapeForLike, requiresTargetForDelete, reservedWords, reservedWordSet, roundTimeToMillisec, SCHEMA_CASE_LOWER, SCHEMA_CASE_PRESERVE, SCHEMA_CASE_UPPER, schemaCase, searchStringEscape, SEC, selectWords, selectWordSet, sequenceNameSQL, sequenceSchemaSQL, sequenceSQL, setStringRightTruncationOn, simulateLocking, smallintTypeName, sqlStateCodes, storageLimitationsFatal, storeCharsAsNumbers, storeLargeNumbersAsStrings, stringLengthFunction, structTypeName, substringFunctionName, supportsAlterTableWithAddColumn, supportsAlterTableWithDropColumn, supportsAutoAssign, supportsCascadeDeleteAction, supportsCascadeUpdateAction, supportsCaseConversionForLob, supportsComments, supportsCorrelatedSubselect, supportsDefaultDeleteAction, supportsDefaultUpdateAction, supportsDeferredConstraints, supportsDelimitedIdentifiers, supportsForeignKeys, supportsForeignKeysComposite, supportsGeneralCaseExpression, supportsGetGeneratedKeys, supportsHaving, supportsLockingWithDistinctClause, supportsLockingWithInnerJoin, supportsLockingWithMultipleTables, supportsLockingWithOrderClause, supportsLockingWithOuterJoin, supportsLockingWithSelectRange, supportsModOperator, supportsMultipleNontransactionalResultSets, supportsNullDeleteAction, supportsNullTableForGetColumns, supportsNullTableForGetImportedKeys, supportsNullTableForGetIndexInfo, supportsNullTableForGetPrimaryKeys, supportsNullUniqueColumn, supportsNullUpdateAction, supportsParameterInSelect, supportsQueryTimeout, supportsRestrictDeleteAction, supportsRestrictUpdateAction, supportsSchemaForGetColumns, supportsSchemaForGetTables, supportsSelectEndIndex, supportsSelectForUpdate, supportsSelectFromFinalTable, supportsSelectStartIndex, supportsSimpleCaseExpression, supportsSubselect, supportsUniqueConstraints, supportsXMLColumn, systemSchemas, systemSchemaSet, systemTables, systemTableSet, tableForUpdateClause, tableLengthIncludesSchema, tableTypes, timestampTypeName, timestampWithZoneTypeName, timeTypeName, timeWithZoneTypeName, tinyintTypeName, toLowerCaseFunction, toUpperCaseFunction, trailingDelimiter, trimBothFunction, trimLeadingFunction, trimSchemaName, trimStringColumns, trimTrailingFunction, typeModifierSet, UNLIMITED, useGetBestRowIdentifierForPrimaryKeys, useGetBytesForBlobs, useGetObjectForBlobs, useGetStringForClobs, useJDBC4SetBinaryStream, useNativeSequenceCache, useSchemaName, useSetBytesForBlobs, useSetStringForClobs, useWildCardForCount, validationSQL, varbinaryTypeName, varcharTypeName, VENDOR_DATADIRECT, VENDOR_OTHER, xmlTypeEncoding, xmlTypeName
-
Fields inherited from interface org.apache.openjpa.jdbc.sql.JoinSyntaxes
SYNTAX_DATABASE, SYNTAX_SQL92, SYNTAX_TRADITIONAL
-
-
Constructor Summary
Constructors Constructor Description InformixDictionary()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidconnectedConfiguration(java.sql.Connection conn)This method is called when the dictionary first sees any connection.java.sql.Connectiondecorate(java.sql.Connection conn)Decorate the given connection if needed.java.lang.String[]getAddForeignKeySQL(ForeignKey fk)Return a series of SQL statements to add the given foreign key to its table.java.lang.String[]getAddPrimaryKeySQL(PrimaryKey pk)Return a series of SQL statements to add the given primary key to its table.Column[]getColumns(java.sql.DatabaseMetaData meta, java.lang.String catalog, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.sql.Connection conn)Reflect on the schema to find columns matching the given table and column patterns.Column[]getColumns(java.sql.DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, DBIdentifier columnName, java.sql.Connection conn)Reflect on the schema to find columns matching the given table and column patterns.java.lang.String[]getCreateTableSQL(Table table)Return a series of SQL statements to create the given table, complete with columns.java.lang.StringgetSchemaCase()Return DB specific schemaCasevoidindexOf(SQLBuffer buf, FilterValue str, FilterValue find, FilterValue start)Invoke this database's indexOf function.booleanisFatalException(int subtype, java.sql.SQLException ex)Determine if the given SQL Exception is fatal or recoverable (such as a timeout).protected intmatchErrorState(java.util.Map<java.lang.Integer,java.util.Set<java.lang.String>> errorStates, java.sql.SQLException ex)Specialized matchErrorState method for Informix.booleanneedsToCreateIndex(Index idx, Table table)ColumnnewColumn(java.sql.ResultSet colMeta)Create a new column from the information in the schema metadata.IndexnewIndex(java.sql.ResultSet idxMeta)Create a new index from the information in the schema metadata.PrimaryKeynewPrimaryKey(java.sql.ResultSet pkMeta)Create a new primary key from the information in the schema metadata.voidsetBoolean(java.sql.PreparedStatement stmnt, int idx, boolean val, Column col)Set the given value as a parameter to the statement.booleansupportsRandomAccessResultSet(Select sel, boolean forUpdate)Return false if the given select requires a forward-only result set.booleanuseJCC()-
Methods inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
addCastAsType, addErrorCode, appendCast, appendLength, appendNumericCast, appendSelect, appendSelectRange, appendSize, appendUpdates, appendXmlComparison, applyRange, assertSupport, calculateValue, canOuterJoin, closeDataSource, combineForeignKey, comment, comparison, configureNamingRules, convertSchemaCase, convertSchemaCase, copy, copy, createIndexIfNecessary, createIndexIfNecessary, deleteStream, delimitAll, endConfiguration, executeQuery, fromDBName, getAddColumnSQL, getAlterSequenceSQL, getArray, getAsciiStream, getBatchFetchSize, getBatchLimit, getBatchUpdateCount, getBigDecimal, getBigInteger, getBinaryStream, getBlob, getBlobObject, getBoolean, getBooleanRepresentation, getByte, getBytes, getCalendar, getCastFunction, getCastFunction, getCatalogNameForMetadata, getCatalogNameForMetadata, getChar, getCharacterStream, getClob, getClobString, getColumnDBName, getColumnIdentifier, getColumnNameForMetadata, getColumnNameForMetadata, getConversionKey, getCreateIndexSQL, getCreateSequenceSQL, getCreateTableSQL, getDate, getDate, getDateFractionDigits, getDeclareColumnSQL, getDefaultIdentifierRule, getDefaultSchemaName, getDeleteTableContentsSQL, getDeleteTargets, getDelimitedCase, getDelimitIdentifiers, getDouble, getDropColumnSQL, getDropForeignKeySQL, getDropIndexSQL, getDropPrimaryKeySQL, getDropSequenceSQL, getDropTableSQL, getFloat, getForeignKeyConstraintSQL, getForUpdateClause, getFrom, getFromSelect, getFullIdentifier, getFullName, getFullName, getFullName, getGeneratedKey, getGeneratedKeySequenceName, getGenKeySeqName, getIdentifierConcatenator, getIdentifierDelimiter, getIdentifierRule, getIdentifierRules, getIdentityColumnName, getImportedKeys, getImportedKeys, getImportedKeys, getImportedKeys, getIndexInfo, getIndexInfo, getInt, getInvalidColumnWordSet, getIsNotNullSQL, getIsNullSQL, getJDBCType, getJDBCType, getJDBCType, getKey, getLeadingDelimiter, getLOBStream, getLocalDate, getLocalDateTime, getLocale, getLocalTime, getLog, getLong, getMajorVersion, getMarkerForInsertUpdate, getMillisecondBehavior, getMinorVersion, getNamingUtil, getNumber, getObject, getOffsetDateTime, getOffsetTime, getPlaceholderValueString, getPreferredType, getPrimaryKeyConstraintSQL, getPrimaryKeys, getPrimaryKeys, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromGetPrimaryKeys, getPrimaryKeysFromGetPrimaryKeys, getRef, getSchemaNameForMetadata, getSchemaNameForMetadata, getSelectOperation, getSelects, getSelectTableAliases, getSequence, getSequences, getSequences, getSequencesSQL, getSequencesSQL, getShort, getStoredProcedure, getString, getSupportsDelimitedIdentifiers, getSupportsXMLColumn, getTableNameForMetadata, getTableNameForMetadata, getTables, getTables, getTime, getTimestamp, getTrailingDelimiter, getTrimSchemaName, getTypeName, getTypeName, getUniqueConstraintSQL, getValidColumnName, getValidColumnName, getValidColumnName, getValidColumnName, getValidForeignKeyName, getValidForeignKeyName, getValidIndexName, getValidIndexName, getValidPrimaryKeyName, getValidSequenceName, getValidSequenceName, getValidTableName, getValidTableName, getValidUniqueName, getValidUniqueName, getVersionColumn, getVersionColumn, getWhere, getXMLTypeEncoding, handleWarning, insertBlobForStreamingLoad, insertClobForStreamingLoad, insertSize, isImplicitJoin, isSelect, isSystemIndex, isSystemIndex, isSystemSequence, isSystemSequence, isSystemSequence, isSystemTable, isSystemTable, isUsingLimit, isUsingOffset, isUsingOrderBy, isUsingRange, makeNameValid, makeNameValid, makeNameValid, makeNameValid, mathFunction, needsToCreateIndex, newForeignKey, newSequence, newStoreException, newTable, prepareStatement, processDBColumnName, putBytes, putChars, putString, refSchemaComponents, serialize, setArray, setAsciiStream, setBatchLimit, setBigDecimal, setBigInteger, setBinaryStream, setBlob, setBlobObject, setBooleanRepresentation, setByte, setBytes, setCalendar, setChar, setCharacterStream, setClob, setClobString, setConfiguration, setDate, setDate, setDateMillisecondBehavior, setDefaultSchemaName, setDelimitedCase, setDelimitIdentifiers, setDouble, setFloat, setInt, setJoinSyntax, setLeadingDelimiter, setLocalDate, setLocalDateTime, setLocale, setLocalTime, setLong, setMajorVersion, setMinorVersion, setNull, setNumber, setObject, setOffsetDateTime, setOffsetTime, setQueryTimeout, setRef, setShort, setStatementQueryTimeout, setString, setSupportsDelimitedIdentifiers, setSupportsXMLColumn, setTime, setTimeouts, setTimeouts, setTimestamp, setTrailingDelimiter, setTrimSchemaName, setTyped, setUnknown, setUnknown, setXMLTypeEncoding, shorten, startConfiguration, storageWarning, substring, supportsDeferredForeignKeyConstraints, supportsDeferredUniqueConstraints, supportsDeleteAction, supportsIsolationForUpdate, supportsLocking, supportsUpdateAction, toBulkOperation, toDBName, toDBName, toDelete, toNativeJoin, toOperation, toOperation, toSelect, toSelect, toSelect, toSelect, toSelect, toSelectCount, toSnakeCase, toSQL92Join, toTraditionalJoin, toUpdate, updateBlob, updateClob, validateBatchProcess, validateDBSpecificBatchProcess, versionEqualOrEarlierThan, versionEqualOrLaterThan, versionLaterThan
-
-
-
-
Field Detail
-
VENDOR_IBM
public static final java.lang.String VENDOR_IBM
- See Also:
- Constant Field Values
-
lockModeEnabled
public boolean lockModeEnabled
If true, then we will issue a "SET LOCK MODE TO WAIT N" statement whenever we create aConnection, in order allow waiting on locks.
-
lockWaitSeconds
public int lockWaitSeconds
IflockModeEnabledistrue, 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. Atruevalue for this property indicates that they should be reversed.
-
useJCC
protected boolean useJCC
-
disableRetainUpdateLocksSQL
public boolean disableRetainUpdateLocksSQL
-
-
Method Detail
-
connectedConfiguration
public void connectedConfiguration(java.sql.Connection conn) throws java.sql.SQLExceptionDescription copied from class:DBDictionaryThis 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 callsuper.connectedConfiguration.- Overrides:
connectedConfigurationin classDBDictionary- Throws:
java.sql.SQLException
-
getColumns
public Column[] getColumns(java.sql.DatabaseMetaData meta, java.lang.String catalog, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.sql.Connection conn) throws java.sql.SQLException
Description copied from class:DBDictionaryReflect on the schema to find columns matching the given table and column patterns.- Overrides:
getColumnsin classDBDictionary- Throws:
java.sql.SQLException
-
getColumns
public Column[] getColumns(java.sql.DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, DBIdentifier columnName, java.sql.Connection conn) throws java.sql.SQLException
Description copied from class:DBDictionaryReflect on the schema to find columns matching the given table and column patterns.- Overrides:
getColumnsin classDBDictionary- Throws:
java.sql.SQLException
-
newColumn
public Column newColumn(java.sql.ResultSet colMeta) throws java.sql.SQLException
Description copied from class:DBDictionaryCreate a new column from the information in the schema metadata.- Overrides:
newColumnin classDBDictionary- Throws:
java.sql.SQLException
-
newPrimaryKey
public PrimaryKey newPrimaryKey(java.sql.ResultSet pkMeta) throws java.sql.SQLException
Description copied from class:DBDictionaryCreate a new primary key from the information in the schema metadata.- Overrides:
newPrimaryKeyin classDBDictionary- Throws:
java.sql.SQLException
-
newIndex
public Index newIndex(java.sql.ResultSet idxMeta) throws java.sql.SQLException
Description copied from class:DBDictionaryCreate a new index from the information in the schema metadata.- Overrides:
newIndexin classDBDictionary- Throws:
java.sql.SQLException
-
setBoolean
public void setBoolean(java.sql.PreparedStatement stmnt, int idx, boolean val, Column col) throws java.sql.SQLExceptionDescription copied from class:DBDictionarySet the given value as a parameter to the statement.- Overrides:
setBooleanin classDBDictionary- Throws:
java.sql.SQLException
-
getCreateTableSQL
public java.lang.String[] getCreateTableSQL(Table table)
Description copied from class:DBDictionaryReturn a series of SQL statements to create the given table, complete with columns. Indexes and constraints will be created separately.- Overrides:
getCreateTableSQLin classDBDictionary
-
getAddPrimaryKeySQL
public java.lang.String[] getAddPrimaryKeySQL(PrimaryKey pk)
Description copied from class:DBDictionaryReturn a series of SQL statements to add the given primary key to its table. Return an empty array if operation not supported. ReturnsALTER TABLE <table name> ADD <pk cons sql >by default.- Overrides:
getAddPrimaryKeySQLin classDBDictionary
-
getAddForeignKeySQL
public java.lang.String[] getAddForeignKeySQL(ForeignKey fk)
Description copied from class:DBDictionaryReturn a series of SQL statements to add the given foreign key to its table. Return an empty array if operation not supported. ReturnsALTER TABLE <table name> ADD <fk cons sql >by default.- Overrides:
getAddForeignKeySQLin classDBDictionary
-
supportsRandomAccessResultSet
public boolean supportsRandomAccessResultSet(Select sel, boolean forUpdate)
Description copied from class:DBDictionaryReturn false if the given select requires a forward-only result set.- Overrides:
supportsRandomAccessResultSetin classDBDictionary
-
decorate
public java.sql.Connection decorate(java.sql.Connection conn) throws java.sql.SQLExceptionDescription copied from class:DBDictionaryDecorate the given connection if needed. Some databases require special handling for JDBC bugs. This implementation issues anyDBDictionary.initializationSQLthat has been set for the dictionary but does not decorate the connection.- Specified by:
decoratein interfaceConnectionDecorator- Overrides:
decoratein classDBDictionary- Throws:
java.sql.SQLException
-
indexOf
public void indexOf(SQLBuffer buf, FilterValue str, FilterValue find, FilterValue start)
Description copied from class:DBDictionaryInvoke this database's indexOf function.- Overrides:
indexOfin classDBDictionary- Parameters:
buf- the SQL buffer to write the indexOf invocation tostr- a query value representing the target stringfind- a query value representing the search stringstart- a query value representing the start index, or null to start at the beginning
-
needsToCreateIndex
public boolean needsToCreateIndex(Index idx, Table table)
- Overrides:
needsToCreateIndexin classDBDictionary
-
useJCC
public boolean useJCC()
-
getSchemaCase
public java.lang.String getSchemaCase()
Return DB specific schemaCase- Specified by:
getSchemaCasein interfaceIdentifierConfiguration- Overrides:
getSchemaCasein classDBDictionary- Returns:
- upper, lower, or preserve
-
isFatalException
public boolean isFatalException(int subtype, java.sql.SQLException ex)Description copied from class:DBDictionaryDetermine 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:
isFatalExceptionin classDBDictionary- Parameters:
subtype- A constant indicating the category of error as defined inStoreException.ex- original SQL Exception as raised by the database driver.- Returns:
- false if the error is fatal.
-
matchErrorState
protected int matchErrorState(java.util.Map<java.lang.Integer,java.util.Set<java.lang.String>> errorStates, java.sql.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:
matchErrorStatein classDBDictionary- Parameters:
errorStates- classification of SQL error states by their specific nature. The keys of the map represent one of the constants defined inStoreException. The value corresponding to a key represent the set of SQL Error States representing specific category of database error. This supplied map is sourced fromsql-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.
-
-