org.eclipse.persistence.platform.database

Class SybasePlatform

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.SybasePlatform

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, CorePlatform<ConversionManager>, Platform

Direct Known Subclasses:

SQLAnywherePlatform

public class SybasePlatform
extends DatabasePlatform

Purpose: Provides Sybase ASE 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, shouldIgnoreCaseOnFieldComparisons, Types_NCLOB, Types_SQLXML

Constructor Summary

Constructors

Constructor and Description
SybasePlatform()

Method Summary

Modifier and Type	Method and Description
ExpressionOperator	atan2Operator() INTERNAL: Build operator.
ValueReadQuery	buildSelectQueryForIdentity() INTERNAL: Build the identity query for native sequencing.
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	getJDBCType(java.lang.Class javaType) Sybase and SQL Anywhere do not support BLOB/CLOB but require LONGVARBINARY/LONGVARCHAR.
java.lang.String	getJdbcTypeName(int jdbcType) INTERNAL: Returns the type name corresponding to the jdbc type
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	getProcedureCallTail() Used for sp calls.
java.lang.String	getSelectForUpdateString() Most database support a syntax.
java.lang.String	getStoredProcedureParameterPrefix()
DatabaseTable	getTempTableForTable(DatabaseTable table) INTERNAL:
ValueReadQuery	getTimestampQuery() PUBLIC: This method returns the query to select the timestamp from the server for Sybase.
void	initializeConnectionData(java.sql.Connection connection) INTERNAL: Allow initialization from the connection.
boolean	isOutputAllowWithResultSet() INTERNAL: Return true if output parameters can be built with result sets.
boolean	isSybase()
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) Append the receiver's field 'identity' constraint clause to a writer.
void	printFieldNullClause(java.io.Writer writer) Append the receiver's field 'NULL' constraint clause to a writer.
void	registerOutputParameter(java.sql.CallableStatement statement, int index, int jdbcType) This method is used to register output parameter on Callable Statements for Stored Procedures as each database seems to have a different method.
boolean	requiresProcedureCallBrackets() USed for sp calls.
boolean	requiresProcedureCallOuputToken() Used for sp calls.
boolean	requiresTypeNameToRegisterOutputParameter() INTERNAL: Indicates whether the version of CallableStatement.registerOutputParameter method that takes type name should be used.
boolean	shouldPrintInOutputTokenBeforeType() This is required in the construction of the stored procedures with output parameters
boolean	shouldPrintLockingClauseAfterWhereClause() The sybase syntax for obtaining pessimistic lock is "SELECT ADDRESS_ID, ...
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	supportsDeleteOnCascade() Sybase (as of Sybase ASE 15, does not support delete on cascade).
boolean	supportsGlobalTempTables() INTERNAL:
boolean	supportsIdentity() INTERNAL: Indicates whether the platform supports identity.
static ExpressionOperator	trim2Operator() INTERNAL: Build Trim operator.
static ExpressionOperator	trimOperator() INTERNAL: Use RTRIM(LTRIM(?)) function for trim.
boolean	useJDBCStoredProcedureSyntax() Return true if this platform is to use the JDBC supported syntax for executing stored procedures.
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, dontBindUpdateAllQueryUsingTempTables, executeBatch, executeStoredProcedure, freeTemporaryObject, getAssignmentString, getBatchBeginString, getBatchEndString, getBatchRowCountAssignString, getBatchRowCountDeclareString, getBatchRowCountReturnString, getBatchWritingMechanism, getCastSizeForVarcharParameter, getClassTypes, getConnection, getConnectionUserName, getConstraintDeletionString, getCreateDatabaseSchemaString, getCreateViewString, getCursorCode, getCustomModifyValueForCall, getDefaultSequenceTableName, getDriverSupportsNVarChar, getDropCascadeString, getDropDatabaseSchemaString, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getIdentifierQuoteCharacter, getIndexNamePrefix, getInputProcedureToken, getJDBCOuterJoinString, getJDBCType, getJDBCTypeForSetNull, getMaxBatchWritingSize, getMaxForeignKeyNameSize, getMaxIndexNameSize, getMaxUniqueKeyNameSize, getNoWaitString, getObjectFromResultSet, getPartitioningCallback, getPingSQL, getProcedureArgumentSetter, getProcedureAsString, getProcedureBeginString, getProcedureEndString, getQualifiedName, getQualifiedSequenceTableName, getRefValue, getRefValue, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSelectForUpdateWaitString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStoredProcedureTerminationToken, getStringBindingSize, getStructConverters, getTableCreationSuffix, getTransactionIsolation, getTypeConverters, getUniqueConstraintDeletionString, getUseNationalCharacterVaryingTypeForString, getVPDClearIdentifierQuery, getVPDCreationFunctionString, getVPDCreationPolicyString, getVPDDeletionString, getVPDSetIdentifierQuery, hasPartitioningCallback, initialize, isAlterSequenceObjectSupported, isCastRequired, isDynamicSQLRequiredForFunctions, isForUpdateCompatibleWithDistinct, isInformixOuterJoin, isJDBCExecuteCompliant, isLobCompatibleWithDistinct, isLockTimeoutException, isNullAllowedInSelectClause, isRowCountOutputParameterRequired, isXDBDocument, minimumTimeIncrement, prepareBatchStatement, printFieldNotNullClause, printFieldTypeSize, printFieldUnique, printSQLSelectStatement, printStoredFunctionReturnKeyWord, printValuelist, printValuelist, requiresNamedPrimaryKeyConstraints, requiresProcedureBrackets, requiresTableInIndexDropDDL, requiresUniqueConstraintCreationOnTableCreate, retrieveFirstPrimaryKeyOrOne, rollbackTransaction, setBatchWritingMechanism, setCastSizeForVarcharParameter, setCursorCode, setDriverName, setDriverSupportsNVarChar, setIsCastRequired, setMaxBatchWritingSize, setParameterValueInDatabaseCall, setPartitioningCallback, setPingSQL, setPrintInnerJoinInWhereClause, setPrintOuterJoinInWhereClause, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldBindLiterals, setShouldCacheAllStatements, setShouldCreateIndicesOnForeignKeys, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setShouldUseRownumFiltering, setStatementCacheSize, setStoredProcedureTerminationToken, setStringBindingSize, setSupportsAutoCommit, setTableCreationSuffix, setTransactionIsolation, setUseJDBCStoredProcedureSyntax, setUseNationalCharacterVaryingTypeForString, setUsesBatchWriting, setUsesByteArrayBinding, setUsesJDBCBatchWriting, setUsesNativeBatchWriting, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, shouldAlwaysUseTempStorageForModifyAll, shouldBindAllParameters, shouldBindLiterals, shouldCacheAllStatements, shouldCreateIndicesForPrimaryKeys, shouldCreateIndicesOnForeignKeys, shouldCreateIndicesOnUniqueKeys, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldOptimizeDataConversion, shouldPrintAliasForUpdate, shouldPrintConstraintNameAfter, shouldPrintFieldIdentityClause, shouldPrintForUpdateClause, shouldPrintInnerJoinInWhereClause, shouldPrintInputTokenAtStart, shouldPrintOuterJoinInWhereClause, shouldPrintOutputTokenAtStart, shouldPrintStoredProcedureArgumentNameInCall, shouldPrintStoredProcedureVariablesAfterBeginString, shouldTrimStrings, shouldUseCustomModifyForCall, shouldUseGetSetNString, shouldUseRownumFiltering, supportsANSIInnerJoinSyntax, supportsAutoCommit, supportsAutoConversionToNumericForArithmeticOperations, supportsConnectionUserName, supportsCountDistinctWithMultipleFields, supportsForeignKeyConstraints, supportsIndexes, supportsIndividualTableLocking, supportsLocalTempTables, supportsLockingQueriesWithMultipleTables, supportsNestingOuterJoins, supportsOuterJoinsWithBrackets, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsTempTables, supportsUniqueColumns, supportsUniqueKeyConstraints, supportsVPD, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeBatchWriting, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, wasFailureCommunicationBased, writeAddColumnClause, 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, getDefaultNativeSequenceToTable, getDefaultSequence, getDefaultSequenceToWrite, getEndDelimiter, getOperator, getPlatformOperators, getSelectSequenceQuery, getSequence, getSequences, getSequencesToWrite, getStartDelimiter, getTableQualifier, getTimestampFromServer, getUpdateSequenceQuery, hasDefaultSequence, initializeDefaultQueries, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isDerby, isFirebird, isH2, isHANA, isHSQL, isInformix, isMaxDB, isMySQL, isODBC, isOracle, isOracle9, isPervasive, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, isSymfoware, isTimesTen, isTimesTen7, removeAllSequences, removeSequence, setConversionManager, setDefaultNativeSequenceToTable, 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

SybasePlatform

public SybasePlatform()

Method Detail

initializeConnectionData

public void initializeConnectionData(java.sql.Connection connection)
                              throws java.sql.SQLException

Description copied from class: DatabasePlatform

INTERNAL: Allow initialization from the connection.

Overrides:

initializeConnectionData in class DatabasePlatform

Throws:

java.sql.SQLException

getJDBCType

public int getJDBCType(java.lang.Class javaType)

Sybase and SQL Anywhere do not support BLOB/CLOB but require LONGVARBINARY/LONGVARCHAR.

Overrides:

getJDBCType in class DatabasePlatform

atan2Operator

public ExpressionOperator atan2Operator()

INTERNAL: Build operator.

buildSelectQueryForIdentity

public ValueReadQuery buildSelectQueryForIdentity()

INTERNAL: Build the identity query for native sequencing.

Overrides:

buildSelectQueryForIdentity in class DatasourcePlatform

shouldPrintLockingClauseAfterWhereClause

public boolean shouldPrintLockingClauseAfterWhereClause()

The sybase syntax for obtaining pessimistic lock is "SELECT ADDRESS_ID, ... FROM ADDRESS WITH (HOLDLOCK) WHERE (ADDRESS_ID = ?)" Please note that above only obtains shared lock. Apparently there is no way to obtain exclusive lock on Sybase using only a select statement

Overrides:

shouldPrintLockingClauseAfterWhereClause in class DatabasePlatform

getSelectForUpdateString

public java.lang.String getSelectForUpdateString()

Description copied from class: DatabasePlatform

Most database support a syntax. although don't actually lock the row. Some require the OF some don't like it.

Overrides:

getSelectForUpdateString 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()

Description copied from class: DatabasePlatform

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()

Description copied from class: DatabasePlatform

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()

Description copied from class: DatabasePlatform

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

Overrides:

getInOutputProcedureToken in class DatabasePlatform

getJdbcTypeName

public java.lang.String getJdbcTypeName(int jdbcType)

INTERNAL: Returns the type name corresponding to the jdbc type

Overrides:

getJdbcTypeName 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()

Description copied from class: DatabasePlatform

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

getProcedureCallTail

public java.lang.String getProcedureCallTail()

Description copied from class: DatabasePlatform

Used for sp calls.

Overrides:

getProcedureCallTail in class DatabasePlatform

useJDBCStoredProcedureSyntax

public boolean useJDBCStoredProcedureSyntax()

Return true if this platform is to use the JDBC supported syntax for executing stored procedures. If the driver is known to be the DataDirec driver, and the value is not set, then set to true and return.

getStoredProcedureParameterPrefix

public java.lang.String getStoredProcedureParameterPrefix()

Overrides:

getStoredProcedureParameterPrefix in class DatabasePlatform

getTimestampQuery

public ValueReadQuery getTimestampQuery()

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

Specified by:

getTimestampQuery in interface Platform

Overrides:

getTimestampQuery in class DatasourcePlatform

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.

isOutputAllowWithResultSet

public boolean isOutputAllowWithResultSet()

INTERNAL: Return true if output parameters can be built with result sets.

Overrides:

isOutputAllowWithResultSet in class DatabasePlatform

isSybase

public boolean isSybase()

Specified by:

isSybase in interface Platform

Overrides:

isSybase 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.

printFieldIdentityClause

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

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

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

Overrides:

printFieldNullClause in class DatabasePlatform

Throws:

ValidationException

registerOutputParameter

public void registerOutputParameter(java.sql.CallableStatement statement,
                                    int index,
                                    int jdbcType)
                             throws java.sql.SQLException

This method is used to register output parameter on Callable Statements for Stored Procedures as each database seems to have a different method.

Overrides:

registerOutputParameter in class DatabasePlatform

Throws:

java.sql.SQLException

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

requiresTypeNameToRegisterOutputParameter

public boolean requiresTypeNameToRegisterOutputParameter()

INTERNAL: Indicates whether the version of CallableStatement.registerOutputParameter method that takes type name should be used.

Overrides:

requiresTypeNameToRegisterOutputParameter in class DatabasePlatform

shouldPrintInOutputTokenBeforeType

public boolean shouldPrintInOutputTokenBeforeType()

Description copied from class: DatabasePlatform

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

Overrides:

shouldPrintInOutputTokenBeforeType in class DatabasePlatform

shouldPrintOutputTokenBeforeType

public boolean shouldPrintOutputTokenBeforeType()

Description copied from class: DatabasePlatform

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

singleArgumentSubstringOperator

public ExpressionOperator singleArgumentSubstringOperator()

Override the default SubstringSingleArg operator.

supportsIdentity

public boolean supportsIdentity()

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

Overrides:

supportsIdentity in class DatasourcePlatform

supportsDeleteOnCascade

public boolean supportsDeleteOnCascade()

Sybase (as of Sybase ASE 15, does not support delete on cascade). Sybase ASA (SQL Anywhere does, so must use different platform).

Overrides:

supportsDeleteOnCascade in class DatabasePlatform

supportsGlobalTempTables

public boolean supportsGlobalTempTables()

INTERNAL:

Overrides:

supportsGlobalTempTables 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