org.eclipse.persistence.platform.database
Class PostgreSQLPlatform

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.eclipse.persistence.internal.databaseaccess.Platform

public class PostgreSQLPlatform
extends DatabasePlatform

Purpose: Provides Postgres specific behavior.

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.
• LIMIT/OFFSET query syntax for select statements.

See Also:

Serialized Form

Since:

OracleAS TopLink 10g (10.1.3)

Field Summary

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

classTypes, cursorCode, DEFAULT_MAX_BATCH_WRITING_SIZE, DEFAULT_PARAMETERIZED_MAX_BATCH_WRITING_SIZE, fieldTypes, maxBatchWritingSize, pingSQL, shouldBindAllParameters, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldOptimizeDataConversion, shouldTrimStrings, statementCacheSize, stringBindingSize, structConverters, supportsAutoCommit, transactionIsolation, typeConverters, Types_NCLOB, useRownumFiltering, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeBatchWriting, usesNativeSQL, usesStreamsForBinding, usesStringBinding

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

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

Constructor Summary

PostgreSQLPlatform()

Method Summary

protected void	appendBoolean(java.lang.Boolean bool, java.io.Writer writer) Appends a Boolean value.
protected java.util.Hashtable	buildFieldTypes()
ValueReadQuery	buildSelectQueryForIdentity() INTERNAL: Returns query used to read back the value generated by Identity.
ValueReadQuery	buildSelectQueryForSequenceObject(java.lang.String seqName, java.lang.Integer size) INTERNAL: Returns query used to read value generated by sequence object (like Oracle sequence).
java.io.Writer	buildSequenceObjectAlterIncrementWriter(java.io.Writer writer, java.lang.String fullSeqName, int increment) INTERNAL: Override this method if the platform supports sequence objects and isAlterSequenceObjectSupported returns true.
java.io.Writer	buildSequenceObjectCreationWriter(java.io.Writer writer, java.lang.String fullSeqName, int increment, int start) INTERNAL: Override this method if the platform supports sequence objects.
java.io.Writer	buildSequenceObjectDeletionWriter(java.io.Writer writer, java.lang.String fullSeqName) INTERNAL: Override this method if the platform supports sequence objects.
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.
java.lang.String	getAssignmentString() INTERNAL Used for stored function calls.
protected java.lang.String	getCreateTempTableSqlBodyForTable(org.eclipse.persistence.internal.helper.DatabaseTable table) INTERNAL:
protected java.lang.String	getCreateTempTableSqlPrefix() INTERNAL:
protected java.lang.String	getCreateTempTableSqlSuffix() INTERNAL:
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.lang.String	getProcedureBeginString() INTERNAL: Used for sp calls.
java.lang.String	getProcedureCallHeader() INTERNAL: Used for sp calls.
java.lang.String	getProcedureEndString() INTERNAL: Used for sp calls.
ValueReadQuery	getTimestampQuery() INTERNAL: This method returns the query to select the timestamp from the server for Derby.
protected void	initializePlatformOperators() INTERNAL: Initialize any platform-specific operators
boolean	isAlterSequenceObjectSupported() INTERNAL: Override this method if the platform supports sequence objects and it's possible to alter sequence object's increment in the database.
boolean	isPostgreSQL() INTERNAL: Answers whether platform is Derby
protected ExpressionOperator	operatorLocate() INTERNAL: Override the default locate operator
void	printFieldIdentityClause(java.io.Writer writer) INTERNAL: Append the receiver's field 'identity' constraint clause to a writer
void	printFieldTypeSize(java.io.Writer writer, FieldDefinition field, org.eclipse.persistence.internal.databaseaccess.FieldTypeDefinition fieldType, boolean shouldPrintFieldIdentityClause)
void	printFieldUnique(java.io.Writer writer, boolean shouldPrintFieldIdentityClause)
void	printSQLSelectStatement(org.eclipse.persistence.internal.databaseaccess.DatabaseCall call, org.eclipse.persistence.internal.expressions.ExpressionSQLPrinter printer, org.eclipse.persistence.internal.expressions.SQLSelectStatement statement)
boolean	shouldPrintAliasForUpdate() INTERNAL: Indicates whether locking OF clause should print alias for field.
boolean	shouldPrintOutputTokenAtStart() 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.
boolean	supportsGlobalTempTables() INTERNAL:
boolean	supportsIdentity() INTERNAL: Indicates whether the platform supports identity.
boolean	supportsSequenceObjects() INTERNAL: Indicates whether the platform supports sequence objects.
protected ExpressionOperator	toNumberOperator() INTERNAL: Postgres to_number has two arguments, as fix format argument.

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

addBatch, addStructConverter, allowsSizeInProcedureArguments, appendByteArray, appendCalendar, appendDate, appendLiteralToCall, appendLiteralToCallWithBinding, appendNumber, appendParameter, appendParameterInternal, appendString, appendTime, appendTimestamp, autoCommit, beginTransaction, buildCallWithReturning, buildClassTypes, buildProcedureCallString, buildSelectQueryForIdentity, buildSelectQueryForSequenceObject, canBatchWriteWithOptimisticLocking, canBuildCallWithReturning, commitTransaction, convertToDatabaseType, copyInto, createArray, createArray, createPlatformDefaultSequence, createStruct, createStruct, dontBindUpdateAllQueryUsingTempTables, executeBatch, executeStoredProcedure, getBatchBeginString, getBatchDelimiterString, getBatchEndString, getClassTypes, getConnection, getConstraintDeletionString, getCreateViewString, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getCursorCode, getCustomModifyValueForCall, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getIdentifierQuoteCharacter, getInputProcedureToken, getJDBCOuterJoinString, getJDBCType, getJDBCType, getJdbcTypeName, getMaxBatchWritingSize, getMaxForeignKeyNameSize, getMaxUniqueKeyNameSize, getNoWaitString, getObjectFromResultSet, getOutputProcedureToken, getPingSQL, getProcedureArgumentSetter, getProcedureArgumentString, getProcedureAsString, getProcedureCallTail, getQualifiedName, getQualifiedSequenceTableName, getRefValue, getRefValue, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSelectForUpdateString, getSelectForUpdateWaitString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStoredProcedureParameterPrefix, getStoredProcedureTerminationToken, getStringBindingSize, getStructConverters, getTempTableForTable, getTransactionIsolation, getTypeConverters, isInformixOuterJoin, isLockTimeoutException, isNullAllowedInSelectClause, isXDBDocument, maximumNumericValues, minimumNumericValues, prepareBatchStatement, printFieldNotNullClause, printFieldNullClause, printFieldTypeSize, printFieldUnique, printValuelist, printValuelist, processResultSet, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureBrackets, requiresProcedureCallBrackets, requiresProcedureCallOuputToken, requiresTypeNameToRegisterOutputParameter, rollbackTransaction, setClassTypes, setCursorCode, setFieldTypes, setMaxBatchWritingSize, setParameterValueInDatabaseCall, setPingSQL, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldCacheAllStatements, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setShouldUseRownumFiltering, setStatementCacheSize, setStringBindingSize, setSupportsAutoCommit, setTransactionIsolation, setUsesBatchWriting, setUsesByteArrayBinding, setUsesJDBCBatchWriting, setUsesNativeBatchWriting, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, shouldAlwaysUseTempStorageForModifyAll, shouldBindAllParameters, shouldBindLiterals, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldNativeSequenceUseTransaction, shouldOptimizeDataConversion, shouldPrintConstraintNameAfter, shouldPrintFieldIdentityClause, shouldPrintInOutputTokenBeforeType, shouldPrintInputTokenAtStart, shouldPrintLockingClauseAfterWhereClause, shouldPrintOuterJoinInWhereClause, shouldPrintOutputTokenBeforeType, shouldPrintStoredProcedureArgumentNameInCall, shouldPrintStoredProcedureVariablesAfterBeginString, shouldTempTableSpecifyPrimaryKeys, shouldTrimStrings, shouldUseCustomModifyForCall, shouldUseRownumFiltering, supportsAutoCommit, supportsForeignKeyConstraints, supportsLocalTempTables, supportsNativeSequenceNumbers, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsTempTables, supportsUniqueKeyConstraints, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeBatchWriting, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, wasFailureCommunicationBased, writeAutoAssignmentSetClause, writeAutoJoinWhereClause, writeCleanUpTempTableSql, writeCreateTempTableSql, writeDeleteFromTargetTableUsingTempTableSql, writeFields, writeFieldsAutoClause, writeFieldsList, writeInsertIntoTableSql, writeJoinWhereClause, writeLOB, writeParameterMarker, writeUpdateOriginalFromTempTableSql

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

addOperator, addSequence, clone, convertObject, createConnectionCustomizer, createSequences, getConversionManager, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultSequence, getDefaultSequenceToWrite, getOperator, getPlatformOperators, getSelectSequenceQuery, getSequence, getSequences, getSequencesToWrite, getTableQualifier, getTimestampFromServer, getUpdateSequenceQuery, hasDefaultSequence, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isDerby, isHSQL, isInformix, isMySQL, isODBC, isOracle, isOracle9, isPointBase, isSQLAnywhere, isSQLServer, isSybase, isTimesTen, isTimesTen7, removeAllSequences, removeSequence, sequencesAfterCloneCleanup, setConversionManager, setDefaultSequence, setSelectSequenceNumberQuery, setSequencePreallocationSize, setSequences, setTableQualifier, setTimestampQuery, setUpdateSequenceQuery, toString, usesPlatformDefaultSequence

Methods inherited from class java.lang.Object

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

Constructor Detail

PostgreSQLPlatform

public PostgreSQLPlatform()

Method Detail

appendBoolean

protected void appendBoolean(java.lang.Boolean bool,
                             java.io.Writer writer)
                      throws java.io.IOException

Appends a Boolean value. Refer to : http://www.postgresql.org/docs/8.0/static/datatype-boolean.html In PostgreSQL the following are the values that are value for a boolean field Valid literal values for the "true" state are: TRUE, 't', 'true', 'y', 'yes', '1' Valid literal values for the false" state are : FALSE, 'f', 'false', 'n', 'no', '0' To be consistent with the other data platforms we are using the values '1' and '0' for true and false states of a boolean field.

Overrides:

appendBoolean in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

Throws:

java.io.IOException

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 PostGreSQL uses case #2 and therefore the maxResults has to be altered based on the firstResultIndex

Overrides:

computeMaxRowsForSQL in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

Parameters:

readQuery -

firstResultIndex -

maxResults -

See Also:

MySQLPlatform

initializePlatformOperators

protected void initializePlatformOperators()

INTERNAL: Initialize any platform-specific operators

Overrides:

initializePlatformOperators in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

toNumberOperator

protected ExpressionOperator toNumberOperator()

INTERNAL: Postgres to_number has two arguments, as fix format argument.

getTimestampQuery

public ValueReadQuery getTimestampQuery()

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

Specified by:

getTimestampQuery in interface org.eclipse.persistence.internal.databaseaccess.Platform

Overrides:

getTimestampQuery in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

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 org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

shouldPrintOutputTokenAtStart

public boolean shouldPrintOutputTokenAtStart()

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

Overrides:

shouldPrintOutputTokenAtStart in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

isPostgreSQL

public boolean isPostgreSQL()

INTERNAL: Answers whether platform is Derby

Specified by:

isPostgreSQL in interface org.eclipse.persistence.internal.databaseaccess.Platform

Overrides:

isPostgreSQL in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

getCreateTempTableSqlSuffix

protected java.lang.String getCreateTempTableSqlSuffix()

INTERNAL:

Overrides:

getCreateTempTableSqlSuffix in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

shouldPrintAliasForUpdate

public boolean shouldPrintAliasForUpdate()

INTERNAL: Indicates whether locking OF clause should print alias for field. Example: on Oracle platform (method returns false): SELECT ADDRESS_ID, ... FROM ADDRESS T1 WHERE (T1.ADDRESS_ID = ?) FOR UPDATE OF T1.ADDRESS_ID on Postgres platform (method returns true): SELECT ADDRESS_ID, ... FROM ADDRESS T1 WHERE (T1.ADDRESS_ID = ?) FOR UPDATE OF T1

Overrides:

shouldPrintAliasForUpdate in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

supportsIdentity

public boolean supportsIdentity()

INTERNAL: Indicates whether the platform supports identity. This method is to be used *ONLY* by sequencing classes

Overrides:

supportsIdentity in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

buildSelectQueryForIdentity

public ValueReadQuery buildSelectQueryForIdentity()

INTERNAL: Returns query used to read back the value generated by Identity. This method is called when identity NativeSequence is connected, the returned query used until the sequence is disconnected. If the platform supportsIdentity then (at least) one of buildSelectQueryForIdentity methods should return non-null query.

Overrides:

buildSelectQueryForIdentity in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

supportsSequenceObjects

public boolean supportsSequenceObjects()

INTERNAL: Indicates whether the platform supports sequence objects. This method is to be used *ONLY* by sequencing classes

Overrides:

supportsSequenceObjects in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

buildSelectQueryForSequenceObject

public ValueReadQuery buildSelectQueryForSequenceObject(java.lang.String seqName,
                                                        java.lang.Integer size)

INTERNAL: Returns query used to read value generated by sequence object (like Oracle sequence). This method is called when sequence object NativeSequence is connected, the returned query used until the sequence is disconnected. If the platform supportsSequenceObjects then (at least) one of buildSelectQueryForSequenceObject methods should return non-null query.

Overrides:

buildSelectQueryForSequenceObject in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

getCreateTempTableSqlBodyForTable

protected java.lang.String getCreateTempTableSqlBodyForTable(org.eclipse.persistence.internal.helper.DatabaseTable table)

INTERNAL:

Overrides:

getCreateTempTableSqlBodyForTable in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

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 org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

Throws:

ValidationException

buildFieldTypes

protected java.util.Hashtable buildFieldTypes()

Overrides:

buildFieldTypes in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

operatorLocate

protected ExpressionOperator operatorLocate()

INTERNAL: Override the default locate operator

supportsGlobalTempTables

public boolean supportsGlobalTempTables()

INTERNAL:

Overrides:

supportsGlobalTempTables in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

getCreateTempTableSqlPrefix

protected java.lang.String getCreateTempTableSqlPrefix()

INTERNAL:

Overrides:

getCreateTempTableSqlPrefix in class org.eclipse.persistence.internal.databaseaccess.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 org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

getProcedureBeginString

public java.lang.String getProcedureBeginString()

INTERNAL: Used for sp calls.

Overrides:

getProcedureBeginString in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

getProcedureEndString

public java.lang.String getProcedureEndString()

INTERNAL: Used for sp calls.

Overrides:

getProcedureEndString in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

getProcedureCallHeader

public java.lang.String getProcedureCallHeader()

INTERNAL: Used for sp calls.

Overrides:

getProcedureCallHeader in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

getAssignmentString

public java.lang.String getAssignmentString()

INTERNAL Used for stored function calls.

Overrides:

getAssignmentString in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

printFieldTypeSize

public void printFieldTypeSize(java.io.Writer writer,
                               FieldDefinition field,
                               org.eclipse.persistence.internal.databaseaccess.FieldTypeDefinition fieldType,
                               boolean shouldPrintFieldIdentityClause)
                        throws java.io.IOException

Overrides:

printFieldTypeSize in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

Throws:

java.io.IOException

printFieldUnique

public void printFieldUnique(java.io.Writer writer,
                             boolean shouldPrintFieldIdentityClause)
                      throws java.io.IOException

Overrides:

printFieldUnique in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

Throws:

java.io.IOException

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 org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

buildSequenceObjectCreationWriter

public java.io.Writer buildSequenceObjectCreationWriter(java.io.Writer writer,
                                                        java.lang.String fullSeqName,
                                                        int increment,
                                                        int start)
                                                 throws java.io.IOException

INTERNAL: Override this method if the platform supports sequence objects. Returns sql used to create sequence object in the database.

Overrides:

buildSequenceObjectCreationWriter in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

Throws:

java.io.IOException

buildSequenceObjectDeletionWriter

public java.io.Writer buildSequenceObjectDeletionWriter(java.io.Writer writer,
                                                        java.lang.String fullSeqName)
                                                 throws java.io.IOException

INTERNAL: Override this method if the platform supports sequence objects. Returns sql used to delete sequence object from the database.

Overrides:

buildSequenceObjectDeletionWriter in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

Throws:

java.io.IOException

buildSequenceObjectAlterIncrementWriter

public java.io.Writer buildSequenceObjectAlterIncrementWriter(java.io.Writer writer,
                                                              java.lang.String fullSeqName,
                                                              int increment)
                                                       throws java.io.IOException

INTERNAL: Override this method if the platform supports sequence objects and isAlterSequenceObjectSupported returns true. Returns sql used to alter sequence object's increment in the database.

Overrides:

buildSequenceObjectAlterIncrementWriter in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

Throws:

java.io.IOException

isAlterSequenceObjectSupported

public boolean isAlterSequenceObjectSupported()

INTERNAL: Override this method if the platform supports sequence objects and it's possible to alter sequence object's increment in the database.

Overrides:

isAlterSequenceObjectSupported in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

printSQLSelectStatement

public void printSQLSelectStatement(org.eclipse.persistence.internal.databaseaccess.DatabaseCall call,
                                    org.eclipse.persistence.internal.expressions.ExpressionSQLPrinter printer,
                                    org.eclipse.persistence.internal.expressions.SQLSelectStatement statement)

Overrides:

printSQLSelectStatement in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform