jimmer-sql-kotlin/org.babyfish.jimmer.sql.kt.cfg/KSqlClientDsl

KSqlClientDsl

class KSqlClientDsl

Types

ConnectionManagerDsl

class ConnectionManagerDsl

Functions

addCacheAbandonedCallback

fun addCacheAbandonedCallback(callback: CacheAbandonedCallback)

addCacheAbandonedCallbacks

fun addCacheAbandonedCallbacks(callbacks: Collection<CacheAbandonedCallback>)

fun addCustomizers(vararg customers: KCustomizer)

fun addCustomizers(customers: Collection<KCustomizer>)

addDisabledFilters

fun addDisabledFilters(vararg filters: KFilter<*>)

fun addDisabledFilters(filters: Collection<KFilter<*>>)

addDraftInterceptor

fun addDraftInterceptor(interceptor: DraftInterceptor<*>)

addDraftInterceptors

fun addDraftInterceptors(vararg interceptors: DraftInterceptor<*>)

fun addDraftInterceptors(interceptor: List<DraftInterceptor<*>>)

fun addFilters(vararg filters: KFilter<*>)

fun addFilters(filters: Collection<KFilter<*>>)

addInitializers

fun addInitializers(vararg initializers: KInitializer)

fun addInitializers(initializers: Collection<KInitializer>)

addScalarProvider

fun addScalarProvider(scalarProvider: ScalarProvider<*, *>)

ignoreBuiltInFilters

fun ignoreBuiltInFilters()

setBinLogPropReader

fun setBinLogPropReader(type: KClass<*>, reader: BinLogPropReader)

fun setBinLogPropReader(prop: KProperty1<*, *>, reader: BinLogPropReader)

setCacheFactory

fun setCacheFactory(cacheFactory: CacheFactory)

setCacheOperator

fun setCacheOperator(cacheOperator: CacheOperator)

fun setCaches(block: KSqlClientDsl.CacheDsl.() -> Unit)

setConnectionManager

fun setConnectionManager(block: KSqlClientDsl.ConnectionManagerDsl.() -> Unit)

fun setConnectionManager(connectionManager: ConnectionManager)

setDatabaseNamingStrategy

fun setDatabaseNamingStrategy(strategy: DatabaseNamingStrategy)

setDatabaseValidationCatalog

fun setDatabaseValidationCatalog(catalog: String?)

setDatabaseValidationMode

fun setDatabaseValidationMode(mode: DatabaseValidationMode)

setDatabaseValidationSchema

fun setDatabaseValidationSchema(schema: String?)

setDefaultBatchSize

fun setDefaultBatchSize(size: Int)

setDefaultBinLogObjectMapper

fun setDefaultBinLogObjectMapper(mapper: ObjectMapper)

setDefaultEnumStrategy

fun setDefaultEnumStrategy(strategy: EnumType.Strategy)

setDefaultListBatchSize

fun setDefaultListBatchSize(size: Int)

setDefaultSerializedTypeObjectMapper

fun setDefaultSerializedTypeObjectMapper(mapper: ObjectMapper)

fun setDialect(dialect: Dialect)

setEntityManager

fun setEntityManager(entityManager: EntityManager)

Under normal circumstances, users do not need to set the entity manager.

fun setExecutor(executor: Executor?)

setExecutorContextPrefixes

fun setExecutorContextPrefixes(prefixes: Collection<String>)

If this option is configured, when jimmer calls back org.babyfish.jimmer.sql.runtime.Executor.execute before executing SQL, it will check the stack trace information of the current thread.

setForeignKeyEnabledByDefault

fun setForeignKeyEnabledByDefault(enabled: Boolean)

This configuration is only useful for {@link org.babyfish.jimmer.sql.JoinColumn} of local associations (not remote associations across microservice boundaries) whose foreignKeyType is specified as AUTO.Its value indicates whether the foreign key is real, that is, whether there is a foreign key constraint in the database.

fun setIdGenerator(idGenerator: IdGenerator)

fun setIdGenerator(entityType: KClass<*>, idGenerator: IdGenerator)

setIdOnlyTargetCheckingLevel

fun setIdOnlyTargetCheckingLevel(checkingLevel: IdOnlyTargetCheckingLevel)

setMicroServiceExchange

fun setMicroServiceExchange(exchange: MicroServiceExchange)

setMicroServiceName

fun setMicroServiceName(microServiceName: String)

setOffsetOptimizingThreshold

fun setOffsetOptimizingThreshold(threshold: Int)

For RDBMS, pagination is slow if offset is large, especially for MySQL.

setSaveCommandPessimisticLock

fun setSaveCommandPessimisticLock(lock: Boolean = true)

setScalarProvider

fun setScalarProvider(prop: KProperty1<*, *>, scalarProvider: ScalarProvider<*, *>)

fun setScalarProvider(prop: ImmutableProp, scalarProvider: ScalarProvider<*, *>)

setSerializedPropObjectMapper

fun setSerializedPropObjectMapper(prop: KProperty1<*, *>, mapper: ObjectMapper)

fun setSerializedPropObjectMapper(prop: ImmutableProp, mapper: ObjectMapper)

setSerializedTypeObjectMapper

fun setSerializedTypeObjectMapper(type: KClass<*>, mapper: ObjectMapper)

setSlaveConnectionManager

fun setSlaveConnectionManager(block: KSqlClientDsl.ConnectionManagerDsl.() -> Unit)

fun setSlaveConnectionManager(connectionManager: ConnectionManager)

setSqlFormatter

fun setSqlFormatter(fFormatter: SqlFormatter)

setTransientResolverProvider

fun setTransientResolverProvider(provider: TransientResolverProvider)

fun setTriggerType(triggerType: TriggerType)

setUserIdGeneratorProvider

fun setUserIdGeneratorProvider(provider: StrategyProvider<UserIdGenerator<*>>)

Properties

val javaBuilder: JSqlClient.Builder