Module eclipselink
Package org.eclipse.persistence.platform.database

Class DB2ZPlatform

  • 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
    public class DB2ZPlatform
extends DB2Platform
    Purpose: Provides DB2 z/OS specific behavior.

    This provides for some additional compatibility in certain DB2 versions.

    Responsibilities:

    • Support creating tables that handle multibyte characters
    See Also:
    Serialized Form

    • Constructor Detail

      • DB2ZPlatform

        public DB2ZPlatform()

    • Method Detail

      • buildFieldTypes

        protected Hashtable<Class<?>,​org.eclipse.persistence.internal.databaseaccess.FieldTypeDefinition> buildFieldTypes()
        Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
        Return the mapping of class types to database types for the schema framework.
        Overrides:
        buildFieldTypes in class DB2Platform

      • getTableCreationSuffix

        public String getTableCreationSuffix()
        Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
        PUBLIC: Get the String used on all table creation statements generated from the DefaultTableGenerator with a session using this project (DDL generation). This value will be appended to CreationSuffix strings stored on the DatabaseTable or TableDefinition.
        Specified by:
        getTableCreationSuffix in interface DDLPlatform
        Overrides:
        getTableCreationSuffix in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

      • getProcedureArgument

        public String getProcedureArgument​(String name,
                                   Object parameter,
                                   org.eclipse.persistence.internal.databaseaccess.DatasourceCall.ParameterType parameterType,
                                   StoredProcedureCall call,
                                   org.eclipse.persistence.internal.sessions.AbstractSession session)
        Description copied from class: DB2Platform
        Obtain the platform specific argument string
        Overrides:
        getProcedureArgument in class DB2Platform

      • getTimestampQuery

        public ValueReadQuery getTimestampQuery()
        INTERNAL: This method returns the query to select the timestamp from the server for DB2.
        Specified by:
        getTimestampQuery in interface org.eclipse.persistence.internal.databaseaccess.Platform
        Overrides:
        getTimestampQuery in class DB2Platform

      • initializePlatformOperators

        protected void initializePlatformOperators()
        INTERNAL: Initialize any platform-specific operators
        Overrides:
        initializePlatformOperators in class DB2Platform

      • avgOperator

        protected ExpressionOperator avgOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • sumOperator

        protected ExpressionOperator sumOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • absOperator

        protected ExpressionOperator absOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • concatOperator

        protected ExpressionOperator concatOperator()
        DB2 z/OS requires that at least one argument be a known type

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610
        Overrides:
        concatOperator in class DB2Platform

      • equalOperator

        protected ExpressionOperator equalOperator()
        DB2 z/OS requires that at least one argument be a known type

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • notEqualOperator

        protected ExpressionOperator notEqualOperator()
        DB2 z/OS requires that at least one argument be a known type

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • greaterThanOperator

        protected ExpressionOperator greaterThanOperator()
        DB2 z/OS requires that at least one argument be a known type

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • greaterThanEqualOperator

        protected ExpressionOperator greaterThanEqualOperator()
        DB2 z/OS requires that at least one argument be a known type

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • lessThanOperator

        protected ExpressionOperator lessThanOperator()
        Set binding support to PARTIAL.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • lessThanEqualOperator

        protected ExpressionOperator lessThanEqualOperator()
        DB2 z/OS requires that at least one argument be a known type

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • isNullOperator

        protected ExpressionOperator isNullOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • isNotNullOperator

        protected ExpressionOperator isNotNullOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • betweenOperator

        protected ExpressionOperator betweenOperator()
        DB2 z/OS requires that at least one argument be a known type

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • notBetweenOperator

        protected ExpressionOperator notBetweenOperator()
        DB2 z/OS requires that at least one argument be a known type

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • likeEscapeOperator

        protected ExpressionOperator likeEscapeOperator()
        DB2 z/OS support for binding the LIKE ESCAPE character depends on database configuration (mixed vs DBCS). Since we cannot know how the database in configured, we will disable parameter binding for the ESCAPE

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • notLikeEscapeOperator

        protected ExpressionOperator notLikeEscapeOperator()
        DB2 z/OS support for binding the LIKE ESCAPE character depends on database configuration (mixed vs DBCS). Since we cannot know how the database in configured, we will disable parameter binding for the ESCAPE

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • locateOperator

        protected ExpressionOperator locateOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

        With binding enabled, DB2 z/OS will throw an error: 

        The data type, the length, or the value of an argument of a scalar function 
 is incorrect. DB2 SQL Error: SQLCODE=-171, SQLSTATE=42815

      • locate2Operator

        protected ExpressionOperator locate2Operator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

        With binding enabled, DB2 z/OS will throw an error: 

        The data type, the length, or the value of an argument of a scalar function 
 is incorrect. DB2 SQL Error: SQLCODE=-171, SQLSTATE=42815

      • modOperator

        protected ExpressionOperator modOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

        With binding enabled, DB2 z/OS will throw an error: 

        The data type, the length, or the value of an argument of a scalar function 
 is incorrect. DB2 SQL Error: SQLCODE=-171, SQLSTATE=42815

      • sqrtOperator

        protected ExpressionOperator sqrtOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • trimOperator

        protected ExpressionOperator trimOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • trim2

        protected ExpressionOperator trim2()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The data type, the length, or the value of an argument of a scalar function 
 is incorrect. DB2 SQL Error: SQLCODE=-171, SQLSTATE=42815
        Overrides:
        trim2 in class DB2Platform

      • ltrimOperator

        protected ExpressionOperator ltrimOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • ltrim2Operator

        protected ExpressionOperator ltrim2Operator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The data type, the length, or the value of an argument of a scalar function 
 is incorrect. DB2 SQL Error: SQLCODE=-171, SQLSTATE=42815
        Overrides:
        ltrim2Operator in class DB2Platform

      • rtrimOperator

        protected ExpressionOperator rtrimOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • rtrim2Operator

        protected ExpressionOperator rtrim2Operator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The data type, the length, or the value of an argument of a scalar function 
 is incorrect. DB2 SQL Error: SQLCODE=-171, SQLSTATE=42815
        Overrides:
        rtrim2Operator in class DB2Platform

      • inOperator

        protected ExpressionOperator inOperator()
        DB2 z/OS requires that at least one argument be a known type

        With binding enabled, DB2 z/OS will throw an error: 

        The statement string specified as the object of a PREPARE contains a 
 predicate or expression where parameter markers have been used as operands of 
 the same operator—for example: ? > ?. DB2 SQL Error: SQLCODE=-417, SQLSTATE=42609

      • ceilingOperator

        protected ExpressionOperator ceilingOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • floorOperator

        protected ExpressionOperator floorOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • roundOperator

        protected ExpressionOperator roundOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The data type, the length, or the value of an argument of a scalar function 
 is incorrect. DB2 SQL Error: SQLCODE=-171, SQLSTATE=42815
        Overrides:
        roundOperator in class DB2Platform

      • expOperator

        protected ExpressionOperator expOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • lnOperator

        protected ExpressionOperator lnOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • powerOperator

        protected ExpressionOperator powerOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • signOperator

        protected ExpressionOperator signOperator()
        Disable binding support.

        With binding enabled, DB2 z/OS will throw an error: 

        The statement cannot be executed because a parameter marker has been used 
 in an invalid way. DB2 SQL Error: SQLCODE=-418, SQLSTATE=42610

      • isDB2Z

        public boolean isDB2Z()
        Specified by:
        isDB2Z in interface org.eclipse.persistence.internal.databaseaccess.Platform
        Overrides:
        isDB2Z in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

      • buildProcedureCallString

        public String buildProcedureCallString​(StoredProcedureCall call,
                                       org.eclipse.persistence.internal.sessions.AbstractSession session,
                                       org.eclipse.persistence.internal.sessions.AbstractRecord row)
        INTERNAL: Used for sp calls. PostGreSQL uses a different method for executing StoredProcedures than other platforms.
        Overrides:
        buildProcedureCallString in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

      • setParameterValueInDatabaseCall

        public void setParameterValueInDatabaseCall​(Object parameter,
                                            CallableStatement statement,
                                            String name,
                                            org.eclipse.persistence.internal.sessions.AbstractSession session)
                                     throws SQLException
        Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
        INTERNAL Set the parameter in the JDBC statement with the given name. This support a wide range of different parameter types, and is heavily optimized for common types.
        Overrides:
        setParameterValueInDatabaseCall in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
        Throws:
        SQLException

      • setNullFromDatabaseField

        protected void setNullFromDatabaseField​(org.eclipse.persistence.internal.helper.DatabaseField databaseField,
                                        CallableStatement statement,
                                        String name)
                                 throws SQLException
        Overrides:
        setNullFromDatabaseField in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
        Throws:
        SQLException

      • getParameterValueFromDatabaseCall

        public Object getParameterValueFromDatabaseCall​(CallableStatement statement,
                                                String name,
                                                org.eclipse.persistence.internal.sessions.AbstractSession session)
                                         throws SQLException
        Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
        INTERNAL Get the parameter from the JDBC statement with the given name.
        Overrides:
        getParameterValueFromDatabaseCall in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
        Throws:
        SQLException