Jakarta Persistence (JPA) Interface

jakarta.persistence.criteria.CriteriaDelete<T>

Type Parameters:
<T> - the entity type that is the target of the DELETE
Super Interfaces:
CommonAbstractCriteria
The CriteriaDelete interface defines functionality for performing bulk delete operations using the Criteria API

Criteria API bulk delete operations map directly to database delete operations. The persistence context is not synchronized with the result of the bulk delete.

A CriteriaDelete object must have a single root.

Since:
Jakarta Persistence (JPA) 2.1

Public Instance Methods

Root<T> from(Class<T> entityClass)
Create and add a query root corresponding to the entity that is the target of the DELETE.
A CriteriaDelete object has a single root, the entity that is being deleted.
Parameters:
entityClass - the entity class
Returns:
query root corresponding to the given entity.
Since:
Jakarta Persistence (JPA) 1.0
Root<T> from(EntityType<T> entity)
Create and add a query root corresponding to the entity that is the target of the DELETE.
A CriteriaDelete object has a single root, the entity that is being deleted.
Parameters:
entity - metamodel entity representing the entity of type X
Returns:
query root corresponding to the given entity.
Since:
Jakarta Persistence (JPA) 1.0
Set<ParameterExpression<?>> getParameters()
Return the parameters of the query.
Returns empty set if there are no parameters. Modifications to the set do not affect the query.
Inherited from CommonAbstractCriteria
Returns:
the query parameters.
Since:
Jakarta Persistence (JPA) 1.0
Predicate getRestriction()
Return the predicate that corresponds to the where clause restriction(s), or null if no restrictions have been specified.
Inherited from CommonAbstractCriteria
Returns:
where clause predicate.
Since:
Jakarta Persistence (JPA) 1.0
Root<T> getRoot()
Return the query root.
Returns:
the query root.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<U> subquery(Class<U> type)
Create a subquery of the query.
Inherited from CommonAbstractCriteria
Parameters:
type - the subquery result type
Returns:
subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<U> subquery(EntityType<U> type)
Create a subquery of the query.
Inherited from CommonAbstractCriteria
Parameters:
type - the subquery result type
Returns:
subquery.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaDelete<T> where(Expression<Boolean> restriction)
Modify the DELETE query to restrict the target of the deletion according to the specified boolean expression.
Replaces the previously added restriction(s), if any.
Parameters:
restriction - a simple or compound boolean expression
Returns:
the modified delete query.
Since:
Jakarta Persistence (JPA) 1.0
CriteriaDelete<T> where(Predicate... restrictions)
Modify the DELETE query to restrict the target of the deletion according to the conjunction of the specified restriction predicates.
Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.
Parameters:
restrictions - zero or more restriction predicates
Returns:
the modified delete query.
Since:
Jakarta Persistence (JPA) 1.0