Package org.apache.openjpa.jdbc.sql
Class MariaDBDictionary
java.lang.Object
org.apache.openjpa.jdbc.sql.DBDictionary
org.apache.openjpa.jdbc.sql.MariaDBDictionary
- All Implemented Interfaces:
JoinSyntaxes
,Configurable
,IdentifierConfiguration
,ConnectionDecorator
,LoggingConnectionDecorator.SQLWarningHandler
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
DBDictionary.DateMillisecondBehaviors, DBDictionary.SerializedData
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
boolean
Whether the driver automatically deserializes blobs.static final String
static final String
static final String
static final String
boolean
Whether to inline multi-table bulk-delete operations into MySQL's combinedDELETE FROM foo, bar, baz
syntax.static final String
The MySQL table type to use when creating tables; defaults to innodb.static final String
static final String
boolean
Whether to use clobs; defaults to true.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
appendXmlComparison
(SQLBuffer buf, String op, FilterValue lhs, FilterValue rhs, boolean lhsxml, boolean rhsxml) Append XML comparison.void
This method is called when the dictionary first sees any connection.decorate
(Connection conn) Decorate the given connection if needed.String[]
Return a series of SQL statements to add the given primary key to its table.int
getBatchFetchSize
(int batchFetchSize) getBlobObject
(ResultSet rs, int column, JDBCStore store) Convert the specified column of the SQL ResultSet to the proper java type.String[]
getCreateTableSQL
(Table table) Return a series of SQL statements to create the given table, complete with columns.String[]
getDeleteTableContentsSQL
(Table[] tables, Connection conn) Create SQL to delete the contents of the specified tables.String[]
getDropForeignKeySQL
(ForeignKey fk, Connection conn) ReturnALTER TABLE <table name> DROP FOREIGN KEY <fk name>
.String[]
getDropIndexSQL
(Index index) Return a series of SQL statements to drop the given index.String[]
ReturnALTER TABLE <table name> DROP PRIMARY KEY
.int
getPreferredType
(int type) Return the preferredTypes
type for the given one.Check to see if we have set theSELECT_HINT
in the fetch configuration, and if so, append the MySQL hint after the "SELECT" part of the query.protected Collection<String>
getTypeName
(Column col) OPENJPA-740 Special case for MySql special column types, like LONGTEXT, LONGBLOG etc..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).protected int
matchErrorState
(Map<Integer, Set<String>> errorStates, SQLException ex) Determine the more appropriate type of store exception by matching the SQL Error State of the the given SQLException to the given Error States categorized by error types.protected Column
Create a new column from the information in the schema metadata.protected void
setDelimitedCase
(DatabaseMetaData metaData) void
setTime
(PreparedStatement stmnt, int idx, Time val, Calendar cal, Column col) Set the given 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, applyRange, assertSupport, calculateValue, canOuterJoin, closeDataSource, combineForeignKey, comment, comparison, configureNamingRules, convertSchemaCase, convertSchemaCase, copy, copy, createIndexIfNecessary, createIndexIfNecessary, deleteStream, delimitAll, endConfiguration, executeQuery, fromDBName, getAddColumnSQL, getAddForeignKeySQL, getAlterSequenceSQL, getArray, getAsciiStream, getBatchLimit, getBatchUpdateCount, getBigDecimal, getBigInteger, getBinaryStream, getBlob, getBoolean, getBooleanRepresentation, getByte, getBytes, getCalendar, getCastFunction, getCastFunction, getCatalogNameForMetadata, getCatalogNameForMetadata, getChar, getCharacterStream, getClob, getClobString, getColumnDBName, getColumnIdentifier, getColumnNameForMetadata, getColumnNameForMetadata, getColumns, getColumns, getConversionKey, getCreateIndexSQL, getCreateSequenceSQL, getCreateTableSQL, getDate, getDate, getDateFractionDigits, getDeclareColumnSQL, getDefaultIdentifierRule, getDefaultSchemaName, getDeleteTargets, getDelimitedCase, getDelimitIdentifiers, getDouble, getDropColumnSQL, 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, getPrimaryKeyConstraintSQL, getPrimaryKeys, getPrimaryKeys, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromGetPrimaryKeys, getPrimaryKeysFromGetPrimaryKeys, getRef, getSchemaCase, getSchemaNameForMetadata, getSchemaNameForMetadata, getSelects, getSequence, getSequences, getSequences, getSequencesSQL, getSequencesSQL, getShort, getStoredProcedure, getString, getSupportsDelimitedIdentifiers, getSupportsXMLColumn, getTableNameForMetadata, getTableNameForMetadata, getTables, getTables, getTime, getTimestamp, getTrailingDelimiter, getTrimSchemaName, 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, needsToCreateIndex, 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, 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, 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
-
Field Details
-
SELECT_HINT
- See Also:
-
DELIMITER_BACK_TICK
- See Also:
-
tableType
The MySQL table type to use when creating tables; defaults to innodb. -
useClobs
public boolean useClobsWhether to use clobs; defaults to true. Set this to false if you have an old version of MySQL which does not handle clobs properly. -
driverDeserializesBlobs
public boolean driverDeserializesBlobsWhether the driver automatically deserializes blobs. -
optimizeMultiTableDeletes
public boolean optimizeMultiTableDeletesWhether to inline multi-table bulk-delete operations into MySQL's combinedDELETE FROM foo, bar, baz
syntax. Defaults to false, since this may fail in the presence of InnoDB tables with foreign keys. -
tinyBlobTypeName
- See Also:
-
mediumBlobTypeName
- See Also:
-
longBlobTypeName
- See Also:
-
tinyTextTypeName
- See Also:
-
mediumTextTypeName
- See Also:
-
longTextTypeName
- See Also:
-
-
Constructor Details
-
MariaDBDictionary
public MariaDBDictionary()
-
-
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
-
setDelimitedCase
- Overrides:
setDelimitedCase
in classDBDictionary
-
decorate
Description copied from class:DBDictionary
Decorate the given connection if needed. Some databases require special handling for JDBC bugs. This implementation issues anyDBDictionary.initializationSQL
that has been set for the dictionary but does not decorate the connection.- Specified by:
decorate
in interfaceConnectionDecorator
- Overrides:
decorate
in classDBDictionary
- Throws:
SQLException
-
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
-
getDropIndexSQL
Description copied from class:DBDictionary
Return a series of SQL statements to drop the given index. ReturnsDROP INDEX <index name>
by default.- Overrides:
getDropIndexSQL
in classDBDictionary
-
getDropPrimaryKeySQL
ReturnALTER TABLE <table name> DROP PRIMARY KEY
.- Overrides:
getDropPrimaryKeySQL
in classDBDictionary
-
getDropForeignKeySQL
ReturnALTER TABLE <table name> DROP FOREIGN KEY <fk name>
.- Overrides:
getDropForeignKeySQL
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
-
getDeleteTableContentsSQL
Description copied from class:DBDictionary
Create SQL to delete the contents of the specified tables. The default implementation drops all non-deferred RESTRICT foreign key constraints involving the specified tables, issues DELETE statements against the tables, and then adds the dropped constraints back in. Databases with more optimal ways of deleting the contents of several tables should override this method.- Overrides:
getDeleteTableContentsSQL
in classDBDictionary
-
appendSelectRange
Description copied from class:DBDictionary
If this dictionary can select ranges, use this method to append the range SQL.- Overrides:
appendSelectRange
in classDBDictionary
-
newColumn
Description copied from class:DBDictionary
Create a new column from the information in the schema metadata.- Overrides:
newColumn
in classDBDictionary
- Throws:
SQLException
-
getBlobObject
Description copied from class:DBDictionary
Convert the specified column of the SQL ResultSet to the proper java type.- Overrides:
getBlobObject
in classDBDictionary
- Throws:
SQLException
-
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
-
appendXmlComparison
public void appendXmlComparison(SQLBuffer buf, String op, FilterValue lhs, FilterValue rhs, boolean lhsxml, boolean rhsxml) Append XML comparison.- Overrides:
appendXmlComparison
in classDBDictionary
- Parameters:
buf
- the SQL buffer to write the comparisonop
- the comparison operation to performlhs
- the left hand side of the comparisonrhs
- the right hand side of the comparisonlhsxml
- indicates whether the left operand maps to XMLrhsxml
- indicates whether the right operand maps to XML
-
getBatchFetchSize
public int getBatchFetchSize(int batchFetchSize) - Overrides:
getBatchFetchSize
in classDBDictionary
-
getSelectOperation
Check to see if we have set theSELECT_HINT
in the fetch configuration, and if so, append the MySQL hint after the "SELECT" part of the query.- Overrides:
getSelectOperation
in classDBDictionary
-
getSelectTableAliases
- Overrides:
getSelectTableAliases
in classDBDictionary
-
matchErrorState
Description copied from class:DBDictionary
Determine the more appropriate type of store exception by matching the SQL Error State of the the given SQLException to the given Error States categorized by error types. Dictionary subclass can override this method and extract SQLException data to figure out if the exception is recoverable.- Overrides:
matchErrorState
in 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
.
-
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.
-
getTypeName
OPENJPA-740 Special case for MySql special column types, like LONGTEXT, LONGBLOG etc..- Overrides:
getTypeName
in classDBDictionary
- See Also:
-
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
-
setTime
public void setTime(PreparedStatement stmnt, int idx, Time val, Calendar cal, Column col) throws SQLException Description copied from class:DBDictionary
Set the given value as a parameter to the statement.- Overrides:
setTime
in classDBDictionary
- Throws:
SQLException
-