public class P2JSQLServer2008Dialect extends org.hibernate.dialect.SQLServer2008Dialect implements P2JDialect
SQLServer2008Dialect
class to add method implementations
required by the P2JDialect
interface.
Note: this implementation expects a directory to be available at the time the class is loaded.
Modifier and Type | Field and Description |
---|---|
private static java.sql.Date |
highDate
Highest date supported by SQL Server 2008 (December 31, 9999)
http://msdn.microsoft.com/en-US/library/ms187819%28v=sql.100%29.aspx
|
private static ContextLocal<java.lang.Boolean> |
inlineLimit
Flag indicating whether to inline a record limit in an SQL SELECT
|
private static java.util.logging.Logger |
LOG
Logger
|
private static java.sql.Date |
lowDate
datetime is deprecated and it does not align with the SQL Standard. |
private static int |
MAX_INDEX_SIZE
The maximum size of all fields of an index, in bytes.
|
private static int |
MAX_LENGTH
Private constant from SQLServer2005Dialect used in sql types mapping with
registerColumnType().
|
private static int |
MAX_PARAMETER_COUNT
The maximum number of parameters allowed by the SQL Server is a single query.
|
Constructor and Description |
---|
P2JSQLServer2008Dialect()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addRtrimmedExpression(java.lang.String expr,
java.lang.StringBuilder sb)
Composes a rtrim equivalent call for a specified expression.
|
void |
beforeDriverLoad()
Set any database parameters before, to be available when the database
driver is loaded.
|
java.lang.String |
buildRemoteURL(java.lang.String url,
Database database)
Build the URL to be used for a remote connection, based on the given URL and database.
|
int |
computeIndexKeySize(BaseDataType value)
Computes the size (in bytes) occupied by this value when stored as index-key in an index.
|
java.lang.Object |
createContext(Persistence persistence)
Create a data object, the purpose of which is specific to a particular
dialect implementation, to be stored as a context-local object.
|
SequenceHandler |
createSequenceHandler(java.lang.String ldbName)
Creates and returns a
SequenceHandler for a SQL Server 2008 database. |
boolean |
explicitSetCollation()
Check if the dialect needs to set an explicit collation during schema
DDL generation.
|
java.lang.String |
extractColumnName(java.lang.String expr)
Given a native column name as queried from database metadata, extract the root name of a
column.
|
java.lang.String |
formatDate(date d)
Format a date object as a string which is appropriate for use in an SQL statement.
|
java.lang.String |
getAlterComputedColumnString(java.lang.String tableName,
org.hibernate.cfg.Configuration config,
java.lang.String implClassName,
java.lang.String colName,
boolean ignoreCase)
Build the DDL to set the formula for the computed columns associated with an indexed,
character column.
|
java.lang.String |
getComputedColumnFormula(java.lang.String colName,
boolean ignoreCase)
Returns the formula for character computed columns.
|
java.lang.String |
getComputedColumnPrefix(boolean caseSensitive)
Get the prefix, if any, which should be prepended to computed column and/or property names.
|
java.lang.String |
getCreateIndexString(P2JIndex index,
boolean unique,
boolean toFile)
Build the DDL to create an index based upon the specified definition.
|
java.lang.String |
getCreateSequenceString(java.lang.String name,
long start)
Generate a DDL string which will create a global sequence with the given
starting value.
|
java.lang.String |
getCreateSequenceString(java.lang.String name,
java.lang.Long init,
java.lang.Long increment,
java.lang.Long minVal,
java.lang.Long maxVal,
java.lang.Boolean cycle)
Generate a DDL string which will create a sequence with given properties.
|
java.util.List<java.lang.String> |
getDatabasePrepareStatements(Database database)
Get a list of database prepare DDL statements.
|
java.lang.String |
getDelimiter()
Get the statement delimiter for this dialect.
|
java.lang.String |
getDropIndexString(P2JIndex index)
Build the DDL to drop an index based upon the specified definition.
|
java.lang.String |
getDropSequenceString(java.lang.String name)
Generate a DDL string which will drop a sequence with given properties.
|
java.sql.Date |
getHighDate()
Retrieve the latest possible date value which is valid for the backing
database.
|
int |
getIndexLengthLimit()
MS SQL Server has constraints about the maximum size of fields that compose an index.
|
java.sql.Date |
getLowDate()
Retrieve the earliest possible date value which is valid for the
backing database.
|
int |
getMaxParameterCount()
Obtain the number of parameters a query of this dialect is allowed by the SQL Server.
|
java.lang.String |
getProcessedCharacterColumnName(java.lang.String name,
boolean ignoreCase)
Adjust a character column name appropriate to this dialect, such that it
can be inserted into an index.
|
java.lang.String |
getSequenceCurrValString(java.lang.String sequenceName)
Generate the appropriate select statement to reset the value of a sequence.
|
java.lang.String |
getSequencePrefetchString(java.lang.String sequenceName)
Generate the appropriate select statement to pre-fetch multiple, ascending values from a
sequence.
|
java.lang.String |
getSequenceSetValString(java.lang.String sequenceName,
long newVal)
Generate the appropriate select statement to retrieve the next value of a sequence.
|
int |
getSyntheticIndexSize(boolean unique)
Returns the size of the synthetic part of the index.
|
java.lang.String |
getTypeName(int code,
long length,
int precision,
int scale)
Get the name of the database type associated with the given
Types typecode
with the given storage specification parameters. |
boolean |
hasFullSequenceSupport()
Returns
true if this dialect fully support the sequences as
4GL language (most important: bounded values, cycle). |
boolean |
injectComputedColumns()
Report whether the computed columns should be injected on table creating.
|
void |
inlineLimit(boolean on)
Enable/disable limit clause inlining.
|
boolean |
isCaseInsensitiveColumn(java.lang.String name)
Report whether the given column name represents an alias or an
expression which indicates the column is case insensitive.
|
boolean |
isComputedColumn(java.lang.String name)
Report whether the given column name represents an alias or an expression which indicates
the column is computed.
|
boolean |
isConnectionError(java.lang.Exception exc)
Given an exception, this method will check if it indicates a database
connectivity error.
|
boolean |
isMetadataSortAsc(java.lang.String value)
Check if the given value is an ascending clause for a column index.
|
boolean |
isMetadataSortDesc(java.lang.String value)
Check if the given value is a descending clause for a column index.
|
boolean |
isQueryRangeParameterInlined()
Indicate whether a query parameter which is part of a range check should
be inlined into the where clause, or whether it should be substituted
into a prepared statement.
|
boolean |
needsComputedColumns()
Indicate whether this dialect requires computed columns to participate
within index definitions, instead of embedded expressions.
|
void |
postTransaction(Persistence persistence,
java.lang.Object context,
boolean rollback)
A dialect-specific callback hook which is invoked by the persistence
runtime framework after a transaction is complete.
|
java.lang.String |
prepareMetadataParameter(java.lang.String param)
Prepare the given metadata query parameter.
|
java.lang.String |
processMetadataResult(java.lang.String value)
Process the given metadata query result, (by making it lowercase ?).
|
boolean |
requiresExplicitCastInsideTernary()
Determines whether substitution parameters should be explicitly casted to their datatypes
inside "then ? else ?" statement.
|
boolean |
supportsBooleanDatatype()
Indicates whether this dialect supports boolean datatype.
|
boolean |
supportsFunctionOverloading()
Indicate whether this dialect natively supports the overloading of user
defined functions by parameter number and data type.
|
appendLockHint, buildLimitHandler, buildSQLExceptionConversionDelegate
appendIdentitySelectToInsert, areStringComparisonsCaseInsensitive, closeQuote, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, getCurrentTimestampSelectString, getInExpressionCountLimit, getLimitString, getNoColumnsInsertString, getSqlTypeDescriptorOverride, openQuote, supportsCircularCascadeDeleteConstraints, supportsLimit, supportsLimitOffset, supportsLobValueChangePropogation, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsVariableLimit, useMaxForLimit
appendLockHint, applySqlLimit, bindLimitParametersFirst, bindLimitParametersInReverseOrder, buildSQLExceptionConverter, cast, cast, cast, convertToFirstRowValue, createCaseFragment, createOuterJoinFragment, dropConstraints, forceLimitUsage, forceLobAsLastValue, forUpdateOfColumns, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAddUniqueConstraintString, getCascadeConstraintsString, getCaseInsensitiveLike, getCastTypeName, getColumnAliasExtractor, getColumnComment, getCreateMultisetTableString, getCreateSequenceString, getCreateSequenceString, getCreateSequenceStrings, getCreateSequenceStrings, getCreateTableString, getCreateTemporaryTablePostfix, getCreateTemporaryTableString, getCrossJoinSeparator, getCurrentTimestampSQLFunctionName, getDefaultProperties, getDialect, getDialect, getDropForeignKeyString, getDropSequenceStrings, getDropTemporaryTableString, getForUpdateNowaitString, getForUpdateNowaitString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFunctions, getHibernateTypeName, getHibernateTypeName, getIdentityColumnString, getIdentityInsertString, getIdentitySelectString, getKeywords, getLimitString, getLobMergeStrategy, getLockingStrategy, getLowercaseFunction, getMaxAliasLength, getNativeIdentifierGeneratorClass, getQuerySequencesString, getReadLockString, getSelectClauseNullString, getSelectSequenceNextValString, getSequenceNextValString, getTableComment, getTableTypeString, getTypeName, getViolatedConstraintNameExtracter, getWriteLockString, hasAlterTable, hasDataTypeInIdentityColumn, hasSelfReferentialForeignKeyBug, isLockTimeoutParameterized, performTemporaryTableDDLInIsolation, quote, registerColumnType, registerColumnType, registerFunction, registerHibernateType, registerHibernateType, registerKeyword, remapSqlTypeDescriptor, replaceResultVariableInOrderByClauseWithPosition, requiresCastingOfParametersInSelectClause, supportsBindAsCallableArgument, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsColumnCheck, supportsCommentOn, supportsExpectedLobUsagePattern, supportsIfExistsAfterTableName, supportsIfExistsBeforeTableName, supportsLockTimeouts, supportsNotNullUnique, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsPooledSequences, supportsRowValueConstructorSyntax, supportsRowValueConstructorSyntaxInInList, supportsSequences, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTupleCounts, supportsUnboundedLobLocatorMaterialization, supportsUnique, supportsUniqueConstraintInCreateAlterTable, toBooleanValueString, toString, transformSelectString, useInputStreamToInsertBlob
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getSequenceNextValString, quote
private static final java.util.logging.Logger LOG
private static final ContextLocal<java.lang.Boolean> inlineLimit
private static final java.sql.Date lowDate
datetime
is deprecated and it does not align with the SQL Standard.
We convert p4gl date
-related datatypes using the MSSQL date
and
datetime2
. For both the lower limit is January 1, 001.
date:
msdn.microsoft.com/en-us/library/bb630352(v=sql.100).aspx
datetime2:
msdn.microsoft.com/en-us/library/bb677335(v=sql.100).aspx
private static final java.sql.Date highDate
private static final int MAX_LENGTH
private static int MAX_INDEX_SIZE
private static int MAX_PARAMETER_COUNT
public P2JSQLServer2008Dialect()
We provide this constructor to override the superclass' mapping of
Types.VARCHAR
and Types.VARBINARY
.
public java.lang.Object createContext(Persistence persistence)
Since the context-local data is specific to a particular dialect
implementation, it is optional. Dialect implementations which do not
have a need for this data should simply return null
.
createContext
in interface P2JDialect
persistence
- Provider of persistence services.null
.public void postTransaction(Persistence persistence, java.lang.Object context, boolean rollback) throws PersistenceException
postTransaction
in interface P2JDialect
persistence
- Provider of persistence services.context
- Optional, context-local data created previously by createContext(com.goldencode.p2j.persist.Persistence)
.rollback
- true
if transaction ended with a rollback;
false
if transaction ended with a commit.PersistenceException
- if any persistence-related error occurs.public java.lang.String getTypeName(int code, long length, int precision, int scale) throws org.hibernate.HibernateException
Types
typecode
with the given storage specification parameters.
The Types.VARCHAR
is handled differently because Hibernate cannot handle the
optional sql size hint (see also the class javadoc for
TypeNames
):
TypeNames.get(int, long, int, int)
cannot set
the optional size parameter;
When generating the *.hbm file all properties must have the 'length' attribute set.
Otherwise, SchemaExport
will use the default column length of 255 when
calling this method so the output will not use the expected MAX_LENGTH size.
getTypeName
in class org.hibernate.dialect.Dialect
code
- The Types
typecodelength
- The datatype lengthprecision
- The datatype precisionscale
- The datatype scaleorg.hibernate.HibernateException
- If no mapping was specified for that type.public java.sql.Date getLowDate()
getLowDate
in interface P2JDialect
public java.sql.Date getHighDate()
getHighDate
in interface P2JDialect
public java.lang.String formatDate(date d)
formatDate
in interface P2JDialect
d
- Date to be formatted as a string.public java.lang.String extractColumnName(java.lang.String expr)
__my_columnWe are interested only in the
my_column
root name, so we strip away the leading
__
prefix.extractColumnName
in interface P2JDialect
expr
- Column name as natively represented by the database dialect.public java.lang.String getProcessedCharacterColumnName(java.lang.String name, boolean ignoreCase)
getProcessedCharacterColumnName
in interface P2JDialect
name
- Base column name.ignoreCase
- true
to cause case to be ignored, else false
.public boolean isCaseInsensitiveColumn(java.lang.String name)
name
is already determined to be the
appropriate data type for textual data.isCaseInsensitiveColumn
in interface P2JDialect
name
- Column name, alias, or expression.true
if name
represents case-insensitive data.public boolean isComputedColumn(java.lang.String name)
name
is
already determined to be the appropriate data type for textual data.isComputedColumn
in interface P2JDialect
name
- Column name, alias, or expression.true
if name
represents a computed column.public boolean needsComputedColumns()
needsComputedColumns
in interface P2JDialect
true
to indicate computed columns are required.public java.lang.String getComputedColumnPrefix(boolean caseSensitive)
getComputedColumnPrefix
in interface P2JDialect
caseSensitive
- true
if this is a character field was declared with
CASE-SENSITIVE
attribute.null
to indicate the backing database does not use computed columns.needsComputedColumns()
public boolean supportsFunctionOverloading()
supportsFunctionOverloading
in interface P2JDialect
public boolean supportsBooleanDatatype()
true
and false
literals;
0
and 1
values) as boolean
replacement, this method always returns false
.supportsBooleanDatatype
in interface P2JDialect
false
.public java.lang.String getCreateSequenceString(java.lang.String name, long start)
getCreateSequenceString
in interface P2JDialect
name
- Sequence name.start
- Sequence starting value.public java.lang.String getCreateSequenceString(java.lang.String name, java.lang.Long init, java.lang.Long increment, java.lang.Long minVal, java.lang.Long maxVal, java.lang.Boolean cycle)
getCreateSequenceString
in interface P2JDialect
name
- Sequence name. Mandatory not null.init
- Sequence starting value. Mandatory(not null).increment
- Sequence incrementing value. Mandatory(not null).minVal
- Sequence minimum value. Optional (may be null).maxVal
- Sequence maximum value. Optional (may be null).cycle
- Sequence cycling property. Optional, if missing assumed not cycling.public java.lang.String getDropSequenceString(java.lang.String name)
getDropSequenceString
in interface P2JDialect
getDropSequenceString
in class org.hibernate.dialect.Dialect
name
- The name of the sequence to be dropped.public java.lang.String getSequenceSetValString(java.lang.String sequenceName, long newVal)
getSequenceSetValString
in interface P2JDialect
sequenceName
- The name of the sequence.newVal
- The new value to be set.public java.lang.String getSequenceCurrValString(java.lang.String sequenceName)
getSequenceCurrValString
in interface P2JDialect
sequenceName
- The name of the sequence to be queried.public boolean hasFullSequenceSupport()
true
if this dialect fully support the sequences as
4GL language (most important: bounded values, cycle). If not fully
supported, additional code is needed in P2J sequence class implementation to fix this.hasFullSequenceSupport
in interface P2JDialect
false
because Server 2008 does not have the concept of a SEQUENCE.
It appeared since SQL Server 2012.public java.lang.String getSequencePrefetchString(java.lang.String sequenceName)
getSequencePrefetchString
in interface P2JDialect
sequenceName
- The name of the sequence from which the values are to be retrieved.null
if this feature is not supported
by the dialect.public boolean isConnectionError(java.lang.Exception exc)
For the SQLServer dialect, 08S01 - common state for disconnect and cancel.
isConnectionError
in interface P2JDialect
exc
- The exception to be checked.true
if the exception indicates a database
connectivity error.public boolean isQueryRangeParameterInlined()
where value ≥ ? and id = ?along with respective substitution parameters of 45 and 100, the inlined version would read:
where value ≥ 45 and id = ?Only the
id
substitution parameter of 100 would be
substituted into the prepared statement.
Inlining in such a way can give some database dialects the opportunity to choose a better query plan, than if the parameter being tested with a range check were to be substituted at statement execution time.
Note: this serves as a hint which may be overridden by runtime logic or other configuration settings.
isQueryRangeParameterInlined
in interface P2JDialect
true
to inline range check parameters;
false
to use normal parameter substitution.public void inlineLimit(boolean on)
Dialects are free to treat this method as a hint.
inlineLimit
in interface P2JDialect
on
- true
to enable inlining; false
to disable it.public boolean requiresExplicitCastInsideTernary()
requiresExplicitCastInsideTernary
in interface P2JDialect
true
for SQL Server dialects.public java.lang.String getDropIndexString(P2JIndex index)
getDropIndexString
in interface P2JDialect
index
- Definition of the index to be dropped.public java.lang.String getCreateIndexString(P2JIndex index, boolean unique, boolean toFile)
getCreateIndexString
in interface P2JDialect
index
- Definition of the index to be created.unique
- If true
, create the index as a unique index,
false
to omit the unique constraint.toFile
- true
if the string will be output to a file or
false
if it will be directly submitted via JDBC.public java.lang.String getAlterComputedColumnString(java.lang.String tableName, org.hibernate.cfg.Configuration config, java.lang.String implClassName, java.lang.String colName, boolean ignoreCase)
ALTER COLUMN
operations, we drop the column and add it
back as a computed column with the correct definition formula.
The syntax to set the formula for the computed column is:
alter table [table] alter column [column] as [formula]
getAlterComputedColumnString
in interface P2JDialect
tableName
- Table name possible containing backticks.config
- The hibernate's configuration object.implClassName
- The full name of the implementing class for the DMO.colName
- The column name which needs to have a computed version. This is not the computed
column name, but the name of its "parent".ignoreCase
- true
if this is a character field which has the
"ignore case" flag set.public java.lang.String getComputedColumnFormula(java.lang.String colName, boolean ignoreCase)
getComputedColumnFormula
in interface P2JDialect
colName
- The base column name.ignoreCase
- true
if this is a char field which has the "ignore case" flag set.null
if the dialect does not
support computed columns.public java.lang.String prepareMetadataParameter(java.lang.String param)
prepareMetadataParameter
in interface P2JDialect
param
- The metadata query parameter.public java.lang.String processMetadataResult(java.lang.String value)
processMetadataResult
in interface P2JDialect
value
- The metadata query result.public boolean isMetadataSortDesc(java.lang.String value)
isMetadataSortDesc
in interface P2JDialect
value
- The value to be checked.true
if the value is the "D" or "d" string.public boolean isMetadataSortAsc(java.lang.String value)
isMetadataSortAsc
in interface P2JDialect
value
- The value to be checked.true
if the value is the "A" or "a" string.public java.util.List<java.lang.String> getDatabasePrepareStatements(Database database)
getDatabasePrepareStatements
in interface P2JDialect
database
- The database which needs to be prepared.public boolean explicitSetCollation()
explicitSetCollation
in interface P2JDialect
true
.public java.lang.String getDelimiter()
getDelimiter
in interface P2JDialect
public void beforeDriverLoad()
This implementation does nothing.
beforeDriverLoad
in interface P2JDialect
public java.lang.String buildRemoteURL(java.lang.String url, Database database) throws PersistenceException
buildRemoteURL
in interface P2JDialect
url
- The URL as received from the remote server.database
- The database to which this URL belongs.PersistenceException
- if the specified connection URL is invalid.public SequenceHandler createSequenceHandler(java.lang.String ldbName)
SequenceHandler
for a SQL Server 2008 database.createSequenceHandler
in interface P2JDialect
ldbName
- The logical name of the database to create the SequenceHandler
for.public boolean injectComputedColumns()
injectComputedColumns
in interface P2JDialect
true
for SQL Server.public int getIndexLengthLimit()
getIndexLengthLimit
in interface P2JDialect
public int computeIndexKeySize(BaseDataType value)
getIndexLengthLimit()
returns
positive values.
If this dialect does not have index-size constraints then this method should return 0.
If the value or value type is unknown or cannot be handled by the dialect -1 will be
returned.computeIndexKeySize
in interface P2JDialect
value
- The value to be analyzed. Except for the char datatype, only the type of value
is used, the actual value is not needed to determine the size occupied by the
value as index-key.public int getSyntheticIndexSize(boolean unique)
id
of the record may be additionally added to an index to add custom properties (eg uniqueness)
but other fields could be added. This part of the index is not visible using index
reflection routines from IndexHelper
. The synthetic components may differ
between unique and non-unique indexes.
getSyntheticIndexSize
in interface P2JDialect
unique
- true
if the index is unique, unused.getCreateIndexString()
.public void addRtrimmedExpression(java.lang.String expr, java.lang.StringBuilder sb)
rtrim(expr)The rtrimmed expression is appended to the string builder.
addRtrimmedExpression
in interface P2JDialect
expr
- The expression to be rtrim -med. It's up to the caller if it is
a qualified field name or not or any other kind of character-type expression.sb
- The StringBuilder
to append the trimmed filed to.public int getMaxParameterCount()
getMaxParameterCount
in interface P2JDialect