com.atlassian.crowd.util.persistence.hibernate

Class HqlInClauseBatchHelper

java.lang.Object

com.atlassian.crowd.util.persistence.hibernate.HqlInClauseBatchHelper

public class HqlInClauseBatchHelper
extends Object

A reusable batching helper for HQL queries using "in" clause with a list of parameters. This helper is here to help with not exceeding the in clause limit on various databases Clients may supply a Consumer instances for applying various parameters for Hibernate Query. Default batch size is 1000 elements provided to "in" clause, which can be overwritten using "crowd.query.in.batch.size" system property

Sample usage:

 
 final List<String> parameters = Lists.newArrayList("param1", "param2")
 HqlInClauseBatchHelper
      .ofNamedQuery(session, "removeInternalUserAttributesById")
      .executeUpdate("parametersNames", parameters);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HqlInClauseBatchHelper.HqlInClauseBatchHelperBuilder

Method Summary

Modifier and Type	Method and Description
<T> void	executeUpdate(String inClauseParameterName, Iterable<T> inClauseObjects) Executes HQL query in batches
static HqlInClauseBatchHelper.HqlInClauseBatchHelperBuilder	ofHqlQuery(org.hibernate.Session session, String query) Constructs a new builder for HQL "in" clause helper with supplied hibernate session object and HQL query
static HqlInClauseBatchHelper.HqlInClauseBatchHelperBuilder	ofNamedQuery(org.hibernate.Session session, String queryName) Constructs a new builder for HQL "in" clause helper with supplied hibernate session object and query name
<T> List<T>	query(String inClauseParameterName, Iterable<?> inClauseObjects)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

ofNamedQuery

public static HqlInClauseBatchHelper.HqlInClauseBatchHelperBuilder ofNamedQuery(org.hibernate.Session session,
                                                                                String queryName)

Constructs a new builder for HQL "in" clause helper with supplied hibernate session object and query name

Parameters:

session - hibernate session object

queryName - name of the HQL query

Returns:

new HqlInClauseBatchHelperBuilder

ofHqlQuery

public static HqlInClauseBatchHelper.HqlInClauseBatchHelperBuilder ofHqlQuery(org.hibernate.Session session,
                                                                              String query)

Constructs a new builder for HQL "in" clause helper with supplied hibernate session object and HQL query

Parameters:

session - hibernate session object

query - the HQL query

Returns:

new HqlInClauseBatchHelperBuilder

executeUpdate

public <T> void executeUpdate(String inClauseParameterName,
                              Iterable<T> inClauseObjects)

Executes HQL query in batches

Type Parameters:

T - represents a type of objects supplied to the query

Parameters:

inClauseParameterName - name of the in clause parameter in query

inClauseObjects - list of parameters that will be supplied to in cluase parameter in query

query

public <T> List<T> query(String inClauseParameterName,
                         Iterable<?> inClauseObjects)