org.babyfish.jimmer.sql.kt.KSaver.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jimmer-sql-kotlin Show documentation
Show all versions of jimmer-sql-kotlin Show documentation
A revolutionary ORM framework for both java and kotlin
package org.babyfish.jimmer.sql.kt
import org.babyfish.jimmer.Input
import org.babyfish.jimmer.sql.ast.mutation.AssociatedSaveMode
import org.babyfish.jimmer.sql.ast.mutation.SaveMode
import org.babyfish.jimmer.sql.kt.ast.mutation.KBatchSaveResult
import org.babyfish.jimmer.sql.kt.ast.mutation.KSaveCommandDsl
import org.babyfish.jimmer.sql.kt.ast.mutation.KSaveCommandPartialDsl
import org.babyfish.jimmer.sql.kt.ast.mutation.KSimpleSaveResult
import java.sql.Connection
interface KSaver {
/**
* Save an entity object
* @param entity The saved entity object.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* - The default value of the [SaveMode] of aggregate-root is [SaveMode.UPSERT],
* it can be overwritten by the lambda represented by the parameter `block`
* - The default value of the [AssociatedSaveMode] of associated objects is [AssociatedSaveMode.REPLACE],
* it can be overwritten by the lambda represented by the parameter `block`
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun save(
entity: E,
con: Connection? = null,
block: (KSaveCommandDsl.() -> Unit)? = null
): KSimpleSaveResult
/**
* Save an entity object
* @param entity The saved entity object.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* @param mode The save mode of aggregate-root
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional, its default value is [AssociatedSaveMode.REPLACE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun save(
entity: E,
mode: SaveMode,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.REPLACE,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(entity, con) {
setMode(mode)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Save an entity object
* @param entity The saved entity object.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.UPSERT]
*
* @param associatedMode The save mode of associated-objects.
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun save(
entity: E,
associatedMode: AssociatedSaveMode,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(entity, con) {
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Save an input DTO
* @param input The saved input DTO.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* - The default value of the [SaveMode] of aggregate-root is [SaveMode.UPSERT],
* it can be overwritten by the lambda represented by the parameter `block`
* - The default value of the [AssociatedSaveMode] of associated objects is [AssociatedSaveMode.REPLACE],
* it can be overwritten by the lambda represented by the parameter `block`
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun save(
input: Input,
con: Connection? = null,
block: (KSaveCommandDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(input.toEntity(), con) {
block?.invoke(this)
}
/**
* Save an input DTO
* @param input The saved input DTO.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* @param mode The save mode of aggregate-root
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional, its default value is [AssociatedSaveMode.REPLACE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun save(
input: Input,
mode: SaveMode,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.REPLACE,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(input.toEntity(), con) {
setMode(mode)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Save an input DTO
* @param input The saved input DTO.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.UPSERT]
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional, its default value is [AssociatedSaveMode.REPLACE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun save(
input: Input,
associatedMode: AssociatedSaveMode,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(input.toEntity(), con) {
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Insert an entity object
* @param entity The inserted entity object.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.INSERT_ONLY]
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional and its default value [AssociatedSaveMode.APPEND]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun insert(
entity: E,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.APPEND,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(entity, con) {
setMode(SaveMode.INSERT_ONLY)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Insert an input DTO
* @param input The inserted input DTOs.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.INSERT_ONLY]
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional and its default value [AssociatedSaveMode.APPEND]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun insert(
input: Input,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.APPEND,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(input.toEntity(), con) {
setMode(SaveMode.INSERT_ONLY)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Insert an entity object if necessary,
* if the entity object exists in database, ignore it.
* - If the value of id property decorated by [Id] is specified,
* use id value to check whether the entity object exists in database
* - otherwise, if the values of key properties decorated by [Key] is specified
* use key values to check whether the entity object exists in database
* - If neither value of id property nor values of key properties is specified,
* exception will be raised.
*
* @param entity The inserted entity object.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.INSERT_IF_ABSENT]
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional and its default value [AssociatedSaveMode.APPEND_IF_ABSENT]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun insertIfAbsent(
entity: E,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.APPEND_IF_ABSENT,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(entity, con) {
setMode(SaveMode.INSERT_IF_ABSENT)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Insert an input DTO if necessary, that means to convert
* the input DTO to entity object and save it.
* If the entity object exists in database, ignore it.
*
* - If the value of id property decorated by [Id] is specified,
* use id value to check whether the entity object exists in database
* - otherwise, if the values of key properties decorated by [Key] is specified
* use key values to check whether the entity object exists in database
* - If neither value of id property nor values of key properties is specified,
* exception will be raised.
*
* @param input The inserted input DTOs.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.INSERT_IF_ABSENT]
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional and its default value [AssociatedSaveMode.APPEND_IF_ABSENT]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun insertIfAbsent(
input: Input,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.APPEND_IF_ABSENT,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(input.toEntity(), con) {
setMode(SaveMode.INSERT_IF_ABSENT)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Update an entity object
* @param entity The updated entity object.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.UPDATE_ONLY]
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional and its default value [AssociatedSaveMode.UPDATE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun update(
entity: E,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.UPDATE,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(entity, con) {
setMode(SaveMode.UPDATE_ONLY)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Update an input DTO
* @param input The updated input DTOs.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.UPDATE_ONLY]
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional and its default value [AssociatedSaveMode.UPDATE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun update(
input: Input,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.UPDATE,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(input.toEntity(), con) {
setMode(SaveMode.UPDATE_ONLY)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Merge an entity object
* @param entity The merged entity object.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.UPSERT]
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional and its default value [AssociatedSaveMode.UPDATE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun merge(
entity: E,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(entity, con) {
setMode(SaveMode.UPSERT)
setAssociatedModeAll(AssociatedSaveMode.MERGE)
block?.invoke(this)
}
/**
* Merge an input DTO
* @param input The merged input DTOs.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The [SaveMode] of aggregate-root is [SaveMode.UPSERT]
*
* @param associatedMode The save mode of associated-objects.
* This parameter is optional and its default value [AssociatedSaveMode.MERGE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
* In addition to setting the [SaveMode] of aggregate root
* and the default value of the [AssociatedSaveMode] of associated objects,
* you can add any other configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for single object
*/
fun merge(
input: Input,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KSimpleSaveResult =
save(input.toEntity(), con) {
setMode(SaveMode.UPSERT)
setAssociatedModeAll(AssociatedSaveMode.MERGE)
block?.invoke(this)
}
/**
* Save some entity objects
* @param entities The saved entity objects.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* - The default value of the [SaveMode] of aggregate-roots is [SaveMode.UPSERT],
* it can be overwritten by the lambda represented by the parameter `block`
* - The default value of the [AssociatedSaveMode] of associated objects is [AssociatedSaveMode.REPLACE],
* it can be overwritten by the lambda represented by the parameter `block`
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for multiple objects
*/
fun saveEntities(
entities: Iterable,
con: Connection? = null,
block: (KSaveCommandDsl.() -> Unit)? = null
): KBatchSaveResult
/**
* Save some entity objects
* @param entities The saved entity objects.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* @param mode The save mode of aggregate-roots
*
* @param associatedMode The associated save mode for associated objects,
* its default value is [AssociatedSaveMode.REPLACE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for multiple objects
*/
fun saveEntities(
entities: Iterable,
mode: SaveMode,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.REPLACE,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
saveEntities(entities, con) {
setMode(mode)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Save some entity objects
* @param entities The saved entity objects.
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* - The default value of the [SaveMode] of aggregate-roots is [SaveMode.UPSERT],
* it can be overwritten by the lambda represented by the parameter `block`
*
* @param associatedMode The associated save mode for associated objects,
* its default value is [AssociatedSaveMode.REPLACE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for multiple objects
*/
fun saveEntities(
entities: Iterable,
associatedMode: AssociatedSaveMode,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
saveEntities(entities, con) {
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Save some input DTOs
*
* @param inputs The saved entity inputs.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* - The default value of the [SaveMode] of aggregate-roots is [SaveMode.UPSERT],
* it can be overwritten by the lambda represented by the parameter `block`
* - The default value of the [AssociatedSaveMode] of associated objects is [AssociatedSaveMode.REPLACE],
* it can be overwritten by the lambda represented by the parameter `block`
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for multiple objects
*/
fun saveInputs(
inputs: Iterable>,
con: Connection? = null,
block: (KSaveCommandDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveEntities(inputs.map(Input::toEntity), con, block)
/**
* Save some input DTOs
*
* @param inputs The saved entity inputs.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* @param mode The save mode of aggregate-roots
*
* @param associatedMode The associated save mode of associated objects,
* its default value is [AssociatedSaveMode.REPLACE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for multiple objects
*/
fun saveInputs(
inputs: Iterable>,
mode: SaveMode,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.REPLACE,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveEntities(inputs.map(Input::toEntity), con) {
setMode(mode)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
/**
* Save some input DTOs
*
* @param inputs The saved entity inputs.
*
* In terms of internal mechanisms, any type of Input DTO is
* automatically converted into an entity object of the same type
*
* **Note: The jimmer entity is not POJO**,
* it can easily express data structures of arbitrary shape,
* you can use it to save data structures of arbitrary shape.
*
* Unlike most JVM ORMs, Jimmer does not specified the shape
* of the saved data structure by using configuration such as
* `insertable`, `updatable` or `cascade`; instead,
* it uses the dynamic nature of entity object itself to describe
* the shape of saved data structure, **without prior design**
*
* Unspecified properties will be ignored,
* only the specified properties *(whether null or not)* will be saved.
* In addition to objects with only id property, any associated objects
* will result in deeper recursive saves.
*
* The default value of the [SaveMode] of aggregate-roots is [SaveMode.UPSERT],
* it can be overwritten by the lambda represented by the parameter `block`
*
* @param associatedMode The associated save mode of associated objects,
* its default value is [AssociatedSaveMode.REPLACE]
*
* @param con An optional JDBC connection. If it is null,
* a connection will be brown from [org.babyfish.jimmer.sql.runtime.ConnectionManager]
*
* @param block An optional lambda to add additional configuration.
*
* @param [E] The type of saved entity
*
* @return The saved result for multiple objects
*/
fun saveInputs(
inputs: Iterable>,
associatedMode: AssociatedSaveMode,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveEntities(inputs.map(Input::toEntity), con) {
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
fun insertEntities(
entities: Iterable,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.APPEND,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveEntities(entities, con) {
setMode(SaveMode.INSERT_ONLY)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
fun insertInputs(
inputs: Iterable>,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.APPEND,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveInputs(inputs, con) {
setMode(SaveMode.INSERT_ONLY)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
fun insertEntitiesIfAbsent(
entities: Iterable,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.APPEND_IF_ABSENT,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveEntities(entities, con) {
setMode(SaveMode.INSERT_IF_ABSENT)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
fun insertInputsIfAbsent(
inputs: Iterable>,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.APPEND_IF_ABSENT,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveInputs(inputs, con) {
setMode(SaveMode.INSERT_IF_ABSENT)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
fun updateEntities(
entities: Iterable,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.UPDATE,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveEntities(entities, con) {
setMode(SaveMode.UPDATE_ONLY)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
fun updateInputs(
inputs: Iterable>,
associatedMode: AssociatedSaveMode = AssociatedSaveMode.UPDATE,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveInputs(inputs, con) {
setMode(SaveMode.UPDATE_ONLY)
setAssociatedModeAll(associatedMode)
block?.invoke(this)
}
fun mergeEntities(
entities: Iterable,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveEntities(entities, con) {
setMode(SaveMode.UPSERT)
setAssociatedModeAll(AssociatedSaveMode.MERGE)
block?.invoke(this)
}
fun mergeInputs(
inputs: Iterable>,
con: Connection? = null,
block: (KSaveCommandPartialDsl.() -> Unit)? = null
): KBatchSaveResult =
this.saveInputs(inputs, con) {
setMode(SaveMode.UPSERT)
setAssociatedModeAll(AssociatedSaveMode.MERGE)
block?.invoke(this)
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy