sirius.db.jdbc.batch

Class UpdateQuery<E extends SQLEntity>

java.lang.Object

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

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

Type Parameters:

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

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

Represents a batch query which updates an entity in the database.

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	UpdateQuery(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().
protected List<Property>	getPropertiesToUpdate()
void	update(E entity, boolean invokeChecks, boolean addBatch) Updates the given entity in the database by comparing the mappings to compare and updating the mappings to update.
UpdateQuery<E>	withUpdatedMappings(Mapping... mappingsToUpdate) Specifies the list of mappings to update.
UpdateQuery<E>	withUpdatedMappings(String... mappingsToUpdate) Specifies the list of mappings to update.

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

UpdateQuery

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

Method Detail

withUpdatedMappings

public UpdateQuery<E> withUpdatedMappings(Mapping... mappingsToUpdate)

Specifies the list of mappings to update.

Note that this must be called once before this first entity is updated and cannot be changed later.

Parameters:

mappingsToUpdate - a list of mappings to update

Returns:

the query itself for fluent method calls

withUpdatedMappings

public UpdateQuery<E> withUpdatedMappings(String... mappingsToUpdate)

Specifies the list of mappings to update.

Note that this must be called once before this first entity is updated and cannot be changed later.

Parameters:

mappingsToUpdate - a list of mappings to update

Returns:

the query itself for fluent method calls

getPropertiesToUpdate

protected List<Property> getPropertiesToUpdate()

update

public void update(@Nonnull
                   E entity,
                   boolean invokeChecks,
                   boolean addBatch)

Updates the given entity in the database by comparing the mappings to compare and updating the mappings to update.

Parameters:

entity - the entity to update

invokeChecks - determines if before- and after save checks should be performed (true) or skipped (false)

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