Package org.hibernate

Interface SQLQuery<T>

    • Method Detail

      • setResultSetMapping

        SQLQuery<T> setResultSetMapping​(String name)
        Deprecated.
        Use a predefined named result-set mapping. This might be defined by a <result-set/> element in a Hibernate hbm.xml file or through a SqlResultSetMapping annotation.
        Parameters:
        name - The name of the mapping to use.
        Returns:
        this, for method chaining

      • isCallable

        boolean isCallable()
        Deprecated.
        Is this native-SQL query known to be callable?
        Returns:
        true if the query is known to be callable; false otherwise.

      • getQueryReturns

        List<NativeSQLQueryReturn> getQueryReturns()
        Deprecated.
        Retrieve the returns associated with this query.
        Returns:
        The return descriptors

      • addScalar

        SQLQuery<T> addScalar​(String columnAlias)
        Deprecated.
        Declare a scalar query result. Hibernate will attempt to automatically detect the underlying type.

        Functions like <return-scalar/> in hbm.xml or ColumnResult

        Parameters:
        columnAlias - The column alias in the result-set to be processed as a scalar result
        Returns:
        this, for method chaining

      • addScalar

        SQLQuery<T> addScalar​(String columnAlias,
                      Type type)
        Deprecated.
        Declare a scalar query result.

        Functions like <return-scalar/> in hbm.xml or ColumnResult

        Parameters:
        columnAlias - The column alias in the result-set to be processed as a scalar result
        type - The Hibernate type as which to treat the value.
        Returns:
        this, for method chaining

      • addRoot

        SQLQuery.RootReturn addRoot​(String tableAlias,
                            String entityName)
        Deprecated.
        Add a new root return mapping, returning a SQLQuery.RootReturn to allow further definition.
        Parameters:
        tableAlias - The SQL table alias to map to this entity
        entityName - The name of the entity.
        Returns:
        The return config object for further control.
        Since:
        3.6

      • addRoot

        SQLQuery.RootReturn addRoot​(String tableAlias,
                            Class entityType)
        Deprecated.
        Add a new root return mapping, returning a SQLQuery.RootReturn to allow further definition.
        Parameters:
        tableAlias - The SQL table alias to map to this entity
        entityType - The java type of the entity.
        Returns:
        The return config object for further control.
        Since:
        3.6

      • addEntity

        SQLQuery<T> addEntity​(String entityName)
        Deprecated.
        Declare a "root" entity, without specifying an alias. The expectation here is that the table alias is the same as the unqualified entity name

        Use addRoot(java.lang.String, java.lang.String) if you need further control of the mapping

        Parameters:
        entityName - The entity name that is the root return of the query.
        Returns:
        this, for method chaining

      • addEntity

        SQLQuery<T> addEntity​(String tableAlias,
                      String entityName)
        Deprecated.
        Declare a "root" entity.
        Parameters:
        tableAlias - The SQL table alias
        entityName - The entity name
        Returns:
        this, for method chaining

      • addEntity

        SQLQuery<T> addEntity​(String tableAlias,
                      String entityName,
                      LockMode lockMode)
        Deprecated.
        Declare a "root" entity, specifying a lock mode.
        Parameters:
        tableAlias - The SQL table alias
        entityName - The entity name
        lockMode - The lock mode for this return.
        Returns:
        this, for method chaining

      • addEntity

        SQLQuery<T> addEntity​(Class entityType)
        Deprecated.
        Declare a "root" entity, without specifying an alias. The expectation here is that the table alias is the same as the unqualified entity name
        Parameters:
        entityType - The java type of the entity to add as a root
        Returns:
        this, for method chaining

      • addEntity

        SQLQuery<T> addEntity​(String tableAlias,
                      Class entityType)
        Deprecated.
        Declare a "root" entity.
        Parameters:
        tableAlias - The SQL table alias
        entityType - The java type of the entity to add as a root
        Returns:
        this, for method chaining

      • addEntity

        SQLQuery<T> addEntity​(String tableAlias,
                      Class entityClass,
                      LockMode lockMode)
        Deprecated.
        Declare a "root" entity, specifying a lock mode.
        Parameters:
        tableAlias - The SQL table alias
        entityClass - The entity Class
        lockMode - The lock mode for this return.
        Returns:
        this, for method chaining

      • addFetch

        SQLQuery.FetchReturn addFetch​(String tableAlias,
                              String ownerTableAlias,
                              String joinPropertyName)
        Deprecated.
        Declare a join fetch result.
        Parameters:
        tableAlias - The SQL table alias for the data to be mapped to this fetch
        ownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch
        joinPropertyName - The name of the property being join fetched.
        Returns:
        The return config object for further control.
        Since:
        3.6

      • addJoin

        SQLQuery<T> addJoin​(String tableAlias,
                    String path)
        Deprecated.
        Declare a join fetch result.
        Parameters:
        tableAlias - The SQL table alias for the data to be mapped to this fetch
        path - The association path ([owner-alias].[property-name]).
        Returns:
        this, for method chaining

      • addJoin

        SQLQuery<T> addJoin​(String tableAlias,
                    String ownerTableAlias,
                    String joinPropertyName)
        Deprecated.
        Declare a join fetch result.
        Parameters:
        tableAlias - The SQL table alias for the data to be mapped to this fetch
        ownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch
        joinPropertyName - The name of the property being join fetched.
        Returns:
        this, for method chaining
        Since:
        3.6

      • addJoin

        SQLQuery<T> addJoin​(String tableAlias,
                    String path,
                    LockMode lockMode)
        Deprecated.
        Declare a join fetch result, specifying a lock mode.
        Parameters:
        tableAlias - The SQL table alias for the data to be mapped to this fetch
        path - The association path ([owner-alias].[property-name]).
        lockMode - The lock mode for this return.
        Returns:
        this, for method chaining

      • setCacheable

        NativeQuery<T> setCacheable​(boolean cacheable)
        Deprecated.
        Description copied from interface: Query
        Enable/disable second level query (result) caching for this query.
        Specified by:
        setCacheable in interface BasicQueryContract<T>
        Specified by:
        setCacheable in interface Query<T>
        Parameters:
        cacheable - Should the query results be cacheable?
        Returns:
        this, for method chaining
        See Also:
        Query.isCacheable()

      • setCacheRegion

        NativeQuery<T> setCacheRegion​(String cacheRegion)
        Deprecated.
        Description copied from interface: Query
        Set the name of the cache region where query results should be cached (if cached at all).
        Specified by:
        setCacheRegion in interface BasicQueryContract<T>
        Specified by:
        setCacheRegion in interface Query<T>
        Parameters:
        cacheRegion - the name of a query cache region, or null to indicate that the default region should be used.
        Returns:
        this, for method chaining
        See Also:
        Query.getCacheRegion()

      • setTimeout

        NativeQuery<T> setTimeout​(int timeout)
        Deprecated.
        Description copied from interface: Query
        Set the query timeout in seconds. NOTE it is important to understand that any value set here is eventually passed directly through to the JDBC Statement which expressly disallows negative values. So negative values should be avoided as a general rule.
        Specified by:
        setTimeout in interface BasicQueryContract<T>
        Specified by:
        setTimeout in interface Query<T>
        Parameters:
        timeout - the timeout in seconds
        Returns:
        this, for method chaining
        See Also:
        Query.getTimeout()

      • setLockMode

        NativeQuery<T> setLockMode​(String alias,
                           LockMode lockMode)
        Deprecated.
        Description copied from interface: Query
        Set the LockMode to use for specific alias (as defined in the query's FROM clause). The alias-specific lock modes specified here are added to the query's internal LockOptions. The effect of these alias-specific LockModes is somewhat dependent on the driver/database in use. Generally speaking, for maximum portability, this method should only be used to mark that the rows corresponding to the given alias should be included in pessimistic locking (LockMode.PESSIMISTIC_WRITE).
        Specified by:
        setLockMode in interface Query<T>
        Parameters:
        alias - a query alias, or "this" for a collection filter
        lockMode - The lock mode to apply.
        Returns:
        this, for method chaining
        See Also:
        Query.getLockOptions()

      • setComment

        NativeQuery<T> setComment​(String comment)
        Deprecated.
        Description copied from interface: Query
        Set the comment for this query.
        Specified by:
        setComment in interface Query<T>
        Parameters:
        comment - The human-readable comment
        Returns:
        this, for method chaining
        See Also:
        Query.getComment()

      • addQueryHint

        NativeQuery<T> addQueryHint​(String hint)
        Deprecated.
        Description copied from interface: Query
        Add a DB query hint to the SQL. These differ from JPA's QueryHint, which is specific to the JPA implementation and ignores DB vendor-specific hints. Instead, these are intended solely for the vendor-specific hints, such as Oracle's optimizers. Multiple query hints are supported; the Dialect will determine concatenation and placement.
        Specified by:
        addQueryHint in interface Query<T>
        Parameters:
        hint - The database specific query hint to add.

      • setParameter

        <P> NativeQuery<T> setParameter​(QueryParameter<P> parameter,
                                P val)
        Deprecated.
        Description copied from interface: Query
        Bind a query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, and Query.setParameter(QueryParameter, Object, Type) should be used instead
        Specified by:
        setParameter in interface Query<T>
        Parameters:
        parameter - The query parameter memento
        val - the possibly-null parameter value
        Returns:
        this, for method chaining

      • setParameter

        NativeQuery<T> setParameter​(String name,
                            Object val)
        Deprecated.
        Description copied from interface: Query
        Bind a named query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, and Query.setParameter(String, Object, Type) should be used instead
        Specified by:
        setParameter in interface Query
        Specified by:
        setParameter in interface Query<T>
        Specified by:
        setParameter in interface TypedQuery<T>
        Parameters:
        name - the parameter name
        val - the (possibly-null) parameter value
        Returns:
        this, for method chaining

      • setParameter

        NativeQuery<T> setParameter​(int position,
                            Object val)
        Deprecated.
        Description copied from interface: Query
        Bind a positional query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, and Query.setParameter(int, Object, Type) should be used instead
        Specified by:
        setParameter in interface Query
        Specified by:
        setParameter in interface Query<T>
        Specified by:
        setParameter in interface TypedQuery<T>
        Parameters:
        position - the position of the parameter in the query string, numbered from 0.
        val - the possibly-null parameter value
        Returns:
        this, for method chaining

      • setParameter

        <P> NativeQuery<T> setParameter​(QueryParameter<P> parameter,
                                P val,
                                Type type)
        Deprecated.
        Description copied from interface: Query
        Bind a query parameter using the supplied Type
        Specified by:
        setParameter in interface Query<T>
        Parameters:
        parameter - The query parameter memento
        val - the possibly-null parameter value
        type - the Hibernate type
        Returns:
        this, for method chaining

      • setParameter

        NativeQuery<T> setParameter​(String name,
                            Object val,
                            Type type)
        Deprecated.
        Description copied from interface: Query
        Bind a named query parameter using the supplied Type
        Specified by:
        setParameter in interface Query<T>
        Parameters:
        name - the name of the parameter
        val - the possibly-null parameter value
        type - the Hibernate type
        Returns:
        this, for method chaining

      • setParameter

        NativeQuery<T> setParameter​(int position,
                            Object val,
                            Type type)
        Deprecated.
        Description copied from interface: Query
        Bind a value to a JDBC-style query parameter.
        Specified by:
        setParameter in interface Query<T>
        Parameters:
        position - the position of the parameter in the query string, numbered from 0.
        val - the possibly-null parameter value
        type - the Hibernate type
        Returns:
        this, for method chaining

      • setParameter

        <P> NativeQuery<T> setParameter​(QueryParameter<P> parameter,
                                P val,
                                TemporalType temporalType)
        Deprecated.
        Description copied from interface: Query
        Bind a query parameter as some form of date/time using the indicated temporal-type.
        Specified by:
        setParameter in interface Query<T>
        Parameters:
        parameter - The query parameter memento
        val - the possibly-null parameter value
        temporalType - the temporal-type to use in binding the date/time
        Returns:
        this, for method chaining

      • setParameter

        <P> NativeQuery<T> setParameter​(String name,
                                P val,
                                TemporalType temporalType)
        Deprecated.
        Description copied from interface: Query
        Bind a named query parameter as some form of date/time using the indicated temporal-type.
        Specified by:
        setParameter in interface Query<T>
        Parameters:
        name - the parameter name
        val - the possibly-null parameter value
        temporalType - the temporal-type to use in binding the date/time
        Returns:
        this, for method chaining

      • setParameter

        <P> NativeQuery<T> setParameter​(int position,
                                P val,
                                TemporalType temporalType)
        Deprecated.
        Description copied from interface: Query
        Bind a positional query parameter as some form of date/time using the indicated temporal-type.
        Specified by:
        setParameter in interface Query<T>
        Parameters:
        position - the position of the parameter in the query string, numbered from 0.
        val - the possibly-null parameter value
        temporalType - the temporal-type to use in binding the date/time
        Returns:
        this, for method chaining

      • setParameterList

        <P> NativeQuery<T> setParameterList​(QueryParameter<P> parameter,
                                    Collection<P> values)
        Deprecated.
        Description copied from interface: Query
        Bind multiple values to a query parameter using its inferred Type. The Hibernate type of the parameter values is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
        Specified by:
        setParameterList in interface Query<T>
        Parameters:
        parameter - the parameter memento
        values - a collection of values to list
        Returns:
        this, for method chaining

      • setParameterList

        NativeQuery<T> setParameterList​(String name,
                                Collection values)
        Deprecated.
        Description copied from interface: Query
        Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
        Specified by:
        setParameterList in interface Query<T>
        Parameters:
        name - the name of the parameter
        values - a collection of values to list
        Returns:
        this, for method chaining

      • setParameterList

        NativeQuery<T> setParameterList​(String name,
                                Collection values,
                                Type type)
        Deprecated.
        Description copied from interface: Query
        Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
        Specified by:
        setParameterList in interface Query<T>
        Parameters:
        name - the name of the parameter
        values - a collection of values to list
        type - the Hibernate type of the values
        Returns:
        this, for method chaining

      • setParameterList

        NativeQuery<T> setParameterList​(String name,
                                Object[] values,
                                Type type)
        Deprecated.
        Description copied from interface: Query
        Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
        Specified by:
        setParameterList in interface Query<T>
        Parameters:
        name - the name of the parameter
        values - a collection of values to list
        type - the Hibernate type of the values
        Returns:
        this, for method chaining

      • setParameterList

        NativeQuery<T> setParameterList​(String name,
                                Object[] values)
        Deprecated.
        Description copied from interface: Query
        Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the array. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
        Specified by:
        setParameterList in interface Query<T>
        Parameters:
        name - the name of the parameter
        values - a collection of values to list
        Returns:
        this, for method chaining

      • setProperties

        NativeQuery<T> setProperties​(Object bean)
        Deprecated.
        Description copied from interface: Query
        Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
        Specified by:
        setProperties in interface Query<T>
        Parameters:
        bean - any JavaBean or POJO
        Returns:
        this, for method chaining

      • setProperties

        NativeQuery<T> setProperties​(Map bean)
        Deprecated.
        Description copied from interface: Query
        Bind the values of the given Map for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
        Specified by:
        setProperties in interface Query<T>
        Parameters:
        bean - a java.util.Map
        Returns:
        this, for method chaining