Module is.codion.framework.db.core
Package is.codion.framework.db
Interface EntityConnection.BatchCopy.Builder
- Enclosing interface:
- EntityConnection.BatchCopy
public static interface EntityConnection.BatchCopy.Builder
A builder for a
EntityConnection.BatchCopy operation.-
Method Summary
Modifier and TypeMethodDescriptionbatchSize(int batchSize) build()conditions(is.codion.framework.domain.entity.condition.Condition... conditions) entityTypes(is.codion.framework.domain.entity.EntityType... entityTypes) voidexecute()Builds and executes this copy operationincludePrimaryKeys(boolean includePrimaryKeys)
-
Method Details
-
entityTypes
EntityConnection.BatchCopy.Builder entityTypes(is.codion.framework.domain.entity.EntityType... entityTypes) - Parameters:
entityTypes- the entity types to copy- Returns:
- this builder instance
-
conditions
EntityConnection.BatchCopy.Builder conditions(is.codion.framework.domain.entity.condition.Condition... conditions) - Parameters:
conditions- the conditions to use when determining which entities of the given type to copy- Returns:
- this builder instance
-
batchSize
- Parameters:
batchSize- the commit batch size- Returns:
- this buildr instance
- Throws:
IllegalArgumentException- ifbatchSizeis not a positive integer
-
includePrimaryKeys
- Parameters:
includePrimaryKeys- true if the primary key values should be included when copying- Returns:
- this builder instance
-
execute
void execute() throws is.codion.common.db.exception.DatabaseExceptionBuilds and executes this copy operation- Throws:
is.codion.common.db.exception.DatabaseException- in case of an exception
-
build
EntityConnection.BatchCopy build()- Returns:
- a new
EntityConnection.BatchCopyinstance
-