oracle.toplink.essentials.platform.database

Class MySQL4Platform

java.lang.Object

oracle.toplink.essentials.internal.databaseaccess.DatasourcePlatform

oracle.toplink.essentials.internal.databaseaccess.DatabasePlatform

oracle.toplink.essentials.platform.database.DatabasePlatform

oracle.toplink.essentials.platform.database.MySQL4Platform

All Implemented Interfaces:

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

public class MySQL4Platform
extends DatabasePlatform

Purpose: Provides MySQL specific behaviour.

Responsibilities:

• Native SQL for Date, Time, & Timestamp.
• Native sequencing.
• Mapping of class types to database types for the schema framework.
• Pessimistic locking.
• Platform specific operators.

Since:

OracleAS TopLink 10g (10.1.3)

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.toplink.essentials.internal.databaseaccess.DatabasePlatform

classTypes, cursorCode, fieldTypes, shouldBindAllParameters, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldOptimizeDataConversion, shouldTrimStrings, statementCacheSize, stringBindingSize, supportsAutoCommit, transactionIsolation, usesByteArrayBinding, usesNativeSQL, usesStreamsForBinding, usesStringBinding

Fields inherited from class oracle.toplink.essentials.internal.databaseaccess.DatasourcePlatform

conversionManager, dataTypesConvertedFromAClass, dataTypesConvertedToAClass, defaultSequence, platformOperators, sequences, tableQualifier, timestampQuery

Constructor Summary

Constructors

Constructor and Description
MySQL4Platform()

Method Summary

Modifier and Type	Method and Description
protected void	appendCalendar(java.util.Calendar calendar, java.io.Writer writer) INTERNAL: Appends an MySQL specific Timestamp, if usesNativeSQL is true otherwise use the ODBC format.
protected void	appendDate(java.sql.Date date, java.io.Writer writer) INTERNAL: Appends an MySQL specific date if usesNativeSQL is true otherwise use the ODBC format.
protected void	appendTime(java.sql.Time time, java.io.Writer writer) INTERNAL: Appends an MySQL specific time if usesNativeSQL is true otherwise use the ODBC format.
protected void	appendTimestamp(java.sql.Timestamp timestamp, java.io.Writer writer) INTERNAL: Appends an MySQL specific Timestamp, if usesNativeSQL is true otherwise use the ODBC format.
protected java.util.Hashtable	buildFieldTypes() INTERNAL: Return the mapping of class types to database types for the schema framework.
ValueReadQuery	buildSelectQueryForNativeSequence() INTERNAL: Build the identity query for native sequencing.
protected ExpressionOperator	dateToStringOperator() INTERNAL: Build MySQL equivalent to TO_CHAR.
java.lang.String	getConstraintDeletionString() INTERNAL: Used for constraint deletion.
protected java.lang.String	getCreateTempTableSqlPrefix() INTERNAL:
java.lang.String	getSelectForUpdateString() INTERNAL: Used for pessimistic locking.
ValueReadQuery	getTimestampQuery() INTERNAL: This method returns the query to select the timestamp from the server for MySQL.
protected void	initializePlatformOperators() INTERNAL: Initialize any platform-specific operators
boolean	isMySQL() Answers whether platform is MySQL
protected ExpressionOperator	leftTrim2() INTERNAL: Build MySQL equivalent to LTRIM(string_exp, character).
protected ExpressionOperator	logOperator() INTERNAL: Create the 10 based log operator for this platform
void	printFieldIdentityClause(java.io.Writer writer) INTERNAL: Append the receiver's field 'identity' constraint clause to a writer
protected ExpressionOperator	rightTrim2() INTERNAL: Build MySQL equivalent to RTRIM(string_exp, character).
boolean	shouldAlwaysUseTempStorageForModifyAll() INTERNAL:
boolean	shouldNativeSequenceAcquireValueAfterInsert() INTERNAL: If native sequencing is being used on Sybase then the values must be retrieved after the insert.
boolean	shouldUseJDBCOuterJoinSyntax() INTERNAL: JDBC defines an outer join syntax which many drivers do not support.
boolean	supportsGlobalTempTables() INTERNAL:
boolean	supportsNativeSequenceNumbers() INTERNAL: Return true if the receiver uses host sequence numbers, generated on the database.
protected ExpressionOperator	toCharOperator() INTERNAL: Build MySQL equivalent to TO_CHAR.
protected ExpressionOperator	toDateOperator() INTERNAL: Build MySQL equivalent to TO_DATE.
protected ExpressionOperator	toNumberOperator() INTERNAL: Build MySQL equivalent to TO_NUMBER.
void	writeDeleteFromTargetTableUsingTempTableSql(java.io.Writer writer, DatabaseTable table, DatabaseTable targetTable, java.util.Collection pkFields, java.util.Collection targetPkFields) INTERNAL:
void	writeUpdateOriginalFromTempTableSql(java.io.Writer writer, DatabaseTable table, java.util.Collection pkFields, java.util.Collection assignedFields) INTERNAL:

Methods inherited from class oracle.toplink.essentials.internal.databaseaccess.DatabasePlatform

allowsSizeInProcedureArguments, appendBoolean, appendByteArray, appendLiteralToCall, appendLiteralToCallWithBinding, appendNumber, appendParameter, appendParameterInternal, appendString, autoCommit, beginTransaction, buildCallWithReturning, buildClassTypes, buildSelectQueryForNativeSequence, canBuildCallWithReturning, commitTransaction, convertToDatabaseType, copyInto, createPlatformDefaultSequence, dontBindUpdateAllQueryUsingTempTables, executeStoredProcedure, getAssignmentString, getBatchBeginString, getBatchDelimiterString, getBatchEndString, getClassTypes, getCreateTempTableSqlBodyForTable, getCreateTempTableSqlSuffix, getCreateViewString, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getCursorCode, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getInOutputProcedureToken, getJDBCOuterJoinString, getJDBCType, getJDBCType, getJdbcTypeName, getMaxFieldNameSize, getMaxForeignKeyNameSize, getMaxUniqueKeyNameSize, getObjectFromResultSet, getOutputProcedureToken, getProcedureArgumentSetter, getProcedureArgumentString, getProcedureAsString, getProcedureBeginString, getProcedureCallHeader, getProcedureCallTail, getProcedureEndString, getQualifiedSequenceTableName, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStoredProcedureParameterPrefix, getStoredProcedureTerminationToken, getStringBindingSize, getTempTableForTable, getTransactionIsolation, isInformixOuterJoin, isNullAllowedInSelectClause, maximumNumericValues, minimumNumericValues, printFieldIdentityClause, printFieldNotNullClause, printFieldNullClause, printFieldTypeSize, printFieldUnique, printValuelist, printValuelist, processResultSet, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureCallBrackets, requiresProcedureCallOuputToken, requiresTypeNameToRegisterOutputParameter, rollbackTransaction, setClassTypes, setCursorCode, setFieldTypes, setParameterValueInDatabaseCall, setParameterValueInDatabaseCall, setParameterValueInDatabaseCall, setPrimitiveParameterValue, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldCacheAllStatements, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setStatementCacheSize, setStringBindingSize, setSupportsAutoCommit, setTransactionIsolation, setUsesByteArrayBinding, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, shouldAcquireSequenceValueAfterInsert, shouldBindAllParameters, shouldBindLiterals, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldNativeSequenceUseTransaction, shouldOptimizeDataConversion, shouldPrintConstraintNameAfter, shouldPrintInOutputTokenBeforeType, shouldPrintOuterJoinInWhereClause, shouldPrintOutputTokenAtStart, shouldPrintOutputTokenBeforeType, shouldTempTableSpecifyPrimaryKeys, shouldTrimStrings, supportsAutoCommit, supportsForeignKeyConstraints, supportsLocalTempTables, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsTempTables, supportsUniqueKeyConstraints, usesByteArrayBinding, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, writeAutoAssignmentSetClause, writeAutoJoinWhereClause, writeCleanUpTempTableSql, writeCreateTempTableSql, writeFields, writeFieldsAutoClause, writeFieldsList, writeInsertIntoTableSql, writeJoinWhereClause, writeLOB, writeParameterMarker

Methods inherited from class oracle.toplink.essentials.internal.databaseaccess.DatasourcePlatform

addOperator, addSequence, clone, convertObject, createSequences, getConversionManager, getCustomModifyValueForCall, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultSequence, getDefaultSequenceToWrite, getOperator, getPlatformOperators, getSequence, getSequences, getSequencesToWrite, getTableQualifier, getTimestampFromServer, hasDefaultSequence, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isDerby, isHSQL, isInformix, isODBC, isOracle, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, isSybase, isTimesTen, platformSpecificSequencingInitialization, removeAllSequences, removeSequence, sequencesAfterCloneCleanup, setConversionManager, setDefaultSequence, setSequences, setTableQualifier, setTimestampQuery, shouldUseCustomModifyForCall, toString, usesPlatformDefaultSequence

Methods inherited from class java.lang.Object

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

Constructor Detail

MySQL4Platform

public MySQL4Platform()

Method Detail

appendDate

protected void appendDate(java.sql.Date date,
                          java.io.Writer writer)
                   throws java.io.IOException

INTERNAL: Appends an MySQL specific date if usesNativeSQL is true otherwise use the ODBC format. Native FORMAT: 'YYYY-MM-DD'

Overrides:

appendDate in class DatabasePlatform

Throws:

java.io.IOException

appendTime

protected void appendTime(java.sql.Time time,
                          java.io.Writer writer)
                   throws java.io.IOException

INTERNAL: Appends an MySQL specific time if usesNativeSQL is true otherwise use the ODBC format. Native FORMAT: 'HH:MM:SS'.

Overrides:

appendTime in class DatabasePlatform

Throws:

java.io.IOException

appendTimestamp

protected void appendTimestamp(java.sql.Timestamp timestamp,
                               java.io.Writer writer)
                        throws java.io.IOException

INTERNAL: Appends an MySQL specific Timestamp, if usesNativeSQL is true otherwise use the ODBC format. Native Format: 'YYYY-MM-DD HH:MM:SS'

Overrides:

appendTimestamp in class DatabasePlatform

Throws:

java.io.IOException

appendCalendar

protected void appendCalendar(java.util.Calendar calendar,
                              java.io.Writer writer)
                       throws java.io.IOException

INTERNAL: Appends an MySQL specific Timestamp, if usesNativeSQL is true otherwise use the ODBC format. Native Format: 'YYYY-MM-DD HH:MM:SS'

Overrides:

appendCalendar in class DatabasePlatform

Throws:

java.io.IOException

buildFieldTypes

protected java.util.Hashtable buildFieldTypes()

INTERNAL: Return the mapping of class types to database types for the schema framework.

Overrides:

buildFieldTypes in class DatabasePlatform

buildSelectQueryForNativeSequence

public ValueReadQuery buildSelectQueryForNativeSequence()

INTERNAL: Build the identity query for native sequencing.

Overrides:

buildSelectQueryForNativeSequence in class DatabasePlatform

getConstraintDeletionString

public java.lang.String getConstraintDeletionString()

INTERNAL: Used for constraint deletion.

Overrides:

getConstraintDeletionString in class DatabasePlatform

getSelectForUpdateString

public java.lang.String getSelectForUpdateString()

INTERNAL: Used for pessimistic locking.

Overrides:

getSelectForUpdateString in class DatabasePlatform

getTimestampQuery

public ValueReadQuery getTimestampQuery()

INTERNAL: This method returns the query to select the timestamp from the server for MySQL.

Specified by:

getTimestampQuery in interface Platform

Overrides:

getTimestampQuery in class DatasourcePlatform

isMySQL

public boolean isMySQL()

Answers whether platform is MySQL

Specified by:

isMySQL in interface Platform

Overrides:

isMySQL in class DatasourcePlatform

initializePlatformOperators

protected void initializePlatformOperators()

INTERNAL: Initialize any platform-specific operators

Overrides:

initializePlatformOperators in class DatasourcePlatform

logOperator

protected ExpressionOperator logOperator()

INTERNAL: Create the 10 based log operator for this platform

toNumberOperator

protected ExpressionOperator toNumberOperator()

INTERNAL: Build MySQL equivalent to TO_NUMBER.

toDateOperator

protected ExpressionOperator toDateOperator()

INTERNAL: Build MySQL equivalent to TO_DATE.

toCharOperator

protected ExpressionOperator toCharOperator()

INTERNAL: Build MySQL equivalent to TO_CHAR.

dateToStringOperator

protected ExpressionOperator dateToStringOperator()

INTERNAL: Build MySQL equivalent to TO_CHAR.

leftTrim2

protected ExpressionOperator leftTrim2()

INTERNAL: Build MySQL equivalent to LTRIM(string_exp, character). MySQL: TRIM(LEADING character FROM string_exp)

rightTrim2

protected ExpressionOperator rightTrim2()

INTERNAL: Build MySQL equivalent to RTRIM(string_exp, character). MySQL: TRIM(TRAILING character FROM string_exp)

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

shouldNativeSequenceAcquireValueAfterInsert

public boolean shouldNativeSequenceAcquireValueAfterInsert()

INTERNAL: If native sequencing is being used on Sybase then the values must be retrieved after the insert. This method is to be used *ONLY* by sequencing classes

Overrides:

shouldNativeSequenceAcquireValueAfterInsert in class DatabasePlatform

shouldUseJDBCOuterJoinSyntax

public boolean shouldUseJDBCOuterJoinSyntax()

INTERNAL: JDBC defines an outer join syntax which many drivers do not support. So we normally avoid it.

Overrides:

shouldUseJDBCOuterJoinSyntax in class DatabasePlatform

supportsNativeSequenceNumbers

public boolean supportsNativeSequenceNumbers()

INTERNAL: Return true if the receiver uses host sequence numbers, generated on the database. MySQL does through AUTO_INCREMENT field types.

Overrides:

supportsNativeSequenceNumbers in class DatabasePlatform

supportsGlobalTempTables

public boolean supportsGlobalTempTables()

INTERNAL:

Overrides:

supportsGlobalTempTables in class DatabasePlatform

getCreateTempTableSqlPrefix

protected java.lang.String getCreateTempTableSqlPrefix()

INTERNAL:

Overrides:

getCreateTempTableSqlPrefix in class DatabasePlatform

shouldAlwaysUseTempStorageForModifyAll

public boolean shouldAlwaysUseTempStorageForModifyAll()

INTERNAL:

Overrides:

shouldAlwaysUseTempStorageForModifyAll in class DatabasePlatform

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

writeDeleteFromTargetTableUsingTempTableSql

public void writeDeleteFromTargetTableUsingTempTableSql(java.io.Writer writer,
                                                        DatabaseTable table,
                                                        DatabaseTable targetTable,
                                                        java.util.Collection pkFields,
                                                        java.util.Collection targetPkFields)
                                                 throws java.io.IOException

INTERNAL:

Overrides:

writeDeleteFromTargetTableUsingTempTableSql in class DatabasePlatform

Throws:

java.io.IOException