org.babyfish.jimmer.sql.JSqlClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jimmer-sql Show documentation
Show all versions of jimmer-sql Show documentation
A revolutionary ORM framework for both java and kotlin
package org.babyfish.jimmer.sql;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.babyfish.jimmer.Input;
import org.babyfish.jimmer.lang.NewChain;
import org.babyfish.jimmer.lang.OldChain;
import org.babyfish.jimmer.meta.ImmutableProp;
import org.babyfish.jimmer.meta.TypedProp;
import org.babyfish.jimmer.sql.association.meta.AssociationType;
import org.babyfish.jimmer.sql.ast.mutation.*;
import org.babyfish.jimmer.sql.ast.query.*;
import org.babyfish.jimmer.sql.ast.table.AssociationTable;
import org.babyfish.jimmer.sql.ast.table.spi.TableProxy;
import org.babyfish.jimmer.sql.cache.*;
import org.babyfish.jimmer.sql.di.*;
import org.babyfish.jimmer.sql.event.TriggerType;
import org.babyfish.jimmer.sql.event.Triggers;
import org.babyfish.jimmer.sql.event.binlog.BinLog;
import org.babyfish.jimmer.sql.event.binlog.BinLogPropReader;
import org.babyfish.jimmer.sql.fetcher.Fetcher;
import org.babyfish.jimmer.sql.filter.Filter;
import org.babyfish.jimmer.sql.filter.FilterConfig;
import org.babyfish.jimmer.sql.filter.Filters;
import org.babyfish.jimmer.sql.meta.DatabaseNamingStrategy;
import org.babyfish.jimmer.sql.ast.table.Table;
import org.babyfish.jimmer.sql.dialect.Dialect;
import org.babyfish.jimmer.sql.meta.IdGenerator;
import org.babyfish.jimmer.sql.runtime.*;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.time.ZoneId;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;
public interface JSqlClient extends SubQueryProvider {
static Builder newBuilder() {
return new JSqlClientImpl.BuilderImpl();
}
> MutableRootQuery createQuery(T table);
MutableUpdate createUpdate(TableProxy table);
MutableDelete createDelete(TableProxy table);
, TE, TT extends Table>
MutableRootQuery> createAssociationQuery(
AssociationTable table
);
Entities getEntities();
/**
* This method is equivalent to `getTriggers(false)`
* @return
*/
Triggers getTriggers();
/**
*
* -
* 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.
*
*
* @param transaction
* @return Trigger
*/
Triggers getTriggers(boolean transaction);
Associations getAssociations(TypedProp.Association prop);
Associations getAssociations(ImmutableProp immutableProp);
Associations getAssociations(AssociationType associationType);
Caches getCaches();
Filters getFilters();
BinLog getBinLog();
@NewChain
JSqlClient caches(Consumer block);
@NewChain
JSqlClient filters(Consumer block);
@NewChain
JSqlClient disableSlaveConnectionManager();
@NewChain
JSqlClient executor(Executor executor);
@Nullable
default E findById(Class type, Object id) {
return getEntities().findById(type, id);
}
@Nullable
default E findById(Fetcher fetcher, Object id) {
return getEntities().findById(fetcher, id);
}
@NotNull
default List findByIds(Class type, Collection ids) {
return getEntities().findByIds(type, ids);
}
@NotNull
default List findByIds(Fetcher fetcher, Collection ids) {
return getEntities().findByIds(fetcher, ids);
}
@NotNull
default Map findMapByIds(Class type, Collection ids) {
return getEntities().findMapByIds(type, ids);
}
@NotNull
default Map findMapByIds(Fetcher fetcher, Collection ids) {
return getEntities().findMapByIds(fetcher, ids);
}
default SimpleSaveResult save(E entity, SaveMode mode) {
return getEntities().saveCommand(entity)
.setMode(mode)
.execute();
}
default SimpleSaveResult save(E entity) {
return save(entity, SaveMode.UPSERT);
}
default SimpleSaveResult insert(E entity) {
return save(entity, SaveMode.INSERT_ONLY);
}
default SimpleSaveResult update(E entity) {
return save(entity, SaveMode.UPDATE_ONLY);
}
default SimpleSaveResult save(Input input, SaveMode mode) {
return save(input.toEntity(), mode);
}
default SimpleSaveResult save(Input input) {
return save(input.toEntity(), SaveMode.UPSERT);
}
default SimpleSaveResult insert(Input input) {
return save(input.toEntity(), SaveMode.INSERT_ONLY);
}
default SimpleSaveResult update(Input input) {
return save(input.toEntity(), SaveMode.UPDATE_ONLY);
}
/**
* Note: The 'merge' of 'Jimmer' and the 'merge' of 'JPA' are completely different concepts!
*
* For associated objects, only insert or update operations are executed.
* The parent object never dissociates the child objects.
*/
default SimpleSaveResult merge(E entity) {
return merge(entity, SaveMode.UPSERT);
}
/**
* Note: The 'merge' of 'Jimmer' and the 'merge' of 'JPA' are completely different concepts!
*
* For associated objects, only insert or update operations are executed.
* The parent object never dissociates the child objects.
*/
default SimpleSaveResult merge(Input input) {
return merge(input.toEntity(), SaveMode.UPSERT);
}
/**
* Note: The 'merge' of 'Jimmer' and the 'merge' of 'JPA' are completely different concepts!
*
* For associated objects, only insert or update operations are executed.
* The parent object never dissociates the child objects.
*/
default SimpleSaveResult merge(E entity, SaveMode mode) {
return getEntities()
.saveCommand(entity)
.setMode(mode)
.setAssociatedModeAll(AssociatedSaveMode.MERGE)
.execute();
}
/**
* Note: The 'merge' of 'Jimmer' and the 'merge' of 'JPA' are completely different concepts!
*
* For associated objects, only insert or update operations are executed.
* The parent object never dissociates the child objects.
*/
default SimpleSaveResult merge(Input input, SaveMode mode) {
return merge(input.toEntity(), mode);
}
/**
* For associated objects, only insert operations are executed.
*/
default SimpleSaveResult append(E entity) {
return append(entity, SaveMode.INSERT_ONLY);
}
/**
* For associated objects, only insert operations are executed.
*/
default SimpleSaveResult append(Input input) {
return append(input.toEntity(), SaveMode.INSERT_ONLY);
}
/**
* For associated objects, only insert operations are executed.
*/
default SimpleSaveResult append(E entity, SaveMode mode) {
return getEntities()
.saveCommand(entity)
.setMode(mode)
.setAssociatedModeAll(AssociatedSaveMode.APPEND)
.execute();
}
/**
* For associated objects, only insert operations are executed.
*/
default SimpleSaveResult append(Input input, SaveMode mode) {
return append(input.toEntity(), mode);
}
default DeleteResult deleteById(Class type, Object id, DeleteMode mode) {
return getEntities().delete(type, id, mode);
}
default DeleteResult deleteById(Class type, Object id) {
return getEntities().delete(type, id, DeleteMode.AUTO);
}
default DeleteResult deleteByIds(Class type, Collection ids, DeleteMode mode) {
return getEntities().deleteAll(type, ids, mode);
}
default DeleteResult deleteByIds(Class type, Collection ids) {
return getEntities().deleteAll(type, ids, DeleteMode.AUTO);
}
interface Builder {
int DEFAULT_BATCH_SIZE = 128;
int DEFAULT_LIST_BATCH_SIZE = 16;
@OldChain
Builder setConnectionManager(ConnectionManager connectionManager);
@OldChain
Builder setSlaveConnectionManager(ConnectionManager connectionManager);
@OldChain
Builder setDialect(Dialect dialect);
@OldChain
Builder setExecutor(Executor executor);
/**
* 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.
*
* However, these stack traces have too much information, including
* infrastructure call frames represented by jdk, jdbc driver, jimmer, and spring,
* and the business-related information you care about will be submerged in the ocean of information.
*
* Through this configuration, you can specify multiple package or class prefixes, and jimmer will
* judge whether there are some call frames in the stack trace whose class names start with some
* of these prefixes. If the judgment is true, jimmer believes that the current callback is related
* to your business, and the `ctx` parameter of `org.babyfish.jimmer.sql.runtime.Executor.execute`
* will be passed as non-null.
*
* If the SQL logging configuration is enabled at the same time, when a SQL statement is caused by
* the business you care about, the business call frame will be printed together with the SQL log.
*/
@OldChain
Builder setExecutorContextPrefixes(Collection prefixes);
@OldChain
Builder setSqlFormatter(SqlFormatter formatter);
@OldChain
Builder setZoneId(@Nullable ZoneId zoneId);
@OldChain
Builder setUserIdGeneratorProvider(UserIdGeneratorProvider userIdGeneratorProvider);
@OldChain
Builder setLogicalDeletedValueGeneratorProvider(LogicalDeletedValueGeneratorProvider logicalDeletedValueGeneratorProvider);
@OldChain
Builder setTransientResolverProvider(TransientResolverProvider transientResolverProvider);
@OldChain
Builder setIdGenerator(IdGenerator idGenerator);
@OldChain
Builder setIdGenerator(Class entityType, IdGenerator idGenerator);
@OldChain
Builder addScalarProvider(ScalarProvider scalarProvider);
@OldChain
Builder setScalarProvider(TypedProp prop, ScalarProvider scalarProvider);
@OldChain
Builder setScalarProvider(ImmutableProp prop, ScalarProvider scalarProvider);
@OldChain
Builder setDefaultSerializedTypeObjectMapper(ObjectMapper mapper);
@OldChain
Builder setSerializedTypeObjectMapper(Class type, ObjectMapper mapper);
@OldChain
Builder setSerializedPropObjectMapper(TypedProp prop, ObjectMapper mapper);
@OldChain
Builder setSerializedPropObjectMapper(ImmutableProp prop, ObjectMapper mapper);
@OldChain
Builder setDefaultJsonProviderCreator(Function> creator);
@OldChain
Builder setDefaultEnumStrategy(EnumType.Strategy strategy);
@OldChain
Builder setDatabaseNamingStrategy(DatabaseNamingStrategy strategy);
@OldChain
Builder setDefaultBatchSize(int size);
@OldChain
Builder setDefaultListBatchSize(int size);
@OldChain
Builder setInListPaddingEnabled(boolean enabled);
@OldChain
Builder setExpandedInListPaddingEnabled(boolean enabled);
/**
* For RDBMS, pagination is slow if `offset` is large, especially for MySQL.
*
* If `offset` >= $thisArgument
*
* {@code
* select t.* from Table t ... limit ? offset ?
* }
*
* will be automatically changed to
*
* {@code
* select t.* from (
* select
* t.id as optimized_core_id_
* from Table t ... limit ? offset ?
* ) optimized_core_
* inner join Table as optimized_
* on optimized_.optimized_core_id_ = optimized_core_.optimized_core_id_
* }
*
* @return An integer which is greater than 0
*/
@OldChain
Builder setOffsetOptimizingThreshold(int threshold);
/**
* Set deault lock mode of save command
* @param lockMode
*/
@OldChain
Builder setDefaultLockMode(LockMode lockMode);
@OldChain
Builder setMaxCommandJoinCount(int maxMutationSubQueryDepth);
/**
* Under normal circumstances, users do not need to set the entity manager.
*
* This configuration is for compatibility with version 0.7.47 and earlier.
*/
@OldChain
Builder setEntityManager(EntityManager entityManager);
@OldChain
Builder setCaches(Consumer block);
@OldChain
Builder setCacheFactory(CacheFactory cacheFactory);
@OldChain
Builder setCacheOperator(CacheOperator cacheOperator);
@OldChain
Builder addCacheAbandonedCallback(CacheAbandonedCallback callback);
@OldChain
Builder addCacheAbandonedCallbacks(Collection callbacks);
@OldChain
Builder setTriggerType(TriggerType triggerType);
@OldChain
Builder setLogicalDeletedBehavior(LogicalDeletedBehavior behavior);
@OldChain
Builder addFilters(Filter... filters);
@OldChain
Builder addFilters(Collection> filters);
@OldChain
Builder addDisabledFilters(Filter... filters);
@OldChain
Builder addDisabledFilters(Collection> filters);
@OldChain
Builder setDefaultDissociateActionCheckable(boolean checkable);
@OldChain
Builder setIdOnlyTargetCheckingLevel(IdOnlyTargetCheckingLevel checkingLevel);
@OldChain
Builder addDraftPreProcessor(DraftPreProcessor processor);
@OldChain
Builder addDraftPreProcessors(DraftPreProcessor... processors);
@OldChain
Builder addDraftPreProcessors(Collection> processors);
@OldChain
Builder addDraftInterceptor(DraftInterceptor interceptor);
@OldChain
Builder addDraftInterceptors(DraftInterceptor... interceptors);
@OldChain
Builder addDraftInterceptors(Collection> interceptors);
Builder setDefaultBinLogObjectMapper(ObjectMapper mapper);
@OldChain
Builder setBinLogPropReader(ImmutableProp prop, BinLogPropReader reader);
@OldChain
Builder setBinLogPropReader(TypedProp.Scalar prop, BinLogPropReader reader);
@OldChain
Builder setBinLogPropReader(Class propType, BinLogPropReader reader);
@OldChain
Builder setForeignKeyEnabledByDefault(boolean enabled);
@OldChain
Builder setTargetTransferable(boolean targetTransferable);
@OldChain
Builder addExceptionTranslator(ExceptionTranslator translator);
@OldChain
Builder addExceptionTranslators(Collection> translators);
@OldChain
Builder addCustomizers(Customizer ... customizers);
@OldChain
Builder addCustomizers(Collection customizers);
@OldChain
Builder addInitializers(Initializer ... initializers);
@OldChain
Builder addInitializers(Collection initializers);
@OldChain
Builder setDatabaseValidationMode(DatabaseValidationMode mode);
@OldChain
Builder setDatabaseValidationCatalog(String catalog);
@OldChain
Builder setDatabaseValidationSchema(String schema);
@OldChain
Builder setAopProxyProvider(AopProxyProvider provider);
@OldChain
Builder setMicroServiceName(String microServiceName);
@OldChain
Builder setMicroServiceExchange(MicroServiceExchange exchange);
@OldChain
Builder setInitializationType(InitializationType type);
JSqlClient build();
}
}