Package org.hibernate.dialect

Class Oracle8iDialect

    • Constructor Detail

      • Oracle8iDialect

        public Oracle8iDialect()
        Constructs a Oracle8iDialect

    • Method Detail

      • registerCharacterTypeMappings

        protected void registerCharacterTypeMappings()

      • registerNumericTypeMappings

        protected void registerNumericTypeMappings()

      • registerDateTimeTypeMappings

        protected void registerDateTimeTypeMappings()

      • registerLargeObjectTypeMappings

        protected void registerLargeObjectTypeMappings()

      • registerReverseHibernateTypeMappings

        protected void registerReverseHibernateTypeMappings()

      • registerFunctions

        protected void registerFunctions()

      • registerDefaultProperties

        protected void registerDefaultProperties()

      • getSqlTypeDescriptorOverride

        protected SqlTypeDescriptor getSqlTypeDescriptorOverride​(int sqlCode)
        Description copied from class: Dialect
        Returns the SqlTypeDescriptor that should be used to handle the given JDBC type code. Returns null if there is no override.
        Overrides:
        getSqlTypeDescriptorOverride in class Dialect
        Parameters:
        sqlCode - A Types constant indicating the SQL column type
        Returns:
        The SqlTypeDescriptor to use as an override, or null if there is no override.

      • getCrossJoinSeparator

        public java.lang.String getCrossJoinSeparator()
        Description copied from class: Dialect
        Returns the separator to use for defining cross joins when translating HQL queries.

        Typically this will be either [ cross join ] or [, ]

        Note that the spaces are important!

        Overrides:
        getCrossJoinSeparator in class Dialect
        Returns:
        The cross join separator

      • createCaseFragment

        public CaseFragment createCaseFragment()
        Map case support to the Oracle DECODE function. Oracle did not add support for CASE until 9i.

        Create a CaseFragment strategy responsible for handling this dialect's variations in how CASE statements are handled.

        Overrides:
        createCaseFragment in class Dialect
        Returns:
        This dialect's CaseFragment strategy.

      • getLimitHandler

        public LimitHandler getLimitHandler()
        Description copied from class: Dialect
        Returns the delegate managing LIMIT clause.
        Overrides:
        getLimitHandler in class Dialect
        Returns:
        LIMIT clause delegate.

      • getLimitString

        public java.lang.String getLimitString​(java.lang.String sql,
                                       boolean hasOffset)
        Description copied from class: Dialect
        Apply s limit clause to the query.

        Typically dialects utilize variable limit clauses when they support limits. Thus, when building the select command we do not actually need to know the limit or the offest since we will just be using placeholders.

        Here we do still pass along whether or not an offset was specified so that dialects not supporting offsets can generate proper exceptions. In general, dialects will override one or the other of this method and Dialect.getLimitString(String, int, int).

        Overrides:
        getLimitString in class Dialect
        Parameters:
        sql - The query to which to apply the limit.
        hasOffset - Is the query requesting an offset?
        Returns:
        the modified SQL

      • getBasicSelectClauseNullString

        public java.lang.String getBasicSelectClauseNullString​(int sqlType)
        Allows access to the basic Dialect.getSelectClauseNullString(int) implementation...
        Parameters:
        sqlType - The Types mapping type code
        Returns:
        The appropriate select cluse fragment

      • getSelectClauseNullString

        public java.lang.String getSelectClauseNullString​(int sqlType)
        Description copied from class: Dialect
        Given a Types type code, determine an appropriate null value to use in a select clause.

        One thing to consider here is that certain databases might require proper casting for the nulls here since the select here will be part of a UNION/UNION ALL.

        Overrides:
        getSelectClauseNullString in class Dialect
        Parameters:
        sqlType - The Types type code.
        Returns:
        The appropriate select clause value fragment.

      • getCurrentTimestampSelectString

        public java.lang.String getCurrentTimestampSelectString()
        Description copied from class: Dialect
        Retrieve the command used to retrieve the current timestamp from the database.
        Overrides:
        getCurrentTimestampSelectString in class Dialect
        Returns:
        The command.

      • getCurrentTimestampSQLFunctionName

        public java.lang.String getCurrentTimestampSQLFunctionName()
        Description copied from class: Dialect
        The name of the database-specific SQL function for retrieving the current timestamp.
        Overrides:
        getCurrentTimestampSQLFunctionName in class Dialect
        Returns:
        The function name.

      • getAddColumnString

        public java.lang.String getAddColumnString()
        Description copied from class: Dialect
        The syntax used to add a column to a table (optional).
        Overrides:
        getAddColumnString in class Dialect
        Returns:
        The "add column" fragment.

      • getSequenceNextValString

        public java.lang.String getSequenceNextValString​(java.lang.String sequenceName)
        Description copied from class: Dialect
        Generate the appropriate select statement to to retrieve the next value of a sequence.

        This should be a "stand alone" select statement.

        Overrides:
        getSequenceNextValString in class Dialect
        Parameters:
        sequenceName - the name of the sequence
        Returns:
        String The "nextval" select string.

      • getSelectSequenceNextValString

        public java.lang.String getSelectSequenceNextValString​(java.lang.String sequenceName)
        Description copied from class: Dialect
        Generate the select expression fragment that will retrieve the next value of a sequence as part of another (typically DML) statement.

        This differs from Dialect.getSequenceNextValString(String) in that this should return an expression usable within another statement.

        Overrides:
        getSelectSequenceNextValString in class Dialect
        Parameters:
        sequenceName - the name of the sequence
        Returns:
        The "nextval" fragment.

      • getCreateSequenceString

        public java.lang.String getCreateSequenceString​(java.lang.String sequenceName)
        Description copied from class: Dialect
        Typically dialects which support sequences can create a sequence with a single command. This is convenience form of Dialect.getCreateSequenceStrings(java.lang.String) to help facilitate that.

        Dialects which support sequences and can create a sequence in a single command need *only* override this method. Dialects which support sequences but require multiple commands to create a sequence should instead override Dialect.getCreateSequenceStrings(java.lang.String).

        Overrides:
        getCreateSequenceString in class Dialect
        Parameters:
        sequenceName - The name of the sequence
        Returns:
        The sequence creation command

      • getCreateSequenceString

        protected java.lang.String getCreateSequenceString​(java.lang.String sequenceName,
                                                   int initialValue,
                                                   int incrementSize)
        Description copied from class: Dialect
        Overloaded form of Dialect.getCreateSequenceString(String), additionally taking the initial value and increment size to be applied to the sequence definition.

        The default definition is to suffix Dialect.getCreateSequenceString(String) with the string: " start with {initialValue} increment by {incrementSize}" where {initialValue} and {incrementSize} are replacement placeholders. Generally dialects should only need to override this method if different key phrases are used to apply the allocation information.
        Overrides:
        getCreateSequenceString in class Dialect
        Parameters:
        sequenceName - The name of the sequence
        initialValue - The initial value to apply to 'create sequence' statement
        incrementSize - The increment value to apply to 'create sequence' statement
        Returns:
        The sequence creation command

      • getDropSequenceString

        public java.lang.String getDropSequenceString​(java.lang.String sequenceName)
        Description copied from class: Dialect
        Typically dialects which support sequences can drop a sequence with a single command. This is convenience form of Dialect.getDropSequenceStrings(java.lang.String) to help facilitate that.

        Dialects which support sequences and can drop a sequence in a single command need *only* override this method. Dialects which support sequences but require multiple commands to drop a sequence should instead override Dialect.getDropSequenceStrings(java.lang.String).

        Overrides:
        getDropSequenceString in class Dialect
        Parameters:
        sequenceName - The name of the sequence
        Returns:
        The sequence drop commands

      • getCascadeConstraintsString

        public java.lang.String getCascadeConstraintsString()
        Description copied from class: Dialect
        Completely optional cascading drop clause
        Overrides:
        getCascadeConstraintsString in class Dialect
        Returns:
        String

      • dropConstraints

        public boolean dropConstraints()
        Description copied from class: Dialect
        Do we need to drop constraints before dropping tables in this dialect?
        Overrides:
        dropConstraints in class Dialect
        Returns:
        True if constraints must be dropped prior to dropping the table; false otherwise.

      • getForUpdateNowaitString

        public java.lang.String getForUpdateNowaitString()
        Description copied from class: Dialect
        Retrieves the FOR UPDATE NOWAIT syntax specific to this dialect.
        Overrides:
        getForUpdateNowaitString in class Dialect
        Returns:
        The appropriate FOR UPDATE NOWAIT clause string.

      • supportsSequences

        public boolean supportsSequences()
        Description copied from class: Dialect
        Does this dialect support sequences?
        Overrides:
        supportsSequences in class Dialect
        Returns:
        True if sequences supported; false otherwise.

      • supportsLimit

        public boolean supportsLimit()
        Description copied from class: Dialect
        Does this dialect support some form of limiting query results via a SQL clause?
        Overrides:
        supportsLimit in class Dialect
        Returns:
        True if this dialect supports some form of LIMIT.

      • getForUpdateString

        public java.lang.String getForUpdateString​(java.lang.String aliases)
        Description copied from class: Dialect
        Get the FOR UPDATE OF column_list fragment appropriate for this dialect given the aliases of the columns to be write locked.
        Overrides:
        getForUpdateString in class Dialect
        Parameters:
        aliases - The columns to be write locked.
        Returns:
        The appropriate FOR UPDATE OF column_list clause string.

      • getForUpdateNowaitString

        public java.lang.String getForUpdateNowaitString​(java.lang.String aliases)
        Description copied from class: Dialect
        Get the FOR UPDATE OF column_list NOWAIT fragment appropriate for this dialect given the aliases of the columns to be write locked.
        Overrides:
        getForUpdateNowaitString in class Dialect
        Parameters:
        aliases - The columns to be write locked.
        Returns:
        The appropriate FOR UPDATE OF colunm_list NOWAIT clause string.

      • bindLimitParametersInReverseOrder

        public boolean bindLimitParametersInReverseOrder()
        Description copied from class: Dialect
        ANSI SQL defines the LIMIT clause to be in the form LIMIT offset, limit. Does this dialect require us to bind the parameters in reverse order?
        Overrides:
        bindLimitParametersInReverseOrder in class Dialect
        Returns:
        true if the correct order is limit, offset

      • useMaxForLimit

        public boolean useMaxForLimit()
        Description copied from class: Dialect
        Does the LIMIT clause take a "maximum" row number instead of a total number of returned rows?

        This is easiest understood via an example. Consider you have a table with 20 rows, but you only want to retrieve rows number 11 through 20. Generally, a limit with offset would say that the offset = 11 and the limit = 10 (we only want 10 rows at a time); this is specifying the total number of returned rows. Some dialects require that we instead specify offset = 11 and limit = 20, where 20 is the "last" row we want relative to offset (i.e. total number of rows = 20 - 11 = 9)

        So essentially, is limit relative from offset? Or is limit absolute?

        Overrides:
        useMaxForLimit in class Dialect
        Returns:
        True if limit is relative from offset; false otherwise.

      • forUpdateOfColumns

        public boolean forUpdateOfColumns()
        Description copied from class: Dialect
        Is FOR UPDATE OF syntax supported?
        Overrides:
        forUpdateOfColumns in class Dialect
        Returns:
        True if the database supports FOR UPDATE OF syntax; false otherwise.

      • getQuerySequencesString

        public java.lang.String getQuerySequencesString()
        Description copied from class: Dialect
        Get the select command used retrieve the names of all sequences.
        Overrides:
        getQuerySequencesString in class Dialect
        Returns:
        The select command; or null if sequences are not supported.
        See Also:
        SchemaUpdate

      • getSelectGUIDString

        public java.lang.String getSelectGUIDString()
        Description copied from class: Dialect
        Get the command used to select a GUID from the underlying database.

        Optional operation.

        Overrides:
        getSelectGUIDString in class Dialect
        Returns:
        The appropriate command.

      • buildSQLExceptionConversionDelegate

        public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()
        Description copied from class: Dialect
        Build an instance of a SQLExceptionConversionDelegate for interpreting dialect-specific error or SQLState codes.

        When Dialect.buildSQLExceptionConverter() returns null, the default SQLExceptionConverter is used to interpret SQLState and error codes. If this method is overridden to return a non-null value, the default SQLExceptionConverter will use the returned SQLExceptionConversionDelegate in addition to the following standard delegates:

        1. a "static" delegate based on the JDBC 4 defined SQLException hierarchy;
        2. a delegate that interprets SQLState codes for either X/Open or SQL-2003 codes, depending on java.sql.DatabaseMetaData#getSQLStateType

        It is strongly recommended that specific Dialect implementations override this method, since interpretation of a SQL error is much more accurate when based on the a vendor-specific ErrorCode rather than the SQLState.

        Specific Dialects may override to return whatever is most appropriate for that vendor.

        Overrides:
        buildSQLExceptionConversionDelegate in class Dialect
        Returns:
        The SQLExceptionConversionDelegate for this dialect

      • registerResultSetOutParameter

        public int registerResultSetOutParameter​(java.sql.CallableStatement statement,
                                         int col)
                                  throws java.sql.SQLException
        Description copied from class: Dialect
        Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returning ResultSet *by position*. Pre-Java 8, registering such ResultSet-returning parameters varied greatly across database and drivers; hence its inclusion as part of the Dialect contract.
        Overrides:
        registerResultSetOutParameter in class Dialect
        Parameters:
        statement - The callable statement.
        col - The bind position at which to register the output param.
        Returns:
        The number of (contiguous) bind positions used.
        Throws:
        java.sql.SQLException - Indicates problems registering the param.

      • getResultSet

        public java.sql.ResultSet getResultSet​(java.sql.CallableStatement ps)
                                throws java.sql.SQLException
        Description copied from class: Dialect
        Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.
        Overrides:
        getResultSet in class Dialect
        Parameters:
        ps - The callable statement.
        Returns:
        The extracted result set.
        Throws:
        java.sql.SQLException - Indicates problems extracting the result set.

      • supportsUnionAll

        public boolean supportsUnionAll()
        Description copied from class: Dialect
        Does this dialect support UNION ALL, which is generally a faster variant of UNION?
        Overrides:
        supportsUnionAll in class Dialect
        Returns:
        True if UNION ALL is supported; false otherwise.

      • supportsCommentOn

        public boolean supportsCommentOn()
        Description copied from class: Dialect
        Does this dialect/database support commenting on tables, columns, etc?
        Overrides:
        supportsCommentOn in class Dialect
        Returns:
        true if commenting is supported

      • supportsCurrentTimestampSelection

        public boolean supportsCurrentTimestampSelection()
        Description copied from class: Dialect
        Does this dialect support a way to retrieve the database's current timestamp value?
        Overrides:
        supportsCurrentTimestampSelection in class Dialect
        Returns:
        True if the current timestamp can be retrieved; false otherwise.

      • supportsEmptyInList

        public boolean supportsEmptyInList()
        Description copied from class: Dialect
        Does this dialect support empty IN lists?

        For example, is [where XYZ in ()] a supported construct?

        Overrides:
        supportsEmptyInList in class Dialect
        Returns:
        True if empty in lists are supported; false otherwise.

      • supportsExistsInSelect

        public boolean supportsExistsInSelect()
        Description copied from class: Dialect
        Does the dialect support an exists statement in the select clause?
        Overrides:
        supportsExistsInSelect in class Dialect
        Returns:
        True if exists checks are allowed in the select clause; false otherwise.

      • getInExpressionCountLimit

        public int getInExpressionCountLimit()
        Description copied from class: Dialect
        Return the limit that the underlying database places on the number of elements in an IN predicate. If the database defines no such limits, simply return zero or less-than-zero.
        Overrides:
        getInExpressionCountLimit in class Dialect
        Returns:
        int The limit, or zero-or-less to indicate no limit.

      • forceLobAsLastValue

        public boolean forceLobAsLastValue()
        Description copied from class: Dialect
        HHH-4635 Oracle expects all Lob values to be last in inserts and updates.
        Overrides:
        forceLobAsLastValue in class Dialect
        Returns:
        boolean True if Lob values should be last, false if it does not matter.

      • getNotExpression

        public java.lang.String getNotExpression​(java.lang.String expression)
        Description copied from class: Dialect
        Negate an expression
        Overrides:
        getNotExpression in class Dialect
        Parameters:
        expression - The expression to negate
        Returns:
        The negated expression

      • getQueryHintString

        public java.lang.String getQueryHintString​(java.lang.String sql,
                                           java.lang.String hints)
        Description copied from class: Dialect
        Apply a hint to the query. The entire query is provided, allowing the Dialect full control over the placement and syntax of the hint. By default, ignore the hint and simply return the query.
        Overrides:
        getQueryHintString in class Dialect
        Parameters:
        sql - The query to which to apply the hint.
        hints - The hints to apply
        Returns:
        The modified SQL

      • getMaxAliasLength

        public int getMaxAliasLength()
        Description copied from class: Dialect
        What is the maximum length Hibernate can use for generated aliases?

        The maximum here should account for the fact that Hibernate often needs to append "uniqueing" information to the end of generated aliases. That "uniqueing" information will be added to the end of a identifier generated to the length specified here; so be sure to leave some room (generally speaking 5 positions will suffice).

        Overrides:
        getMaxAliasLength in class Dialect
        Returns:
        The maximum length.

      • canCreateSchema

        public boolean canCreateSchema()
        Description copied from class: Dialect
        Does this dialect support schema creation?
        Overrides:
        canCreateSchema in class Dialect
        Returns:
        True if the dialect supports schema creation; false otherwise.

      • getCurrentSchemaCommand

        public java.lang.String getCurrentSchemaCommand()
        Description copied from class: Dialect
        Get the SQL command used to retrieve the current schema name. Works in conjunction with Dialect.getSchemaNameResolver(), unless the return from there does not need this information. E.g., a custom impl might make use of the Java 1.7 addition of the Connection.getSchema() method
        Overrides:
        getCurrentSchemaCommand in class Dialect
        Returns:
        The current schema retrieval SQL

      • supportsPartitionBy

        public boolean supportsPartitionBy()
        Description copied from class: Dialect
        Does the underlying database support partition by
        Overrides:
        supportsPartitionBy in class Dialect
        Returns:
        boolean

      • statementType

        protected java.lang.String statementType​(java.lang.String sql)

      • supportsNoWait

        public boolean supportsNoWait()
        Description copied from class: Dialect
        Does this dialect/database support NO_WAIT timeout.
        Overrides:
        supportsNoWait in class Dialect
        Returns:
        true if NO_WAIT is supported