Module io.ebean.core

Package io.ebeaninternal.server.core

Class DefaultServer

java.lang.Object

io.ebeaninternal.server.core.DefaultServer

All Implemented Interfaces:

BeanCollectionLoader, Database, ExtendedServer, SpiServer, SpiEbeanServer

@NonNullApi
public final class DefaultServer
extends Object
implements SpiServer, SpiEbeanServer

The default server side implementation of EbeanServer.

Constructor Summary

Constructors

Constructor	Description
DefaultServer(InternalConfiguration config, ServerCacheManager cache)	Create the DefaultServer.

Method Summary

Modifier and Type	Method	Description
void	addBatch(SpiSqlUpdate sqlUpdate, SpiTransaction transaction)	Add to JDBC batch for later execution.
AutoTune	autoTune()
BackgroundExecutor	backgroundExecutor()
Object	beanId(Object bean)
Object	beanId(Object bean, Object id)
BeanLoader	beanLoader()
BeanState	beanState(Object bean)
<T> BeanType<T>	beanType(Class<T> beanType)	Return the SPI bean types for the given bean class.
List<? extends BeanType<?>>	beanTypes()	Return all the SPI BeanTypes.
List<? extends BeanType<?>>	beanTypes(String tableName)	Return the SPI bean types mapped to the given table.
SpiTransaction	beginServerTransaction()	Begin a managed transaction (Uses scope manager / ThreadLocal).
Transaction	beginTransaction()
Transaction	beginTransaction(io.ebean.annotation.TxIsolation isolation)
Transaction	beginTransaction(TxScope txScope)
ServerCacheManager	cacheManager()
Set<Property>	checkUniqueness(Object bean)
Set<Property>	checkUniqueness(Object bean, Transaction transaction)
void	clearQueryStatistics()	Clear the query execution statistics.
void	clearServerTransaction()	Clear an implicit transaction from the scope.
long	clockNow()	Return the NOW time from the Clock.
<T> CQuery<T>	compileQuery(SpiQuery.Type type, SpiQuery<T> query, Transaction transaction)	Compile a query.
DatabaseBuilder.Settings	config()
CallableSql	createCallableSql(String sql)
CallOrigin	createCallOrigin()	Create a CallStack object.
<T> T	createEntityBean(Class<T> type)	Create a new EntityBean bean.
<T> DefaultOrmQuery<T>	createQuery(Class<T> beanType)	Override in order to return SpiQuery
SpiQueryBindCapture	createQueryBindCapture(SpiQueryPlan plan)	Create a query bind capture for the given query plan.
SpiTransaction	createReadOnlyTransaction(Object tenantId, boolean useMaster)	Create a ServerTransaction for query purposes.
Transaction	createTransaction()	Creates a new Transaction that is NOT stored in TransactionThreadLocal.
Transaction	createTransaction(io.ebean.annotation.TxIsolation isolation)	Create a transaction additionally specify the Isolation level.
<T> Update<T>	createUpdate(Class<T> beanType, String ormUpdate)
SpiTransaction	currentServerTransaction()	Return the current transaction or null if there is no current transaction.
Object	currentTenantId()	Return the current Tenant Id.
Transaction	currentTransaction()
DatabasePlatform	databasePlatform()
DataSource	dataSource()
DataTimeZone	dataTimeZone()	Return the DataTimeZone to use when reading/writing timestamps via JDBC.
<T> int	delete(SpiQuery<T> query)
int	delete(Class<?> beanType, Object id)
int	delete(Class<?> beanType, Object id, Transaction transaction)
boolean	delete(Object bean)	Delete the bean.
boolean	delete(Object bean, Transaction transaction)	Delete the bean with the explicit transaction.
int	deleteAll(Class<?> beanType, Collection<?> ids)
int	deleteAll(Class<?> beanType, Collection<?> ids, Transaction transaction)
int	deleteAll(Collection<?> beans)	Delete all the beans in the collection.
int	deleteAll(Collection<?> beans, Transaction transaction)	Delete all the beans in the collection.
int	deleteAllPermanent(Class<?> beanType, Collection<?> ids)
int	deleteAllPermanent(Class<?> beanType, Collection<?> ids, Transaction transaction)
int	deleteAllPermanent(Collection<?> beans)
int	deleteAllPermanent(Collection<?> beans, Transaction transaction)
int	deletePermanent(Class<?> beanType, Object id)
int	deletePermanent(Class<?> beanType, Object id, Transaction transaction)
boolean	deletePermanent(Object bean)
boolean	deletePermanent(Object bean, Transaction transaction)
void	deregister(BeanPersistController controller)
<T> BeanDescriptor<T>	descriptor(Class<T> beanClass)	Return the BeanDescriptor for a given type of bean.
BeanDescriptor<?>	descriptorById(String beanClassName)	Return the BeanDescriptor using its class name.
List<BeanDescriptor<?>>	descriptors()	Return all the BeanDescriptors.
List<BeanDescriptor<?>>	descriptors(String tableName)	Return the BeanDescriptor's for a given table name.
Map<String,ValuePair>	diff(Object a, Object b)
void	endTransaction()	End the current transaction if it is active.
int	execute(CallableSql callSql)	Execute the CallableSql.
int	execute(CallableSql callSql, Transaction transaction)	Execute the CallableSql with an explicit transaction.
int	execute(SqlUpdate updSql)	Execute the updateSql.
int	execute(SqlUpdate updSql, Transaction transaction)	Execute the updateSql with an explicit transaction.
void	execute(TxScope scope, Runnable runnable)
int	execute(Update<?> update)	Execute the orm update.
int	execute(Update<?> update, Transaction transaction)	Execute the updateSql with an explicit transaction.
void	execute(Runnable runnable)
int[]	executeBatch(SpiSqlUpdate sqlUpdate, SpiTransaction transaction)	Execute the batched statement.
<T> T	executeCall(TxScope scope, Callable<T> callable)
<T> T	executeCall(Callable<T> callable)
int	executeNow(SpiSqlUpdate sqlUpdate)	Execute the sql update regardless of transaction batch mode.
void	executePlugins(boolean online)	Execute all the plugins with an online flag indicating the DB is up or not.
<T> boolean	exists(SpiQuery<T> ormQuery)
boolean	exists(Class<?> beanType, Object beanId, Transaction transaction)	Return true if a row for the bean type and id exists.
ExpressionFactory	expressionFactory()
ExtendedServer	extended()
void	externalModification(TransactionEventTable tableEvent)	Process committed beans from another framework or server in another cluster.
void	externalModification(String tableName, boolean inserts, boolean updates, boolean deletes)	Developer informing eBean that tables where modified outside of eBean.
<T> Filter<T>	filter(Class<T> beanType)
<T> Query<T>	find(Class<T> beanType)
<T> T	find(Class<T> beanType, Object uid)
<T> T	find(Class<T> beanType, Object id, Transaction transaction)	Find a bean using its unique id.
<T> int	findCount(SpiQuery<T> query)
<T> int	findCountWithCopy(SpiQuery<T> query)	Execute the findCount query but without copying the query.
<T> DtoQuery<T>	findDto(Class<T> dtoType, SpiQuery<?> ormQuery)	Return / wrap the ORM query as a DTO query.
<T> DtoQuery<T>	findDto(Class<T> dtoType, String sql)
<T> void	findDtoEach(SpiDtoQuery<T> query, int batch, Consumer<List<T>> consumer)	DTO findEach batch query.
<T> void	findDtoEach(SpiDtoQuery<T> query, Consumer<T> consumer)	DTO findEach query.
<T> void	findDtoEachWhile(SpiDtoQuery<T> query, Predicate<T> consumer)	DTO findEachWhile query.
<T> QueryIterator<T>	findDtoIterate(SpiDtoQuery<T> query)	DTO findIterate query.
<T> List<T>	findDtoList(SpiDtoQuery<T> query)	DTO findList query.
<T> T	findDtoOne(SpiDtoQuery<T> query)	DTO findOne query.
<T> Stream<T>	findDtoStream(SpiDtoQuery<T> query)	DTO findStream query.
<T> void	findEach(SpiQuery<T> query, int batch, Consumer<List<T>> consumer)
<T> void	findEach(SpiQuery<T> query, Consumer<T> consumer)
void	findEach(SpiSqlQuery query, Consumer<SqlRow> consumer)
void	findEachRow(SpiSqlQuery query, RowConsumer consumer)	SqlQuery find each with consumer.
<T> void	findEachWhile(SpiQuery<T> query, Predicate<T> consumer)
void	findEachWhile(SpiSqlQuery query, Predicate<SqlRow> consumer)
<T> FutureRowCount<T>	findFutureCount(SpiQuery<T> query)
<T> FutureIds<T>	findFutureIds(SpiQuery<T> query)
<T> FutureList<T>	findFutureList(SpiQuery<T> query)
<A, T> List<A>	findIds(SpiQuery<T> query)
<A, T> List<A>	findIdsWithCopy(SpiQuery<T> query)	Execute the findId's query but without copying the query.
<T> QueryIterator<T>	findIterate(SpiQuery<T> query)
<T> List<T>	findList(SpiQuery<T> query)
List<SqlRow>	findList(SpiSqlQuery query)
<T> List<T>	findListMapper(SpiSqlQuery query, RowMapper<T> mapper)	SqlQuery find list with mapper.
<K, T> Map<K,T>	findMap(SpiQuery<T> query)
<T> Query<T>	findNative(Class<T> beanType, String nativeSql)
<T> T	findOne(SpiQuery<T> query)
SqlRow	findOne(SpiSqlQuery query)
<T> T	findOneMapper(SpiSqlQuery query, RowMapper<T> mapper)	SqlQuery find one with mapper.
<T> Optional<T>	findOneOrEmpty(SpiQuery<T> query)
<T> PagedList<T>	findPagedList(SpiQuery<T> query)
SpiResultSet	findResultSet(SpiQuery<?> ormQuery)	Execute the underlying ORM query returning as a JDBC ResultSet to map to DTO beans.
<T> Set<T>	findSet(SpiQuery<T> query)
<T> T	findSingleAttribute(SpiSqlQuery query, Class<T> cls)	SqlQuery find single attribute.
<T> void	findSingleAttributeEach(SpiSqlQuery query, Class<T> cls, Consumer<T> consumer)	SqlQuery find single attribute streaming the result to a consumer.
<A, T> List<A>	findSingleAttributeList(SpiQuery<T> query)
<T> List<T>	findSingleAttributeList(SpiSqlQuery query, Class<T> cls)	SqlQuery find single attribute list.
<A, T> Set<A>	findSingleAttributeSet(SpiQuery<T> query)
<T> Stream<T>	findStream(SpiQuery<T> query)
<T> List<Version<T>>	findVersions(SpiQuery<T> query)
void	flush()
void	initialise()	Run any initialisation required before registering with the ClusterManager.
void	insert(Object bean)
void	insert(Object bean, InsertOptions insertOptions)
void	insert(Object bean, InsertOptions insertOptions, Transaction transaction)
void	insert(Object bean, Transaction transaction)
void	insertAll(Collection<?> beans)
void	insertAll(Collection<?> beans, InsertOptions options)
void	insertAll(Collection<?> beans, InsertOptions options, Transaction transaction)
void	insertAll(Collection<?> beans, Transaction transaction)
boolean	isDisableL2Cache()	Return true if the L2 cache has been disabled.
boolean	isSupportedType(Type genericType)	Return true if the type is known as an Entity or Xml type or a List Set or Map of known bean types.
boolean	isUpdateAllPropertiesInBatch()	Return true if updates in JDBC batch should include all columns if unspecified on the transaction.
JsonContext	json()
SpiJsonContext	jsonExtended()	Return the server extended Json context.
int	lazyLoadBatchSize()	Return the default batch size for lazy loading.
void	loadBean(EntityBeanIntercept ebi)
void	loadBean(LoadBeanRequest loadRequest)	Load a batch of Associated One Beans.
void	loadBeanL2(EntityBeanIntercept ebi)
void	loadBeanRef(EntityBeanIntercept ebi)
void	loadMany(BeanCollection<?> bc, boolean onlyIds)
void	loadMany(LoadManyRequest loadRequest)	Lazy load a batch of Many's.
void	lock(Object bean)
SpiLogManager	log()	Return the log manager.
void	markAsDirty(Object bean)
void	merge(Object bean)
void	merge(Object bean, MergeOptions options)
void	merge(Object bean, MergeOptions options, Transaction transaction)
MetaInfoManager	metaInfo()
String	name()	Return the server name.
Object	nextId(Class<?> beanType)
PersistenceContextScope	persistenceContextScope(SpiQuery<?> query)	Return the PersistenceContextScope to use defined at query or server level.
io.ebean.annotation.Platform	platform()
SpiServer	pluginApi()
DataSource	readOnlyDataSource()
<T> T	reference(Class<T> type, Object id)	Return a Reference bean.
void	refresh(Object bean)
void	refreshMany(Object parentBean, String propertyName)
void	register(BeanPersistController controller)
void	register(TransactionCallback transactionCallback)
void	remoteTransactionEvent(RemoteTransactionEvent event)	Another server in the cluster sent this event so that we can inform local BeanListeners of inserts updates and deletes that occurred remotely (on another server in the cluster).
void	save(Object bean)	Persist the bean by either performing an insert or update.
void	save(Object bean, Transaction transaction)	Save the bean with an explicit transaction.
int	saveAll(Object... beans)
int	saveAll(Collection<?> beans)
int	saveAll(Collection<?> beans, Transaction transaction)
void	scopedTransactionEnter(TxScope txScope)	Start an enhanced transactional method.
void	scopedTransactionExit(Object returnOrThrowable, int opCode)	Handle the end of an enhanced Transactional method.
ScriptRunner	script()
void	setClock(Clock clock)
void	shutdown()
void	shutdown(boolean shutdownDataSource, boolean deregisterDriver)
void	slowQueryCheck(long timeMicros, int rowCount, SpiQuery<?> query)	Check for slow query event.
<T> void	sort(List<T> list, String sortByClause)
SqlQuery	sqlQuery(String sql)
SqlUpdate	sqlUpdate(String sql)
void	start()	Start any services after registering with the ClusterManager.
String	toString()
SpiTransactionManager	transactionManager()	Return the transaction manager.
void	truncate(Class<?>... types)
void	truncate(String... tables)
<T> int	update(SpiQuery<T> query)
<T> UpdateQuery<T>	update(Class<T> beanType)
void	update(Object bean)
void	update(Object bean, Transaction transaction)
void	updateAll(Collection<?> beans)
void	updateAll(Collection<?> beans, Transaction transaction)	Update all beans in the collection with an explicit transaction.
<T> Set<String>	validateQuery(Query<T> query)
void	visitMetrics(MetricVisitor visitor)	Visit all the metrics (typically reporting them).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DefaultServer

public DefaultServer(InternalConfiguration config,
 ServerCacheManager cache)

Create the DefaultServer.

Method Details

executePlugins

public void executePlugins(boolean online)

Execute all the plugins with an online flag indicating the DB is up or not.

isDisableL2Cache

public boolean isDisableL2Cache()

Description copied from interface: SpiEbeanServer

Return true if the L2 cache has been disabled.

Specified by:

isDisableL2Cache in interface SpiEbeanServer

log

public SpiLogManager log()

Description copied from interface: SpiEbeanServer

Return the log manager.

Specified by:

log in interface SpiEbeanServer

isUpdateAllPropertiesInBatch

public boolean isUpdateAllPropertiesInBatch()

Description copied from interface: SpiEbeanServer

Return true if updates in JDBC batch should include all columns if unspecified on the transaction.

Specified by:

isUpdateAllPropertiesInBatch in interface SpiEbeanServer

lazyLoadBatchSize

public int lazyLoadBatchSize()

Description copied from interface: SpiEbeanServer

Return the default batch size for lazy loading.

Specified by:

lazyLoadBatchSize in interface SpiEbeanServer

currentTenantId

@Nullable
public Object currentTenantId()

Description copied from interface: SpiEbeanServer

Return the current Tenant Id.

Specified by:

currentTenantId in interface SpiEbeanServer

config

public DatabaseBuilder.Settings config()

Specified by:

config in interface SpiServer

databasePlatform

public DatabasePlatform databasePlatform()

Specified by:

databasePlatform in interface SpiServer

script

public ScriptRunner script()

Specified by:

script in interface Database

dataTimeZone

public DataTimeZone dataTimeZone()

Description copied from interface: SpiEbeanServer

Return the DataTimeZone to use when reading/writing timestamps via JDBC.

Specified by:

dataTimeZone in interface SpiEbeanServer

metaInfo

public MetaInfoManager metaInfo()

Specified by:

metaInfo in interface Database

platform

public io.ebean.annotation.Platform platform()

Specified by:

platform in interface Database

pluginApi

public SpiServer pluginApi()

Specified by:

pluginApi in interface Database

backgroundExecutor

public BackgroundExecutor backgroundExecutor()

Specified by:

backgroundExecutor in interface Database

expressionFactory

public ExpressionFactory expressionFactory()

Specified by:

expressionFactory in interface Database

autoTune

public AutoTune autoTune()

Specified by:

autoTune in interface Database

dataSource

public DataSource dataSource()

Specified by:

dataSource in interface Database

readOnlyDataSource

public DataSource readOnlyDataSource()

Specified by:

readOnlyDataSource in interface Database

initialise

public void initialise()

Run any initialisation required before registering with the ClusterManager.

start

public void start()

Start any services after registering with the ClusterManager.

shutdown

public void shutdown()

Specified by:

shutdown in interface Database

shutdown

public void shutdown(boolean shutdownDataSource,
 boolean deregisterDriver)

Specified by:

shutdown in interface Database

toString

public String toString()

Overrides:

toString in class Object

name

public String name()

Return the server name.

Specified by:

name in interface BeanCollectionLoader

Specified by:

name in interface Database

extended

public ExtendedServer extended()

Specified by:

extended in interface Database

clockNow

public long clockNow()

Description copied from interface: SpiEbeanServer

Return the NOW time from the Clock.

Specified by:

clockNow in interface SpiEbeanServer

setClock

public void setClock(Clock clock)

Specified by:

setClock in interface ExtendedServer

beanState

public BeanState beanState(Object bean)

Specified by:

beanState in interface Database

compileQuery

public <T> CQuery<T> compileQuery(SpiQuery.Type type,
 SpiQuery<T> query,
 Transaction transaction)

Compile a query. Only valid for ORM queries.

Specified by:

compileQuery in interface SpiEbeanServer

cacheManager

public ServerCacheManager cacheManager()

Specified by:

cacheManager in interface Database

refreshMany

public void refreshMany(Object parentBean,
 String propertyName)

Specified by:

refreshMany in interface Database

loadMany

public void loadMany(LoadManyRequest loadRequest)

Description copied from interface: SpiEbeanServer

Lazy load a batch of Many's.

Specified by:

loadMany in interface SpiEbeanServer

loadMany

public void loadMany(BeanCollection<?> bc,
 boolean onlyIds)

Specified by:

loadMany in interface BeanCollectionLoader

refresh

public void refresh(Object bean)

Specified by:

refresh in interface Database

loadBean

public void loadBean(LoadBeanRequest loadRequest)

Description copied from interface: SpiEbeanServer

Load a batch of Associated One Beans.

Specified by:

loadBean in interface SpiEbeanServer

beanLoader

public BeanLoader beanLoader()

Specified by:

beanLoader in interface SpiServer

loadBean

public void loadBean(EntityBeanIntercept ebi)

Specified by:

loadBean in interface SpiServer

loadBeanRef

public void loadBeanRef(EntityBeanIntercept ebi)

Specified by:

loadBeanRef in interface SpiServer

loadBeanL2

public void loadBeanL2(EntityBeanIntercept ebi)

Specified by:

loadBeanL2 in interface SpiServer

diff

public Map<String,ValuePair> diff(@Nullable
 Object a,
 Object b)

Specified by:

diff in interface Database

externalModification

public void externalModification(TransactionEventTable tableEvent)

Process committed beans from another framework or server in another cluster.

This notifies this instance of the framework that beans have been committed externally to it. Either by another framework or clustered server. It needs to maintain its cache and text indexes appropriately.

Specified by:

externalModification in interface SpiEbeanServer

externalModification

public void externalModification(String tableName,
 boolean inserts,
 boolean updates,
 boolean deletes)

Developer informing eBean that tables where modified outside of eBean. Invalidate the cache etc as required.

Specified by:

externalModification in interface Database

truncate

public void truncate(Class<?>... types)

Specified by:

truncate in interface Database

truncate

public void truncate(String... tables)

Specified by:

truncate in interface Database

clearQueryStatistics

public void clearQueryStatistics()

Clear the query execution statistics.

Specified by:

clearQueryStatistics in interface SpiEbeanServer

createEntityBean

public <T> T createEntityBean(Class<T> type)

Create a new EntityBean bean.

This will generally return a subclass of the parameter 'type' which additionally implements the EntityBean interface. That is, the returned bean is typically an instance of a dynamically generated class.

Specified by:

createEntityBean in interface Database

reference

public <T> T reference(Class<T> type,
 Object id)

Return a Reference bean.

If a current transaction is active then this will check the Context of that transaction to see if the bean is already loaded. If it is already loaded then it will returned that object.

Specified by:

reference in interface Database

register

public void register(TransactionCallback transactionCallback)

Specified by:

register in interface Database

createTransaction

public Transaction createTransaction()

Creates a new Transaction that is NOT stored in TransactionThreadLocal. Use this when you want a thread to have a second independent transaction.

Specified by:

createTransaction in interface Database

createTransaction

public Transaction createTransaction(io.ebean.annotation.TxIsolation isolation)

Create a transaction additionally specify the Isolation level.

Note that this transaction is not stored in a thread local.

Specified by:

createTransaction in interface Database

executeCall

public <T> T executeCall(Callable<T> callable)

Specified by:

executeCall in interface Database

executeCall

public <T> T executeCall(@Nullable
 TxScope scope,
 Callable<T> callable)

Specified by:

executeCall in interface Database

execute

public void execute(Runnable runnable)

Specified by:

execute in interface Database

execute

public void execute(@Nullable
 TxScope scope,
 Runnable runnable)

Specified by:

execute in interface Database

scopedTransactionEnter

public void scopedTransactionEnter(TxScope txScope)

Description copied from interface: SpiEbeanServer

Start an enhanced transactional method.

Specified by:

scopedTransactionEnter in interface SpiEbeanServer

scopedTransactionExit

public void scopedTransactionExit(Object returnOrThrowable,
 int opCode)

Description copied from interface: SpiEbeanServer

Handle the end of an enhanced Transactional method.

Specified by:

scopedTransactionExit in interface SpiEbeanServer

currentServerTransaction

@Nullable
public SpiTransaction currentServerTransaction()

Description copied from interface: SpiEbeanServer

Return the current transaction or null if there is no current transaction.

Specified by:

currentServerTransaction in interface SpiEbeanServer

beginTransaction

public Transaction beginTransaction()

Specified by:

beginTransaction in interface Database

beginTransaction

public Transaction beginTransaction(TxScope txScope)

Specified by:

beginTransaction in interface Database

beginTransaction

public Transaction beginTransaction(io.ebean.annotation.TxIsolation isolation)

Specified by:

beginTransaction in interface Database

currentTransaction

public Transaction currentTransaction()

Specified by:

currentTransaction in interface Database

flush

public void flush()

Specified by:

flush in interface Database

endTransaction

public void endTransaction()

Description copied from interface: SpiEbeanServer

End the current transaction if it is active.

Specified by:

endTransaction in interface SpiEbeanServer

nextId

public Object nextId(Class<?> beanType)

Specified by:

nextId in interface Database

sort

public <T> void sort(List<T> list,
 String sortByClause)

Specified by:

sort in interface Database

validateQuery

public <T> Set<String> validateQuery(Query<T> query)

Specified by:

validateQuery in interface Database

filter

public <T> Filter<T> filter(Class<T> beanType)

Specified by:

filter in interface Database

update

public <T> UpdateQuery<T> update(Class<T> beanType)

Specified by:

update in interface Database

merge

public void merge(Object bean)

Specified by:

merge in interface Database

merge

public void merge(Object bean,
 MergeOptions options)

Specified by:

merge in interface Database

merge

public void merge(Object bean,
 MergeOptions options,
 @Nullable
 Transaction transaction)

Specified by:

merge in interface Database

lock

public void lock(Object bean)

Specified by:

lock in interface Database

find

public <T> Query<T> find(Class<T> beanType)

Specified by:

find in interface Database

findNative

public <T> Query<T> findNative(Class<T> beanType,
 String nativeSql)

Specified by:

findNative in interface Database

createQuery

public <T> DefaultOrmQuery<T> createQuery(Class<T> beanType)

Description copied from interface: SpiEbeanServer

Override in order to return SpiQuery

Specified by:

createQuery in interface Database

Specified by:

createQuery in interface SpiEbeanServer

createUpdate

public <T> Update<T> createUpdate(Class<T> beanType,
 String ormUpdate)

Specified by:

createUpdate in interface Database

findDto

public <T> DtoQuery<T> findDto(Class<T> dtoType,
 String sql)

Specified by:

findDto in interface Database

findDto

public <T> DtoQuery<T> findDto(Class<T> dtoType,
 SpiQuery<?> ormQuery)

Description copied from interface: SpiEbeanServer

Return / wrap the ORM query as a DTO query.

Specified by:

findDto in interface SpiEbeanServer

findResultSet

public SpiResultSet findResultSet(SpiQuery<?> ormQuery)

Description copied from interface: SpiEbeanServer

Execute the underlying ORM query returning as a JDBC ResultSet to map to DTO beans.

Specified by:

findResultSet in interface SpiEbeanServer

sqlQuery

public SqlQuery sqlQuery(String sql)

Specified by:

sqlQuery in interface Database

sqlUpdate

public SqlUpdate sqlUpdate(String sql)

Specified by:

sqlUpdate in interface Database

createCallableSql

public CallableSql createCallableSql(String sql)

Specified by:

createCallableSql in interface Database

find

public <T> T find(Class<T> beanType,
 Object uid)

Specified by:

find in interface Database

find

public <T> T find(Class<T> beanType,
 Object id,
 @Nullable
 Transaction transaction)

Find a bean using its unique id.

Specified by:

find in interface Database

persistenceContextScope

public PersistenceContextScope persistenceContextScope(SpiQuery<?> query)

Return the PersistenceContextScope to use defined at query or server level.

Specified by:

persistenceContextScope in interface SpiEbeanServer

findOneOrEmpty

public <T> Optional<T> findOneOrEmpty(SpiQuery<T> query)

Specified by:

findOneOrEmpty in interface SpiEbeanServer

findOne

@Nullable
public <T> T findOne(SpiQuery<T> query)

Specified by:

findOne in interface SpiEbeanServer

findSet

public <T> Set<T> findSet(SpiQuery<T> query)

Specified by:

findSet in interface SpiEbeanServer

findMap

public <K,
T> Map<K,T> findMap(SpiQuery<T> query)

Specified by:

findMap in interface SpiEbeanServer

findSingleAttributeList

public <A,
T> List<A> findSingleAttributeList(SpiQuery<T> query)

Specified by:

findSingleAttributeList in interface SpiEbeanServer

findSingleAttributeSet

public <A,
T> Set<A> findSingleAttributeSet(SpiQuery<T> query)

Specified by:

findSingleAttributeSet in interface SpiEbeanServer

findCount

public <T> int findCount(SpiQuery<T> query)

Specified by:

findCount in interface SpiEbeanServer

findCountWithCopy

public <T> int findCountWithCopy(SpiQuery<T> query)

Description copied from interface: SpiEbeanServer

Execute the findCount query but without copying the query.

Specified by:

findCountWithCopy in interface SpiEbeanServer

exists

public boolean exists(Class<?> beanType,
 Object beanId,
 Transaction transaction)

Description copied from interface: SpiEbeanServer

Return true if a row for the bean type and id exists.

Specified by:

exists in interface SpiEbeanServer

exists

public <T> boolean exists(SpiQuery<T> ormQuery)

Specified by:

exists in interface SpiEbeanServer

findIds

public <A,
T> List<A> findIds(SpiQuery<T> query)

Specified by:

findIds in interface SpiEbeanServer

findIdsWithCopy

public <A,
T> List<A> findIdsWithCopy(SpiQuery<T> query)

Description copied from interface: SpiEbeanServer

Execute the findId's query but without copying the query.

Used so that the list of Id's can be made accessible to client code before the query has finished (if executing in a background thread).

Specified by:

findIdsWithCopy in interface SpiEbeanServer

delete

public <T> int delete(SpiQuery<T> query)

Specified by:

delete in interface SpiEbeanServer

update

public <T> int update(SpiQuery<T> query)

Specified by:

update in interface SpiEbeanServer

findFutureCount

public <T> FutureRowCount<T> findFutureCount(SpiQuery<T> query)

Specified by:

findFutureCount in interface SpiEbeanServer

findFutureIds

public <T> FutureIds<T> findFutureIds(SpiQuery<T> query)

Specified by:

findFutureIds in interface SpiEbeanServer

findFutureList

public <T> FutureList<T> findFutureList(SpiQuery<T> query)

Specified by:

findFutureList in interface SpiEbeanServer

findPagedList

public <T> PagedList<T> findPagedList(SpiQuery<T> query)

Specified by:

findPagedList in interface SpiEbeanServer

findIterate

public <T> QueryIterator<T> findIterate(SpiQuery<T> query)

Specified by:

findIterate in interface SpiEbeanServer

findStream

public <T> Stream<T> findStream(SpiQuery<T> query)

Specified by:

findStream in interface SpiEbeanServer

findEach

public <T> void findEach(SpiQuery<T> query,
 Consumer<T> consumer)

Specified by:

findEach in interface SpiEbeanServer

findEach

public <T> void findEach(SpiQuery<T> query,
 int batch,
 Consumer<List<T>> consumer)

Specified by:

findEach in interface SpiEbeanServer

findEachWhile

public <T> void findEachWhile(SpiQuery<T> query,
 Predicate<T> consumer)

Specified by:

findEachWhile in interface SpiEbeanServer

findVersions

public <T> List<Version<T>> findVersions(SpiQuery<T> query)

Specified by:

findVersions in interface SpiEbeanServer

findList

public <T> List<T> findList(SpiQuery<T> query)

Specified by:

findList in interface SpiEbeanServer

findOne

@Nullable
public SqlRow findOne(SpiSqlQuery query)

Specified by:

findOne in interface SpiEbeanServer

findEach

public void findEach(SpiSqlQuery query,
 Consumer<SqlRow> consumer)

Specified by:

findEach in interface SpiEbeanServer

findEachWhile

public void findEachWhile(SpiSqlQuery query,
 Predicate<SqlRow> consumer)

Specified by:

findEachWhile in interface SpiEbeanServer

findList

public List<SqlRow> findList(SpiSqlQuery query)

Specified by:

findList in interface SpiEbeanServer

findEachRow

public void findEachRow(SpiSqlQuery query,
 RowConsumer consumer)

Description copied from interface: SpiEbeanServer

SqlQuery find each with consumer.

Specified by:

findEachRow in interface SpiEbeanServer

findListMapper

public <T> List<T> findListMapper(SpiSqlQuery query,
 RowMapper<T> mapper)

Description copied from interface: SpiEbeanServer

SqlQuery find list with mapper.

Specified by:

findListMapper in interface SpiEbeanServer

findOneMapper

public <T> T findOneMapper(SpiSqlQuery query,
 RowMapper<T> mapper)

Description copied from interface: SpiEbeanServer

SqlQuery find one with mapper.

Specified by:

findOneMapper in interface SpiEbeanServer

findSingleAttributeEach

public <T> void findSingleAttributeEach(SpiSqlQuery query,
 Class<T> cls,
 Consumer<T> consumer)

Description copied from interface: SpiEbeanServer

SqlQuery find single attribute streaming the result to a consumer.

Specified by:

findSingleAttributeEach in interface SpiEbeanServer

findSingleAttributeList

public <T> List<T> findSingleAttributeList(SpiSqlQuery query,
 Class<T> cls)

Description copied from interface: SpiEbeanServer

SqlQuery find single attribute list.

Specified by:

findSingleAttributeList in interface SpiEbeanServer

findSingleAttribute

public <T> T findSingleAttribute(SpiSqlQuery query,
 Class<T> cls)

Description copied from interface: SpiEbeanServer

SqlQuery find single attribute.

Specified by:

findSingleAttribute in interface SpiEbeanServer

findDtoEach

public <T> void findDtoEach(SpiDtoQuery<T> query,
 Consumer<T> consumer)

Description copied from interface: SpiEbeanServer

DTO findEach query.

Specified by:

findDtoEach in interface SpiEbeanServer

findDtoEach

public <T> void findDtoEach(SpiDtoQuery<T> query,
 int batch,
 Consumer<List<T>> consumer)

Description copied from interface: SpiEbeanServer

DTO findEach batch query.

Specified by:

findDtoEach in interface SpiEbeanServer

findDtoEachWhile

public <T> void findDtoEachWhile(SpiDtoQuery<T> query,
 Predicate<T> consumer)

Description copied from interface: SpiEbeanServer

DTO findEachWhile query.

Specified by:

findDtoEachWhile in interface SpiEbeanServer

findDtoIterate

public <T> QueryIterator<T> findDtoIterate(SpiDtoQuery<T> query)

Description copied from interface: SpiEbeanServer

DTO findIterate query.

Specified by:

findDtoIterate in interface SpiEbeanServer

findDtoStream

public <T> Stream<T> findDtoStream(SpiDtoQuery<T> query)

Description copied from interface: SpiEbeanServer

DTO findStream query.

Specified by:

findDtoStream in interface SpiEbeanServer

findDtoList

public <T> List<T> findDtoList(SpiDtoQuery<T> query)

Description copied from interface: SpiEbeanServer

DTO findList query.

Specified by:

findDtoList in interface SpiEbeanServer

findDtoOne

@Nullable
public <T> T findDtoOne(SpiDtoQuery<T> query)

Description copied from interface: SpiEbeanServer

DTO findOne query.

Specified by:

findDtoOne in interface SpiEbeanServer

save

public void save(Object bean)

Persist the bean by either performing an insert or update.

Specified by:

save in interface Database

save

public void save(Object bean,
 @Nullable
 Transaction transaction)

Save the bean with an explicit transaction.

Specified by:

save in interface Database

markAsDirty

public void markAsDirty(Object bean)

Specified by:

markAsDirty in interface Database

update

public void update(Object bean)

Specified by:

update in interface Database

update

public void update(Object bean,
 @Nullable
 Transaction transaction)

Specified by:

update in interface Database

updateAll

public void updateAll(Collection<?> beans)
               throws jakarta.persistence.OptimisticLockException

Specified by:

updateAll in interface Database

Throws:

jakarta.persistence.OptimisticLockException

updateAll

public void updateAll(@Nullable
 Collection<?> beans,
 @Nullable
 Transaction transaction)

Update all beans in the collection with an explicit transaction.

Specified by:

updateAll in interface Database

insert

public void insert(Object bean)

Specified by:

insert in interface Database

insert

public void insert(Object bean,
 @Nullable
 InsertOptions insertOptions)

Specified by:

insert in interface Database

insert

public void insert(Object bean,
 @Nullable
 Transaction transaction)

Specified by:

insert in interface Database

insert

public void insert(Object bean,
 InsertOptions insertOptions,
 Transaction transaction)

Specified by:

insert in interface Database

insertAll

public void insertAll(Collection<?> beans)

Specified by:

insertAll in interface Database

insertAll

public void insertAll(Collection<?> beans,
 InsertOptions options)

Specified by:

insertAll in interface Database

insertAll

public void insertAll(@Nullable
 Collection<?> beans,
 @Nullable
 Transaction transaction)

Specified by:

insertAll in interface Database

insertAll

public void insertAll(@Nullable
 Collection<?> beans,
 InsertOptions options,
 @Nullable
 Transaction transaction)

Specified by:

insertAll in interface Database

saveAll

public int saveAll(Collection<?> beans,
 Transaction transaction)
            throws jakarta.persistence.OptimisticLockException

Specified by:

saveAll in interface Database

Throws:

jakarta.persistence.OptimisticLockException

saveAll

public int saveAll(Collection<?> beans)
            throws jakarta.persistence.OptimisticLockException

Specified by:

saveAll in interface Database

Throws:

jakarta.persistence.OptimisticLockException

saveAll

public int saveAll(Object... beans)
            throws jakarta.persistence.OptimisticLockException

Specified by:

saveAll in interface Database

Throws:

jakarta.persistence.OptimisticLockException

delete

public int delete(Class<?> beanType,
 Object id)

Specified by:

delete in interface Database

delete

public int delete(Class<?> beanType,
 Object id,
 @Nullable
 Transaction transaction)

Specified by:

delete in interface Database

deletePermanent

public int deletePermanent(Class<?> beanType,
 Object id)

Specified by:

deletePermanent in interface Database

deletePermanent

public int deletePermanent(Class<?> beanType,
 Object id,
 @Nullable
 Transaction transaction)

Specified by:

deletePermanent in interface Database

deleteAll

public int deleteAll(Class<?> beanType,
 Collection<?> ids)

Specified by:

deleteAll in interface Database

deleteAll

public int deleteAll(Class<?> beanType,
 Collection<?> ids,
 @Nullable
 Transaction transaction)

Specified by:

deleteAll in interface Database

deleteAllPermanent

public int deleteAllPermanent(Class<?> beanType,
 Collection<?> ids)

Specified by:

deleteAllPermanent in interface Database

deleteAllPermanent

public int deleteAllPermanent(Class<?> beanType,
 Collection<?> ids,
 @Nullable
 Transaction transaction)

Specified by:

deleteAllPermanent in interface Database

delete

public boolean delete(Object bean)

Delete the bean.

Specified by:

delete in interface Database

delete

public boolean delete(Object bean,
 @Nullable
 Transaction transaction)
               throws jakarta.persistence.OptimisticLockException

Delete the bean with the explicit transaction.

Specified by:

delete in interface Database

Throws:

jakarta.persistence.OptimisticLockException

deletePermanent

public boolean deletePermanent(Object bean)
                        throws jakarta.persistence.OptimisticLockException

Specified by:

deletePermanent in interface Database

Throws:

jakarta.persistence.OptimisticLockException

deletePermanent

public boolean deletePermanent(Object bean,
 @Nullable
 Transaction transaction)
                        throws jakarta.persistence.OptimisticLockException

Specified by:

deletePermanent in interface Database

Throws:

jakarta.persistence.OptimisticLockException

deleteAllPermanent

public int deleteAllPermanent(Collection<?> beans)

Specified by:

deleteAllPermanent in interface Database

deleteAllPermanent

public int deleteAllPermanent(Collection<?> beans,
 @Nullable
 Transaction transaction)

Specified by:

deleteAllPermanent in interface Database

deleteAll

public int deleteAll(Collection<?> beans)

Delete all the beans in the collection.

Specified by:

deleteAll in interface Database

deleteAll

public int deleteAll(Collection<?> beans,
 @Nullable
 Transaction transaction)

Delete all the beans in the collection.

Specified by:

deleteAll in interface Database

execute

public int execute(CallableSql callSql,
 @Nullable
 Transaction transaction)

Execute the CallableSql with an explicit transaction.

Specified by:

execute in interface Database

execute

public int execute(CallableSql callSql)

Execute the CallableSql.

Specified by:

execute in interface Database

execute

public int execute(SqlUpdate updSql,
 @Nullable
 Transaction transaction)

Execute the updateSql with an explicit transaction.

Specified by:

execute in interface Database

executeNow

public int executeNow(SpiSqlUpdate sqlUpdate)

Description copied from interface: SpiEbeanServer

Execute the sql update regardless of transaction batch mode.

Specified by:

executeNow in interface SpiEbeanServer

addBatch

public void addBatch(SpiSqlUpdate sqlUpdate,
 @Nullable
 SpiTransaction transaction)

Description copied from interface: SpiEbeanServer

Add to JDBC batch for later execution.

Specified by:

addBatch in interface SpiEbeanServer

executeBatch

public int[] executeBatch(SpiSqlUpdate sqlUpdate,
 @Nullable
 SpiTransaction transaction)

Description copied from interface: SpiEbeanServer

Execute the batched statement.

Specified by:

executeBatch in interface SpiEbeanServer

execute

public int execute(SqlUpdate updSql)

Execute the updateSql.

Specified by:

execute in interface Database

execute

public int execute(Update<?> update,
 @Nullable
 Transaction transaction)

Execute the updateSql with an explicit transaction.

Specified by:

execute in interface Database

execute

public int execute(Update<?> update)

Execute the orm update.

Specified by:

execute in interface Database

descriptors

public List<BeanDescriptor<?>> descriptors()

Return all the BeanDescriptors.

Specified by:

descriptors in interface SpiEbeanServer

transactionManager

public SpiTransactionManager transactionManager()

Return the transaction manager.

Specified by:

transactionManager in interface SpiEbeanServer

register

public void register(BeanPersistController controller)

deregister

public void deregister(BeanPersistController controller)

isSupportedType

public boolean isSupportedType(Type genericType)

Description copied from interface: SpiEbeanServer

Return true if the type is known as an Entity or Xml type or a List Set or Map of known bean types.

Specified by:

isSupportedType in interface SpiEbeanServer

beanId

public Object beanId(Object bean,
 Object id)

Specified by:

beanId in interface Database

beanId

public Object beanId(Object bean)

Specified by:

beanId in interface Database

descriptor

public <T> BeanDescriptor<T> descriptor(Class<T> beanClass)

Return the BeanDescriptor for a given type of bean.

Specified by:

descriptor in interface SpiEbeanServer

descriptors

public List<BeanDescriptor<?>> descriptors(String tableName)

Return the BeanDescriptor's for a given table name.

Specified by:

descriptors in interface SpiEbeanServer

beanTypes

public List<? extends BeanType<?>> beanTypes()

Return all the SPI BeanTypes.

Specified by:

beanTypes in interface SpiServer

beanTypes

public List<? extends BeanType<?>> beanTypes(String tableName)

Return the SPI bean types mapped to the given table.

Specified by:

beanTypes in interface SpiServer

beanType

public <T> BeanType<T> beanType(Class<T> beanType)

Return the SPI bean types for the given bean class.

Specified by:

beanType in interface SpiServer

descriptorById

public BeanDescriptor<?> descriptorById(String beanClassName)

Return the BeanDescriptor using its class name.

Specified by:

descriptorById in interface SpiEbeanServer

remoteTransactionEvent

public void remoteTransactionEvent(RemoteTransactionEvent event)

Another server in the cluster sent this event so that we can inform local BeanListeners of inserts updates and deletes that occurred remotely (on another server in the cluster).

Specified by:

remoteTransactionEvent in interface SpiEbeanServer

clearServerTransaction

public void clearServerTransaction()

Description copied from interface: SpiEbeanServer

Clear an implicit transaction from the scope.

Specified by:

clearServerTransaction in interface SpiEbeanServer

beginServerTransaction

public SpiTransaction beginServerTransaction()

Description copied from interface: SpiEbeanServer

Begin a managed transaction (Uses scope manager / ThreadLocal).

Specified by:

beginServerTransaction in interface SpiEbeanServer

createReadOnlyTransaction

public SpiTransaction createReadOnlyTransaction(Object tenantId,
 boolean useMaster)

Description copied from interface: SpiEbeanServer

Create a ServerTransaction for query purposes.

Specified by:

createReadOnlyTransaction in interface SpiEbeanServer

Parameters:

tenantId - For multi-tenant lazy loading provide the tenantId to use.

useMaster - Set to true when the query should use the master data source.

createCallOrigin

public CallOrigin createCallOrigin()

Create a CallStack object.

This trims off the avaje ebean part of the stack trace so that the first element in the CallStack should be application code.

Specified by:

createCallOrigin in interface SpiEbeanServer

json

public JsonContext json()

Specified by:

json in interface Database

jsonExtended

public SpiJsonContext jsonExtended()

Description copied from interface: SpiEbeanServer

Return the server extended Json context.

Specified by:

jsonExtended in interface SpiEbeanServer

slowQueryCheck

public void slowQueryCheck(long timeMicros,
 int rowCount,
 SpiQuery<?> query)

Description copied from interface: SpiEbeanServer

Check for slow query event.

Specified by:

slowQueryCheck in interface SpiEbeanServer

checkUniqueness

public Set<Property> checkUniqueness(Object bean)

Specified by:

checkUniqueness in interface Database

checkUniqueness

public Set<Property> checkUniqueness(Object bean,
 @Nullable
 Transaction transaction)

Specified by:

checkUniqueness in interface Database

visitMetrics

public void visitMetrics(MetricVisitor visitor)

Description copied from interface: SpiEbeanServer

Visit all the metrics (typically reporting them).

Specified by:

visitMetrics in interface SpiEbeanServer

createQueryBindCapture

public SpiQueryBindCapture createQueryBindCapture(SpiQueryPlan plan)

Description copied from interface: SpiEbeanServer

Create a query bind capture for the given query plan.

Specified by:

createQueryBindCapture in interface SpiEbeanServer