oracle.toplink.essentials.platform.database

Class PostgreSQLPlatform

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

All Implemented Interfaces:

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

public class PostgreSQLPlatform
extends DatabasePlatform

Purpose: Provides Postgres 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
PostgreSQLPlatform()

Method Summary

Modifier and Type	Method and Description
protected void	appendBoolean(java.lang.Boolean bool, java.io.Writer writer) Appends a Boolean value.
protected java.util.Hashtable	buildFieldTypes() Return the mapping of class types to database types for the schema framework.
ValueReadQuery	buildSelectQueryForNativeSequence(java.lang.String seqName, java.lang.Integer size) INTERNAL: Build the identity query for native sequencing.
java.lang.String	getAssignmentString() INTERNAL Used for stored function calls.
protected java.lang.String	getCreateTempTableSqlBodyForTable(DatabaseTable table) INTERNAL:
protected java.lang.String	getCreateTempTableSqlPrefix() INTERNAL:
protected java.lang.String	getCreateTempTableSqlSuffix() INTERNAL:
protected java.lang.String	getDBSequenceName(java.lang.String tableName, java.lang.String pkFieldName)
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	isPostgreSQL() INTERNAL: Answers whether platform is Derby
protected ExpressionOperator	operatorLocate() INTERNAL: Override the default locate operator
void	platformSpecificSequencingInitialization(DatabaseSession session) INTERNAL: Platform specific sequencing initialization.
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, AbstractSession session, java.lang.String qualifiedFieldName)
void	printFieldUnique(java.io.Writer writer, boolean isUnique, AbstractSession session, java.lang.String qualifiedFieldName)
protected void	setPrimitiveParameterValue(java.sql.PreparedStatement statement, int index, java.lang.Object parameter) Set a primitive parameter.
boolean	shouldNativeSequenceAcquireValueAfterInsert() INTERNAL: Indicates whether NativeSequence should retrieve sequence value after the object has been inserted into the db This method is to be used *ONLY* by sequencing classes
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	supportsNativeSequenceNumbers()

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

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

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, isMySQL, isODBC, isOracle, isPointBase, isSQLAnywhere, isSQLServer, isSybase, isTimesTen, 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

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 DatabasePlatform

Throws:

java.io.IOException

initializePlatformOperators

protected void initializePlatformOperators()

INTERNAL: Initialize any platform-specific operators

Overrides:

initializePlatformOperators in class DatasourcePlatform

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

isPostgreSQL

public boolean isPostgreSQL()

INTERNAL: Answers whether platform is Derby

Specified by:

isPostgreSQL in interface Platform

Overrides:

isPostgreSQL in class DatasourcePlatform

getCreateTempTableSqlSuffix

protected java.lang.String getCreateTempTableSqlSuffix()

INTERNAL:

Overrides:

getCreateTempTableSqlSuffix in class DatabasePlatform

supportsNativeSequenceNumbers

public boolean supportsNativeSequenceNumbers()

Overrides:

supportsNativeSequenceNumbers in class DatabasePlatform

shouldNativeSequenceAcquireValueAfterInsert

public boolean shouldNativeSequenceAcquireValueAfterInsert()

INTERNAL: Indicates whether NativeSequence should retrieve sequence value after the object has been inserted into the db This method is to be used *ONLY* by sequencing classes

Overrides:

shouldNativeSequenceAcquireValueAfterInsert in class DatabasePlatform

buildSelectQueryForNativeSequence

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

INTERNAL: Build the identity query for native sequencing.

Overrides:

buildSelectQueryForNativeSequence in class DatabasePlatform

getCreateTempTableSqlBodyForTable

protected java.lang.String getCreateTempTableSqlBodyForTable(DatabaseTable table)

INTERNAL:

Overrides:

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

Throws:

ValidationException

buildFieldTypes

protected java.util.Hashtable buildFieldTypes()

Description copied from class: DatabasePlatform

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

Overrides:

buildFieldTypes in class DatabasePlatform

operatorLocate

protected ExpressionOperator operatorLocate()

INTERNAL: Override the default locate operator

supportsGlobalTempTables

public boolean supportsGlobalTempTables()

INTERNAL:

Overrides:

supportsGlobalTempTables in class DatabasePlatform

getCreateTempTableSqlPrefix

protected java.lang.String getCreateTempTableSqlPrefix()

INTERNAL:

Overrides:

getCreateTempTableSqlPrefix 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

getProcedureCallHeader

public java.lang.String getProcedureCallHeader()

INTERNAL: Used for sp calls.

Overrides:

getProcedureCallHeader in class DatabasePlatform

getAssignmentString

public java.lang.String getAssignmentString()

INTERNAL Used for stored function calls.

Overrides:

getAssignmentString in class DatabasePlatform

printFieldTypeSize

public void printFieldTypeSize(java.io.Writer writer,
                               FieldDefinition field,
                               FieldTypeDefinition fieldType,
                               AbstractSession session,
                               java.lang.String qualifiedFieldName)
                        throws java.io.IOException

Overrides:

printFieldTypeSize in class DatabasePlatform

Throws:

java.io.IOException

printFieldUnique

public void printFieldUnique(java.io.Writer writer,
                             boolean isUnique,
                             AbstractSession session,
                             java.lang.String qualifiedFieldName)
                      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

setPrimitiveParameterValue

protected void setPrimitiveParameterValue(java.sql.PreparedStatement statement,
                                          int index,
                                          java.lang.Object parameter)
                                   throws java.sql.SQLException

Set a primitive parameter. Postgres jdbc client driver give problem when doing a setObject() for wrapper types. Ideally this code should be in the DatabasePlatform so that all platforms can use this.

Overrides:

setPrimitiveParameterValue in class DatabasePlatform

Throws:

java.sql.SQLException

getDBSequenceName

protected java.lang.String getDBSequenceName(java.lang.String tableName,
                                             java.lang.String pkFieldName)

platformSpecificSequencingInitialization

public void platformSpecificSequencingInitialization(DatabaseSession session)

INTERNAL: Platform specific sequencing initialization. This internal method should only be called by SequencingManager. For PostgreSQL database for id fields that are defined as "SERIAL" the database creates an implicit sequence. The name of the sequence provided by the database is of the form __seq. As part of the insert statement we need to get the correct sequence to be able to get the next value. This code ensures that we have our internal structures pointing to the correct sequence name for the runtime code to work correctly. The current version of postgresql allows only 1 SERIAL field to be defined per table.

Specified by:

platformSpecificSequencingInitialization in interface Platform

Overrides:

platformSpecificSequencingInitialization in class DatasourcePlatform