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, CorePlatform<ConversionManager>, 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.

Since:

OracleAS TopLink 10g (10.1.3)

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

Method Summary

Modifier and Type	Method and Description
DatabaseCall	buildCallWithReturning(SQLCall sqlCall, java.util.Vector returnFields) INTERNAL: Uses the returning clause on Postgres.
java.lang.String	buildProcedureCallString(StoredProcedureCall call, AbstractSession session, AbstractRecord row) INTERNAL: Used for sp calls.
ValueReadQuery	buildSelectQueryForIdentity() INTERNAL: Returns query used to read back the value generated by Identity.
ValueReadQuery	buildSelectQueryForSequenceObject(java.lang.String qualifiedSeqName, java.lang.Integer size) INTERNAL: Returns query used to read value generated by sequence object (like Oracle sequence).
boolean	canBuildCallWithReturning() INTERNAL: Postgres has a returning clause.
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.
java.lang.String	getDropCascadeString() Allows DROP TABLE to cascade dropping of any dependent constraints if the database supports this option.
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) Return the JDBC type for the Java type.
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	getProcedureEndString() INTERNAL: Used for sp calls.
ValueReadQuery	getTimestampQuery() INTERNAL: This method returns the query to select the timestamp from the server for Postgres.
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	isJDBCExecuteCompliant() Calling a stored procedure query on PostgreSQL with no output parameters always returns true from an execute call regardless if a result set is returned or not.
boolean	isPostgreSQL() INTERNAL: Answers whether platform is Postgres.
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, FieldTypeDefinition fieldType, boolean shouldPrintFieldIdentityClause)
void	printFieldUnique(java.io.Writer writer, boolean shouldPrintFieldIdentityClause)
void	printSQLSelectStatement(DatabaseCall call, ExpressionSQLPrinter printer, SQLSelectStatement statement) Print the pagination SQL using Postgres syntax " LIMIT <max> OFFSET <first>".
static ExpressionOperator	regexpOperator() INTERNAL: Create the ~ operator.
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	supportsIdentity() INTERNAL: Indicates whether the platform supports identity.
boolean	supportsLocalTempTables() INTERNAL:
boolean	supportsSequenceObjects() INTERNAL: Indicates whether the platform supports sequence objects.
void	writeUpdateOriginalFromTempTableSql(java.io.Writer writer, DatabaseTable table, java.util.Collection pkFields, java.util.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.internal.databaseaccess.DatabasePlatform

addBatch, addStructConverter, allowsSizeInProcedureArguments, appendLiteralToCall, appendParameter, appendParameterInternal, autoCommit, beginTransaction, buildBatchCriteria, buildBatchCriteriaForComplexId, buildCreateIndex, buildCreateIndex, buildDropIndex, buildDropIndex, buildSequenceObjectAlterIncrementWriter, buildSequenceObjectCreationWriter, buildSequenceObjectDeletionWriter, canBatchWriteWithOptimisticLocking, commitTransaction, convertToDatabaseType, copyInto, createArray, createArray, createStruct, createStruct, dontBindUpdateAllQueryUsingTempTables, executeBatch, executeStoredProcedure, freeTemporaryObject, getBatchBeginString, getBatchDelimiterString, getBatchEndString, getBatchRowCountAssignString, getBatchRowCountDeclareString, getBatchRowCountReturnString, getBatchWritingMechanism, getCastSizeForVarcharParameter, getClassTypes, getConnection, getConnectionUserName, getConstraintDeletionString, getCreateDatabaseSchemaString, getCreateViewString, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getCursorCode, getCustomModifyValueForCall, getDefaultSequenceTableName, getDriverSupportsNVarChar, getDropDatabaseSchemaString, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getIdentifierQuoteCharacter, getIndexNamePrefix, getInputProcedureToken, getJDBCOuterJoinString, getJDBCType, getJDBCTypeForSetNull, getJdbcTypeName, getMaxBatchWritingSize, getMaxForeignKeyNameSize, getMaxIndexNameSize, getMaxUniqueKeyNameSize, getNoWaitString, getObjectFromResultSet, getOutputProcedureToken, getPartitioningCallback, getPingSQL, getProcedureArgumentSetter, getProcedureArgumentString, getProcedureAsString, getProcedureCallHeader, getProcedureCallTail, getQualifiedName, getQualifiedSequenceTableName, getRefValue, getRefValue, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSelectForUpdateString, getSelectForUpdateWaitString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStoredProcedureParameterPrefix, getStoredProcedureTerminationToken, getStringBindingSize, getStructConverters, getTableCreationSuffix, getTempTableForTable, getTransactionIsolation, getTypeConverters, getUniqueConstraintDeletionString, getUseNationalCharacterVaryingTypeForString, getVPDClearIdentifierQuery, getVPDCreationFunctionString, getVPDCreationPolicyString, getVPDDeletionString, getVPDSetIdentifierQuery, hasPartitioningCallback, initialize, initializeConnectionData, isCastRequired, isDynamicSQLRequiredForFunctions, isForUpdateCompatibleWithDistinct, isInformixOuterJoin, isLobCompatibleWithDistinct, isLockTimeoutException, isNullAllowedInSelectClause, isOutputAllowWithResultSet, isRowCountOutputParameterRequired, isXDBDocument, maximumNumericValues, minimumNumericValues, minimumTimeIncrement, prepareBatchStatement, printFieldNotNullClause, printFieldNullClause, printStoredFunctionReturnKeyWord, printValuelist, printValuelist, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureBrackets, requiresProcedureCallBrackets, requiresProcedureCallOuputToken, requiresTableInIndexDropDDL, requiresTypeNameToRegisterOutputParameter, 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, shouldPrintConstraintNameAfter, shouldPrintFieldIdentityClause, shouldPrintForUpdateClause, shouldPrintInnerJoinInWhereClause, shouldPrintInOutputTokenBeforeType, shouldPrintInputTokenAtStart, shouldPrintLockingClauseAfterWhereClause, shouldPrintOuterJoinInWhereClause, shouldPrintOutputTokenBeforeType, shouldPrintStoredProcedureArgumentNameInCall, shouldPrintStoredProcedureVariablesAfterBeginString, shouldTrimStrings, shouldUseCustomModifyForCall, shouldUseGetSetNString, shouldUseRownumFiltering, supportsANSIInnerJoinSyntax, supportsAutoCommit, supportsAutoConversionToNumericForArithmeticOperations, supportsConnectionUserName, supportsCountDistinctWithMultipleFields, supportsDeleteOnCascade, supportsForeignKeyConstraints, supportsGlobalTempTables, supportsIndexes, supportsIndividualTableLocking, 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, 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, isSQLAnywhere, isSQLServer, isSybase, isSymfoware, isTimesTen, isTimesTen7, removeAllSequences, removeSequence, setConversionManager, setDefaultNativeSequenceToTable, setDefaultSequence, setEndDelimiter, setSelectSequenceNumberQuery, setSequencePreallocationSize, setSequences, setStartDelimiter, setTableQualifier, setTimestampQuery, setUpdateSequenceQuery, shouldNativeSequenceUseTransaction, shouldPrepare, shouldSelectDistinctIncludeOrderBy, shouldSelectIncludeOrderBy, supportsNativeSequenceNumbers, toString, usesPlatformDefaultSequence

Methods inherited from class java.lang.Object

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

Constructor Detail

PostgreSQLPlatform

public PostgreSQLPlatform()

Method Detail

getJDBCType

public int getJDBCType(java.lang.Class javaType)

Return the JDBC type for the Java type. For some reason PostgreSQL does not seem to like the JDBC Blob type (PostgreSQL 8.2).

Overrides:

getJDBCType in class DatabasePlatform

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 DatabasePlatform

Parameters:

firstResultIndex -

maxResults -

See Also:

MySQLPlatform

regexpOperator

public static ExpressionOperator regexpOperator()

INTERNAL: Create the ~ operator. REGEXP allows for comparison through regular expression.

getTimestampQuery

public ValueReadQuery getTimestampQuery()

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

Specified by:

getTimestampQuery in interface Platform

Overrides:

getTimestampQuery in class 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 DatabasePlatform

shouldPrintOutputTokenAtStart

public boolean shouldPrintOutputTokenAtStart()

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

Overrides:

shouldPrintOutputTokenAtStart in class DatabasePlatform

isJDBCExecuteCompliant

public boolean isJDBCExecuteCompliant()

Calling a stored procedure query on PostgreSQL with no output parameters always returns true from an execute call regardless if a result set is returned or not. This flag will help avoid throwing a JPA mandated exception on an executeUpdate call (which calls jdbc execute and checks the return value to ensure no results sets are returned (true))

Overrides:

isJDBCExecuteCompliant in class DatabasePlatform

See Also:

PostgreSQLPlatform

isPostgreSQL

public boolean isPostgreSQL()

INTERNAL: Answers whether platform is Postgres.

Specified by:

isPostgreSQL in interface Platform

Overrides:

isPostgreSQL in class DatasourcePlatform

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 DatabasePlatform

supportsIdentity

public boolean supportsIdentity()

INTERNAL: Indicates whether the platform supports identity.

Overrides:

supportsIdentity in class DatasourcePlatform

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 DatasourcePlatform

supportsSequenceObjects

public boolean supportsSequenceObjects()

INTERNAL: Indicates whether the platform supports sequence objects.

Overrides:

supportsSequenceObjects in class DatasourcePlatform

buildSelectQueryForSequenceObject

public ValueReadQuery buildSelectQueryForSequenceObject(java.lang.String qualifiedSeqName,
                                                        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 DatasourcePlatform

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

supportsLocalTempTables

public boolean supportsLocalTempTables()

INTERNAL:

Overrides:

supportsLocalTempTables 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

getProcedureBeginString

public java.lang.String getProcedureBeginString()

INTERNAL: Used for sp calls.

Overrides:

getProcedureBeginString in class DatabasePlatform

getProcedureEndString

public java.lang.String getProcedureEndString()

INTERNAL: Used for sp calls.

Overrides:

getProcedureEndString in class DatabasePlatform

buildProcedureCallString

public java.lang.String buildProcedureCallString(StoredProcedureCall call,
                                                 AbstractSession session,
                                                 AbstractRecord row)

INTERNAL: Used for sp calls. PostGreSQL uses a different method for executing StoredProcedures than other platforms.

Overrides:

buildProcedureCallString in class DatabasePlatform

getAssignmentString

public java.lang.String getAssignmentString()

INTERNAL Used for stored function calls.

Overrides:

getAssignmentString in class DatabasePlatform

getDropCascadeString

public java.lang.String getDropCascadeString()

Allows DROP TABLE to cascade dropping of any dependent constraints if the database supports this option.

Overrides:

getDropCascadeString in class DatabasePlatform

printFieldTypeSize

public void printFieldTypeSize(java.io.Writer writer,
                               FieldDefinition field,
                               FieldTypeDefinition fieldType,
                               boolean shouldPrintFieldIdentityClause)
                        throws java.io.IOException

Overrides:

printFieldTypeSize in class DatabasePlatform

Throws:

java.io.IOException

printFieldUnique

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

Overrides:

printFieldUnique in class 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 DatabasePlatform

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 DatabasePlatform

printSQLSelectStatement

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

Print the pagination SQL using Postgres syntax " LIMIT <max> OFFSET <first>".

Overrides:

printSQLSelectStatement 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: 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:

java.io.IOException

canBuildCallWithReturning

public boolean canBuildCallWithReturning()

INTERNAL: Postgres has a returning clause.

Overrides:

canBuildCallWithReturning in class DatabasePlatform

buildCallWithReturning

public DatabaseCall buildCallWithReturning(SQLCall sqlCall,
                                           java.util.Vector returnFields)

INTERNAL: Uses the returning clause on Postgres.

Overrides:

buildCallWithReturning in class DatabasePlatform