org.datanucleus.store.rdbms.adapter

Class MySQLAdapter

java.lang.Object

org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

org.datanucleus.store.rdbms.adapter.MySQLAdapter

All Implemented Interfaces:

DatastoreAdapter

public class MySQLAdapter
extends BaseDatastoreAdapter

Provides methods for adapting SQL language elements to the MySQL database. Note that this also supports the MariaDB database.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NONSQL92_RESERVED_WORDS A string containing the list of MySQL keywords that are not also SQL/92 reserved words, separated by commas.

Fields inherited from class org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

catalogSeparator, datastoreMajorVersion, datastoreMinorVersion, datastoreProductName, datastoreProductVersion, datastoreRevisionVersion, driverMajorVersion, driverMinorVersion, driverName, driverVersion, identifierQuoteString, maxColumnNameLength, maxConstraintNameLength, maxIndexNameLength, maxTableNameLength, properties, reservedKeywords, supportedJdbcTypesById, supportedOptions, unsupportedJdbcTypesById

Fields inherited from interface org.datanucleus.store.rdbms.adapter.DatastoreAdapter

ACCESS_PARENTQUERY_IN_SUBQUERY_JOINED, ALTER_TABLE_DROP_CONSTRAINT_SYNTAX, ALTER_TABLE_DROP_FOREIGN_KEY_CONSTRAINT, ANALYSIS_METHODS, ANSI_CROSSJOIN_SYNTAX, ANSI_JOIN_SYNTAX, AUTO_INCREMENT_COLUMN_TYPE_SPECIFICATION, AUTO_INCREMENT_KEYS_NULL_SPECIFICATION, AUTO_INCREMENT_PK_IN_CREATE_TABLE_COLUMN_DEF, BIT_IS_REALLY_BOOLEAN, BLOB_SET_USING_SETSTRING, BOOLEAN_COMPARISON, CATALOGS_IN_TABLE_DEFINITIONS, CHAR_COLUMNS_PADDED_WITH_SPACES, CHECK_IN_CREATE_STATEMENTS, CHECK_IN_END_CREATE_STATEMENTS, CLOB_SET_USING_SETSTRING, CREATE_INDEXES_BEFORE_FOREIGN_KEYS, CROSSJOIN_ASINNER11_SYNTAX, DATETIME_STORES_MILLISECS, DEFAULT_BEFORE_NULL_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_WITH_NOT_NULL_IN_COLUMN_OPTIONS, DEFERRED_CONSTRAINTS, DISTINCT_WITH_SELECT_FOR_UPDATE, ESCAPE_EXPRESSION_IN_LIKE_PREDICATE, EXISTS_SYNTAX, FK_DELETE_ACTION_CASCADE, FK_DELETE_ACTION_DEFAULT, FK_DELETE_ACTION_NULL, FK_DELETE_ACTION_RESTRICT, FK_IN_END_CREATE_STATEMENTS, FK_UPDATE_ACTION_CASCADE, FK_UPDATE_ACTION_DEFAULT, FK_UPDATE_ACTION_NULL, FK_UPDATE_ACTION_RESTRICT, GET_GENERATED_KEYS_STATEMENT, GROUP_BY_REQUIRES_ALL_SELECT_PRIMARIES, GROUPING_WITH_SELECT_FOR_UPDATE, HAVING_WITH_SELECT_FOR_UPDATE, HOLD_CURSORS_OVER_COMMIT, IDENTIFIERS_LOWERCASE, IDENTIFIERS_LOWERCASE_QUOTED, IDENTIFIERS_MIXEDCASE, IDENTIFIERS_MIXEDCASE_QUOTED, IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE, IDENTIFIERS_MIXEDCASE_SENSITIVE, IDENTIFIERS_UPPERCASE, IDENTIFIERS_UPPERCASE_QUOTED, IDENTITY_COLUMNS, INCLUDE_ORDERBY_COLS_IN_SELECT, LOCK_OPTION_PLACED_AFTER_FROM, LOCK_OPTION_PLACED_WITHIN_JOIN, LOCK_WITH_SELECT_FOR_UPDATE, MULTITABLES_WITH_SELECT_FOR_UPDATE, NULL_EQUALS_EMPTY_STRING, NULLS_IN_CANDIDATE_KEYS, NULLS_KEYWORD_IN_COLUMN_OPTIONS, OPERATOR_BITWISE_AND, OPERATOR_BITWISE_OR, OPERATOR_BITWISE_XOR, ORDERBY_NULLS_DIRECTIVES, ORDERBY_NULLS_USING_CASE_NULL, ORDERBY_NULLS_USING_COLUMN_IS_NULL, ORDERBY_NULLS_USING_ISNULL, ORDERBY_USING_SELECT_COLUMN_INDEX, ORDERING_WITH_SELECT_FOR_UPDATE, PERSIST_OF_UNASSIGNED_CHAR, PRIMARYKEY_IN_CREATE_STATEMENTS, PROJECTION_IN_TABLE_REFERENCE_JOINS, RESULTSET_TYPE_FORWARD_ONLY, RESULTSET_TYPE_SCROLL_INSENSITIVE, RESULTSET_TYPE_SCROLL_SENSITIVE, RIGHT_OUTER_JOIN, SCHEMAS_IN_TABLE_DEFINITIONS, SELECT_FOR_UPDATE_NOWAIT, SEQUENCES, SOME_ANY_ALL_SUBQUERY_EXPRESSIONS, STATEMENT_BATCHING, STORED_PROCEDURES, SUBQUERY_IN_HAVING, TX_ISOLATION_NONE, TX_ISOLATION_READ_COMMITTED, TX_ISOLATION_READ_UNCOMMITTED, TX_ISOLATION_REPEATABLE_READ, TX_ISOLATION_SERIALIZABLE, UNION_SYNTAX, UNIQUE_IN_END_CREATE_STATEMENTS, UPDATE_DELETE_STATEMENT_ALLOW_TABLE_ALIAS_IN_WHERE_CLAUSE, UPDATE_STATEMENT_ALLOW_TABLE_ALIAS_IN_SET_CLAUSE, USE_UNION_ALL, VIEWS

Constructor Summary

Constructors

Constructor and Description
MySQLAdapter(DatabaseMetaData metadata) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getAddColumnStatement(Table table, Column col) Accessor for the SQL statement to add a column to a table.
String	getAddPrimaryKeyStatement(PrimaryKey pk, IdentifierFactory factory) MySQL, when using AUTO_INCREMENT, requires the primary key specified in the CREATE TABLE, so we do nothing here.
String	getAutoIncrementKeyword() Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).
String	getAutoIncrementStmt(Table table, String columnName) Accessor for the auto-increment sql statement for this datastore.
String	getCreateDatabaseStatement(String catalogName, String schemaName) Method to return the statement necessary to create a database with this RDBMS.
String	getCreateTableStatement(TableImpl table, Column[] columns, Properties props, IdentifierFactory factory) Method to return the CREATE TABLE statement.
String	getDeleteTableStatement(SQLTable tbl) Method to return the basic SQL for a DELETE TABLE statement.
String	getDropDatabaseStatement(String catalogName, String schemaName) Method to return the statement necessary to drop a database with this RDBMS.
String	getDropTableStatement(Table table) Method to return the DROP TABLE statement.
String	getEscapePatternExpression() The character for escaping patterns.
String	getRangeByLimitEndOfStatementClause(long offset, long count, boolean hasOrdering) Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the LIMUT keyword.
String	getSelectNewUUIDStmt() The function to creates a unique value of type uniqueidentifier.
String	getVendorID() Accessor for the Vendor ID for this datastore.
void	initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler, org.datanucleus.store.connection.ManagedConnection mconn) Initialise the types for this datastore.
RDBMSColumnInfo	newRDBMSColumnInfo(ResultSet rs) Method to create a column info for the current row.
SQLTypeInfo	newSQLTypeInfo(ResultSet rs) Create a new SQL type info from the current row of the passed ResultSet.
boolean	validToIndexMapping(JavaTypeMapping mapping) Method to return whether the specified mapping is indexable.

Methods inherited from class org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

addSQLTypeForJDBCType, getAdapterTime, getAddCandidateKeyStatement, getAddForeignKeyStatement, getAutoIncrementJavaTypeForType, getCatalogName, getCatalogSeparator, getCheckConstraintForValues, getColumns, getContinuationString, getCreateIndexStatement, getDatastoreDateStatement, getDatastoreDriverName, getDatastoreDriverVersion, getDatastoreIdentifierMaxLength, getDatastoreProductName, getDatastoreProductVersion, getDriverMajorVersion, getDriverMinorVersion, getDropViewStatement, getEscapeCharacter, getExistingIndexes, getIdentifierQuoteString, getInsertStatementForNoColumns, getJDBCTypeForName, getMappingManager, getMaxForeignKeys, getMaxIndexes, getMiliseconds, getNameForJDBCType, getNewUUIDFunction, getNumericConversionFunction, getOperatorConcat, getOrderString, getPatternExpressionAnyCharacter, getPatternExpressionZeroMoreCharacters, getRangeByRowNumberColumn, getRangeByRowNumberColumn2, getRequiredTransactionIsolationLevel, getSchemaName, getSelectForUpdateText, getSelectWithLockOption, getSequenceCreateStmt, getSequenceNextStmt, getSQLTypeInfoForJdbcType, getSupportedOptions, getSurrogateForEmptyStrings, getTime, getTransactionIsolationForSchemaCreation, getUnlimitedLengthPrecisionValue, getUpdateTableStatement, getValueForProperty, initialiseDatastore, isIdentityFieldDataType, isReservedKeyword, isStatementCancel, isStatementTimeout, isValidPrimaryKeyType, iteratorReservedWords, newFKInfo, removeUnsupportedMappings, sequenceExists, setProperties, supportsOption, supportsQueryFetchSize, supportsTransactionIsolation, toString, validToSelectMappingInStatement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NONSQL92_RESERVED_WORDS

public static final String NONSQL92_RESERVED_WORDS

A string containing the list of MySQL keywords that are not also SQL/92 reserved words, separated by commas. This list is normally obtained dynamically from the driver using DatabaseMetaData.getSQLKeywords(), but MySQL drivers are known to return an incomplete list.

This list was produced based on the reserved word list in the MySQL Manual (Version 4.0.10-gamma) at http://www.mysql.com/doc/en/Reserved_words.html.

See Also:

Constant Field Values

Constructor Detail

MySQLAdapter

public MySQLAdapter(DatabaseMetaData metadata)

Constructor. Overridden so we can add on our own list of NON SQL92 reserved words which is returned incorrectly with the JDBC driver.

Parameters:

metadata - MetaData for the DB

Method Detail

initialiseTypes

public void initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler,
                            org.datanucleus.store.connection.ManagedConnection mconn)

Initialise the types for this datastore.

Specified by:

initialiseTypes in interface DatastoreAdapter

Overrides:

initialiseTypes in class BaseDatastoreAdapter

Parameters:

handler - SchemaHandler that we initialise the types for

mconn - Managed connection to use

getVendorID

public String getVendorID()

Description copied from interface: DatastoreAdapter

Accessor for the Vendor ID for this datastore.

Specified by:

getVendorID in interface DatastoreAdapter

Overrides:

getVendorID in class BaseDatastoreAdapter

Returns:

Vendor id for this datastore

newRDBMSColumnInfo

public RDBMSColumnInfo newRDBMSColumnInfo(ResultSet rs)

Method to create a column info for the current row. Overrides the dataType for BLOB/CLOB as necessary

Specified by:

newRDBMSColumnInfo in interface DatastoreAdapter

Overrides:

newRDBMSColumnInfo in class BaseDatastoreAdapter

Parameters:

rs - ResultSet from DatabaseMetaData.getColumns()

Returns:

column info

newSQLTypeInfo

public SQLTypeInfo newSQLTypeInfo(ResultSet rs)

Description copied from interface: DatastoreAdapter

Create a new SQL type info from the current row of the passed ResultSet. Allows an adapter to override particular types where the JDBC driver is known to be buggy.

Specified by:

newSQLTypeInfo in interface DatastoreAdapter

Overrides:

newSQLTypeInfo in class BaseDatastoreAdapter

Parameters:

rs - ResultSet

Returns:

The SQL type info

getCreateDatabaseStatement

public String getCreateDatabaseStatement(String catalogName,
                                         String schemaName)

Description copied from interface: DatastoreAdapter

Method to return the statement necessary to create a database with this RDBMS. Note that some RDBMS don't support this.

Specified by:

getCreateDatabaseStatement in interface DatastoreAdapter

Overrides:

getCreateDatabaseStatement in class BaseDatastoreAdapter

Parameters:

catalogName - name of the catalog

schemaName - Name of the schema

Returns:

The DDL statement

getDropDatabaseStatement

public String getDropDatabaseStatement(String catalogName,
                                       String schemaName)

Description copied from interface: DatastoreAdapter

Method to return the statement necessary to drop a database with this RDBMS. Note that some RDBMS don't support this.

Specified by:

getDropDatabaseStatement in interface DatastoreAdapter

Overrides:

getDropDatabaseStatement in class BaseDatastoreAdapter

Parameters:

catalogName - Name of the catalog

schemaName - Name of the schema

Returns:

The DDL statement

getAddPrimaryKeyStatement

public String getAddPrimaryKeyStatement(PrimaryKey pk,
                                        IdentifierFactory factory)

MySQL, when using AUTO_INCREMENT, requires the primary key specified in the CREATE TABLE, so we do nothing here.

Specified by:

getAddPrimaryKeyStatement in interface DatastoreAdapter

Overrides:

getAddPrimaryKeyStatement in class BaseDatastoreAdapter

Parameters:

pk - An object describing the primary key.

factory - Identifier factory

Returns:

The PK statement

getCreateTableStatement

public String getCreateTableStatement(TableImpl table,
                                      Column[] columns,
                                      Properties props,
                                      IdentifierFactory factory)

Method to return the CREATE TABLE statement. Versions before 5 need INNODB table type selecting for them. It seems, MySQL ≥ 5 still needs innodb in order to support transactions.

Specified by:

getCreateTableStatement in interface DatastoreAdapter

Overrides:

getCreateTableStatement in class BaseDatastoreAdapter

Parameters:

table - The table

columns - The columns in the table

props - Properties for controlling the table creation

factory - Identifier factory

Returns:

The creation statement

getDropTableStatement

public String getDropTableStatement(Table table)

Method to return the DROP TABLE statement. Override the default omitting the CASCADE part since MySQL doesn't support that.

Specified by:

getDropTableStatement in interface DatastoreAdapter

Overrides:

getDropTableStatement in class BaseDatastoreAdapter

Parameters:

table - The table

Returns:

The drop statement

getAddColumnStatement

public String getAddColumnStatement(Table table,
                                    Column col)

Accessor for the SQL statement to add a column to a table.

Specified by:

getAddColumnStatement in interface DatastoreAdapter

Overrides:

getAddColumnStatement in class BaseDatastoreAdapter

Parameters:

table - The table

col - The column

Returns:

The SQL necessary to add the column

getDeleteTableStatement

public String getDeleteTableStatement(SQLTable tbl)

Method to return the basic SQL for a DELETE TABLE statement. Returns the String as DELETE t1 FROM tbl t1. Doesn't include any where clause.

Specified by:

getDeleteTableStatement in interface DatastoreAdapter

Overrides:

getDeleteTableStatement in class BaseDatastoreAdapter

Parameters:

tbl - The SQLTable to delete

Returns:

The delete table string

getAutoIncrementStmt

public String getAutoIncrementStmt(Table table,
                                   String columnName)

Accessor for the auto-increment sql statement for this datastore.

Specified by:

getAutoIncrementStmt in interface DatastoreAdapter

Overrides:

getAutoIncrementStmt in class BaseDatastoreAdapter

Parameters:

table - Name of the table that the autoincrement is for

columnName - Name of the column that the autoincrement is for

Returns:

The statement for getting the latest auto-increment key

getAutoIncrementKeyword

public String getAutoIncrementKeyword()

Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).

Specified by:

getAutoIncrementKeyword in interface DatastoreAdapter

Overrides:

getAutoIncrementKeyword in class BaseDatastoreAdapter

Returns:

The keyword for a column using auto-increment

getSelectNewUUIDStmt

public String getSelectNewUUIDStmt()

The function to creates a unique value of type uniqueidentifier. MySQL generates 36-character hex uuids.

Specified by:

getSelectNewUUIDStmt in interface DatastoreAdapter

Overrides:

getSelectNewUUIDStmt in class BaseDatastoreAdapter

Returns:

The function. e.g. "SELECT uuid()"

getRangeByLimitEndOfStatementClause

public String getRangeByLimitEndOfStatementClause(long offset,
                                                  long count,
                                                  boolean hasOrdering)

Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the LIMUT keyword.

Specified by:

getRangeByLimitEndOfStatementClause in interface DatastoreAdapter

Overrides:

getRangeByLimitEndOfStatementClause in class BaseDatastoreAdapter

Parameters:

offset - The offset to return from

count - The number of items to return

hasOrdering - Whether ordering is present

Returns:

The SQL to append to allow for ranges using OFFSET/FETCH.

getEscapePatternExpression

public String getEscapePatternExpression()

The character for escaping patterns.

Specified by:

getEscapePatternExpression in interface DatastoreAdapter

Overrides:

getEscapePatternExpression in class BaseDatastoreAdapter

Returns:

Escape character(s)

validToIndexMapping

public boolean validToIndexMapping(JavaTypeMapping mapping)

Description copied from interface: DatastoreAdapter

Method to return whether the specified mapping is indexable. Allows a datastore to not index particular column types.

Specified by:

validToIndexMapping in interface DatastoreAdapter

Overrides:

validToIndexMapping in class BaseDatastoreAdapter

Parameters:

mapping - The mapping

Returns:

Whether it is indexable