org.eclipse.persistence.platform.database

Class SQLServerPlatform

java.lang.Object

org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

org.eclipse.persistence.platform.database.DatabasePlatform

org.eclipse.persistence.platform.database.SQLServerPlatform

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Platform

public class SQLServerPlatform
extends DatabasePlatform

Purpose: Provides SQL Server specific behavior.

Responsibilities:

• Native SQL for byte[], Date, Time, & Timestamp.
• Native sequencing using @@IDENTITY.

Since:

TOPLink/Java 1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class org.eclipse.persistence.platform.database.DatabasePlatform

DEFAULT_VARCHAR_SIZE

Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

DEFAULT_MAX_BATCH_WRITING_SIZE, DEFAULT_PARAMETERIZED_MAX_BATCH_WRITING_SIZE, IS_VALID_TIMEOUT, Types_NCLOB, Types_SQLXML

Constructor Summary

Constructors

Constructor and Description
SQLServerPlatform()

Method Summary

Modifier and Type	Method and Description
ValueReadQuery	buildSelectQueryForIdentity() INTERNAL: Build the identity query for native sequencing.
boolean	dontBindUpdateAllQueryUsingTempTables() INTERNAL: In SQLServer local temporary table created by one PreparedStatement can't be used in another PreparedStatement.
java.lang.Object	executeStoredProcedure(DatabaseCall dbCall, java.sql.PreparedStatement statement, DatabaseAccessor accessor, AbstractSession session) because each platform has different requirements for accessing stored procedures and the way that we can combine resultsets and output params the stored procedure call is being executed on the platform.
static ExpressionOperator	extractOperator() INTERNAL: Derby does not support EXTRACT, but does have DATEPART.
java.lang.String	getBatchDelimiterString() Used for batch writing and sp defs.
java.lang.String	getCreationInOutputProcedureToken() This method is used to print the required output parameter token for the specific platform.
java.lang.String	getCreationOutputProcedureToken() This method is used to print the required output parameter token for the specific platform.
java.lang.String	getInOutputProcedureToken() This method is used to print the output parameter token when stored procedures are called
int	getMaxFieldNameSize() INTERNAL: returns the maximum number of characters that can be used in a field name on this platform.
java.util.Vector	getNativeTableInfo(java.lang.String table, java.lang.String creator, AbstractSession session) Return the catalog information through using the native SQL catalog selects.
java.lang.String	getOutputProcedureToken() This method is used to print the output parameter token when stored procedures are called
java.lang.String	getProcedureArgumentString() Used for sp defs.
java.lang.String	getProcedureCallHeader() Used for sp calls.
java.lang.String	getSelectForUpdateNoWaitString() INTERNAL: This syntax does no wait on the lock.
java.lang.String	getSelectForUpdateString() INTERNAL: Lock.
java.lang.String	getStoredProcedureParameterPrefix()
java.lang.String	getStoredProcedureTerminationToken() INTERNAL: This method returns the delimiter between stored procedures in multiple stored procedure calls.
DatabaseTable	getTempTableForTable(DatabaseTable table) INTERNAL:
ValueReadQuery	getTimestampQuery() PUBLIC: This method returns the query to select the timestamp from the server for SQLServer.
boolean	isSQLServer()
static ExpressionOperator	locate2Operator() INTERNAL: create the Locate2 Operator for this platform
java.util.Hashtable	maximumNumericValues() Builds a table of maximum numeric values keyed on java class.
java.util.Hashtable	minimumNumericValues() Builds a table of minimum numeric values keyed on java class.
ExpressionOperator	modOperator() Override the default MOD operator.
void	printFieldIdentityClause(java.io.Writer writer) INTERNAL: Append the receiver's field 'identity' constraint clause to a writer.
void	printFieldNullClause(java.io.Writer writer) INTERNAL: Append the receiver's field 'NULL' constraint clause to a writer.
boolean	requiresProcedureCallBrackets() USed for sp calls.
boolean	requiresProcedureCallOuputToken() Used for sp calls.
boolean	shouldPrintInOutputTokenBeforeType() This is required in the construction of the stored procedures with output parameters
boolean	shouldPrintLockingClauseAfterWhereClause() INTERNAL: Indicates whether locking clause should be printed after where clause by SQLSelectStatement.
boolean	shouldPrintOutputTokenBeforeType() This is required in the construction of the stored procedures with output parameters
boolean	shouldUseJDBCOuterJoinSyntax() JDBC defines and outer join syntax, many drivers do not support this.
ExpressionOperator	singleArgumentSubstringOperator() Override the default SubstringSingleArg operator.
boolean	supportsIdentity() INTERNAL: Indicates whether the platform supports identity.
boolean	supportsLocalTempTables() INTERNAL:
static ExpressionOperator	trim2Operator() INTERNAL: Build Trim operator.
static ExpressionOperator	trimOperator() INTERNAL: Use RTRIM(LTRIM(?)) function for trim.
void	writeUpdateOriginalFromTempTableSql(java.io.Writer writer, DatabaseTable table, java.util.Collection pkFields, java.util.Collection assignedFields) INTERNAL:

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

addBatch, addStructConverter, allowsSizeInProcedureArguments, appendLiteralToCall, appendParameter, appendParameterInternal, autoCommit, beginTransaction, buildBatchCriteria, buildBatchCriteriaForComplexId, buildCallWithReturning, buildCreateIndex, buildCreateIndex, buildDropIndex, buildDropIndex, buildProcedureCallString, buildSequenceObjectAlterIncrementWriter, buildSequenceObjectCreationWriter, buildSequenceObjectDeletionWriter, canBatchWriteWithOptimisticLocking, canBuildCallWithReturning, commitTransaction, computeMaxRowsForSQL, convertToDatabaseType, copyInto, createArray, createArray, createStruct, createStruct, executeBatch, freeTemporaryObject, getAssignmentString, getBatchBeginString, getBatchEndString, getCastSizeForVarcharParameter, getClassTypes, getConnection, getConstraintDeletionString, getCreateViewString, getCursorCode, getCustomModifyValueForCall, getDefaultSequenceTableName, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getIdentifierQuoteCharacter, getIndexNamePrefix, getInputProcedureToken, getJDBCOuterJoinString, getJDBCType, getJDBCType, getJDBCTypeForSetNull, getJdbcTypeName, getMaxBatchWritingSize, getMaxForeignKeyNameSize, getMaxIndexNameSize, getMaxUniqueKeyNameSize, getNoWaitString, getObjectFromResultSet, getPartitioningCallback, getPingSQL, getProcedureArgumentSetter, getProcedureAsString, getProcedureBeginString, getProcedureCallTail, getProcedureEndString, getQualifiedName, getQualifiedSequenceTableName, getRefValue, getRefValue, getSelectForUpdateOfString, getSelectForUpdateWaitString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStringBindingSize, getStructConverters, getTableCreationSuffix, getTransactionIsolation, getTypeConverters, getVPDClearIdentifierQuery, getVPDCreationFunctionString, getVPDCreationPolicyString, getVPDDeletionString, getVPDSetIdentifierQuery, hasPartitioningCallback, initialize, initializeConnectionData, isAlterSequenceObjectSupported, isCastRequired, isDynamicSQLRequiredForFunctions, isForUpdateCompatibleWithDistinct, isInformixOuterJoin, isLockTimeoutException, isNullAllowedInSelectClause, isXDBDocument, minimumTimeIncrement, prepareBatchStatement, printFieldNotNullClause, printFieldTypeSize, printFieldUnique, printSQLSelectStatement, printStoredFunctionReturnKeyWord, printValuelist, printValuelist, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureBrackets, requiresTableInIndexDropDDL, requiresTypeNameToRegisterOutputParameter, requiresUniqueConstraintCreationOnTableCreate, retrieveFirstPrimaryKeyOrOne, rollbackTransaction, setCastSizeForVarcharParameter, setCursorCode, setIsCastRequired, setMaxBatchWritingSize, setParameterValueInDatabaseCall, setPartitioningCallback, setPingSQL, setPrintInnerJoinInWhereClause, setPrintOuterJoinInWhereClause, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldBindLiterals, setShouldCacheAllStatements, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setShouldUseRownumFiltering, setStatementCacheSize, setStringBindingSize, setSupportsAutoCommit, setTableCreationSuffix, setTransactionIsolation, setUsesBatchWriting, setUsesByteArrayBinding, setUsesJDBCBatchWriting, setUsesNativeBatchWriting, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, shouldAlwaysUseTempStorageForModifyAll, shouldBindAllParameters, shouldBindLiterals, shouldCacheAllStatements, shouldCreateIndicesForPrimaryKeys, shouldCreateIndicesOnUniqueKeys, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldOptimizeDataConversion, shouldPrintAliasForUpdate, shouldPrintConstraintNameAfter, shouldPrintFieldIdentityClause, shouldPrintInnerJoinInWhereClause, shouldPrintInputTokenAtStart, shouldPrintOuterJoinInWhereClause, shouldPrintOutputTokenAtStart, shouldPrintStoredProcedureArgumentNameInCall, shouldPrintStoredProcedureVariablesAfterBeginString, shouldTrimStrings, shouldUseCustomModifyForCall, shouldUseRownumFiltering, supportsANSIInnerJoinSyntax, supportsAutoCommit, supportsAutoConversionToNumericForArithmeticOperations, supportsCountDistinctWithMultipleFields, supportsDeleteOnCascade, supportsForeignKeyConstraints, supportsGlobalTempTables, supportsIndexes, supportsIndividualTableLocking, supportsLockingQueriesWithMultipleTables, supportsNestingOuterJoins, supportsOuterJoinsWithBrackets, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsTempTables, supportsUniqueColumns, supportsUniqueKeyConstraints, supportsVPD, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeBatchWriting, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, wasFailureCommunicationBased, writeCleanUpTempTableSql, writeCreateTempTableSql, writeDeleteFromTargetTableUsingTempTableSql, writeInsertIntoTableSql, writeLOB, writeParameterMarker, writeTableCreationSuffix

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

addSequence, addSequence, buildNativeCall, buildSelectQueryForIdentity, buildSelectQueryForSequenceObject, buildSelectQueryForSequenceObject, clone, convertObject, createConnectionCustomizer, getConversionManager, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultSequence, getDefaultSequenceToWrite, getEndDelimiter, getOperator, getPlatformOperators, getSelectSequenceQuery, getSequence, getSequences, getSequencesToWrite, getStartDelimiter, getTableQualifier, getTimestampFromServer, getUpdateSequenceQuery, hasDefaultSequence, initializeDefaultQueries, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isDerby, isFirebird, isH2, isHSQL, isInformix, isMaxDB, isMySQL, isODBC, isOracle, isOracle9, isPointBase, isPostgreSQL, isSQLAnywhere, isSybase, isSymfoware, isTimesTen, isTimesTen7, removeAllSequences, removeSequence, setConversionManager, setDefaultSequence, setEndDelimiter, setSelectSequenceNumberQuery, setSequencePreallocationSize, setSequences, setStartDelimiter, setTableQualifier, setTimestampQuery, setUpdateSequenceQuery, shouldNativeSequenceUseTransaction, shouldPrepare, shouldSelectDistinctIncludeOrderBy, shouldSelectIncludeOrderBy, supportsNativeSequenceNumbers, supportsSequenceObjects, toString, usesPlatformDefaultSequence

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLServerPlatform

public SQLServerPlatform()

Method Detail

buildSelectQueryForIdentity

public ValueReadQuery buildSelectQueryForIdentity()

INTERNAL: Build the identity query for native sequencing.

Overrides:

buildSelectQueryForIdentity in class DatasourcePlatform

dontBindUpdateAllQueryUsingTempTables

public boolean dontBindUpdateAllQueryUsingTempTables()

INTERNAL: In SQLServer local temporary table created by one PreparedStatement can't be used in another PreparedStatement. Workaround is to use Statement instead of PreparedStatement.

Overrides:

dontBindUpdateAllQueryUsingTempTables in class DatabasePlatform

getBatchDelimiterString

public java.lang.String getBatchDelimiterString()

Used for batch writing and sp defs.

Overrides:

getBatchDelimiterString in class DatabasePlatform

getCreationInOutputProcedureToken

public java.lang.String getCreationInOutputProcedureToken()

This method is used to print the required output parameter token for the specific platform. Used when stored procedures are created.

Overrides:

getCreationInOutputProcedureToken in class DatabasePlatform

getCreationOutputProcedureToken

public java.lang.String getCreationOutputProcedureToken()

This method is used to print the required output parameter token for the specific platform. Used when stored procedures are created.

Overrides:

getCreationOutputProcedureToken in class DatabasePlatform

getInOutputProcedureToken

public java.lang.String getInOutputProcedureToken()

This method is used to print the output parameter token when stored procedures are called

Overrides:

getInOutputProcedureToken in class DatabasePlatform

getMaxFieldNameSize

public int getMaxFieldNameSize()

INTERNAL: returns the maximum number of characters that can be used in a field name on this platform.

Overrides:

getMaxFieldNameSize in class DatabasePlatform

getNativeTableInfo

public java.util.Vector getNativeTableInfo(java.lang.String table,
                                           java.lang.String creator,
                                           AbstractSession session)

Return the catalog information through using the native SQL catalog selects. This is required because many JDBC driver do not support meta-data. Willcards can be passed as arguments.

getOutputProcedureToken

public java.lang.String getOutputProcedureToken()

This method is used to print the output parameter token when stored procedures are called

Overrides:

getOutputProcedureToken in class DatabasePlatform

getProcedureArgumentString

public java.lang.String getProcedureArgumentString()

Used for sp defs.

Overrides:

getProcedureArgumentString in class DatabasePlatform

getProcedureCallHeader

public java.lang.String getProcedureCallHeader()

Used for sp calls.

Overrides:

getProcedureCallHeader in class DatabasePlatform

getStoredProcedureParameterPrefix

public java.lang.String getStoredProcedureParameterPrefix()

Overrides:

getStoredProcedureParameterPrefix in class DatabasePlatform

getStoredProcedureTerminationToken

public java.lang.String getStoredProcedureTerminationToken()

INTERNAL: This method returns the delimiter between stored procedures in multiple stored procedure calls.

Overrides:

getStoredProcedureTerminationToken in class DatabasePlatform

getTimestampQuery

public ValueReadQuery getTimestampQuery()

PUBLIC: This method returns the query to select the timestamp from the server for SQLServer.

Specified by:

getTimestampQuery in interface Platform

Overrides:

getTimestampQuery in class DatasourcePlatform

getSelectForUpdateString

public java.lang.String getSelectForUpdateString()

INTERNAL: Lock. UPDLOCK seems like the correct table hint to use: HOLDLOCK is too weak - doesn't lock out another read with HOLDLOCK, XLOCK is too strong - locks out another read which doesn't use any locks. UPDLOCK seems to behave exactly like Oracle's FOR UPDATE: locking out updates and other reads with FOR UPDATE but allowing other reads without locks. SQLServer seems to decide itself on the granularity of the lock - it could lock more than the returned rows (for instance a page). It could be forced to obtain to make sure to obtain row level lock: WITH (UPDLOCK, ROWLOCK) However this approach is strongly discouraged because it can consume too much resources: selecting 900 rows from and requiring a "personal" lock for each row may not be feasible because of not enough memory available at the moment - in that case SQLServer will wait until the resource becomes available.

Overrides:

getSelectForUpdateString in class DatabasePlatform

getSelectForUpdateNoWaitString

public java.lang.String getSelectForUpdateNoWaitString()

INTERNAL: This syntax does no wait on the lock.

Overrides:

getSelectForUpdateNoWaitString in class DatabasePlatform

executeStoredProcedure

public java.lang.Object executeStoredProcedure(DatabaseCall dbCall,
                                               java.sql.PreparedStatement statement,
                                               DatabaseAccessor accessor,
                                               AbstractSession session)
                                        throws java.sql.SQLException

because each platform has different requirements for accessing stored procedures and the way that we can combine resultsets and output params the stored procedure call is being executed on the platform. This entire process needs some serious refactoring to eliminate the chance of bugs.

Overrides:

executeStoredProcedure in class DatabasePlatform

Throws:

java.sql.SQLException

shouldPrintLockingClauseAfterWhereClause

public boolean shouldPrintLockingClauseAfterWhereClause()

INTERNAL: Indicates whether locking clause should be printed after where clause by SQLSelectStatement. Example: on Oracle platform (method returns true): SELECT ADDRESS_ID, ... FROM ADDRESS WHERE (ADDRESS_ID = ?) FOR UPDATE on SQLServer platform (method returns false): SELECT ADDRESS_ID, ... FROM ADDRESS WITH (UPDLOCK) WHERE (ADDRESS_ID = ?)

Overrides:

shouldPrintLockingClauseAfterWhereClause in class DatabasePlatform

extractOperator

public static ExpressionOperator extractOperator()

INTERNAL: Derby does not support EXTRACT, but does have DATEPART.

trimOperator

public static ExpressionOperator trimOperator()

INTERNAL: Use RTRIM(LTRIM(?)) function for trim.

trim2Operator

public static ExpressionOperator trim2Operator()

INTERNAL: Build Trim operator.

isSQLServer

public boolean isSQLServer()

Specified by:

isSQLServer in interface Platform

Overrides:

isSQLServer in class DatasourcePlatform

maximumNumericValues

public java.util.Hashtable maximumNumericValues()

Builds a table of maximum numeric values keyed on java class. This is used for type testing but might also be useful to end users attempting to sanitize values.

NOTE: BigInteger & BigDecimal maximums are dependent upon their precision & Scale

Overrides:

maximumNumericValues in class DatabasePlatform

minimumNumericValues

public java.util.Hashtable minimumNumericValues()

Builds a table of minimum numeric values keyed on java class. This is used for type testing but might also be useful to end users attempting to sanitize values.

NOTE: BigInteger & BigDecimal minimums are dependent upon their precision & Scale

Overrides:

minimumNumericValues in class DatabasePlatform

modOperator

public ExpressionOperator modOperator()

Override the default MOD operator.

singleArgumentSubstringOperator

public ExpressionOperator singleArgumentSubstringOperator()

Override the default SubstringSingleArg operator.

locate2Operator

public static ExpressionOperator locate2Operator()

INTERNAL: create the Locate2 Operator for this platform

printFieldIdentityClause

public void printFieldIdentityClause(java.io.Writer writer)
                              throws ValidationException

INTERNAL: Append the receiver's field 'identity' constraint clause to a writer.

Overrides:

printFieldIdentityClause in class DatabasePlatform

Throws:

ValidationException

printFieldNullClause

public void printFieldNullClause(java.io.Writer writer)
                          throws ValidationException

INTERNAL: Append the receiver's field 'NULL' constraint clause to a writer.

Overrides:

printFieldNullClause in class DatabasePlatform

Throws:

ValidationException

requiresProcedureCallBrackets

public boolean requiresProcedureCallBrackets()

USed for sp calls.

Overrides:

requiresProcedureCallBrackets in class DatabasePlatform

requiresProcedureCallOuputToken

public boolean requiresProcedureCallOuputToken()

Used for sp calls. Sybase must print output after output params.

Overrides:

requiresProcedureCallOuputToken in class DatabasePlatform

shouldPrintInOutputTokenBeforeType

public boolean shouldPrintInOutputTokenBeforeType()

This is required in the construction of the stored procedures with output parameters

Overrides:

shouldPrintInOutputTokenBeforeType in class DatabasePlatform

shouldPrintOutputTokenBeforeType

public boolean shouldPrintOutputTokenBeforeType()

This is required in the construction of the stored procedures with output parameters

Overrides:

shouldPrintOutputTokenBeforeType in class DatabasePlatform

shouldUseJDBCOuterJoinSyntax

public boolean shouldUseJDBCOuterJoinSyntax()

JDBC defines and outer join syntax, many drivers do not support this. So we normally avoid it.

Overrides:

shouldUseJDBCOuterJoinSyntax in class DatabasePlatform

supportsIdentity

public boolean supportsIdentity()

INTERNAL: Indicates whether the platform supports identity. SQLServer does through IDENTITY field types. This method is to be used *ONLY* by sequencing classes

Overrides:

supportsIdentity in class DatasourcePlatform

supportsLocalTempTables

public boolean supportsLocalTempTables()

INTERNAL:

Overrides:

supportsLocalTempTables in class DatabasePlatform

getTempTableForTable

public DatabaseTable getTempTableForTable(DatabaseTable table)

INTERNAL:

Overrides:

getTempTableForTable in class DatabasePlatform

Returns:

DatabaseTable temorary table

writeUpdateOriginalFromTempTableSql

public void writeUpdateOriginalFromTempTableSql(java.io.Writer writer,
                                                DatabaseTable table,
                                                java.util.Collection pkFields,
                                                java.util.Collection assignedFields)
                                         throws java.io.IOException

INTERNAL:

Overrides:

writeUpdateOriginalFromTempTableSql in class DatabasePlatform

Throws:

java.io.IOException