sirius.db.jdbc.batch

Class BatchContext

java.lang.Object

sirius.db.jdbc.batch.BatchContext

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public class BatchContext
extends Object
implements Closeable

Bundles the preparation and execution of a bunch of batch queries.

Constructor Summary

Constructors

Constructor and Description
BatchContext(Supplier<String> description, Duration expectedDuration) Creates a new context with the given debugging description and the expected runtime.

Method Summary

Modifier and Type	Method and Description
DeleteQuery<?>	autoDeleteQuery(String... mappingsToCompare) Returns an autoinitializing delete query.
FindQuery<?>	autoFindQuery(String... mappingsToCompare) Returns an autoinitializing find query.
InsertQuery<?>	autoInsertQuery(boolean fetchId, String... mappingsToInsert) Returns an autoinitializing insert query.
InsertQuery<?>	autoInsertQuery(String... mappingsToInsert) Returns an autoinitializing insert query.
UpdateQuery<?>	autoUpdateByIdQuery(String... mappingsToUpdate) Returns an autoinitializing update query which uses SQLEntity.ID as mapping to compare.
UpdateQuery<?>	autoUpdateQuery(String... mappingsToCompare) Returns an autoinitializing update query.
void	close()
protected Connection	createConnection(String realm)
CustomQuery	customQuery(Class<? extends SQLEntity> type, boolean fetchId, String sql) Prepares the given SQL statement as custom query.
<E extends SQLEntity> DeleteQuery<E>	deleteQuery(Class<E> type, Mapping... mappingsToCompare) Creates a new delete query.
<E extends SQLEntity> FindQuery<E>	findQuery(Class<E> type, Mapping... mappingsToCompare) Creates a find query.
protected Connection	getConnection(String realm)
<E extends SQLEntity> InsertQuery<E>	insertQuery(Class<E> type, boolean fetchId, Mapping... mappingsToInsert) Creates a new insert query.
<E extends SQLEntity> InsertQuery<E>	insertQuery(Class<E> type, Mapping... mappingsToInsert) Creates a new insert query.
protected void	safeClose()
protected static String[]	simplifyMappings(Mapping[] mappingsToCompare)
String	toString()
protected void	unregister(BatchQuery<?> query)
<E extends SQLEntity> UpdateQuery<E>	updateByIdQuery(Class<E> type, Mapping... mappingsToUpdate) Creates a new update query which uses SQLEntity.ID as mapping to compare.
<E extends SQLEntity> UpdateQuery<E>	updateQuery(Class<E> type, Mapping... mappingsToCompare) Creates a new update query.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchContext

public BatchContext(Supplier<String> description,
                    Duration expectedDuration)

Creates a new context with the given debugging description and the expected runtime.

Parameters:

description - a provider for a description used for debugging purposes

expectedDuration - the expected duration of the whole batch operation

Method Detail

unregister

protected void unregister(BatchQuery<?> query)

simplifyMappings

protected static String[] simplifyMappings(Mapping[] mappingsToCompare)

getConnection

protected Connection getConnection(String realm)

createConnection

protected Connection createConnection(String realm)

safeClose

protected void safeClose()

findQuery

public <E extends SQLEntity> FindQuery<E> findQuery(Class<E> type,
                                                    Mapping... mappingsToCompare)

Creates a find query.

Type Parameters:

E - the generic type of the entities to find

Parameters:

type - the type of entities to find

mappingsToCompare - the mappings to compare in order to find an entity

Returns:

the query used to find entities

autoFindQuery

public FindQuery<?> autoFindQuery(String... mappingsToCompare)

Returns an autoinitializing find query.

Based on the first call passed to FindQuery.find(SQLEntity) the type of entities to resolve is determined.

This is used in JavaScript as there is no real notion of class literals. Also it is quite simpler to provide mappings as string rather than as real Mapping.

Parameters:

mappingsToCompare - the mappings to compare in order to find an entity

Returns:

the query used to find entities

insertQuery

public <E extends SQLEntity> InsertQuery<E> insertQuery(Class<E> type,
                                                        boolean fetchId,
                                                        Mapping... mappingsToInsert)

Creates a new insert query.

Type Parameters:

E - the generic type of the entities to insert

Parameters:

type - the type of entities to insert

fetchId - true if generated id should be fetched, false otherwise

mappingsToInsert - the fields or mappings to insert

Returns:

the query used to insert entities into the database

autoInsertQuery

public InsertQuery<?> autoInsertQuery(boolean fetchId,
                                      String... mappingsToInsert)

Returns an autoinitializing insert query.

Parameters:

fetchId - true if generated id should be fetched, false otherwise

mappingsToInsert - the fields or mappings to insert

Returns:

the query used to find entities

See Also:

autoFindQuery(String...)

insertQuery

public <E extends SQLEntity> InsertQuery<E> insertQuery(Class<E> type,
                                                        Mapping... mappingsToInsert)

Creates a new insert query.

Type Parameters:

E - the generic type of the entities to insert

Parameters:

type - the type of entities to insert

mappingsToInsert - the fields or mappings to insert

Returns:

the query used to insert entities into the database

autoInsertQuery

public InsertQuery<?> autoInsertQuery(String... mappingsToInsert)

Returns an autoinitializing insert query.

Parameters:

mappingsToInsert - the fields or mappings to insert

Returns:

the query used to find entities

See Also:

autoFindQuery(String...)

updateQuery

public <E extends SQLEntity> UpdateQuery<E> updateQuery(Class<E> type,
                                                        Mapping... mappingsToCompare)

Creates a new update query.

Type Parameters:

E - the generic type of the entities to update

Parameters:

type - the type of entities to update

mappingsToCompare - the mappings to compare in order to find the entity to update

Returns:

the query used to update entities in the database

autoUpdateQuery

public UpdateQuery<?> autoUpdateQuery(String... mappingsToCompare)

Returns an autoinitializing update query.

Parameters:

mappingsToCompare - the mappings to compare in order to find the entity to update

Returns:

the query used to update entities in the database

See Also:

autoFindQuery(String...)

updateByIdQuery

public <E extends SQLEntity> UpdateQuery<E> updateByIdQuery(Class<E> type,
                                                            Mapping... mappingsToUpdate)

Creates a new update query which uses SQLEntity.ID as mapping to compare.

Type Parameters:

E - the generic type of the entities to update

Parameters:

type - the type of entities to insert

mappingsToUpdate - the mappings to update

Returns:

the query used to update entities in the database

autoUpdateByIdQuery

public UpdateQuery<?> autoUpdateByIdQuery(String... mappingsToUpdate)

Returns an autoinitializing update query which uses SQLEntity.ID as mapping to compare.

Parameters:

mappingsToUpdate - the mappings to update

Returns:

the query used to update entities in the database

See Also:

autoFindQuery(String...)

deleteQuery

public <E extends SQLEntity> DeleteQuery<E> deleteQuery(Class<E> type,
                                                        Mapping... mappingsToCompare)

Creates a new delete query.

Type Parameters:

E - the generic type of the entities to delete

Parameters:

type - the type of entities to delete

mappingsToCompare - the mappings to compare in order to find the entity to delete

Returns:

the query used to delete entities in the database

autoDeleteQuery

public DeleteQuery<?> autoDeleteQuery(String... mappingsToCompare)

Returns an autoinitializing delete query.

Parameters:

mappingsToCompare - the mappings to compare in order to find the entity to delete

Returns:

the query used to delete entities in the database

See Also:

autoFindQuery(String...)

customQuery

public CustomQuery customQuery(Class<? extends SQLEntity> type,
                               boolean fetchId,
                               String sql)

Prepares the given SQL statement as custom query.

Parameters:

type - the type of entities to process

fetchId - determines if generated IDs should be fetched

sql - the statement to prepare

Returns:

the prepared statement wrapped as custom query

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object