sirius.db.jdbc.batch

Class DeleteQuery<E extends SQLEntity>

java.lang.Object

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

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

Type Parameters:

E - the generic type of entities to delete with this query

public class DeleteQuery<E extends SQLEntity>
extends BatchQuery<E>

Represents a batch query which deletes one or more entities from the database.

A query is created by enumerating which mappings to compare in order to identify entities to delete. The query is then supplied with an example entity from which the values are derived.

Field Summary

Fields inherited from class sirius.db.jdbc.batch.BatchQuery

avarage, batchBacklog, batchBacklogLimit, context, descriptor, mappings, MAX_BATCH_BACKLOG, mixing, oma, properties, query, stmt, type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeleteQuery(BatchContext context, Class<E> type, String[] mappings)

Method Summary

Modifier and Type	Method and Description
protected void	buildSQL() Determines the SQL statement to prepare in BatchQuery.prepareStmt().
void	delete(E example, boolean invokeChecks, boolean addBatch) Deletes all entities where the compared mappings match the ones given in the example.

Methods inherited from class sirius.db.jdbc.batch.BatchQuery

addBatch, close, commit, createStmt, getDescriptor, getProperties, prepareStmt, safeClose, toString, tryCommit, withCustomBatchLimit

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteQuery

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

Method Detail

delete

public void delete(@Nonnull
                   E example,
                   boolean invokeChecks,
                   boolean addBatch)

Deletes all entities where the compared mappings match the ones given in the example.

Parameters:

example - the example entity used to determine which other entities to delete

invokeChecks - true to signal that before- and after delete checks should be executed, false otherwise

addBatch - determines if the query should be executed instantly (false) or added to the batch update (true).

buildSQL

protected void buildSQL()
                 throws SQLException

Description copied from class: BatchQuery

Determines the SQL statement to prepare in BatchQuery.prepareStmt().

Specified by:

buildSQL in class BatchQuery<E extends SQLEntity>

Throws:

SQLException - in case of a database error