Package org.eclipse.persistence.platform.database

Class DerbyPlatform

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

org.eclipse.persistence.platform.database.DerbyPlatform

All Implemented Interfaces:

Serializable, Cloneable, CorePlatform<ConversionManager>, Platform

Direct Known Subclasses:

JavaDBPlatform

public class DerbyPlatform
extends DB2Platform

Purpose: Provides Derby DBMS specific behavior.

Since:

TOPLink Essentials 1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isConnectionDataInitialized
protected boolean	isSequenceSupported	Allow sequence support to be disabled for Derby < 10.6.1.
static int	MAX_BLOB
static int	MAX_CLOB

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

DEFAULT_VARCHAR_SIZE

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

batchWritingMechanism, castSizeForVarcharParameter, classTypes, cursorCode, DEFAULT_MAX_BATCH_WRITING_SIZE, DEFAULT_PARAMETERIZED_MAX_BATCH_WRITING_SIZE, driverName, driverSupportsNationalCharacterVarying, fieldTypes, IS_VALID_TIMEOUT, isCastRequired, maxBatchWritingSize, partitioningCallback, pingSQL, printInnerJoinInWhereClause, printOuterJoinInWhereClause, shouldBindAllParameters, shouldBindLiterals, shouldCacheAllStatements, shouldCreateIndicesOnForeignKeys, shouldForceBindAllParameters, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldOptimizeDataConversion, shouldTrimStrings, statementCacheSize, storedProcedureTerminationToken, stringBindingSize, structConverters, supportsAutoCommit, tableCreationSuffix, transactionIsolation, typeConverters, useJDBCStoredProcedureSyntax, useNationalCharacterVarying, useRownumFiltering, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeBatchWriting, usesNativeSQL, usesStreamsForBinding, usesStringBinding

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

conversionManager, dataTypesConvertedFromAClass, dataTypesConvertedToAClass, defaultNativeSequenceToTable, defaultSeqenceAtNextValue, defaultSequence, endDelimiter, platformOperators, sequences, sequencesLock, startDelimiter, tableQualifier, timestampQuery

Constructor Summary

Constructors

Constructor	Description
DerbyPlatform()

Method Summary

Modifier and Type	Method	Description
protected void	appendByteArray(byte[] bytes, Writer writer)	INTERNAL: TODO: Need to find out how can byte arrays be inlined in Derby
protected Hashtable	buildFieldTypes()	Return the mapping of class types to database types for the schema framework.
ValueReadQuery	buildSelectQueryForIdentity()	INTERNAL: Build the identity query for native sequencing.
Writer	buildSequenceObjectDeletionWriter(Writer writer, String fullSeqName)	INTERNAL: Derby supports sequence objects as of 10.6.1.
int	computeMaxRowsForSQL(int firstResultIndex, int maxResults)	INTERNAL: Use the JDBC maxResults and firstResultIndex setting to compute a value to use when limiting the results of a query in SQL.
Object	convertToDatabaseType(Object value)	Derby error the data type, length or value of arguments 'TIMESTAMP' and 'DATE' is incompatible.
static ExpressionOperator	extractOperator()	INTERNAL: Derby does not support EXTRACT, but does have YEAR, MONTH, DAY, etc.
protected String	getCreateTempTableSqlBodyForTable(DatabaseTable table)	INTERNAL:
protected String	getCreateTempTableSqlSuffix()	INTERNAL:
String	getInOutputProcedureToken()	This method is used to print the output parameter token when stored procedures are called
Vector	getNativeTableInfo(String table, String creator, AbstractSession session)	INTERNAL: Not currently used.
String	getProcedureBeginString()	Used for stored procedure defs.
String	getProcedureEndString()	Used for stored procedure defs.
String	getSelectForUpdateString()	INTERNAL: Used for pessimistic locking in DB2.
ValueReadQuery	getTimestampQuery()	INTERNAL: This method returns the query to select the timestamp from the server for Derby.
void	initializeConnectionData(Connection connection)	INTERNAL:
protected void	initializePlatformOperators()	Initialize any platform-specific operators
boolean	isAlterSequenceObjectSupported()	INTERNAL: DB2 added SEQUENCE support as of (I believe) v8.
boolean	isDB2()
boolean	isDerby()	INTERNAL: Answers whether platform is Derby
void	printFieldIdentityClause(Writer writer)	INTERNAL: Append the receiver's field 'identity' constraint clause to a writer.
void	printSQLSelectStatement(DatabaseCall call, ExpressionSQLPrinter printer, SQLSelectStatement statement)	INTERNAL: Print the SQL representation of the statement on a stream, storing the fields in the DatabaseCall.
protected void	setNullFromDatabaseField(DatabaseField databaseField, PreparedStatement statement, int index)
boolean	shouldIgnoreException(SQLException exception)	Allow for the platform to ignore exceptions.
boolean	shouldPrintOutputTokenAtStart()	This is required in the construction of the stored procedures with output parameters
protected boolean	shouldTempTableSpecifyPrimaryKeys()	INTERNAL: Indicates whether temporary table can specify primary keys (some platforms don't allow that).
boolean	supportsSequenceObjects()	INTERNAL: Derby supports sequence objects as of 10.6.1.
void	writeUpdateOriginalFromTempTableSql(Writer writer, DatabaseTable table, Collection pkFields, Collection assignedFields)	INTERNAL: May need to override this method if the platform supports temporary tables and the generated sql doesn't work.

Methods inherited from class org.eclipse.persistence.platform.database.DB2Platform

appendCalendar, appendDate, appendDB2Calendar, appendDB2Date, appendDB2Timestamp, appendTime, appendTimestamp, buildSelectQueryForSequenceObject, dontBindUpdateAllQueryUsingTempTables, getCreateTempTableSqlPrefix, getMaxFieldNameSize, getMaxForeignKeyNameSize, getMaxUniqueKeyNameSize, getNoWaitString, getProcedureArgument, getProcedureAsString, getProcedureCallHeader, getTempTableForTable, isDynamicSQLRequiredForFunctions, isNullAllowedInSelectClause, maximumNumericValues, minimumNumericValues, printFieldTypeSize, shouldPrintForUpdateClause, shouldUseJDBCOuterJoinSyntax, supportsGlobalTempTables, supportsIdentity, supportsLockingQueriesWithMultipleTables, supportsOrderByParameters, writeParameterMarker

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

addBatch, addStructConverter, allowsSizeInProcedureArguments, appendBoolean, appendLiteralToCall, appendLiteralToCallWithBinding, appendNumber, appendParameter, appendParameterInternal, appendString, autoCommit, beginTransaction, buildBatchCriteria, buildBatchCriteriaForComplexId, buildCallWithReturning, buildClassTypes, buildCreateIndex, buildCreateIndex, buildDropIndex, buildDropIndex, buildProcedureCallString, buildSequenceObjectAlterIncrementWriter, buildSequenceObjectCreationWriter, canBatchWriteWithOptimisticLocking, canBuildCallWithReturning, checkTableExists, commitTransaction, copyInto, createArray, createArray, createPlatformDefaultSequence, createStruct, createStruct, createStruct, executeBatch, executeStoredProcedure, freeTemporaryObject, getAssignmentString, getBatchBeginString, getBatchDelimiterString, getBatchEndString, getBatchRowCountAssignString, getBatchRowCountDeclareString, getBatchRowCountReturnString, getBatchWritingMechanism, getCastSizeForVarcharParameter, getClassTypes, getConnection, getConnectionUserName, getConstraintDeletionString, getCreateDatabaseSchemaString, getCreateViewString, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getCursorCode, getCustomModifyValueForCall, getDefaultSequenceTableName, getDriverSupportsNVarChar, getDropCascadeString, getDropDatabaseSchemaString, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getIndexNamePrefix, getInputProcedureToken, getJDBCOuterJoinString, getJDBCType, getJDBCType, getJDBCTypeForSetNull, getJdbcTypeName, getMaxBatchWritingSize, getMaxIndexNameSize, getObjectFromResultSet, getOutputProcedureToken, getParameterValueFromDatabaseCall, getParameterValueFromDatabaseCall, getPartitioningCallback, getPingSQL, getProcedureArgumentString, getProcedureCallTail, getProcedureOptionList, getQualifiedName, getQualifiedSequenceTableName, getRefValue, getRefValue, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSelectForUpdateWaitString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStoredProcedureParameterPrefix, getStoredProcedureTerminationToken, getStringBindingSize, getStructConverters, getTableCreationSuffix, getTableExistsQuery, getTransactionIsolation, getTypeConverters, getUniqueConstraintDeletionString, getUseNationalCharacterVaryingTypeForString, getVPDClearIdentifierQuery, getVPDCreationFunctionString, getVPDCreationPolicyString, getVPDDeletionString, getVPDSetIdentifierQuery, hasPartitioningCallback, initialize, isCastRequired, isForUpdateCompatibleWithDistinct, isInformixOuterJoin, isJDBCExecuteCompliant, isLobCompatibleWithDistinct, isLockTimeoutException, isOutputAllowWithResultSet, isRowCountOutputParameterRequired, isXDBDocument, minimumTimeIncrement, prepareBatchStatement, printFieldNotNullClause, printFieldNullClause, printFieldTypeSize, printFieldUnique, printFieldUnique, printStoredFunctionReturnKeyWord, printValuelist, printValuelist, registerOutputParameter, registerOutputParameter, registerOutputParameter, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureBrackets, requiresProcedureCallBrackets, requiresProcedureCallOuputToken, requiresTableInIndexDropDDL, requiresTypeNameToRegisterOutputParameter, requiresUniqueConstraintCreationOnTableCreate, retrieveFirstPrimaryKeyOrOne, rollbackTransaction, setBatchWritingMechanism, setCastSizeForVarcharParameter, setClassTypes, setCursorCode, setDriverName, setDriverSupportsNVarChar, setFieldTypes, setIsCastRequired, setMaxBatchWritingSize, setNullFromDatabaseField, setParameterValueInDatabaseCall, setParameterValueInDatabaseCall, setPartitioningCallback, setPingSQL, setPrintInnerJoinInWhereClause, setPrintOuterJoinInWhereClause, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldBindLiterals, setShouldCacheAllStatements, setShouldCreateIndicesOnForeignKeys, setShouldForceBindAllParameters, 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, shouldForceBindAllParameters, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldOptimizeDataConversion, shouldPrintAliasForUpdate, shouldPrintConstraintNameAfter, shouldPrintFieldIdentityClause, shouldPrintInnerJoinInWhereClause, shouldPrintInOutputTokenBeforeType, shouldPrintInputTokenAtStart, shouldPrintLockingClauseAfterWhereClause, shouldPrintOuterJoinInWhereClause, shouldPrintOutputTokenBeforeType, shouldPrintStoredProcedureArgumentNameInCall, shouldPrintStoredProcedureVariablesAfterBeginString, shouldTrimStrings, shouldUseCustomModifyForCall, shouldUseGetSetNString, shouldUseRownumFiltering, supportsANSIInnerJoinSyntax, supportsAutoCommit, supportsAutoConversionToNumericForArithmeticOperations, supportsConnectionUserName, supportsCountDistinctWithMultipleFields, supportsDeleteOnCascade, supportsForeignKeyConstraints, supportsIndexes, supportsIndividualTableLocking, supportsLocalTempTables, supportsNestingOuterJoins, supportsOuterJoinsWithBrackets, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsTempTables, supportsUniqueColumns, supportsUniqueKeyConstraints, supportsVPD, supportsWaitForUpdate, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeBatchWriting, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, wasFailureCommunicationBased, writeAddColumnClause, writeAutoAssignmentSetClause, writeAutoJoinWhereClause, writeCleanUpTempTableSql, writeCreateTempTableSql, writeDeleteFromTargetTableUsingTempTableSql, writeFields, writeFieldsAutoClause, writeFieldsList, writeInsertIntoTableSql, writeJoinWhereClause, writeLOB, writeTableCreationSuffix

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

addOperator, addSequence, addSequence, buildNativeCall, buildSelectQueryForIdentity, buildSelectQueryForSequenceObject, clone, convertObject, createConnectionCustomizer, createExpressionFor, getConversionManager, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultNativeSequenceToTable, getDefaultSeqenceAtNextValue, getDefaultSequence, getDefaultSequenceToWrite, getEndDelimiter, getINClauseLimit, getOperator, getPlatformOperators, getSelectSequenceQuery, getSequence, getSequences, getSequencesToWrite, getStartDelimiter, getTableQualifier, getTimestampFromServer, getUpdateSequenceQuery, hasDefaultSequence, initializeDefaultQueries, initIdentitySequences, isAccess, isAttunity, isCloudscape, isDB2Z, isDBase, isFirebird, isH2, isHANA, isHSQL, isInformix, isMaxDB, isMySQL, isODBC, isOracle, isOracle12, isOracle9, isPervasive, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, isSybase, isSymfoware, isTimesTen, isTimesTen7, removeAllSequences, removeIdentitySequences, removeSequence, sequencesAfterCloneCleanup, setConversionManager, setDefaultNativeSequenceToTable, setDefaultSeqenceAtNextValue, setDefaultSequence, setEndDelimiter, setSelectSequenceNumberQuery, setSequencePreallocationSize, setSequences, setStartDelimiter, setTableQualifier, setTimestampQuery, setUpdateSequenceQuery, shouldNativeSequenceUseTransaction, shouldPrepare, shouldSelectDistinctIncludeOrderBy, shouldSelectIncludeOrderBy, supportsNativeSequenceNumbers, toString, usesPlatformDefaultSequence

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CLOB

public static final int MAX_CLOB

See Also:

Constant Field Values

MAX_BLOB

public static final int MAX_BLOB

See Also:

Constant Field Values

isSequenceSupported

protected boolean isSequenceSupported

Allow sequence support to be disabled for Derby < 10.6.1.

isConnectionDataInitialized

protected boolean isConnectionDataInitialized

Constructor Detail

DerbyPlatform

public DerbyPlatform()

Method Detail

appendByteArray

protected void appendByteArray(byte[] bytes,
                               Writer writer)
                        throws IOException

INTERNAL: TODO: Need to find out how can byte arrays be inlined in Derby

Overrides:

appendByteArray in class DB2Platform

Throws:

IOException

convertToDatabaseType

public Object convertToDatabaseType(Object value)

Derby error the data type, length or value of arguments 'TIMESTAMP' and 'DATE' is incompatible. Instead, use a java.sql.Date type for property {d } casting

Overrides:

convertToDatabaseType in class DatabasePlatform

getTimestampQuery

public ValueReadQuery getTimestampQuery()

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

Specified by:

getTimestampQuery in interface Platform

Overrides:

getTimestampQuery in class DB2Platform

getNativeTableInfo

public Vector getNativeTableInfo(String table,
                                 String creator,
                                 AbstractSession session)

INTERNAL: Not currently used.

Overrides:

getNativeTableInfo in class DB2Platform

getProcedureEndString

public String getProcedureEndString()

Used for stored procedure defs.

Overrides:

getProcedureEndString in class DB2Platform

getProcedureBeginString

public String getProcedureBeginString()

Used for stored procedure defs.

Overrides:

getProcedureBeginString in class DB2Platform

getInOutputProcedureToken

public String getInOutputProcedureToken()

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

Overrides:

getInOutputProcedureToken in class DatabasePlatform

shouldPrintOutputTokenAtStart

public boolean shouldPrintOutputTokenAtStart()

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

Overrides:

shouldPrintOutputTokenAtStart in class DB2Platform

isDerby

public boolean isDerby()

INTERNAL: Answers whether platform is Derby

Specified by:

isDerby in interface Platform

Overrides:

isDerby in class DatasourcePlatform

isDB2

public boolean isDB2()

Specified by:

isDB2 in interface Platform

Overrides:

isDB2 in class DB2Platform

getSelectForUpdateString

public String getSelectForUpdateString()

Description copied from class: DB2Platform

INTERNAL: Used for pessimistic locking in DB2. Without the "WITH RS" the lock is not held.

Overrides:

getSelectForUpdateString in class DB2Platform

shouldIgnoreException

public boolean shouldIgnoreException(SQLException exception)

Allow for the platform to ignore exceptions.

Overrides:

shouldIgnoreException in class DB2Platform

getCreateTempTableSqlSuffix

protected String getCreateTempTableSqlSuffix()

INTERNAL:

Overrides:

getCreateTempTableSqlSuffix in class DB2Platform

buildSelectQueryForIdentity

public ValueReadQuery buildSelectQueryForIdentity()

INTERNAL: Build the identity query for native sequencing.

Overrides:

buildSelectQueryForIdentity in class DB2Platform

shouldTempTableSpecifyPrimaryKeys

protected boolean shouldTempTableSpecifyPrimaryKeys()

INTERNAL: Indicates whether temporary table can specify primary keys (some platforms don't allow that). Used by writeCreateTempTableSql method.

Overrides:

shouldTempTableSpecifyPrimaryKeys in class DatabasePlatform

getCreateTempTableSqlBodyForTable

protected String getCreateTempTableSqlBodyForTable(DatabaseTable table)

INTERNAL:

Overrides:

getCreateTempTableSqlBodyForTable in class DB2Platform

Parameters:

table - is original table for which temp table is created.

Returns:

String

writeUpdateOriginalFromTempTableSql

public void writeUpdateOriginalFromTempTableSql(Writer writer,
                                                DatabaseTable table,
                                                Collection pkFields,
                                                Collection assignedFields)
                                         throws IOException

INTERNAL: May need to override this method if the platform supports temporary tables and the generated sql doesn't work. Write an sql string for updating the original table from the temporary table. Precondition: supportsTempTables() == true. Precondition: pkFields and assignFields don't intersect.

Overrides:

writeUpdateOriginalFromTempTableSql in class DatabasePlatform

Parameters:

writer - for writing the sql

table - is original table for which temp table is created.

pkFields - - primary key fields for the original table.

assignedFields - - fields to be assigned a new value.

Throws:

IOException

printFieldIdentityClause

public void printFieldIdentityClause(Writer writer)
                              throws ValidationException

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

Overrides:

printFieldIdentityClause in class DB2Platform

Throws:

ValidationException

buildFieldTypes

protected Hashtable buildFieldTypes()

Description copied from class: DatabasePlatform

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

Overrides:

buildFieldTypes in class DB2Platform

setNullFromDatabaseField

protected void setNullFromDatabaseField(DatabaseField databaseField,
                                        PreparedStatement statement,
                                        int index)
                                 throws SQLException

Overrides:

setNullFromDatabaseField in class DatabasePlatform

Throws:

SQLException

initializePlatformOperators

protected void initializePlatformOperators()

Initialize any platform-specific operators

Overrides:

initializePlatformOperators in class DB2Platform

extractOperator

public static ExpressionOperator extractOperator()

INTERNAL: Derby does not support EXTRACT, but does have YEAR, MONTH, DAY, etc.

computeMaxRowsForSQL

public int computeMaxRowsForSQL(int firstResultIndex,
                                int maxResults)

INTERNAL: Use the JDBC maxResults and firstResultIndex setting to compute a value to use when limiting the results of a query in SQL. These limits tend to be used in two ways. 1. MaxRows is the index of the last row to be returned (like JDBC maxResults) 2. MaxRows is the number of rows to be returned Derby uses case #2 and therefore the maxResults has to be altered based on the firstResultIndex.

Overrides:

computeMaxRowsForSQL in class DatabasePlatform

See Also:

MySQLPlatform

printSQLSelectStatement

public void printSQLSelectStatement(DatabaseCall call,
                                    ExpressionSQLPrinter printer,
                                    SQLSelectStatement statement)

INTERNAL: Print the SQL representation of the statement on a stream, storing the fields in the DatabaseCall. Derby supports pagination through its "OFFSET n ROWS FETCH NEXT m ROWS" syntax.

Overrides:

printSQLSelectStatement in class DB2Platform

supportsSequenceObjects

public boolean supportsSequenceObjects()

INTERNAL: Derby supports sequence objects as of 10.6.1.

Overrides:

supportsSequenceObjects in class DB2Platform

isAlterSequenceObjectSupported

public boolean isAlterSequenceObjectSupported()

Description copied from class: DB2Platform

INTERNAL: DB2 added SEQUENCE support as of (I believe) v8.

Overrides:

isAlterSequenceObjectSupported in class DB2Platform

buildSequenceObjectDeletionWriter

public Writer buildSequenceObjectDeletionWriter(Writer writer,
                                                String fullSeqName)
                                         throws IOException

INTERNAL: Derby supports sequence objects as of 10.6.1.

Overrides:

buildSequenceObjectDeletionWriter in class DatabasePlatform

Throws:

IOException

initializeConnectionData

public void initializeConnectionData(Connection connection)
                              throws SQLException

INTERNAL:

Overrides:

initializeConnectionData in class DB2Platform

Throws:

SQLException