Module eclipselink
Package 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:
Serializable, Cloneable, org.eclipse.persistence.internal.core.databaseaccess.CorePlatform<org.eclipse.persistence.internal.helper.ConversionManager>, org.eclipse.persistence.internal.databaseaccess.Platform, DDLPlatform
Direct Known Subclasses:
PostgreSQL10Platform
public class PostgreSQLPlatform extends DatabasePlatform

Purpose: Provides Postgres specific behavior.

Responsibilities:

  • Native SQL for Date, Time, & Timestamp.
  • SQL time types with with fractional seconds precision support.
  • 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:

  • 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

    batchWritingMechanism, castSizeForVarcharParameter, cursorCode, DEFAULT_MAX_BATCH_WRITING_SIZE, DEFAULT_PARAMETERIZED_MAX_BATCH_WRITING_SIZE, driverName, driverSupportsNationalCharacterVarying, IS_VALID_TIMEOUT, isCastRequired, maxBatchWritingSize, partitioningCallback, pingSQL, printInnerJoinInWhereClause, printOuterJoinInWhereClause, shouldBindAllParameters, shouldBindLiterals, shouldBindPartialParameters, shouldCacheAllStatements, shouldForceBindAllParameters, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldOptimizeDataConversion, shouldTrimStrings, statementCacheSize, stringBindingSize, structConverters, supportsAutoCommit, 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, supportsReturnGeneratedKeys, tableQualifier, timestampQuery, uuidQuery

    Fields inherited from interface org.eclipse.persistence.tools.schemaframework.DDLPlatform

    CLASS_TYPES, DB_TYPES, TYPE_BIG_DECIMAL, TYPE_BIG_INTEGER, TYPE_BINARY, TYPE_BLOB, TYPE_BOOLEAN, TYPE_BYTE, TYPE_CHAR, TYPE_CLOB, TYPE_DATE, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INTEGER, TYPE_LONG, TYPE_NUMBER, TYPE_NUMERIC, TYPE_SHORT, TYPE_TIME, TYPE_TIMESTAMP, TYPE_VARCHAR

  • Constructor Summary

    Constructors
    Constructor
    Description
    PostgreSQLPlatform()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    appendBoolean(Boolean bool, Writer writer)
    Appends a Boolean value.
    int
    appendParameterInternal(Call call, Writer writer, Object parameter)
    Returns the number of parameters that used binding.
    org.eclipse.persistence.internal.databaseaccess.DatabaseCall
    buildCallWithReturning(SQLCall sqlCall, List<org.eclipse.persistence.internal.helper.DatabaseField> returnFields)
    INTERNAL: Uses the returning clause on Postgres.
    protected Map<Class<?>,FieldDefinition.DatabaseType>
    buildDatabaseTypes()
    Return the mapping of class types to database types for the schema framework.
    ValueReadQuery
    buildSelectQueryForIdentity()
    INTERNAL: Returns query used to read back the value generated by Identity.
    ValueReadQuery
    buildSelectQueryForSequenceObject(String qualifiedSeqName, 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.
    String
    getAssignmentString()
    INTERNAL Used for stored function calls.
    protected String
    getCreateTempTableSqlPrefix()
    INTERNAL:
    protected String
    getCreateTempTableSqlSuffix()
    INTERNAL:
    String
    getDropCascadeString()
    Allows DROP TABLE to cascade dropping of any dependent constraints if the database supports this option.
    String
    getInOutputProcedureToken()
    This method is used to print the output parameter token when stored procedures are called
    int
    getJDBCType(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.
    String
    getProcedureBeginString()
    Used for stored procedure defs.
    String
    getProcedureCallHeader()
    INTERNAL: Used for sp calls.
    String
    getProcedureEndString()
    Used for stored procedure defs.
    ValueReadQuery
    getTimestampQuery()
    INTERNAL: This method returns the query to select the timestamp from the server for Postgres.
    ValueReadQuery
    getUUIDQuery()
    This method can be overridden by subclasses to return a query that will return the UUID from the server.
    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
    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.
    protected ExpressionOperator
    operatorLocate()
    INTERNAL: Override the default locate operator.
    protected ExpressionOperator
    operatorLocate2()
    INTERNAL: Override the default locate operator.
    void
    printFieldIdentityClause(Writer writer)
    Prints the platform-specific identity clause for a field (e.g., AUTO_INCREMENT).
    void
    printFieldUnique(Writer writer, boolean shouldPrintFieldIdentityClause)
    Prints the platform-specific UNIQUE clause for a field.
    void
    printSQLSelectStatement(org.eclipse.persistence.internal.databaseaccess.DatabaseCall call, org.eclipse.persistence.internal.expressions.ExpressionSQLPrinter printer, org.eclipse.persistence.internal.expressions.SQLSelectStatement statement)
    Print the pagination SQL using Postgres syntax " LIMIT <max> OFFSET <first>".
    static ExpressionOperator
    regexpOperator()
    INTERNAL: Create the ~ operator.
    protected void
    setNullFromDatabaseField(org.eclipse.persistence.internal.helper.DatabaseField databaseField, PreparedStatement statement, int index)
     
    void
    setParameterValueInDatabaseCall(Object parameter, CallableStatement statement, String name, org.eclipse.persistence.internal.sessions.AbstractSession session)
    INTERNAL Set the parameter in the JDBC statement at the given index in case it is a UUID value.
    void
    setParameterValueInDatabaseCall(Object parameter, PreparedStatement statement, int index, org.eclipse.persistence.internal.sessions.AbstractSession session)
    INTERNAL Set the parameter in the JDBC statement at the given index in case it is a UUID value.
    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
    shouldPrintStoredProcedureArgumentNameInCall()
    INTERNAL: Should the variable name of a stored procedure call be printed as part of the procedure call e.g.
    boolean
    shouldUseJDBCOuterJoinSyntax()
    JDBC defines and outer join syntax, many drivers do not support this.
    boolean
    supportsFractionalTime()
    Override this method if the platform supports setting fractional seconds precision in a SQL time or timestamp data type.
    boolean
    supportsIdentity()
    INTERNAL: Indicates whether the platform supports identity.
    boolean
    supportsLocalTempTables()
    INTERNAL:
    boolean
    supportsSequenceObjects()
    INTERNAL: Indicates whether the platform supports sequence objects.
    protected ExpressionOperator
    toNumberOperator()
    INTERNAL: Postgres to_number has two arguments, as fix format argument.
    void
    writeUpdateOriginalFromTempTableSql(Writer writer, org.eclipse.persistence.internal.helper.DatabaseTable table, Collection<org.eclipse.persistence.internal.helper.DatabaseField> pkFields, Collection<org.eclipse.persistence.internal.helper.DatabaseField> 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, allowBindingForSelectClause, appendByteArray, appendCalendar, appendDate, appendLiteralToCall, appendLiteralToCallWithBinding, appendNumber, appendParameter, appendString, appendTime, appendTimestamp, autoCommit, beginTransaction, buildBatchCriteria, buildBatchCriteriaForComplexId, buildCreateIndex, buildDropIndex, buildJavaTypes, buildProcedureCallString, canBatchWriteWithOptimisticLocking, checkSequenceExists, checkTableExists, commitTransaction, convertToDatabaseType, copyInto, createArray, createArray, createPlatformDefaultSequence, createStruct, createStruct, createStruct, dontBindUpdateAllQueryUsingTempTables, executeBatch, executeStoredProcedure, freeTemporaryObject, getBatchRowCountAssignString, getBatchRowCountDeclareString, getBatchRowCountReturnString, getBatchWritingMechanism, getCastSizeForVarcharParameter, getConnection, getConnectionUserName, getCreateTempTableSqlBodyForTable, getCursorCode, getCustomModifyValueForCall, getDatabaseType, getDatabaseTypes, getDefaultSequenceTableName, getDriverSupportsNVarChar, getExecuteBatchRowCounts, getFunctionCallHeader, getJavaTypes, getJDBCOuterJoinString, getJDBCType, getJDBCTypeForSetNull, getJdbcTypeName, getJsonPlatform, getMaxBatchWritingSize, getNoWaitString, getObjectFromResultSet, getParameterValueFromDatabaseCall, getParameterValueFromDatabaseCall, getPartitioningCallback, getPingSQL, getProcedureArgument, getProcedureCallTail, getQualifiedName, getQualifiedSequenceTableName, getRefValue, getRefValue, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSelectForUpdateString, getSelectForUpdateWaitString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequenceTableName, getStatementCacheSize, getStoredProcedureParameterPrefix, getStoredProcedureTerminationToken, getStringBindingSize, getStructConverters, getTableCreationSuffix, getTableExistsQuery, getTempTableForTable, getTransactionIsolation, getTypeConverters, getUseNationalCharacterVaryingTypeForString, getVPDClearIdentifierQuery, getVPDCreationFunctionString, getVPDCreationPolicyString, getVPDDeletionString, getVPDSetIdentifierQuery, hasPartitioningCallback, initialize, initializeConnectionData, isCastRequired, isDynamicSQLRequiredForFunctions, isForUpdateCompatibleWithDistinct, isInformixOuterJoin, isLobCompatibleWithDistinct, isLockTimeoutException, isNullAllowedInSelectClause, isOutputAllowWithResultSet, isRowCountOutputParameterRequired, isXDBDocument, maximumNumericValues, minimumNumericValues, minimumTimeIncrement, prepareBatchStatement, printStoredFunctionReturnKeyWord, printValuelist, printValuelist, registerOutputParameter, registerOutputParameter, registerOutputParameter, registerOutputParameter, requiresProcedureCallBrackets, requiresProcedureCallOuputToken, requiresTypeNameToRegisterOutputParameter, retrieveFirstPrimaryKeyOrOne, rollbackTransaction, setBatchWritingMechanism, setCastSizeForVarcharParameter, setCursorCode, setDatabaseTypes, setDriverName, setDriverSupportsNVarChar, setExecuteBatchRowCounts, setIsCastRequired, setJavaTypes, setMaxBatchWritingSize, setNullFromDatabaseField, setPartitioningCallback, setPingSQL, setPrintInnerJoinInWhereClause, setPrintOuterJoinInWhereClause, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldBindLiterals, setShouldBindPartialParameters, 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, shouldBindPartialParameters, shouldCacheAllStatements, shouldCreateIndicesOnForeignKeys, shouldForceBindAllParameters, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldOptimizeDataConversion, shouldPrintFieldIdentityClause, shouldPrintForUpdateClause, shouldPrintInnerJoinInWhereClause, shouldPrintInOutputTokenBeforeType, shouldPrintLockingClauseAfterWhereClause, shouldPrintOuterJoinInWhereClause, shouldTempTableSpecifyPrimaryKeys, shouldTrimStrings, shouldUseCustomModifyForCall, shouldUseGetSetNString, shouldUseRownumFiltering, supportsANSIInnerJoinSyntax, supportsAutoCommit, supportsAutoConversionToNumericForArithmeticOperations, supportsConnectionUserName, supportsCountDistinctWithMultipleFields, supportsGlobalTempTables, supportsIndividualTableLocking, supportsLockingQueriesWithMultipleTables, supportsNestingOuterJoins, supportsOrderByParameters, supportsOuterJoinsWithBrackets, supportsTempTables, supportsVPD, supportsWaitForUpdate, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeBatchWriting, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, wasFailureCommunicationBased, writeAddColumnClause, writeAutoAssignmentSetClause, writeAutoJoinWhereClause, writeCleanUpTempTableSql, writeCreateTempTableSql, writeDeleteFromTargetTableUsingTempTableSql, writeDropColumnClause, writeFields, writeFieldsAutoClause, writeFieldsList, writeInsertIntoTableSql, writeJoinWhereClause, writeLOB, writeParameterMarker, writeTruncateTable

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

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

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.eclipse.persistence.tools.schemaframework.DDLPlatform

    allowsSizeInProcedureArguments, buildCreateIndex, buildDropIndex, buildSequenceObjectAlterIncrementWriter, buildSequenceObjectCreationWriter, buildSequenceObjectDeletionWriter, getBatchBeginString, getBatchDelimiterString, getBatchEndString, getConstraintDeletionString, getCreateDatabaseSchemaString, getCreateViewString, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getDatabaseType, getDatabaseType, getDropDatabaseSchemaString, getEndDelimiter, getIndexNamePrefix, getInputProcedureToken, getMaxForeignKeyNameSize, getMaxIndexNameSize, getMaxUniqueKeyNameSize, getOutputProcedureToken, getProcedureArgumentString, getProcedureAsString, getProcedureOptionList, getStartDelimiter, getUniqueConstraintDeletionString, printFieldNotNullClause, printFieldNullClause, printFieldTypeSize, printFieldTypeSize, requiresNamedPrimaryKeyConstraints, requiresProcedureBrackets, requiresTableInIndexDropDDL, requiresUniqueConstraintCreationOnTableCreate, shouldCreateIndicesForPrimaryKeys, shouldCreateIndicesOnUniqueKeys, shouldPrintConstraintNameAfter, shouldPrintInputTokenAtStart, shouldPrintOutputTokenBeforeType, shouldPrintStoredProcedureVariablesAfterBeginString, supportsDeleteOnCascade, supportsForeignKeyConstraints, supportsIndexes, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsUniqueColumns, supportsUniqueKeyConstraints, writeTableCreationSuffix

    Methods inherited from interface org.eclipse.persistence.internal.databaseaccess.Platform

    connectionProperties

  • Constructor Details

    • PostgreSQLPlatform

      public PostgreSQLPlatform()

  • Method Details

    • getJDBCType

      public int getJDBCType(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 org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • appendBoolean

      protected void appendBoolean(Boolean bool, Writer writer) throws 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:
      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
      See Also:

    • initializePlatformOperators

      protected void initializePlatformOperators()
      INTERNAL: Initialize any platform-specific operators
      Overrides:
      initializePlatformOperators in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

    • regexpOperator

      public static ExpressionOperator regexpOperator()
      INTERNAL: Create the ~ operator. REGEXP allows for comparison through regular expression.

    • 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 Postgres.
      Specified by:
      getTimestampQuery in interface org.eclipse.persistence.internal.databaseaccess.Platform
      Overrides:
      getTimestampQuery in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

    • shouldPrintStoredProcedureArgumentNameInCall

      public boolean shouldPrintStoredProcedureArgumentNameInCall()
      INTERNAL: Should the variable name of a stored procedure call be printed as part of the procedure call e.g. EXECUTE PROCEDURE MyStoredProc(myvariable = ?) In case of PostgreSQL NO as JDBC driver and DB doesn't support pass parameters by name. It expects, that parameters are passed by index or persistence property <property name="eclipselink.jpa.naming_into_indexed" value="true"/> is used.
      Overrides:
      shouldPrintStoredProcedureArgumentNameInCall in class org.eclipse.persistence.internal.databaseaccess.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)). PostgreSQL also doesn't support parameters passed by name in case of stored procedure calls.
      Overrides:
      isJDBCExecuteCompliant in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
      See Also:

    • isPostgreSQL

      public boolean isPostgreSQL()
      INTERNAL: Answers whether platform is Postgres.
      Specified by:
      isPostgreSQL in interface org.eclipse.persistence.internal.databaseaccess.Platform
      Overrides:
      isPostgreSQL in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

    • getCreateTempTableSqlSuffix

      protected 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.
      Overrides:
      supportsIdentity in class org.eclipse.persistence.internal.databaseaccess.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 org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

    • supportsSequenceObjects

      public boolean supportsSequenceObjects()
      INTERNAL: Indicates whether the platform supports sequence objects.
      Overrides:
      supportsSequenceObjects in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

    • buildSelectQueryForSequenceObject

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

    • operatorLocate

      protected ExpressionOperator operatorLocate()
      INTERNAL: Override the default locate operator.

    • operatorLocate2

      protected ExpressionOperator operatorLocate2()
      INTERNAL: Override the default locate operator.

    • supportsLocalTempTables

      public boolean supportsLocalTempTables()
      INTERNAL:
      Overrides:
      supportsLocalTempTables in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • getCreateTempTableSqlPrefix

      protected String getCreateTempTableSqlPrefix()
      INTERNAL:
      Overrides:
      getCreateTempTableSqlPrefix in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • getProcedureCallHeader

      public String getProcedureCallHeader()
      INTERNAL: Used for sp calls.
      Overrides:
      getProcedureCallHeader in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • getAssignmentString

      public String getAssignmentString()
      INTERNAL Used for stored function calls.
      Overrides:
      getAssignmentString in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • 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

    • 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)
      Print the pagination SQL using Postgres syntax " LIMIT <max> OFFSET <first>".
      Overrides:
      printSQLSelectStatement in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • writeUpdateOriginalFromTempTableSql

      public void writeUpdateOriginalFromTempTableSql(Writer writer, org.eclipse.persistence.internal.helper.DatabaseTable table, Collection<org.eclipse.persistence.internal.helper.DatabaseField> pkFields, Collection<org.eclipse.persistence.internal.helper.DatabaseField> 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 org.eclipse.persistence.internal.databaseaccess.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

    • canBuildCallWithReturning

      public boolean canBuildCallWithReturning()
      INTERNAL: Postgres has a returning clause.
      Overrides:
      canBuildCallWithReturning in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • buildCallWithReturning

      public org.eclipse.persistence.internal.databaseaccess.DatabaseCall buildCallWithReturning(SQLCall sqlCall, List<org.eclipse.persistence.internal.helper.DatabaseField> returnFields)
      INTERNAL: Uses the returning clause on Postgres.
      Overrides:
      buildCallWithReturning in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • setNullFromDatabaseField

      protected void setNullFromDatabaseField(org.eclipse.persistence.internal.helper.DatabaseField databaseField, PreparedStatement statement, int index) throws SQLException
      Overrides:
      setNullFromDatabaseField in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
      Throws:
      SQLException

    • setParameterValueInDatabaseCall

      public void setParameterValueInDatabaseCall(Object parameter, PreparedStatement statement, int index, org.eclipse.persistence.internal.sessions.AbstractSession session) throws SQLException
      INTERNAL Set the parameter in the JDBC statement at the given index in case it is a UUID value.
      Overrides:
      setParameterValueInDatabaseCall in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
      Parameters:
      parameter - the parameter to set
      statement - target PreparedStatement instance
      index - index of the parameter in the statement
      session - current database session
      Throws:
      SQLException

    • setParameterValueInDatabaseCall

      public void setParameterValueInDatabaseCall(Object parameter, CallableStatement statement, String name, org.eclipse.persistence.internal.sessions.AbstractSession session) throws SQLException
      INTERNAL Set the parameter in the JDBC statement at the given index in case it is a UUID value.
      Overrides:
      setParameterValueInDatabaseCall in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
      Parameters:
      parameter - the parameter to set
      statement - target CallableStatement instance
      name - name of the parameter in the statement
      session - current database session
      Throws:
      SQLException

    • getUUIDQuery

      public ValueReadQuery getUUIDQuery()
      Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform
      This method can be overridden by subclasses to return a query that will return the UUID from the server. return null if UUID can't be generated by platform.
      Specified by:
      getUUIDQuery in interface org.eclipse.persistence.internal.databaseaccess.Platform
      Overrides:
      getUUIDQuery in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

    • appendParameterInternal

      public int appendParameterInternal(Call call, Writer writer, Object parameter)
      Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
      Returns the number of parameters that used binding. Should only be called in case binding is not used.
      Overrides:
      appendParameterInternal in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • buildDatabaseTypes

      protected Map<Class<?>,FieldDefinition.DatabaseType> buildDatabaseTypes()
      Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
      Return the mapping of class types to database types for the schema framework.
      Overrides:
      buildDatabaseTypes in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

    • getDropCascadeString

      public String getDropCascadeString()
      Description copied from interface: DDLPlatform
      Allows DROP TABLE to cascade dropping of any dependent constraints if the database supports this option.

    • getInOutputProcedureToken

      public String getInOutputProcedureToken()
      Description copied from interface: DDLPlatform
      This method is used to print the output parameter token when stored procedures are called

    • getMaxFieldNameSize

      public int getMaxFieldNameSize()
      Description copied from interface: DDLPlatform
      INTERNAL: returns the maximum number of characters that can be used in a field name on this platform.

    • getProcedureBeginString

      public String getProcedureBeginString()
      Description copied from interface: DDLPlatform
      Used for stored procedure defs.

    • getProcedureEndString

      public String getProcedureEndString()
      Description copied from interface: DDLPlatform
      Used for stored procedure defs.

    • isAlterSequenceObjectSupported

      public boolean isAlterSequenceObjectSupported()
      Description copied from interface: DDLPlatform
      INTERNAL: Override this method if the platform supports sequence objects and it's possible to alter sequence object's increment in the database.

    • printFieldIdentityClause

      public void printFieldIdentityClause(Writer writer) throws ValidationException
      Description copied from interface: DDLPlatform
      Prints the platform-specific identity clause for a field (e.g., AUTO_INCREMENT).
      Parameters:
      writer - the writer to append to
      Throws:
      ValidationException

    • printFieldUnique

      public void printFieldUnique(Writer writer, boolean shouldPrintFieldIdentityClause) throws IOException
      Description copied from interface: DDLPlatform
      Prints the platform-specific UNIQUE clause for a field.
      Parameters:
      writer - the writer to append to
      shouldPrintFieldIdentityClause - indicates if the identity clause should be printed
      Throws:
      IOException - if an I/O error occurs while writing

    • shouldPrintOutputTokenAtStart

      public boolean shouldPrintOutputTokenAtStart()
      Description copied from interface: DDLPlatform
      This is required in the construction of the stored procedures with output parameters

    • supportsFractionalTime

      public boolean supportsFractionalTime()
      Description copied from interface: DDLPlatform
      Override this method if the platform supports setting fractional seconds precision in a SQL time or timestamp data type.
      Returns:
      value of true when current database platform supports fractional seconds precision or false otherwise