Package org.apache.openjpa.jdbc.sql
Class H2Dictionary
java.lang.Object
org.apache.openjpa.jdbc.sql.DBDictionary
org.apache.openjpa.jdbc.sql.H2Dictionary
- All Implemented Interfaces:
JoinSyntaxes
,Configurable
,IdentifierConfiguration
,ConnectionDecorator
,LoggingConnectionDecorator.SQLWarningHandler
Dictionary for H2 ({@link http://www.h2database.com}).
- Since:
- 0.9.7
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
DBDictionary.DateMillisecondBehaviors, DBDictionary.SerializedData
-
Field Summary
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
appendSelectRange
(SQLBuffer buf, long start, long end, boolean subselect) If this dictionary can select ranges, use this method to append the range SQL.void
This method is called when the dictionary first sees any connection.String[]
getAddColumnSQL
(Column column) Return a series of SQL statements to add the given column to its table.String[]
Return a series of SQL statements to add the given primary key to its table.Column[]
getColumns
(DatabaseMetaData meta, String catalog, String schemaName, String tableName, String columnName, Connection conn) Reflect on the schema to find columns matching the given table and column patterns.Column[]
getColumns
(DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, DBIdentifier columnName, Connection conn) Reflect on the schema to find columns matching the given table and column patterns.String[]
getCreateTableSQL
(Table table) Return a series of SQL statements to create the given table, complete with columns.String[]
Return a series of SQL statements to drop the given primary key from its table.int
Convert the specified column of the SQL ResultSet to the proper java type.int
getJDBCType
(int metaTypeCode, boolean lob) getLocalDate
(ResultSet rs, int column) Retrieve the specified column of the SQL ResultSet to the properLocalDate
java type.getLocalDateTime
(ResultSet rs, int column) Retrieve the specified column of the SQL ResultSet to the properLocalDateTime
java type.getLocalTime
(ResultSet rs, int column) Retrieve the specified column of the SQL ResultSet to the properLocalTime
java type.getOffsetDateTime
(ResultSet rs, int column) h2 does intentionally not supportgetTimestamp()
for 'TIME WITH TIME ZONE' columns.int
getPreferredType
(int type) Return the preferredTypes
type for the given one.protected String
Return the declaration SQL for the given primary key.protected String
getSequencesSQL
(String schemaName, String sequenceName) Return the SQL needed to select the list of sequences.protected String
getSequencesSQL
(DBIdentifier schemaName, DBIdentifier sequenceName) void
indexOf
(SQLBuffer buf, FilterValue str, FilterValue find, FilterValue start) Invoke this database's indexOf function.boolean
isFatalException
(int subtype, SQLException ex) Determine if the given SQL Exception is fatal or recoverable (such as a timeout).boolean
isSystemIndex
(String name, Table table) This method is used to filter system indexes from database metadata.boolean
isSystemIndex
(DBIdentifier name, Table table) This method is used to filter system indexes from database metadata.void
setLocalDate
(PreparedStatement stmnt, int idx, LocalDate val, Column col) Set the given LocalDate value as a parameter to the statement.void
setLocalDateTime
(PreparedStatement stmnt, int idx, LocalDateTime val, Column col) Set the given LocalTime value as a parameter to the statement.void
setLocalTime
(PreparedStatement stmnt, int idx, LocalTime val, Column col) Set the given LocalTime value as a parameter to the statement.void
setOffsetDateTime
(PreparedStatement stmnt, int idx, OffsetDateTime val, Column col) Set the given LocalTime value as a parameter to the statement.Methods inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
addCastAsType, addErrorCode, appendCast, appendLength, appendNumericCast, appendSelect, appendSize, appendUpdates, appendXmlComparison, applyRange, assertSupport, calculateValue, canOuterJoin, closeDataSource, combineForeignKey, comment, comparison, configureNamingRules, convertSchemaCase, convertSchemaCase, copy, copy, createIndexIfNecessary, createIndexIfNecessary, decorate, deleteStream, delimitAll, endConfiguration, executeQuery, fromDBName, getAddForeignKeySQL, 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, 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, getInvalidColumnWordSet, getIsNotNullSQL, getIsNullSQL, getJDBCType, getJDBCType, getKey, getLeadingDelimiter, getLOBStream, getLocale, getLog, getLong, getMajorVersion, getMarkerForInsertUpdate, getMillisecondBehavior, getMinorVersion, getNamingUtil, getNumber, getObject, getOffsetTime, getPlaceholderValueString, getPrimaryKeys, getPrimaryKeys, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromGetPrimaryKeys, getPrimaryKeysFromGetPrimaryKeys, getRef, getSchemaCase, getSchemaNameForMetadata, getSchemaNameForMetadata, getSelectOperation, getSelects, getSelectTableAliases, getSequence, getSequences, getSequences, 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, isSystemSequence, isSystemSequence, isSystemSequence, isSystemTable, isSystemTable, isUsingLimit, isUsingOffset, isUsingOrderBy, isUsingRange, makeNameValid, makeNameValid, makeNameValid, makeNameValid, matchErrorState, mathFunction, needsToCreateIndex, needsToCreateIndex, newColumn, newForeignKey, newIndex, newPrimaryKey, newSequence, newStoreException, newTable, prepareStatement, processDBColumnName, putBytes, putChars, putString, refSchemaComponents, serialize, setArray, setAsciiStream, setBatchLimit, setBigDecimal, setBigInteger, setBinaryStream, setBlob, setBlobObject, setBoolean, setBooleanRepresentation, setByte, setBytes, setCalendar, setChar, setCharacterStream, setClob, setClobString, setConfiguration, setDate, setDate, setDateMillisecondBehavior, setDefaultSchemaName, setDelimitedCase, setDelimitIdentifiers, setDouble, setFloat, setInt, setJoinSyntax, setLeadingDelimiter, setLocale, setLong, setMajorVersion, setMinorVersion, setNull, setNumber, setObject, 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, supportsRandomAccessResultSet, 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
-
Constructor Details
-
H2Dictionary
public H2Dictionary()
-
-
Method Details
-
connectedConfiguration
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 callsuper.connectedConfiguration
.- Overrides:
connectedConfiguration
in classDBDictionary
- Throws:
SQLException
-
getJDBCType
public int getJDBCType(int metaTypeCode, boolean lob) Description copied from class:DBDictionary
- Overrides:
getJDBCType
in classDBDictionary
-
getPreferredType
public int getPreferredType(int type) Description copied from class:DBDictionary
Return the preferredTypes
type for the given one. Returns the given type by default.- Overrides:
getPreferredType
in classDBDictionary
-
getAddPrimaryKeySQL
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. ReturnsALTER TABLE <table name> ADD <pk cons sql >
by default.- Overrides:
getAddPrimaryKeySQL
in classDBDictionary
-
getDropPrimaryKeySQL
Description copied from class:DBDictionary
Return a series of SQL statements to drop the given primary key from its table. Return an empty array if operation not supported. ReturnsALTER TABLE <table name> DROP CONSTRAINT <pk name>
by default.- Overrides:
getDropPrimaryKeySQL
in classDBDictionary
-
getAddColumnSQL
Description copied from class:DBDictionary
Return a series of SQL statements to add the given column to its table. Return an empty array if operation not supported. ReturnsALTER TABLE <table name> ADD (<col dec>)
by default.- Overrides:
getAddColumnSQL
in classDBDictionary
-
getCreateTableSQL
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 classDBDictionary
-
getPrimaryKeyConstraintSQL
Description copied from class:DBDictionary
Return the declaration SQL for the given primary key. This method is used from withinDBDictionary.getCreateTableSQL(org.apache.openjpa.jdbc.schema.Table, org.apache.openjpa.jdbc.schema.SchemaGroup)
andDBDictionary.getAddPrimaryKeySQL(org.apache.openjpa.jdbc.schema.PrimaryKey)
. ReturnsCONSTRAINT <pk name> PRIMARY KEY (<col list>)
by default.- Overrides:
getPrimaryKeyConstraintSQL
in classDBDictionary
-
isSystemIndex
Description copied from class:DBDictionary
This method is used to filter system indexes from database metadata. Return true if the given index name represents a system index that should not appear in the schema definition. Returns false by default.- Overrides:
isSystemIndex
in classDBDictionary
- Parameters:
name
- the index nametable
- the index table
-
isSystemIndex
Description copied from class:DBDictionary
This method is used to filter system indexes from database metadata. Return true if the given index name represents a system index that should not appear in the schema definition. Returns false by default.- Overrides:
isSystemIndex
in classDBDictionary
- Parameters:
name
- the index nametable
- the index table
-
getSequencesSQL
Description copied from class:DBDictionary
Return the SQL needed to select the list of sequences.- Overrides:
getSequencesSQL
in classDBDictionary
-
getSequencesSQL
- Overrides:
getSequencesSQL
in classDBDictionary
-
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 classDBDictionary
- 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 classDBDictionary
- Throws:
SQLException
-
setLocalDate
public void setLocalDate(PreparedStatement stmnt, int idx, LocalDate val, Column col) throws SQLException Description copied from class:DBDictionary
Set the given LocalDate value as a parameter to the statement.- Overrides:
setLocalDate
in classDBDictionary
- Throws:
SQLException
-
getLocalDate
Description copied from class:DBDictionary
Retrieve the specified column of the SQL ResultSet to the properLocalDate
java type.- Overrides:
getLocalDate
in classDBDictionary
- Throws:
SQLException
-
setLocalTime
public void setLocalTime(PreparedStatement stmnt, int idx, LocalTime val, Column col) throws SQLException Description copied from class:DBDictionary
Set the given LocalTime value as a parameter to the statement.- Overrides:
setLocalTime
in classDBDictionary
- Throws:
SQLException
-
getLocalTime
Description copied from class:DBDictionary
Retrieve the specified column of the SQL ResultSet to the properLocalTime
java type.- Overrides:
getLocalTime
in classDBDictionary
- Throws:
SQLException
-
setLocalDateTime
public void setLocalDateTime(PreparedStatement stmnt, int idx, LocalDateTime val, Column col) throws SQLException Description copied from class:DBDictionary
Set the given LocalTime value as a parameter to the statement.- Overrides:
setLocalDateTime
in classDBDictionary
- Throws:
SQLException
-
getLocalDateTime
Description copied from class:DBDictionary
Retrieve the specified column of the SQL ResultSet to the properLocalDateTime
java type.- Overrides:
getLocalDateTime
in classDBDictionary
- Throws:
SQLException
-
setOffsetDateTime
public void setOffsetDateTime(PreparedStatement stmnt, int idx, OffsetDateTime val, Column col) throws SQLException Description copied from class:DBDictionary
Set the given LocalTime value as a parameter to the statement.- Overrides:
setOffsetDateTime
in classDBDictionary
- Throws:
SQLException
-
getInt
Description copied from class:DBDictionary
Convert the specified column of the SQL ResultSet to the proper java type.- Overrides:
getInt
in classDBDictionary
- Throws:
SQLException
-
getOffsetDateTime
h2 does intentionally not supportgetTimestamp()
for 'TIME WITH TIME ZONE' columns. See h2 ticket #413.- Overrides:
getOffsetDateTime
in classDBDictionary
- Throws:
SQLException
-
appendSelectRange
Description copied from class:DBDictionary
If this dictionary can select ranges, use this method to append the range SQL.- Overrides:
appendSelectRange
in classDBDictionary
-
indexOf
Description copied from class:DBDictionary
Invoke this database's indexOf function.- Overrides:
indexOf
in 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
-
isFatalException
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 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.
-