Dialect (Nuxeo ECM Projects 9.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.core.storage.sql.jdbc.dialect.Dialect

Direct Known Subclasses:

DialectDB2, DialectDerby, DialectH2, DialectHSQLDB, DialectMySQL, DialectOracle, DialectPostgreSQL, DialectSQLServer
```
public abstract class Dialect
extends Object
```
A Dialect encapsulates knowledge about database-specific behavior.

Author:

Florent Guillaume

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Dialect.ArraySubQuery` Structured Array Subquery Abstract Class.
`static class`	`Dialect.DialectIdType` Type of id when stored in the database.
`static class`	`Dialect.FulltextMatchInfo` Information needed to express fulltext search with scoring.
`static class`	`Dialect.JDBCInfo`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`aclOptimizationsEnabled`
`static String`	`ARRAY_SEP`
`protected boolean`	`clusteringEnabled`
`static boolean`	`DEBUG_REAL_UUIDS`
`static boolean`	`DEBUG_UUIDS`
`protected String`	`descending` Store the SQL for descending order
`static String`	`DIALECT_CLASS` System property to override the dialect to use globally instead of the one auto-detected.
`static Map<String,Class<? extends Dialect>>`	`DIALECTS`
`protected boolean`	`fulltextDisabled`
`protected boolean`	`fulltextSearchDisabled`
`protected static char[]`	`HEX_DIGITS`
`static String`	`NULLS_LAST_ON_DESC_PROP` Property used to disable NULLS LAST usage when sorting DESC.
`protected boolean`	`proxiesEnabled`
`protected int`	`readAclMaxSize`
`protected boolean`	`softDeleteEnabled`
`protected boolean`	`storesUpperCaseIdentifiers`

Constructor Summary

Constructors
Constructor and Description

Dialect(DatabaseMetaData metadata, RepositoryDescriptor repositoryDescriptor)

Constructors
Constructor and Description
`Dialect(DatabaseMetaData metadata, RepositoryDescriptor repositoryDescriptor)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addPagingClause(String sql, long limit, long offset)` Returns the SQL query with a paging clause
`String`	`castIdToVarchar(String expr)` Casts an id column to a VARCHAR type.
`abstract List<String>`	`checkStoredProcedure(String procName, String procCreate, String ddlMode, Connection connection, JDBCLogger logger, Map<String,Serializable> properties)` Checks if a given stored procedure exists and is identical to the passed creation SQL.
`char`	`closeQuote()`
`Array`	`createArrayOf(int type, Object[] elements, Connection connection)` Factory method for creating Array objects, suitable for passing to `PreparedStatement.setArray(int, java.sql.Array)`.
`static Dialect`	`createDialect(Connection connection, RepositoryDescriptor repositoryDescriptor)` Creates a `Dialect` by connecting to the datasource to check what database is used.
`abstract boolean`	`doesUpdateFromRepeatSelf()` When doing an UPDATE t SET ...
`String`	`getAddColumnString()`
`String`	`getAddForeignKeyConstraintString(String constraintName, String[] foreignKeys, String referencedTable, String[] primaryKeys, boolean referencesPrimaryKey)`
`String`	`getAddPrimaryKeyConstraintString(String constraintName)`
`String`	`getAncestorsIdsSql()` Gets the SQL query to get the ancestors of a set of ids.
`String`	`getArrayElementString(String arrayColumnName, int arrayElementIndex)` Get SQL Array Element Subscripted string.
`String`	`getArrayIlikeSql(Column arrayColumn, String refName, boolean positive, Table dataHierTable)` Gets the SQL string for an array column ILIKE expression.
`String`	`getArrayInSql(Column arrayColumn, String cast, boolean positive, List<Serializable> params)` Gets the SQL string for an array column IN expression.
`String`	`getArrayLikeSql(Column arrayColumn, String refName, boolean positive, Table dataHierTable)` Gets the SQL string for an array column LIKE expression.
`Serializable[]`	`getArrayResult(Array array)` Gets the array result as a converted array of Serializable.
`Dialect.ArraySubQuery`	`getArraySubQuery(Column arrayColumn, String subQueryAlias)` Gets the dialect-specific subquery for an array column.
`String`	`getBinaryFulltextSql(List<String> columns)` Return the SQL to get the columns fulltext fields
`String`	`getBlobLengthFunction()` Gets the SQL function that returns the length of a blob, in bytes.
`Calendar`	`getCalendarFromTimestamp(Timestamp value)`
`Calendar[]`	`getCalendarFromTimestamp(Timestamp[] value)`
`String`	`getCascadeDropConstraintsString()`
`String`	`getClobCast(boolean inOrderBy)` When using a CLOB field in an expression, is some casting required and with what pattern?
`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`	`getColumnName(String name)`
`String`	`getConnectionSchema(Connection connection)` Gets the schema to use to query metadata about existing tables.
`abstract String`	`getCreateFulltextIndexSql(String indexName, String quotedIndexName, Table table, List<Column> columns, Model model)` Gets a CREATE INDEX statement for a fulltext index.
`String`	`getCreateIndexSql(String indexName, Table.IndexType indexType, Table table, List<Column> columns, Model model)` Gets a CREATE INDEX statement for an index.
`String`	`getCustomColumnDefinition(Table table)` Additional column definitions for CREATE TABLE.
`List<String>`	`getCustomPostCreateSqls(Table table, Model model)` Additional things to execute after CREATE TABLE.
`String`	`getDateCast()` Get the expression to use to cast a column to a DATE type.
`String`	`getDescending()` Gets the SQL descending sort direction with option to sort nulls last.
`abstract String`	`getDialectFulltextQuery(String query)` Get the dialect-specific version of a fulltext query.
`Collection<? extends String>`	`getDumpStart()` Returns the initial DDL statements to add to a DDL dump.
`Collection<? extends String>`	`getDumpStop()` Returns the final DDL statements to add to a DDL dump.
`String`	`getForeignKeyConstraintName(String tableName, String foreignColumnName, String foreignTableName)`
`String`	`getFreeVariableSetterForType(ColumnType type)` Gets the JDBC expression setting a free value for this column type.
`abstract Serializable`	`getFromResultSet(ResultSet rs, int index, Column column)`
`protected Serializable`	`getFromResultSetString(ResultSet rs, int index, Column column)`
`protected Serializable`	`getFromResultSetTimestamp(ResultSet rs, int index, Column column)`
`abstract int`	`getFulltextIndexedColumns()` Specifies what columns of the fulltext table have to be indexed.
`abstract 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.
`int`	`getFulltextType()` Gets the type of a fulltext column has known by JDBC.
`Serializable`	`getGeneratedId(Connection connection)` Gets a generated id if so configured, otherwise returns null.
`String`	`getIdentityGeneratedKeySql(Column column)` Gets the SQL query to execute to retrieve the last generated identity key.
`Dialect.DialectIdType`	`getIdType()` Gets the type of id when stored in the database.
`List<String>`	`getIgnoredColumns(Table table)` Columns ignored if we see them in existing tables.
`String`	`getIndexName(String tableName, List<String> columnNames)`
`abstract String`	`getInTreeSql(String idColumnName, String id)` Gets the expression to use to check tree membership.
`abstract Dialect.JDBCInfo`	`getJDBCTypeAndString(ColumnType type)` Gets the JDBC type and string from Nuxeo's type abstraction.
`String`	`getLikeEscaping()` Gets the SQL fragment to add after a LIKE match to specify the escaping character.
`String`	`getMatchMixinType(Column mixinsColumn, String mixin, boolean positive, String[] returnParam)` Gets the SQL fragment to match a mixin type.
`abstract boolean`	`getMaterializeFulltextSyntheticColumn()` Does the fulltext synthetic column have to be materialized.
`int`	`getMaximumArgsForIn()` Maximum number of values in a IN (?, ?, ...) statement.
`protected int`	`getMaxIndexNameSize()`
`protected int`	`getMaxNameSize()`
`String`	`getNoColumnsInsertString(Column idColumn)`
`String`	`getNullColumnString()`
`List<String>`	`getPostCreateIdentityColumnSql(Column column)` Gets additional SQL statements to execute after the CREATE TABLE when creating an identity column.
`String`	`getPrepareUserReadAclsSql()` Gets the SQL expression to prepare the user read acls cache.
`String`	`getPrimaryKeyConstraintName(String tableName)`
`String`	`getReadAclsCheckSql(String userIdCol)` Gets the expression to check if access is allowed using read acls.
`String`	`getRebuildReadAclsSql()` Gets the statement to rebuild the wall read acls
`abstract String`	`getSecurityCheckSql(String idColumnName)` Gets the expression to use to check security.
`String`	`getSoftDeleteCleanupSql()` SQL to clean soft-delete documents.
`String`	`getSoftDeleteSql()` SQL to soft delete documents.
`String`	`getSQLForDump(String sql)` Returns the SQL statement with proper terminator to use in a dump.
`abstract String`	`getSQLStatementsFilename()` Gets the name of the file containing the SQL statements.
`abstract Map<String,Serializable>`	`getSQLStatementsProperties(Model model, Database database)` Gets the properties to use with the SQL statements.
`List<String>`	`getStartupSqls(Model model, Database database)` Gets the sql statements to execute after the repository init (at startup).
`String`	`getTableName(String name)`
`String`	`getTableTypeString(Table table)`
`abstract String`	`getTestSQLStatementsFilename()`
`Timestamp`	`getTimestampFromCalendar(Calendar value)`
`Timestamp[]`	`getTimestampFromCalendar(Serializable[] value)`
`String`	`getUpdateReadAclsSql()` Gets the statement to update the read acls
`String`	`getValidationQuery()` A query that, when executed, will make at least a round-trip to the server to check that the connection is alive.
`boolean`	`hasIdentityGeneratedKey()` True if the dialect returns the generated key for the identity from the insert statement.
`boolean`	`hasNullEmptyString()` Does the dialect have an empty string identical to NULL (Oracle).
`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 ( `getClusterGetInvalidations()`) need a separate delete for them.
`boolean`	`isClusteringSupported()` Checks that clustering is supported.
`boolean`	`isConcurrentUpdateException(Throwable t)` Checks if an exception received means that a concurrent update was detected.
`boolean`	`isIdentityAlreadyPrimary()` Checks if an identity column is already defined as a primary key and does not need a separate index added.
`static Dialect.JDBCInfo`	`jdbcInfo(String string, int jdbcType)`
`static Dialect.JDBCInfo`	`jdbcInfo(String string, int length, int jdbcType)`
`static Dialect.JDBCInfo`	`jdbcInfo(String string, int length, int jdbcType, String jdbcBaseTypeString, int jdbcBaseType)`
`static Dialect.JDBCInfo`	`jdbcInfo(String string, int jdbcType, String jdbcBaseTypeString, int jdbcBaseType)`
`protected String`	`makeName(String name, int maxNameSize)`
`protected String`	`makeName(String prefix, String string, String suffix, int maxNameSize)`
`boolean`	`needsAliasForDerivedTable()` Whether a derived table (subselect in a FROM statement) needs an alias.
`boolean`	`needsNullsLastOnDescSort()` True if the dialect need an extra NULLS LAST on DESC sort.
`boolean`	`needsOracleJoins()` Whether implicit Oracle joins (instead of explicit ANSI joins) are needed.
`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?
`boolean`	`needsOriginalColumnInGroupBy()` Whether a GROUP BY can only be used with the original column name and not an alias.
`boolean`	`needsPrepareUserReadAcls()` The dialect need an extra SQL statement to populate a user read acl cache before running the query.
`char`	`openQuote()`
`void`	`performAdditionalStatements(Connection connection)` Let the dialect processes additional statements after tables creation and conditional statements.
`void`	`performPostOpenStatements(Connection connection)` Let the dialect perform additional statements just after the connection is opened.
`boolean`	`qualifyIndexName()`
`void`	`setId(PreparedStatement ps, int index, Serializable value)` Sets a prepared statement value that is a Nuxeo main id (usually UUID).
`void`	`setIdLong(PreparedStatement ps, int index, Serializable value)` Sets a long id (sequence) from a value that may be a String or already a Long.
`abstract void`	`setToPreparedStatement(PreparedStatement ps, int index, Serializable value, Column column)`
`protected void`	`setToPreparedStatementString(PreparedStatement ps, int index, Serializable value, Column column)`
`void`	`setToPreparedStatementTimestamp(PreparedStatement ps, int index, Serializable value, Column column)`
`boolean`	`storesUpperCaseIdentifiers()`
`boolean`	`supportsAncestorsTable()` Checks if the dialect supports an ancestors table.
`boolean`	`supportsArrayColumns()` Does the dialect support storing arrays in table columns.
`boolean`	`supportsArrays()` Does the dialect support passing ARRAY values (to stored procedures mostly).
`boolean`	`supportsArraysReturnInsteadOfRows()` Does a stored function returning an result set need to access it as a single array instead of iterating over a normal result set's rows.
`boolean`	`supportsBatchUpdateCount()` Does the dialect report accurate update counts for batch updates.
`boolean`	`supportsCircularCascadeDeleteConstraints()`
`boolean`	`supportsFastDescendants()` Checks whether `getInTreeSql(String, String)` is optimized for fast results (using an ancestors or descendants table).
`boolean`	`supportsIfExistsAfterTableName()`
`boolean`	`supportsIfExistsBeforeTableName()`
`boolean`	`supportsIlike()` Does the dialect support ILIKE operator
`boolean`	`supportsMultipleFulltextIndexes()` SQL Server supports only one fulltext index.
`boolean`	`supportsPaging()` Indicates if dialect supports paging
`boolean`	`supportsReadAcl()` Does the dialect support an optimized read security checks
`boolean`	`supportsScroll()` Does the dialect support an scroll API
`boolean`	`supportsSysNameArray()` Checks if the dialect supports storing arrays of system names (for mixins for instance).
`abstract boolean`	`supportsUpdateFrom()` Does the dialect support UPDATE t SET ...
`boolean`	`supportsWith()` Does the dialect support SQL-99 WITH common table expressions.
`String`	`toBooleanValueString(boolean bool)`
`static String`	`toHexString(byte[] bytes)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DEBUG_UUIDS
```
public static final boolean DEBUG_UUIDS
```
  See Also:
  
  Constant Field Values
- DEBUG_REAL_UUIDS
```
public static final boolean DEBUG_REAL_UUIDS
```
  See Also:
  
  Constant Field Values
- NULLS_LAST_ON_DESC_PROP
```
public static final String NULLS_LAST_ON_DESC_PROP
```
  Property used to disable NULLS LAST usage when sorting DESC. This increase performance for some dialects because they can use an index for sorting when there are no NULL value.
  
  Since:
  
  5.9
  
  See Also:
  
  Constant Field Values
- descending
```
protected String descending
```
  Store the SQL for descending order
  
  Since:
  
  5.9
- DIALECT_CLASS
```
public static final String DIALECT_CLASS
```
  System property to override the dialect to use globally instead of the one auto-detected. It can be suffixed by "." and the database name (without spaces and as returned by the database itself) to override only for a specific database.
  
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- DIALECTS
```
public static final Map<String,Class<? extends Dialect>> DIALECTS
```
- storesUpperCaseIdentifiers
```
protected final boolean storesUpperCaseIdentifiers
```
- fulltextDisabled
```
protected boolean fulltextDisabled
```
- fulltextSearchDisabled
```
protected boolean fulltextSearchDisabled
```
- aclOptimizationsEnabled
```
protected final boolean aclOptimizationsEnabled
```
- clusteringEnabled
```
protected boolean clusteringEnabled
```
  Since:
  
  5.7
- softDeleteEnabled
```
protected boolean softDeleteEnabled
```
  Since:
  
  5.7
- proxiesEnabled
```
protected boolean proxiesEnabled
```
- readAclMaxSize
```
protected final int readAclMaxSize
```
- ARRAY_SEP
```
public static final String ARRAY_SEP
```
  See Also:
  
  Constant Field Values
- HEX_DIGITS
```
protected static final char[] HEX_DIGITS
```

Constructor Detail

Dialect

public Dialect(DatabaseMetaData metadata,
               RepositoryDescriptor repositoryDescriptor)

Method Detail

supportsScroll
```
public boolean supportsScroll()
```
Does the dialect support an scroll API

Since:

8.4

jdbcInfo

public static Dialect.JDBCInfo jdbcInfo(String string,
                                        int jdbcType)

jdbcInfo

public static Dialect.JDBCInfo jdbcInfo(String string,
                                        int length,
                                        int jdbcType)

jdbcInfo

public static Dialect.JDBCInfo jdbcInfo(String string,
                                        int jdbcType,
                                        String jdbcBaseTypeString,
                                        int jdbcBaseType)

jdbcInfo

public static Dialect.JDBCInfo jdbcInfo(String string,
                                        int length,
                                        int jdbcType,
                                        String jdbcBaseTypeString,
                                        int jdbcBaseType)

createDialect

public static Dialect createDialect(Connection connection,
                                    RepositoryDescriptor repositoryDescriptor)

Creates a Dialect by connecting to the datasource to check what database is used.

getConnectionSchema

public String getConnectionSchema(Connection connection)
                           throws SQLException

Gets the schema to use to query metadata about existing tables.

Throws:: SQLException

getJDBCTypeAndString
```
public abstract Dialect.JDBCInfo getJDBCTypeAndString(ColumnType type)
```
Gets the JDBC type and string from Nuxeo's type abstraction.

isAllowedConversion

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

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

getGeneratedId

public Serializable getGeneratedId(Connection connection)
                            throws SQLException

Gets a generated id if so configured, otherwise returns null.

Throws:: SQLException

setId
```
public void setId(PreparedStatement ps,
                  int index,
                  Serializable value)
           throws SQLException
```
Sets a prepared statement value that is a Nuxeo main id (usually UUID).

Parameters:

ps - the prepared statement

index - the parameter index in the prepared statement

value - the value to set

Throws:

SQLException

setIdLong

public void setIdLong(PreparedStatement ps,
                      int index,
                      Serializable value)
               throws SQLException

Sets a long id (sequence) from a value that may be a String or already a Long.

Throws:: SQLException

setToPreparedStatement

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

Throws:: SQLException

setToPreparedStatementString

protected void setToPreparedStatementString(PreparedStatement ps,
                                            int index,
                                            Serializable value,
                                            Column column)
                                     throws SQLException

Throws:: SQLException

setToPreparedStatementTimestamp

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

Throws:: SQLException

getTimestampFromCalendar

public Timestamp getTimestampFromCalendar(Calendar value)

getTimestampFromCalendar

public Timestamp[] getTimestampFromCalendar(Serializable[] value)

getCalendarFromTimestamp

public Calendar getCalendarFromTimestamp(Timestamp value)

getCalendarFromTimestamp

public Calendar[] getCalendarFromTimestamp(Timestamp[] value)

getFromResultSet

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

Throws:: SQLException

getFromResultSetString

protected Serializable getFromResultSetString(ResultSet rs,
                                              int index,
                                              Column column)
                                       throws SQLException

Throws:: SQLException

getFromResultSetTimestamp

protected Serializable getFromResultSetTimestamp(ResultSet rs,
                                                 int index,
                                                 Column column)
                                          throws SQLException

Throws:: SQLException

storesUpperCaseIdentifiers

public boolean storesUpperCaseIdentifiers()

openQuote
```
public char openQuote()
```

closeQuote
```
public char closeQuote()
```

toBooleanValueString

public String toBooleanValueString(boolean bool)

getMaxNameSize
```
protected int getMaxNameSize()
```

getMaxIndexNameSize
```
protected int getMaxIndexNameSize()
```

makeName

protected String makeName(String name,
                          int maxNameSize)

makeName

protected String makeName(String prefix,
                          String string,
                          String suffix,
                          int maxNameSize)

toHexString

public static String toHexString(byte[] bytes)

getTableName

public String getTableName(String name)

getColumnName

public String getColumnName(String name)

getPrimaryKeyConstraintName

public String getPrimaryKeyConstraintName(String tableName)

getForeignKeyConstraintName

public String getForeignKeyConstraintName(String tableName,
                                          String foreignColumnName,
                                          String foreignTableName)

getIndexName

public String getIndexName(String tableName,
                           List<String> columnNames)

getCreateIndexSql

public String getCreateIndexSql(String indexName,
                                Table.IndexType indexType,
                                Table table,
                                List<Column> columns,
                                Model model)

Gets a CREATE INDEX statement for an index.

Parameters:: indexName - the index name (for fulltext); indexType - the index type; table - the table; columns - the columns to index; model - the model

getFulltextIndexedColumns
```
public abstract int getFulltextIndexedColumns()
```
Specifies what columns of the fulltext table have to be indexed.

Returns:

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

supportsMultipleFulltextIndexes
```
public boolean supportsMultipleFulltextIndexes()
```
SQL Server supports only one fulltext index.

getMaterializeFulltextSyntheticColumn
```
public abstract boolean getMaterializeFulltextSyntheticColumn()
```
Does the fulltext synthetic column have to be materialized.

getCreateFulltextIndexSql

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

Gets a CREATE INDEX statement for a fulltext index.

getDialectFulltextQuery
```
public abstract String getDialectFulltextQuery(String query)
```
Get the dialect-specific version of a fulltext query.

Parameters:

query - the CMIS-syntax-based fulltext query string

Returns:

the dialect native fulltext query string

getFulltextScoredMatchInfo

public abstract 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.

getLikeEscaping
```
public String getLikeEscaping()
```
Gets the SQL fragment to add after a LIKE match to specify the escaping character.

Since:

7.4

getMatchMixinType

public String getMatchMixinType(Column mixinsColumn,
                                String mixin,
                                boolean positive,
                                String[] returnParam)

Gets the SQL fragment to match a mixin type.

supportsPaging
```
public boolean supportsPaging()
```
Indicates if dialect supports paging

Returns:

true if the dialect supports paging

addPagingClause

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

Returns the SQL query with a paging clause

Since:: 5.7 (replacing getPagingClause)

getFulltextType
```
public int getFulltextType()
```
Gets the type of a fulltext column has known by JDBC.
This is used for setNull.

getFreeVariableSetterForType
```
public String getFreeVariableSetterForType(ColumnType type)
```
Gets the JDBC expression setting a free value for this column type.
Needed for columns that need an expression around the value being set, usually for conversion (this is the case for PostgreSQL fulltext TSVECTOR columns for instance).

Parameters:

type - the column type

Returns:

the expression containing a free variable

getNoColumnsInsertString

public String getNoColumnsInsertString(Column idColumn)

getNullColumnString
```
public String getNullColumnString()
```

getTableTypeString

public String getTableTypeString(Table table)

getAddPrimaryKeyConstraintString

public String getAddPrimaryKeyConstraintString(String constraintName)

getAddForeignKeyConstraintString

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

qualifyIndexName
```
public boolean qualifyIndexName()
```

supportsIfExistsBeforeTableName

public boolean supportsIfExistsBeforeTableName()

supportsIfExistsAfterTableName

public boolean supportsIfExistsAfterTableName()

getCascadeDropConstraintsString

public String getCascadeDropConstraintsString()

supportsCircularCascadeDeleteConstraints

public boolean supportsCircularCascadeDeleteConstraints()

getAddColumnString
```
public String getAddColumnString()
```

supportsUpdateFrom
```
public abstract boolean supportsUpdateFrom()
```
Does the dialect support UPDATE t SET ... FROM t, u WHERE ... ?

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

needsOrderByKeysAfterDistinct
```
public 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?

needsAliasForDerivedTable
```
public boolean needsAliasForDerivedTable()
```
Whether a derived table (subselect in a FROM statement) needs an alias.

needsOriginalColumnInGroupBy
```
public boolean needsOriginalColumnInGroupBy()
```
Whether a GROUP BY can only be used with the original column name and not an alias.

needsOracleJoins
```
public boolean needsOracleJoins()
```
Whether implicit Oracle joins (instead of explicit ANSI joins) are needed.

needsPrepareUserReadAcls
```
public boolean needsPrepareUserReadAcls()
```
The dialect need an extra SQL statement to populate a user read acl cache before running the query.

Since:

5.5

needsNullsLastOnDescSort
```
public boolean needsNullsLastOnDescSort()
```
True if the dialect need an extra NULLS LAST on DESC sort.

Since:

5.9

getClobCast
```
public String getClobCast(boolean inOrderBy)
```
When using a CLOB field in an expression, is some casting required and with what pattern?
Needed for Derby and H2.

Parameters:

inOrderBy - true if the expression is for an ORDER BY column

Returns:

a pattern for String.format with one parameter for the column name and one for the width, or null if no cast is required

getDateCast
```
public String getDateCast()
```
Get the expression to use to cast a column to a DATE type.

Returns:

a pattern for String.format with one parameter for the column name

Since:

5.6

castIdToVarchar
```
public String castIdToVarchar(String expr)
```
Casts an id column to a VARCHAR type.
Used for uuid/varchar joins.

Returns:

the casted expression

Since:

5.7

getIdType
```
public Dialect.DialectIdType getIdType()
```
Gets the type of id when stored in the database.

Since:

5.7

getSecurityCheckSql
```
public abstract String getSecurityCheckSql(String idColumnName)
```
Gets the expression to use to check security.

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

supportsAncestorsTable
```
public boolean supportsAncestorsTable()
```
Checks if the dialect supports an ancestors table.

supportsFastDescendants
```
public boolean supportsFastDescendants()
```
Checks whether getInTreeSql(String, String) is optimized for fast results (using an ancestors or descendants table).

Since:

7.10, 6.0-HF21

getInTreeSql
```
public abstract String getInTreeSql(String idColumnName,
                                    String id)
```
Gets the expression to use to check tree membership.

Parameters:

idColumnName - the quoted name of the id column to use

id - the id, to check syntax with respect to specialized id column types

Returns:

an SQL expression with one parameters for the based id that is true if the document is under base id, or null if the query cannot match

supportsArrays
```
public boolean supportsArrays()
```
Does the dialect support passing ARRAY values (to stored procedures mostly).
If not, we'll simulate them using a string and a separator.

Returns:

true if ARRAY values are supported

supportsArraysReturnInsteadOfRows
```
public boolean supportsArraysReturnInsteadOfRows()
```
Does a stored function returning an result set need to access it as a single array instead of iterating over a normal result set's rows.
Oracle needs this.

getArrayResult

public Serializable[] getArrayResult(Array array)
                              throws SQLException

Gets the array result as a converted array of Serializable.

Throws:: SQLException
Since:: 5.9.3

supportsSysNameArray
```
public boolean supportsSysNameArray()
```
Checks if the dialect supports storing arrays of system names (for mixins for instance).

supportsArrayColumns
```
public boolean supportsArrayColumns()
```
Does the dialect support storing arrays in table columns.

Returns:

true if ARRAY columns are supported

getArraySubQuery

public Dialect.ArraySubQuery getArraySubQuery(Column arrayColumn,
                                              String subQueryAlias)

Gets the dialect-specific subquery for an array column.

getArrayElementString

public String getArrayElementString(String arrayColumnName,
                                    int arrayElementIndex)

Get SQL Array Element Subscripted string.

getArrayInSql

public String getArrayInSql(Column arrayColumn,
                            String cast,
                            boolean positive,
                            List<Serializable> params)

Gets the SQL string for an array column IN expression.

getArrayLikeSql

public String getArrayLikeSql(Column arrayColumn,
                              String refName,
                              boolean positive,
                              Table dataHierTable)

Gets the SQL string for an array column LIKE expression.

getArrayIlikeSql

public String getArrayIlikeSql(Column arrayColumn,
                               String refName,
                               boolean positive,
                               Table dataHierTable)

Gets the SQL string for an array column ILIKE expression.

createArrayOf
```
public Array createArrayOf(int type,
                           Object[] elements,
                           Connection connection)
                    throws SQLException
```
Factory method for creating Array objects, suitable for passing to PreparedStatement.setArray(int, java.sql.Array).
(An equivalent method is defined by JDBC4 on the Connection class.)

Parameters:

type - the SQL type of the elements

elements - the elements of the array

connection - the connection

Returns:

an Array holding the elements

Throws:

SQLException

getSQLStatementsFilename
```
public abstract String getSQLStatementsFilename()
```
Gets the name of the file containing the SQL statements.

getTestSQLStatementsFilename

public abstract String getTestSQLStatementsFilename()

getSQLStatementsProperties

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

Gets the properties to use with the SQL statements.

isClusteringSupported
```
public boolean isClusteringSupported()
```
Checks that clustering is supported.

isClusteringDeleteNeeded
```
public boolean isClusteringDeleteNeeded()
```
Does clustering fetch of invalidations ( getClusterGetInvalidations()) need a separate delete for them.

getClusterInsertInvalidations
```
public String getClusterInsertInvalidations()
```
Gets the SQL to send an invalidation to the cluster.

Returns:

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

getClusterGetInvalidations
```
public String getClusterGetInvalidations()
```
Gets the SQL to query invalidations for this cluster node.

Returns:

an SQL statement returning a result set

supportsIlike
```
public boolean supportsIlike()
```
Does the dialect support ILIKE operator

supportsReadAcl
```
public boolean supportsReadAcl()
```
Does the dialect support an optimized read security checks

supportsWith
```
public boolean supportsWith()
```
Does the dialect support SQL-99 WITH common table expressions.

hasNullEmptyString
```
public boolean hasNullEmptyString()
```
Does the dialect have an empty string identical to NULL (Oracle).

getMaximumArgsForIn
```
public int getMaximumArgsForIn()
```
Maximum number of values in a IN (?, ?, ...) statement.
Beyond this size we'll do the query in several chunks.
PostgreSQL is limited to 65535 values in a prepared statement.
Oracle is limited to 1000 expressions in a list (ORA-01795).

getUpdateReadAclsSql
```
public String getUpdateReadAclsSql()
```
Gets the statement to update the read acls

getRebuildReadAclsSql
```
public String getRebuildReadAclsSql()
```
Gets the statement to rebuild the wall read acls

getReadAclsCheckSql
```
public String getReadAclsCheckSql(String userIdCol)
```
Gets the expression to check if access is allowed using read acls. The dialect must suppportsReadAcl.

Parameters:

userIdCol - the quoted name of the aclr_user_map user_id column to use

Returns:

an SQL expression with one parameter (principals) that is true if access is allowed

getPrepareUserReadAclsSql
```
public String getPrepareUserReadAclsSql()
```
Gets the SQL expression to prepare the user read acls cache. This can be used to populate a table cache.

Returns:

and SQL expression with one parameter (principals)

Since:

5.5

getStartupSqls
```
public List<String> getStartupSqls(Model model,
                                   Database database)
```
Gets the sql statements to execute after the repository init (at startup).
Used for vacuum-like operations.

Since:

6.0-HF24, 7.10-HF01, 8.1

isConcurrentUpdateException
```
public boolean isConcurrentUpdateException(Throwable t)
```
Checks if an exception received means that a concurrent update was detected.

Since:

5.8

performAdditionalStatements
```
public void performAdditionalStatements(Connection connection)
                                 throws SQLException
```
Let the dialect processes additional statements after tables creation and conditional statements. Can be used for specific upgrade procedure.

Throws:

SQLException

getValidationQuery
```
public String getValidationQuery()
```
A query that, when executed, will make at least a round-trip to the server to check that the connection is alive.
The query should throw an error if the connection is dead.

getBlobLengthFunction
```
public String getBlobLengthFunction()
```
Gets the SQL function that returns the length of a blob, in bytes.

performPostOpenStatements
```
public void performPostOpenStatements(Connection connection)
                               throws SQLException
```
Let the dialect perform additional statements just after the connection is opened.

Throws:

SQLException

getPostCreateIdentityColumnSql
```
public List<String> getPostCreateIdentityColumnSql(Column column)
```
Gets additional SQL statements to execute after the CREATE TABLE when creating an identity column.
Oracle needs both a sequence and a trigger.

isIdentityAlreadyPrimary
```
public boolean isIdentityAlreadyPrimary()
```
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.

hasIdentityGeneratedKey
```
public boolean hasIdentityGeneratedKey()
```
True if the dialect returns the generated key for the identity from the insert statement.
Oracle needs a separate call to CURRVAL.

getIdentityGeneratedKeySql
```
public String getIdentityGeneratedKeySql(Column column)
```
Gets the SQL query to execute to retrieve the last generated identity key.
Oracle needs a separate call to CURRVAL.

getAncestorsIdsSql
```
public String getAncestorsIdsSql()
```
Gets the SQL query to get the ancestors of a set of ids.

Returns:

null if not available

getDescending
```
public String getDescending()
```
Gets the SQL descending sort direction with option to sort nulls last. Use to unify database behavior.

Returns:

DESC or DESC NULLS LAST depending on dialects.

getIgnoredColumns
```
public List<String> getIgnoredColumns(Table table)
```
Columns ignored if we see them in existing tables.

getCustomColumnDefinition
```
public String getCustomColumnDefinition(Table table)
```
Additional column definitions for CREATE TABLE.

getCustomPostCreateSqls

public List<String> getCustomPostCreateSqls(Table table,
                                            Model model)

Additional things to execute after CREATE TABLE.

getSoftDeleteSql
```
public String getSoftDeleteSql()
```
SQL to soft delete documents. SQL returned has free parameters for the array of ids and time.

getSoftDeleteCleanupSql
```
public String getSoftDeleteCleanupSql()
```
SQL to clean soft-delete documents. SQL returned has free parameters max and beforeTime.

getBinaryFulltextSql
```
public String getBinaryFulltextSql(List<String> columns)
```
Return the SQL to get the columns fulltext fields

Since:

5.9.3

checkStoredProcedure
```
public abstract List<String> checkStoredProcedure(String procName,
                                                  String procCreate,
                                                  String ddlMode,
                                                  Connection connection,
                                                  JDBCLogger logger,
                                                  Map<String,Serializable> properties)
                                           throws SQLException
```
Checks if a given stored procedure exists and is identical to the passed creation SQL.
There are 3 cases to deal with, and actions to perform:
- the stored procedure doesn't exist, and must be created (create the stored procedure);
- the stored procedure exists but is not up to date (drop the old stored procedure and re-create it);
- the stored procedure exists and is up to date (nothing to do).
When there is nothing to do, null is returned. Otherwise the returned value is a list of SQL statements to execute. Note that the SQL statements will include also INSERT statements to be executed to remember the creation SQL itself.
Parameters:

procName - the stored procedure name

procCreate - the creation SQL for the stored procedure

ddlMode - the DDL mode

connection - the connection

logger - the logger

properties - the statement execution properties

Returns:

a list of SQL statements

Throws:

SQLException

Since:

6.0-HF24, 7.10-HF01, 8.1

getDumpStart
```
public Collection<? extends String> getDumpStart()
```
Returns the initial DDL statements to add to a DDL dump.

Returns:

a list of SQL statements, usually empty

Since:

6.0-HF24, 7.10-HF01, 8.1

getDumpStop
```
public Collection<? extends String> getDumpStop()
```
Returns the final DDL statements to add to a DDL dump.

Returns:

a list of SQL statements, usually empty

Since:

6.0-HF24, 7.10-HF01, 8.1

getSQLForDump
```
public String getSQLForDump(String sql)
```
Returns the SQL statement with proper terminator to use in a dump.

Returns:

the SQL statement

Since:

6.0-HF24, 7.10-HF01, 8.1

supportsBatchUpdateCount
```
public boolean supportsBatchUpdateCount()
```
Does the dialect report accurate update counts for batch updates.

Since:

9.2

Class Dialect

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG_UUIDS

DEBUG_REAL_UUIDS

NULLS_LAST_ON_DESC_PROP

descending

DIALECT_CLASS

DIALECTS

storesUpperCaseIdentifiers

fulltextDisabled

fulltextSearchDisabled

aclOptimizationsEnabled

clusteringEnabled

softDeleteEnabled

proxiesEnabled

readAclMaxSize

ARRAY_SEP

HEX_DIGITS

Constructor Detail

Dialect

Method Detail

supportsScroll

jdbcInfo

jdbcInfo

jdbcInfo

jdbcInfo

createDialect

getConnectionSchema

getJDBCTypeAndString

isAllowedConversion

getGeneratedId

setId

setIdLong

setToPreparedStatement

setToPreparedStatementString

setToPreparedStatementTimestamp

getTimestampFromCalendar

getTimestampFromCalendar

getCalendarFromTimestamp

getCalendarFromTimestamp

getFromResultSet

getFromResultSetString

getFromResultSetTimestamp

storesUpperCaseIdentifiers

openQuote

closeQuote

toBooleanValueString

getMaxNameSize

getMaxIndexNameSize

makeName

makeName

toHexString

getTableName

getColumnName

getPrimaryKeyConstraintName

getForeignKeyConstraintName

getIndexName

getCreateIndexSql

getFulltextIndexedColumns

supportsMultipleFulltextIndexes

getMaterializeFulltextSyntheticColumn

getCreateFulltextIndexSql

getDialectFulltextQuery

getFulltextScoredMatchInfo

getLikeEscaping

getMatchMixinType

supportsPaging

addPagingClause

getFulltextType

getFreeVariableSetterForType

getNoColumnsInsertString

getNullColumnString

getTableTypeString

getAddPrimaryKeyConstraintString

getAddForeignKeyConstraintString