Package org.hibernate.query

Interface MutationQuery

All Superinterfaces:

CommonQueryContract

All Known Subinterfaces:

NativeQuery<T>, NativeQueryImplementor<R>, ProcedureCallImplementor<R>, Query<R>, QueryImplementor<R>, SqmQueryImplementor<R>

All Known Implementing Classes:

AbstractQuery, NativeQueryImpl, ProcedureCallImpl, QuerySqmImpl

@Incubating
public interface MutationQuery
extends CommonQueryContract

Within the context of an active session, an instance of this type represents an executable mutation query, that is, an insert, update, or delete. It is a slimmed-down version of Query, providing only methods relevant to mutation queries.

A MutationQuery may be obtained from the Session by calling:

• QueryProducer.createMutationQuery(String), passing the HQL as a string,
• QueryProducer.createNativeMutationQuery(String), passing native SQL as a string,
• QueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaUpdate) or QueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaDelete), passing a criteria update or delete object, or
• QueryProducer.createNamedMutationQuery(String), passing the name of a query defined using NamedQuery or NamedNativeQuery.

A MutationQuery controls how the mutation query is executed, and allows arguments to be bound to its parameters.

• Mutation queries must be executed using executeUpdate().
• The various overloads of setParameter(String, Object) and setParameter(int, Object) allow arguments to be bound to named and ordinal parameters defined by the query.

Method Summary

Modifier and Type	Method	Description
int	executeUpdate()	Execute an insert, update, or delete statement, and return the number of affected entities.
MutationQuery	setComment(String comment)	Set a comment for this query.
MutationQuery	setFlushMode(FlushModeType flushMode)	Set the FlushMode in to use for this query.
MutationQuery	setHibernateFlushMode(FlushMode flushMode)	Set the current FlushMode in effect for this query.
MutationQuery	setHint(String hintName, Object value)	Set a hint.
MutationQuery	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
MutationQuery	setParameter(int position, Instant value, TemporalType temporalType)	Bind an Instant to an ordinal query parameter using just the portion indicated by the given TemporalType.
MutationQuery	setParameter(int position, Calendar value, TemporalType temporalType)
MutationQuery	setParameter(int position, Date value, TemporalType temporalType)
<P> MutationQuery	setParameter(int position, P value, Class<P> type)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
<P> MutationQuery	setParameter(int position, P value, BindableType<P> type)	Bind the given argument to an ordinal query parameter using the given BindableType.
MutationQuery	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)
MutationQuery	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)
<T> MutationQuery	setParameter(Parameter<T> param, T value)
MutationQuery	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
MutationQuery	setParameter(String name, Instant value, TemporalType temporalType)	Bind an Instant to the named query parameter using just the portion indicated by the given TemporalType.
MutationQuery	setParameter(String name, Calendar value, TemporalType temporalType)
MutationQuery	setParameter(String name, Date value, TemporalType temporalType)
<P> MutationQuery	setParameter(String name, P value, Class<P> type)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the BindableType.
<P> MutationQuery	setParameter(String name, P value, BindableType<P> type)	Bind the given argument to a named query parameter using the given BindableType.
<P> MutationQuery	setParameter(QueryParameter<P> parameter, P value, Class<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the BindableType to use.
<P> MutationQuery	setParameter(QueryParameter<P> parameter, P val, BindableType<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given BindableType.
<T> MutationQuery	setParameter(QueryParameter<T> parameter, T value)	Bind an argument to the query parameter represented by the given QueryParameter.
MutationQuery	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
MutationQuery	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> MutationQuery	setParameterList(int position, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
<P> MutationQuery	setParameterList(int position, Collection<? extends P> values, BindableType<P> type)	Bind multiple arguments to an ordinal query parameter using the given BindableType.
<P> MutationQuery	setParameterList(int position, P[] values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
<P> MutationQuery	setParameterList(int position, P[] values, BindableType<P> type)	Bind multiple arguments to an ordinal query parameter using the given BindableType.
MutationQuery	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
MutationQuery	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> MutationQuery	setParameterList(String name, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the BindableType If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameterList(String, Collection).
<P> MutationQuery	setParameterList(String name, Collection<? extends P> values, BindableType<P> type)	Bind multiple arguments to a named query parameter using the given BindableType.
<P> MutationQuery	setParameterList(String name, P[] values, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the BindableType to use.
<P> MutationQuery	setParameterList(String name, P[] values, BindableType<P> type)	Bind multiple arguments to a named query parameter using the given BindableType.
<P> MutationQuery	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> MutationQuery	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the BindableType to use.
<P> MutationQuery	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, BindableType<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given BindableType.
<P> MutationQuery	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> MutationQuery	setParameterList(QueryParameter<P> parameter, P[] values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the BindableType to use.
<P> MutationQuery	setParameterList(QueryParameter<P> parameter, P[] values, BindableType<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the BindableType.
MutationQuery	setProperties(Object bean)	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.
MutationQuery	setProperties(Map bean)	Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
MutationQuery	setTimeout(int timeout)	Set the query timeout in seconds.

Methods inherited from interface org.hibernate.query.CommonQueryContract

getComment, getFlushMode, getHibernateFlushMode, getTimeout

Method Detail

executeUpdate

int executeUpdate()

Execute an insert, update, or delete statement, and return the number of affected entities.

For use with instances of MutationQuery created using QueryProducer.createMutationQuery(String), QueryProducer.createNamedMutationQuery(String), QueryProducer.createNativeMutationQuery(String), QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaUpdate), or QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaDelete).

Returns:

the number of affected entity instances (may differ from the number of affected rows)

See Also:

QueryProducer.createMutationQuery(String), QueryProducer.createNamedMutationQuery(String), QueryProducer.createNativeMutationQuery(String), Query.executeUpdate()

setFlushMode

MutationQuery setFlushMode(FlushModeType flushMode)

Description copied from interface: CommonQueryContract

Set the FlushMode in to use for this query.

Specified by:

setFlushMode in interface CommonQueryContract

See Also:

CommonQueryContract.getHibernateFlushMode(), Session.getHibernateFlushMode()

setHibernateFlushMode

MutationQuery setHibernateFlushMode(FlushMode flushMode)

Description copied from interface: CommonQueryContract

Set the current FlushMode in effect for this query.

Specified by:

setHibernateFlushMode in interface CommonQueryContract

See Also:

CommonQueryContract.getHibernateFlushMode(), Session.getHibernateFlushMode()

setTimeout

MutationQuery setTimeout(int timeout)

Description copied from interface: CommonQueryContract

Set the query timeout in seconds.

Any value set here is eventually passed directly along to the JDBC statement, which expressly disallows negative values. So negative values should be avoided as a general rule.

A value of zero indicates no timeout.

Specified by:

setTimeout in interface CommonQueryContract

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

CommonQueryContract.getTimeout()

setComment

MutationQuery setComment(String comment)

Description copied from interface: CommonQueryContract

Set a comment for this query.

Specified by:

setComment in interface CommonQueryContract

See Also:

Query.setComment(String)

setHint

MutationQuery setHint(String hintName,
                      Object value)

Description copied from interface: CommonQueryContract

Set a hint. The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setHint in interface CommonQueryContract

See Also:

HibernateHints, SpecHints

setParameter

MutationQuery setParameter(String name,
                           Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

See Also:

CommonQueryContract.setParameter(String, Object, Class), CommonQueryContract.setParameter(String, Object, BindableType)

setParameter

<P> MutationQuery setParameter(String name,
                               P value,
                               Class<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter using the given Class reference to attempt to infer the BindableType. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameter(String, Object).

Specified by:

setParameter in interface CommonQueryContract

See Also:

CommonQueryContract.setParameter(String, Object, BindableType)

setParameter

<P> MutationQuery setParameter(String name,
                               P value,
                               BindableType<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter using the given BindableType.

Specified by:

setParameter in interface CommonQueryContract

setParameter

MutationQuery setParameter(String name,
                           Instant value,
                           TemporalType temporalType)

Description copied from interface: CommonQueryContract

Bind an Instant to the named query parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

setParameter

MutationQuery setParameter(String name,
                           Calendar value,
                           TemporalType temporalType)

Specified by:

setParameter in interface CommonQueryContract

See Also:

Query.setParameter(String, Calendar, TemporalType)

setParameter

MutationQuery setParameter(String name,
                           Date value,
                           TemporalType temporalType)

Specified by:

setParameter in interface CommonQueryContract

See Also:

Query.setParameter(String, Date, TemporalType)

setParameter

MutationQuery setParameter(int position,
                           Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

See Also:

CommonQueryContract.setParameter(int, Object, Class), CommonQueryContract.setParameter(int, Object, BindableType)

setParameter

<P> MutationQuery setParameter(int position,
                               P value,
                               Class<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the BindableType. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameter(int, Object).

Specified by:

setParameter in interface CommonQueryContract

See Also:

CommonQueryContract.setParameter(int, Object, BindableType)

setParameter

<P> MutationQuery setParameter(int position,
                               P value,
                               BindableType<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter using the given BindableType.

Specified by:

setParameter in interface CommonQueryContract

setParameter

MutationQuery setParameter(int position,
                           Instant value,
                           TemporalType temporalType)

Description copied from interface: CommonQueryContract

Bind an Instant to an ordinal query parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

setParameter

MutationQuery setParameter(int position,
                           Date value,
                           TemporalType temporalType)

Specified by:

setParameter in interface CommonQueryContract

See Also:

Query.setParameter(int, Date, TemporalType)

setParameter

MutationQuery setParameter(int position,
                           Calendar value,
                           TemporalType temporalType)

Specified by:

setParameter in interface CommonQueryContract

See Also:

Query.setParameter(int, Calendar, TemporalType)

setParameter

<T> MutationQuery setParameter(QueryParameter<T> parameter,
                               T value)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameter(QueryParameter, Object, BindableType)

setParameter

<P> MutationQuery setParameter(QueryParameter<P> parameter,
                               P value,
                               Class<P> type)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the BindableType to use. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameter(QueryParameter, Object).

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

type - a BindableType representing the type of the parameter

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameter(QueryParameter, Object, BindableType)

setParameter

<P> MutationQuery setParameter(QueryParameter<P> parameter,
                               P val,
                               BindableType<P> type)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter, using the given BindableType.

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - a BindableType representing the type of the parameter

Returns:

this, for method chaining

setParameter

<T> MutationQuery setParameter(Parameter<T> param,
                               T value)

Specified by:

setParameter in interface CommonQueryContract

See Also:

Query.setParameter(Parameter, Object)

setParameter

MutationQuery setParameter(Parameter<Calendar> param,
                           Calendar value,
                           TemporalType temporalType)

Specified by:

setParameter in interface CommonQueryContract

See Also:

Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

MutationQuery setParameter(Parameter<Date> param,
                           Date value,
                           TemporalType temporalType)

Specified by:

setParameter in interface CommonQueryContract

See Also:

Query.setParameter(Parameter, Date, TemporalType)

setParameterList

MutationQuery setParameterList(String name,
                               Collection values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, BindableType)

setParameterList

<P> MutationQuery setParameterList(String name,
                                   Collection<? extends P> values,
                                   Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the BindableType If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, BindableType)

setParameterList

<P> MutationQuery setParameterList(String name,
                                   Collection<? extends P> values,
                                   BindableType<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given BindableType.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

MutationQuery setParameterList(String name,
                               Object[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

<P> MutationQuery setParameterList(String name,
                                   P[] values,
                                   Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, CommonQueryContract.setParameterList(String, Collection) is used

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(java.lang.String, Object[], BindableType)

setParameterList

<P> MutationQuery setParameterList(String name,
                                   P[] values,
                                   BindableType<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given BindableType.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

MutationQuery setParameterList(int position,
                               Collection values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

<P> MutationQuery setParameterList(int position,
                                   Collection<? extends P> values,
                                   Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the BindableType. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(int, Collection, BindableType)

setParameterList

<P> MutationQuery setParameterList(int position,
                                   Collection<? extends P> values,
                                   BindableType<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given BindableType.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

MutationQuery setParameterList(int position,
                               Object[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

<P> MutationQuery setParameterList(int position,
                                   P[] values,
                                   Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the BindableType. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(int, Object[], BindableType)

setParameterList

<P> MutationQuery setParameterList(int position,
                                   P[] values,
                                   BindableType<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given BindableType.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

<P> MutationQuery setParameterList(QueryParameter<P> parameter,
                                   Collection<? extends P> values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred from the context in which it occurs, and from the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

<P> MutationQuery setParameterList(QueryParameter<P> parameter,
                                   Collection<? extends P> values,
                                   Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the BindableType to use. If unable to infer an appropriate BindableType, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(QueryParameter, java.util.Collection, BindableType)

setParameterList

<P> MutationQuery setParameterList(QueryParameter<P> parameter,
                                   Collection<? extends P> values,
                                   BindableType<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given BindableType.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

<P> MutationQuery setParameterList(QueryParameter<P> parameter,
                                   P[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred between the context in which it occurs, the type associated with the QueryParameter and the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

<P> MutationQuery setParameterList(QueryParameter<P> parameter,
                                   P[] values,
                                   Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the BindableType to use. If unable to infer an appropriate BindableType, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(QueryParameter, Object[], BindableType)

setParameterList

<P> MutationQuery setParameterList(QueryParameter<P> parameter,
                                   P[] values,
                                   BindableType<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the BindableType.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setProperties

MutationQuery setProperties(Object bean)

Description copied from interface: CommonQueryContract

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 CommonQueryContract

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

MutationQuery setProperties(Map bean)

Description copied from interface: CommonQueryContract

Bind the values of the given Map to 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 CommonQueryContract

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining