sirius.db.jdbc.batch

Class BatchQuery<E extends SQLEntity>

java.lang.Object

sirius.db.jdbc.batch.BatchQuery<E>

Type Parameters:

E - the type of entities being processed by this query.

Direct Known Subclasses:

CustomQuery, DeleteQuery, FindQuery, InsertQuery, UpdateQuery

public abstract class BatchQuery<E extends SQLEntity>
extends Object

Provides an abstract wrapper around a PreparedStatement to be used within a BatchContext.

Field Summary

Fields

Modifier and Type	Field and Description
protected sirius.kernel.health.Average	avarage
protected int	batchBacklog
protected int	batchBacklogLimit
protected BatchContext	context
protected EntityDescriptor	descriptor
protected String[]	mappings
static int	MAX_BATCH_BACKLOG Defines the default batch size used by a query.
protected static Mixing	mixing
protected static OMA	oma
protected List<Property>	properties
protected String	query
protected PreparedStatement	stmt
protected Class<E>	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BatchQuery(BatchContext context, Class<E> type, String[] mappings) Creates a new instance for the given context, type and mappings.

Method Summary

Modifier and Type	Method and Description
protected void	addBatch() Adds the current parameter set as batch.
protected abstract void	buildSQL() Determines the SQL statement to prepare in prepareStmt().
void	close() Closes the query by executing the last batch and releasing all resources.
void	commit() Forces a batch to be processed (independent of it size, as long as it isn't empty).
protected void	createStmt(String sql, boolean returnGeneratedKeys) Prepares a new statement for the given sql and options.
protected EntityDescriptor	getDescriptor() Determines the descriptor for the our entity type.
protected List<Property>	getProperties() Transforms the mappings into a list of properties.
protected PreparedStatement	prepareStmt() Prepares a new statement if not done already.
protected void	safeClose() Releases all resources with graceful error handling
String	toString()
protected void	tryCommit(boolean cascade)
void	withCustomBatchLimit(int maxBacklog) Specifies a custom batch size for this query.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_BATCH_BACKLOG

public static final int MAX_BATCH_BACKLOG

Defines the default batch size used by a query.

See Also:

Constant Field Values

context

protected BatchContext context

stmt

protected PreparedStatement stmt

batchBacklog

protected int batchBacklog

batchBacklogLimit

protected int batchBacklogLimit

type

protected Class<E extends SQLEntity> type

mappings

protected final String[] mappings

properties

protected List<Property> properties

descriptor

protected EntityDescriptor descriptor

query

protected String query

avarage

protected sirius.kernel.health.Average avarage

oma

protected static OMA oma

mixing

protected static Mixing mixing

Constructor Detail

BatchQuery

protected BatchQuery(BatchContext context,
                     Class<E> type,
                     String[] mappings)

Creates a new instance for the given context, type and mappings.

Parameters:

context - the batch context to participate in

type - the type of entities being processed

mappings - the mappings to process

Method Detail

withCustomBatchLimit

public void withCustomBatchLimit(int maxBacklog)

Specifies a custom batch size for this query.

Parameters:

maxBacklog - the max. batch size to process

tryCommit

protected void tryCommit(boolean cascade)

commit

public void commit()

Forces a batch to be processed (independent of it size, as long as it isn't empty).

addBatch

protected void addBatch()
                 throws SQLException

Adds the current parameter set as batch.

Throws:

SQLException - in case of a database error

createStmt

protected void createStmt(String sql,
                          boolean returnGeneratedKeys)
                   throws SQLException

Prepares a new statement for the given sql and options.

Parameters:

sql - the statement to prepare

returnGeneratedKeys - determines if generated key should be returned or not

Throws:

SQLException - in case of a database error

prepareStmt

protected PreparedStatement prepareStmt()
                                 throws SQLException

Prepares a new statement if not done already.

Returns:

the prepared statment

Throws:

SQLException - in case of a database error

buildSQL

protected abstract void buildSQL()
                          throws SQLException

Determines the SQL statement to prepare in prepareStmt().

Throws:

SQLException - in case of a database error

getDescriptor

protected EntityDescriptor getDescriptor()

Determines the descriptor for the our entity type.

Returns:

the descriptor for the type of entities this query can process

getProperties

protected List<Property> getProperties()

Transforms the mappings into a list of properties.

Returns:

the list of properties defined by the given list of mappings

close

public void close()

Closes the query by executing the last batch and releasing all resources.

safeClose

protected void safeClose()

Releases all resources with graceful error handling

toString

public String toString()

Overrides:

toString in class Object