org.hibernate.query.MutationQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of beangle-hibernate-core Show documentation
Hibernate Orm Core Shade,Support Scala Collection
There is a newer version: 6.6.2.Final
Show newest version
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
 */
package org.hibernate.query;

import java.time.Instant;
import java.util.Calendar;
import java.util.Collection;
import java.util.Date;
import java.util.Map;

import org.hibernate.FlushMode;
import org.hibernate.Incubating;
import org.hibernate.Session;

import jakarta.persistence.FlushModeType;
import jakarta.persistence.Parameter;
import jakarta.persistence.TemporalType;

/**
 * Within the context of an active {@linkplain org.hibernate.Session session},
 * an instance of this type represents an executable mutation query, that is,
 * an {@code insert}, {@code update}, or {@code delete}. It is a slimmed-down
 * version of {@link Query}, providing only methods relevant to mutation queries.
 * 
 * A {@code MutationQuery} may be obtained from the {@link org.hibernate.Session}
 * by calling:
 * 

 * {@link QueryProducer#createMutationQuery(String)}, passing the HQL as a
 *     string,
 * 
{@link QueryProducer#createNativeMutationQuery(String)}, passing native
 *     SQL as a string,
 * 
{@link QueryProducer#createMutationQuery(jakarta.persistence.criteria.CriteriaUpdate)} or
 *     {@link QueryProducer#createMutationQuery(jakarta.persistence.criteria.CriteriaDelete)},
 *     passing a criteria update or delete object, or
 * 
{@link QueryProducer#createNamedMutationQuery(String)}, passing the
 *     name of a query defined using {@link jakarta.persistence.NamedQuery} or
 *     {@link jakarta.persistence.NamedNativeQuery}.
 * 
 * 
 * A {@code MutationQuery} controls how the mutation query is executed, and
 * allows arguments to be bound to its parameters.
 * 

 * Mutation queries must be executed using {@link #executeUpdate()}.
 * 
The various overloads of {@link #setParameter(String, Object)} and
 *     {@link #setParameter(int, Object)} allow arguments to be bound to named
 *     and ordinal parameters defined by the query.
 * 
 *
 * @author Steve Ebersole
 */
@Incubating
public interface MutationQuery extends CommonQueryContract {

	/**
	 * Execute an insert, update, or delete statement, and return the
	 * number of affected entities.
	 * 
	 * For use with instances of {@code MutationQuery} created using
	 * {@link QueryProducer#createMutationQuery(String)},
	 * {@link QueryProducer#createNamedMutationQuery(String)},
	 * {@link QueryProducer#createNativeMutationQuery(String)},
	 * {@link QueryProducer#createQuery(jakarta.persistence.criteria.CriteriaUpdate)}, or
	 * {@link QueryProducer#createQuery(jakarta.persistence.criteria.CriteriaDelete)}.
	 *
	 * @return the number of affected entity instances
	 *         (may differ from the number of affected rows)
	 *
	 * @see QueryProducer#createMutationQuery(String)
	 * @see QueryProducer#createNamedMutationQuery(String)
	 * @see QueryProducer#createNativeMutationQuery(String)
	 *
	 * @see jakarta.persistence.Query#executeUpdate()
	 */
	int executeUpdate();


	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Covariant returns

	@Override
	MutationQuery setFlushMode(FlushModeType flushMode);

	@Override
	MutationQuery setHibernateFlushMode(FlushMode flushMode);

	@Override
	MutationQuery setTimeout(int timeout);

	@Override
	MutationQuery setComment(String comment);

	@Override
	MutationQuery setHint(String hintName, Object value);

	@Override
	MutationQuery setParameter(String name, Object value);

	@Override
	
 MutationQuery setParameter(String name, P value, Class
 type);

	@Override
	
 MutationQuery setParameter(String name, P value, BindableType
 type);

	@Override
	MutationQuery setParameter(String name, Instant value, TemporalType temporalType);

	@Override
	MutationQuery setParameter(String name, Calendar value, TemporalType temporalType);

	@Override
	MutationQuery setParameter(String name, Date value, TemporalType temporalType);

	@Override
	MutationQuery setParameter(int position, Object value);

	@Override
	
 MutationQuery setParameter(int position, P value, Class
 type);

	@Override
	
 MutationQuery setParameter(int position, P value, BindableType
 type);

	@Override
	MutationQuery setParameter(int position, Instant value, TemporalType temporalType);

	@Override
	MutationQuery setParameter(int position, Date value, TemporalType temporalType);

	@Override
	MutationQuery setParameter(int position, Calendar value, TemporalType temporalType);

	@Override
	 MutationQuery setParameter(QueryParameter parameter, T value);

	@Override
	
 MutationQuery setParameter(QueryParameter
 parameter, P value, Class
 type);

	@Override
	
 MutationQuery setParameter(QueryParameter
 parameter, P val, BindableType
 type);

	@Override
	 MutationQuery setParameter(Parameter param, T value);

	@Override
	MutationQuery setParameter(Parameter param, Calendar value, TemporalType temporalType);

	@Override
	MutationQuery setParameter(Parameter param, Date value, TemporalType temporalType);

	@Override
	MutationQuery setParameterList(String name, @SuppressWarnings("rawtypes") Collection values);

	@Override
	
 MutationQuery setParameterList(String name, Collection values, Class
 javaType);

	@Override
	
 MutationQuery setParameterList(String name, Collection values, BindableType
 type);

	@Override
	MutationQuery setParameterList(String name, Object[] values);

	@Override
	
 MutationQuery setParameterList(String name, P[] values, Class
 javaType);

	@Override
	
 MutationQuery setParameterList(String name, P[] values, BindableType
 type);

	@Override
	MutationQuery setParameterList(int position, @SuppressWarnings("rawtypes") Collection values);

	@Override
	
 MutationQuery setParameterList(int position, Collection values, Class
 javaType);

	@Override
	
 MutationQuery setParameterList(int position, Collection values, BindableType
 type);

	@Override
	MutationQuery setParameterList(int position, Object[] values);

	@Override
	
 MutationQuery setParameterList(int position, P[] values, Class
 javaType);

	@Override
	
 MutationQuery setParameterList(int position, P[] values, BindableType
 type);

	@Override
	
 MutationQuery setParameterList(QueryParameter
 parameter, Collection values);

	@Override
	
 MutationQuery setParameterList(QueryParameter
 parameter, Collection values, Class
 javaType);

	@Override
	
 MutationQuery setParameterList(QueryParameter
 parameter, Collection values, BindableType
 type);

	@Override
	
 MutationQuery setParameterList(QueryParameter
 parameter, P[] values);

	@Override
	
 MutationQuery setParameterList(QueryParameter
 parameter, P[] values, Class
 javaType);

	@Override
	
 MutationQuery setParameterList(QueryParameter
 parameter, P[] values, BindableType type);

	@Override
	MutationQuery setProperties(Object bean);

	@Override
	MutationQuery setProperties(@SuppressWarnings("rawtypes") Map bean);
}