程序包 org.babyfish.jimmer.sql

接口 JSqlClient

所有超级接口:

DeprecatedMoreSaveOperations, DeprecatedSaveOperations, SaveCommandCreator, SaveOperations, SubQueryProvider

所有已知子接口:

JSqlClientImplementor

所有已知实现类:

AbstractJSqlClientDelegate, JLazyInitializationSqlClient

public interface JSqlClient
extends SubQueryProvider, DeprecatedMoreSaveOperations

嵌套类概要

嵌套类

修饰符和类型	接口	说明
static interface	JSqlClient.Builder

方法概要

修饰符和类型	方法	说明
JSqlClient	caches(Consumer<CacheDisableConfig> block)
<SE, ST extends Table<SE>, TE, TT extends Table<TE>> MutableRootQuery<AssociationTable<SE,ST,TE,TT>>	createAssociationQuery(AssociationTable<SE,ST,TE,TT> table)
MutableDelete	createDelete(TableProxy<?> table)
<T extends TableProxy<?>> MutableRootQuery<T>	createQuery(T table)
MutableUpdate	createUpdate(TableProxy<?> table)
default DeleteResult	deleteById(@NotNull Class<?> type, @NotNull Object id, @NotNull DeleteMode mode)
default DeleteResult	deleteById(Class<?> type, Object id)
default DeleteResult	deleteByIds(Class<?> type, Iterable<?> ids)
default DeleteResult	deleteByIds(Class<?> type, Iterable<?> ids, DeleteMode mode)
JSqlClient	disableSlaveConnectionManager()
JSqlClient	executor(Executor executor)
JSqlClient	filters(Consumer<FilterConfig> block)
default <T> T	findById(Class<T> type, Object id)
default <E> E	findById(Fetcher<E> fetcher, Object id)
default <T> @NotNull List<T>	findByIds(Class<T> type, Iterable<?> ids)
default <E> @NotNull List<E>	findByIds(Fetcher<E> fetcher, Iterable<?> ids)
default <K, T> @NotNull Map<K,T>	findMapByIds(Class<T> type, Iterable<K> ids)
default <K, V> @NotNull Map<K,V>	findMapByIds(Fetcher<V> fetcher, Iterable<K> ids)
default <T> T	findOneById(Class<T> type, Object id)
default <E> E	findOneById(Fetcher<E> fetcher, Object id)
Associations	getAssociations(org.babyfish.jimmer.meta.ImmutableProp immutableProp)
Associations	getAssociations(org.babyfish.jimmer.meta.TypedProp.Association<?,?> prop)
Associations	getAssociations(AssociationType associationType)
BinLog	getBinLog()
Caches	getCaches()
Entities	getEntities()
Filters	getFilters()
Triggers	getTriggers()	This method is equivalent to `getTriggers(false)`
Triggers	getTriggers(boolean transaction)	If trigger type is 'BINLOG_ONLY' If `transaction` is true, throws exception If `transaction` is false, return binlog trigger If trigger type is 'TRANSACTION_ONLY', returns transaction trigger no matter what the `transaction` is If trigger type is 'BOTH' If `transaction` is true, return transaction trigger If `transaction` is false, return binlog trigger Note that the objects returned by different parameters are independent of each other.
static JSqlClient.Builder	newBuilder()
default <E> SimpleEntitySaveCommand<E>	saveCommand(E entity)
default <E> BatchEntitySaveCommand<E>	saveEntitiesCommand(Iterable<E> entities)
default <R> R	transaction(Supplier<R> block)	Execute a transaction by the default propagation behavior Propagation.REQUIRED If an IOC framework is used, its implementation should be an encapsulation of the transaction management within the IOC framework.
<R> R	transaction(Propagation propagation, Supplier<R> block)	Execute a transaction by the specified Propagation behavior If an IOC framework is used, its implementation should be an encapsulation of the transaction management within the IOC framework.
@Nullable DatabaseValidationException	validateDatabase()	Validate the database manually.

从接口继承的方法 org.babyfish.jimmer.sql.ast.mutation.DeprecatedMoreSaveOperations

save, save, save, save, save, save, save, save, save, save, save, save, saveEntities, saveEntities, saveEntities, saveEntities, saveEntities, saveEntities, saveInputs, saveInputs, saveInputs, saveInputs, saveInputs, saveInputs

从接口继承的方法 org.babyfish.jimmer.sql.ast.mutation.DeprecatedSaveOperations

insert, insert, insert, insert, insertEntities, insertEntities, insertEntitiesIfAbsent, insertEntitiesIfAbsent, insertIfAbsent, insertIfAbsent, insertIfAbsent, insertIfAbsent, insertInputs, insertInputs, insertInputsIfAbsent, insertInputsIfAbsent, merge, merge, mergeEntities, mergeInputs, save, save, save, save, save, save, save, save, save, save, save, save, saveEntities, saveEntities, saveEntities, saveEntities, saveEntities, saveEntities, saveInputs, saveInputs, saveInputs, saveInputs, saveInputs, saveInputs, update, update, update, update, updateEntities, updateEntities, updateInputs, updateInputs

从接口继承的方法 org.babyfish.jimmer.sql.ast.mutation.SaveCommandCreator

saveCommand, saveInputsCommand

从接口继承的方法 org.babyfish.jimmer.sql.ast.query.SubQueryProvider

createAssociationSubQuery, createSubQuery

方法详细资料

newBuilder

static JSqlClient.Builder newBuilder()

createQuery

<T extends TableProxy<?>> MutableRootQuery<T> createQuery(T table)

createUpdate

MutableUpdate createUpdate(TableProxy<?> table)

createDelete

MutableDelete createDelete(TableProxy<?> table)

createAssociationQuery

<SE,
ST extends Table<SE>,
TE,
TT extends Table<TE>>
MutableRootQuery<AssociationTable<SE,ST,TE,TT>> createAssociationQuery(AssociationTable<SE,ST,TE,TT> table)

getEntities

Entities getEntities()

getTriggers

Triggers getTriggers()

This method is equivalent to `getTriggers(false)`

返回:

getTriggers

Triggers getTriggers(boolean transaction)

• If trigger type is 'BINLOG_ONLY'
  • If `transaction` is true, throws exception
  • If `transaction` is false, return binlog trigger
• If trigger type is 'TRANSACTION_ONLY', returns transaction trigger no matter what the `transaction` is
• If trigger type is 'BOTH'
  • If `transaction` is true, return transaction trigger
  • If `transaction` is false, return binlog trigger
  Note that the objects returned by different parameters are independent of each other.

参数:

transaction -

返回:

Trigger

getAssociations

Associations getAssociations(org.babyfish.jimmer.meta.TypedProp.Association<?,?> prop)

getAssociations

Associations getAssociations(org.babyfish.jimmer.meta.ImmutableProp immutableProp)

getAssociations

Associations getAssociations(AssociationType associationType)

getCaches

Caches getCaches()

getFilters

Filters getFilters()

getBinLog

BinLog getBinLog()

caches

@NewChain
JSqlClient caches(Consumer<CacheDisableConfig> block)

filters

@NewChain
JSqlClient filters(Consumer<FilterConfig> block)

disableSlaveConnectionManager

@NewChain
JSqlClient disableSlaveConnectionManager()

executor

@NewChain
JSqlClient executor(Executor executor)

findById

@Nullable
default <T> T findById(Class<T> type,
 Object id)

类型参数:

T - Entity type or output DTO type

findById

@Nullable
default <E> E findById(Fetcher<E> fetcher,
 Object id)

findOneById

@NotNull
default <T> T findOneById(Class<T> type,
 Object id)

类型参数:

T - Entity type or output DTO type

findOneById

@NotNull
default <E> E findOneById(Fetcher<E> fetcher,
 Object id)

findByIds

@NotNull
default <T> @NotNull List<T> findByIds(Class<T> type,
 Iterable<?> ids)

类型参数:

T - Entity type or output DTO type

findByIds

@NotNull
default <E> @NotNull List<E> findByIds(Fetcher<E> fetcher,
 Iterable<?> ids)

findMapByIds

@NotNull
default <K,
T> @NotNull Map<K,T> findMapByIds(Class<T> type,
 Iterable<K> ids)

类型参数:

T - Entity type or output DTO type

findMapByIds

@NotNull
default <K,
V> @NotNull Map<K,V> findMapByIds(Fetcher<V> fetcher,
 Iterable<K> ids)

saveCommand

default <E> SimpleEntitySaveCommand<E> saveCommand(E entity)

指定者:

saveCommand 在接口中 SaveCommandCreator

saveEntitiesCommand

default <E> BatchEntitySaveCommand<E> saveEntitiesCommand(Iterable<E> entities)

指定者:

saveEntitiesCommand 在接口中 SaveCommandCreator

deleteById

default DeleteResult deleteById(@NotNull
 @NotNull Class<?> type,
 @NotNull
 @NotNull Object id,
 @NotNull
 @NotNull DeleteMode mode)

deleteById

default DeleteResult deleteById(Class<?> type,
 Object id)

deleteByIds

default DeleteResult deleteByIds(Class<?> type,
 Iterable<?> ids,
 DeleteMode mode)

deleteByIds

default DeleteResult deleteByIds(Class<?> type,
 Iterable<?> ids)

transaction

default <R> R transaction(Supplier<R> block)

Execute a transaction by the default propagation behavior Propagation.REQUIRED

• If an IOC framework is used, its implementation should be an encapsulation of the transaction management within the IOC framework. Taking jimmer-spring-starter as an example, it is the SpringConnectionManager which will be created and enabled automatically.
• If no IOC framework is used, the class AbstractTxConnectionManager is the lightweight implementation provided by jimmer, please specify the connection manager of sqlClient by ConnectionManager.simpleConnectionManager(DataSource)

参数:

block - The action to be executed in transaction

返回:

The result of transaction

transaction

<R> R transaction(Propagation propagation,
 Supplier<R> block)

Execute a transaction by the specified Propagation behavior

• If an IOC framework is used, its implementation should be an encapsulation of the transaction management within the IOC framework. Taking jimmer-spring-starter as an example, it is the SpringConnectionManager which will be created and enabled automatically.
• If no IOC framework is used, the class AbstractTxConnectionManager is the lightweight implementation provided by jimmer, please specify the connection manager of sqlClient by ConnectionManager.simpleConnectionManager(DataSource)

参数:

propagation - The propagation behavior

block - The action to be executed in transaction

返回:

The result of transaction

validateDatabase

@Nullable
@Nullable DatabaseValidationException validateDatabase()

Validate the database manually.

User can either automatically validate the database or manually validate it.

• Automatically: Specify the databaseValidationMode as DatabaseValidationMode.ERROR or DatabaseValidationMode.ERROR when building the JSqlClient object, so there is NO need to call this method
• Manually: Specify the databaseValidationMode as DatabaseValidationMode.NONE and call this method after obtaining the JSqlClient object

Note: If there are any database validation errors, the relevant exceptions will be returned as the result of this method instead of being thrown directly.

返回:

The validation error or null