org.nuxeo.ecm.core.storage.sql.jdbc.dialect

Class DialectMySQL

java.lang.Object

org.nuxeo.ecm.core.storage.sql.jdbc.dialect.Dialect

org.nuxeo.ecm.core.storage.sql.jdbc.dialect.DialectMySQL

public class DialectMySQL
extends Dialect

MySQL-specific dialect.

Author:

Florent Guillaume

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.core.storage.sql.jdbc.dialect.Dialect

Dialect.ArraySubQuery, Dialect.DialectIdType, Dialect.FulltextMatchInfo, Dialect.JDBCInfo

Field Summary

Fields inherited from class org.nuxeo.ecm.core.storage.sql.jdbc.dialect.Dialect

ARRAY_SEP, DEBUG_REAL_UUIDS, DEBUG_UUIDS, DIALECT_CLASS, DIALECTS, NULLS_LAST_ON_DESC_PROP

Constructor Summary

Constructors

Constructor and Description
DialectMySQL(DatabaseMetaData metadata, RepositoryDescriptor repositoryDescriptor)

Method Summary

Methods

Modifier and Type	Method and Description
String	addPagingClause(String sql, long limit, long offset) Returns the SQL query with a paging clause
char	closeQuote()
boolean	doesUpdateFromRepeatSelf() When doing an UPDATE t SET ...
String	getAddForeignKeyConstraintString(String constraintName, String[] foreignKeys, String referencedTable, String[] primaryKeys, boolean referencesPrimaryKey)
String	getBinaryFulltextSql(List<String> columns) Return the SQL to get the columns fulltext fields
String	getClusterDeleteInvalidations() Gets the SQL to delete invalidations for this cluster node.
String	getClusterGetInvalidations() Gets the SQL to query invalidations for this cluster node.
String	getClusterInsertInvalidations() Gets the SQL to send an invalidation to the cluster.
String	getCreateFulltextIndexSql(String indexName, String quotedIndexName, Table table, List<Column> columns, Model model) Gets a CREATE INDEX statement for a fulltext index.
String	getDialectFulltextQuery(String query) Get the dialect-specific version of a fulltext query.
Serializable	getFromResultSet(ResultSet rs, int index, Column column)
int	getFulltextIndexedColumns() Specifies what columns of the fulltext table have to be indexed.
Dialect.FulltextMatchInfo	getFulltextScoredMatchInfo(String fulltextQuery, String indexName, int nthMatch, Column mainColumn, Model model, Database database) Gets the SQL information needed to do a a fulltext match, either with a direct expression in the WHERE clause, or using a join with an additional table.
String	getInTreeSql(String idColumnName) Gets the expression to use to check tree membership.
Dialect.JDBCInfo	getJDBCTypeAndString(ColumnType type) Gets the JDBC type and string from Nuxeo's type abstraction.
boolean	getMaterializeFulltextSyntheticColumn() Does the fulltext synthetic column have to be materialized.
String	getSecurityCheckSql(String idColumnName) Gets the expression to use to check security.
String	getSQLStatementsFilename() Gets the name of the file containing the SQL statements.
Map<String,Serializable>	getSQLStatementsProperties(Model model, Database database) Gets the properties to use with the SQL statements.
String	getTableTypeString(Table table)
String	getTestSQLStatementsFilename()
boolean	isAllowedConversion(int expected, int actual, String actualName, int actualSize) Check mismatches between expected and actual JDBC types read from database introspection.
boolean	isClusteringDeleteNeeded() Does clustering fetch of invalidations ( Dialect.getClusterGetInvalidations()) need a separate delete for them ( Dialect.getClusterDeleteInvalidations()).
boolean	isClusteringSupported() Checks that clustering is supported.
boolean	isConcurrentUpdateException(Throwable t) Checks if an exception received means that a concurrent update was detected.
boolean	isConnectionClosedException(Throwable t) Checks if an exception received means that the low level connection has been trashed and must be reset.
boolean	isIdentityAlreadyPrimary() Checks if an identity column is already defined as a primary key and does not need a separate index added.
boolean	needsAliasForDerivedTable() Whether a derived table (subselect in a FROM statement) needs an alias.
boolean	needsOrderByKeysAfterDistinct() When doing a SELECT DISTINCT that uses a ORDER BY, do the keys along which we order have to be mentioned in the DISTINCT clause?
char	openQuote()
boolean	qualifyIndexName()
void	setToPreparedStatement(PreparedStatement ps, int index, Serializable value, Column column)
boolean	supportsIfExistsBeforeTableName()
boolean	supportsPaging() Indicates if dialect supports paging
boolean	supportsUpdateFrom() Does the dialect support UPDATE t SET ...

Methods inherited from class org.nuxeo.ecm.core.storage.sql.jdbc.dialect.Dialect

castIdToVarchar, createArrayOf, createDialect, existingTableDetected, getAddColumnString, getAddPrimaryKeyConstraintString, getAncestorsIdsSql, getArrayElementString, getArrayIlikeSql, getArrayInSql, getArrayLikeSql, getArrayResult, getArraySubQuery, getBlobLengthFunction, getCalendarFromTimestamp, getCalendarFromTimestamp, getCascadeDropConstraintsString, getClobCast, getClusterNodeIdSql, getColumnName, getConnectionSchema, getCreateIndexSql, getCustomColumnDefinition, getCustomPostCreateSqls, getDateCast, getDescending, getForeignKeyConstraintName, getFreeVariableSetterForType, getFulltextType, getGeneratedId, getIdentityGeneratedKeySql, getIdType, getIgnoredColumns, getIndexName, getMatchMixinType, getMaximumArgsForIn, getNoColumnsInsertString, getNullColumnString, getPostCreateIdentityColumnSql, getPostCreateTableSqls, getPrepareUserReadAclsSql, getPrimaryKeyConstraintName, getReadAclsCheckSql, getRebuildReadAclsSql, getSoftDeleteCleanupSql, getSoftDeleteSql, getTableName, getTimestampFromCalendar, getTimestampFromCalendar, getUpdateReadAclsSql, getValidationQuery, hasIdentityGeneratedKey, hasNullEmptyString, jdbcInfo, jdbcInfo, jdbcInfo, jdbcInfo, needsNullsLastOnDescSort, needsOracleJoins, needsOriginalColumnInGroupBy, needsPrepareUserReadAcls, performAdditionalStatements, performPostOpenStatements, preCreateTable, setId, setIdLong, setToPreparedStatementTimestamp, storesUpperCaseIdentifiers, supportsAncestorsTable, supportsArrayColumns, supportsArrays, supportsArraysReturnInsteadOfRows, supportsCircularCascadeDeleteConstraints, supportsIfExistsAfterTableName, supportsIlike, supportsMultipleFulltextIndexes, supportsReadAcl, supportsSysNameArray, supportsWith, toBooleanValueString, toHexString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DialectMySQL

public DialectMySQL(DatabaseMetaData metadata,
            RepositoryDescriptor repositoryDescriptor)
             throws StorageException

Throws:

StorageException

Method Detail

openQuote

public char openQuote()

Overrides:

openQuote in class Dialect

closeQuote

public char closeQuote()

Overrides:

closeQuote in class Dialect

getAddForeignKeyConstraintString

public String getAddForeignKeyConstraintString(String constraintName,
                                      String[] foreignKeys,
                                      String referencedTable,
                                      String[] primaryKeys,
                                      boolean referencesPrimaryKey)

Overrides:

getAddForeignKeyConstraintString in class Dialect

qualifyIndexName

public boolean qualifyIndexName()

Overrides:

qualifyIndexName in class Dialect

supportsIfExistsBeforeTableName

public boolean supportsIfExistsBeforeTableName()

Overrides:

supportsIfExistsBeforeTableName in class Dialect

getJDBCTypeAndString

public Dialect.JDBCInfo getJDBCTypeAndString(ColumnType type)

Description copied from class: Dialect

Gets the JDBC type and string from Nuxeo's type abstraction.

Specified by:

getJDBCTypeAndString in class Dialect

isAllowedConversion

public boolean isAllowedConversion(int expected,
                          int actual,
                          String actualName,
                          int actualSize)

Description copied from class: Dialect

Check mismatches between expected and actual JDBC types read from database introspection.

Overrides:

isAllowedConversion in class Dialect

setToPreparedStatement

public void setToPreparedStatement(PreparedStatement ps,
                          int index,
                          Serializable value,
                          Column column)
                            throws SQLException

Specified by:

setToPreparedStatement in class Dialect

Throws:

SQLException

getFromResultSet

public Serializable getFromResultSet(ResultSet rs,
                            int index,
                            Column column)
                              throws SQLException

Specified by:

getFromResultSet in class Dialect

Throws:

SQLException

getCreateFulltextIndexSql

public String getCreateFulltextIndexSql(String indexName,
                               String quotedIndexName,
                               Table table,
                               List<Column> columns,
                               Model model)

Description copied from class: Dialect

Gets a CREATE INDEX statement for a fulltext index.

Specified by:

getCreateFulltextIndexSql in class Dialect

getDialectFulltextQuery

public String getDialectFulltextQuery(String query)

Description copied from class: Dialect

Get the dialect-specific version of a fulltext query.

Specified by:

getDialectFulltextQuery in class Dialect

Parameters:

query - the CMIS-syntax-based fulltext query string

Returns:

the dialect native fulltext query string

getFulltextScoredMatchInfo

public Dialect.FulltextMatchInfo getFulltextScoredMatchInfo(String fulltextQuery,
                                                   String indexName,
                                                   int nthMatch,
                                                   Column mainColumn,
                                                   Model model,
                                                   Database database)

Description copied from class: Dialect

Gets the SQL information needed to do a a fulltext match, either with a direct expression in the WHERE clause, or using a join with an additional table.

Specified by:

getFulltextScoredMatchInfo in class Dialect

getMaterializeFulltextSyntheticColumn

public boolean getMaterializeFulltextSyntheticColumn()

Description copied from class: Dialect

Does the fulltext synthetic column have to be materialized.

Specified by:

getMaterializeFulltextSyntheticColumn in class Dialect

getFulltextIndexedColumns

public int getFulltextIndexedColumns()

Description copied from class: Dialect

Specifies what columns of the fulltext table have to be indexed.

Specified by:

getFulltextIndexedColumns in class Dialect

Returns:

0 for none, 1 for the synthetic one, 2 for the individual ones

getTableTypeString

public String getTableTypeString(Table table)

Overrides:

getTableTypeString in class Dialect

supportsUpdateFrom

public boolean supportsUpdateFrom()

Description copied from class: Dialect

Does the dialect support UPDATE t SET ... FROM t, u WHERE ... ?

Specified by:

supportsUpdateFrom in class Dialect

doesUpdateFromRepeatSelf

public boolean doesUpdateFromRepeatSelf()

Description copied from class: Dialect

When doing an UPDATE t SET ... FROM t, u WHERE ..., does the FROM clause need to repeate the updated table (t).

Specified by:

doesUpdateFromRepeatSelf in class Dialect

needsOrderByKeysAfterDistinct

public boolean needsOrderByKeysAfterDistinct()

Description copied from class: Dialect

When doing a SELECT DISTINCT that uses a ORDER BY, do the keys along which we order have to be mentioned in the DISTINCT clause?

Overrides:

needsOrderByKeysAfterDistinct in class Dialect

needsAliasForDerivedTable

public boolean needsAliasForDerivedTable()

Description copied from class: Dialect

Whether a derived table (subselect in a FROM statement) needs an alias.

Overrides:

needsAliasForDerivedTable in class Dialect

getSecurityCheckSql

public String getSecurityCheckSql(String idColumnName)

Description copied from class: Dialect

Gets the expression to use to check security.

Specified by:

getSecurityCheckSql in class Dialect

Parameters:

idColumnName - the quoted name of the id column to use

Returns:

an SQL expression with two parameters (principals and permissions) that is true if access is allowed

getInTreeSql

public String getInTreeSql(String idColumnName)

Description copied from class: Dialect

Gets the expression to use to check tree membership.

Specified by:

getInTreeSql in class Dialect

Parameters:

idColumnName - the quoted name of the id column to use

Returns:

an SQL expression with one parameters for the based id that is true if the document is under base id

getSQLStatementsFilename

public String getSQLStatementsFilename()

Description copied from class: Dialect

Gets the name of the file containing the SQL statements.

Specified by:

getSQLStatementsFilename in class Dialect

getTestSQLStatementsFilename

public String getTestSQLStatementsFilename()

Specified by:

getTestSQLStatementsFilename in class Dialect

getSQLStatementsProperties

public Map<String,Serializable> getSQLStatementsProperties(Model model,
                                                  Database database)

Description copied from class: Dialect

Gets the properties to use with the SQL statements.

Specified by:

getSQLStatementsProperties in class Dialect

isConnectionClosedException

public boolean isConnectionClosedException(Throwable t)

Description copied from class: Dialect

Checks if an exception received means that the low level connection has been trashed and must be reset.

Overrides:

isConnectionClosedException in class Dialect

isConcurrentUpdateException

public boolean isConcurrentUpdateException(Throwable t)

Description copied from class: Dialect

Checks if an exception received means that a concurrent update was detected.

Overrides:

isConcurrentUpdateException in class Dialect

isClusteringSupported

public boolean isClusteringSupported()

Description copied from class: Dialect

Checks that clustering is supported.

Overrides:

isClusteringSupported in class Dialect

isClusteringDeleteNeeded

public boolean isClusteringDeleteNeeded()

Description copied from class: Dialect

Does clustering fetch of invalidations ( Dialect.getClusterGetInvalidations()) need a separate delete for them ( Dialect.getClusterDeleteInvalidations()).

Overrides:

isClusteringDeleteNeeded in class Dialect

getClusterInsertInvalidations

public String getClusterInsertInvalidations()

Description copied from class: Dialect

Gets the SQL to send an invalidation to the cluster.

Overrides:

getClusterInsertInvalidations in class Dialect

Returns:

an SQL statement with parameters for: id, fragments, kind

getClusterGetInvalidations

public String getClusterGetInvalidations()

Description copied from class: Dialect

Gets the SQL to query invalidations for this cluster node.

Overrides:

getClusterGetInvalidations in class Dialect

Returns:

an SQL statement returning a result set

getClusterDeleteInvalidations

public String getClusterDeleteInvalidations()

Description copied from class: Dialect

Gets the SQL to delete invalidations for this cluster node.

Overrides:

getClusterDeleteInvalidations in class Dialect

Returns:

an SQL statement returning a result set

supportsPaging

public boolean supportsPaging()

Description copied from class: Dialect

Indicates if dialect supports paging

Overrides:

supportsPaging in class Dialect

Returns:

true if the dialect supports paging

addPagingClause

public String addPagingClause(String sql,
                     long limit,
                     long offset)

Description copied from class: Dialect

Returns the SQL query with a paging clause

Overrides:

addPagingClause in class Dialect

isIdentityAlreadyPrimary

public boolean isIdentityAlreadyPrimary()

Description copied from class: Dialect

Checks if an identity column is already defined as a primary key and does not need a separate index added.

MySQL defines the identity column directly as primary key.

Overrides:

isIdentityAlreadyPrimary in class Dialect

getBinaryFulltextSql

public String getBinaryFulltextSql(List<String> columns)

Description copied from class: Dialect

Return the SQL to get the columns fulltext fields

Overrides:

getBinaryFulltextSql in class Dialect