Package org.hibernate.query.specification

Interface MutationSpecification<T>

Type Parameters:

T - The entity type which is the target of the mutation.

All Superinterfaces:

QuerySpecification<T>

All Known Implementing Classes:

MutationSpecificationImpl

@Incubating
public interface MutationSpecification<T>
extends QuerySpecification<T>

Specialization of QuerySpecification for programmatic customization of mutation queries.

The method restrict(Restriction) allows application of additional filtering to the mutated entity. The static factory methods of Restriction are used to express filtering criteria of various kinds.

 MutationSpecification.create(Book.class, "delete from Book")
         .restrict(Restriction.lessThan(Book_.publicationDate,
                                        LocalDate.ofYearDay(2000,1)))
         .createQuery(session)
         .executeUpdate();
 

Once all restrictions are specified, call createQuery() to obtain an executable mutation query object.

Since:

7.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MutationSpecification.Augmentation<T>	A function capable of modifying or augmenting a criteria query.

Method Summary

Modifier and Type	Method	Description
MutationSpecification<T>	augment(MutationSpecification.Augmentation<T> augmentation)	Add an augmentation to the specification.
static <T> MutationSpecification<T>	create(CriteriaDelete<T> criteriaDelete)	Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery based on the given criteria delete, allowing the addition of restrictions.
static <T> MutationSpecification<T>	create(CriteriaUpdate<T> criteriaUpdate)	Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery based on the given criteria update, allowing the addition of restrictions.
static <T> MutationSpecification<T>	create(Class<T> mutationTarget, String hql)	Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery based on a base HQL statement, allowing the addition of restrictions.
MutationQuery	createQuery(Session session)	Finalize the building and create the MutationQuery instance.
MutationQuery	createQuery(StatelessSession session)	Finalize the building and create the MutationQuery instance.
TypedQueryReference<Void>	reference()	Obtain a reference to this specification which may be passed along to EntityManager.createQuery(TypedQueryReference).
MutationSpecification<T>	restrict(Restriction<? super T> restriction)	Adds a restriction to the query specification.
MutationSpecification<T>	validate(CriteriaBuilder builder)	Validate the query.

Methods inherited from interface org.hibernate.query.specification.QuerySpecification

buildCriteria, createQuery

Method Details

restrict

MutationSpecification<T> restrict(Restriction<? super T> restriction)

Description copied from interface: QuerySpecification

Adds a restriction to the query specification.

Specified by:

restrict in interface QuerySpecification<T>

Parameters:

restriction - The restriction predicate to be added.

Returns:

this for method chaining.

augment

MutationSpecification<T> augment(MutationSpecification.Augmentation<T> augmentation)

Add an augmentation to the specification.

Parameters:

augmentation - A function capable of modifying or augmenting a criteria query.

Returns:

this for method chaining.

createQuery

MutationQuery createQuery(Session session)

Finalize the building and create the MutationQuery instance.

Specified by:

createQuery in interface QuerySpecification<T>

createQuery

MutationQuery createQuery(StatelessSession session)

Finalize the building and create the MutationQuery instance.

Specified by:

createQuery in interface QuerySpecification<T>

validate

MutationSpecification<T> validate(CriteriaBuilder builder)

Description copied from interface: QuerySpecification

Validate the query.

Specified by:

validate in interface QuerySpecification<T>

Returns:

this if everything is fine

reference

TypedQueryReference<Void> reference()

Description copied from interface: QuerySpecification

Obtain a reference to this specification which may be passed along to EntityManager.createQuery(TypedQueryReference).

Specified by:

reference in interface QuerySpecification<T>

create

static <T> MutationSpecification<T> create(Class<T> mutationTarget,
 String hql)

Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery based on a base HQL statement, allowing the addition of restrictions.

Type Parameters:

T - The root entity type for the mutation (the "target"). mutationTarget and <T> are both expected to refer to the mutation target.

Parameters:

hql - The base HQL query (expected to be an update or delete query).

mutationTarget - The entity which is the target of the mutation.

Throws:

IllegalMutationQueryException - Only update and delete are supported; this method will throw an exception if the given HQL query is not an update or delete.

create

static <T> MutationSpecification<T> create(CriteriaUpdate<T> criteriaUpdate)

Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery based on the given criteria update, allowing the addition of restrictions.

Type Parameters:

T - The root entity type for the mutation (the "target").

Parameters:

criteriaUpdate - The criteria update query

create

static <T> MutationSpecification<T> create(CriteriaDelete<T> criteriaDelete)

Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery based on the given criteria delete, allowing the addition of restrictions.

Type Parameters:

T - The root entity type for the mutation (the "target").

Parameters:

criteriaDelete - The criteria delete query