net.ymate.platform.persistence.mongodb

Interface IMongo

All Superinterfaces:

AutoCloseable, IDestroyable, IInitialization<IApplication>, IPersistence<IMongoSession,IMongoConfig,IMongoConnectionHolder>

All Known Implementing Classes:

MongoDB

@Ignored
public interface IMongo
extends IPersistence<IMongoSession,IMongoConfig,IMongoConnectionHolder>

Author:

刘镇 (suninformation@163.com) on 15/11/21 上午9:24

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IMongo.GridFs GridFS常量
static class	IMongo.Opt 操作符常量

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODULE_NAME

Method Summary

Modifier and Type	Method and Description
IMongoDataSourceAdapter	getDataSourceAdapter(String dataSourceName) 获取指定源数据源适配器
IMongoDataSourceAdapter	getDefaultDataSourceAdapter() 获取默认数据源适配器
IGridFsSession	openGridFsSession() 开启数据库文件储存会话(注意一定记得关闭会话)
IGridFsSession	openGridFsSession(IDataSourceRouter dataSourceRouter) 开启数据库文件储存会话(注意一定记得关闭会话)
<T> T	openGridFsSession(IDataSourceRouter dataSourceRouter, IGridFsSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
IGridFsSession	openGridFsSession(IDataSourceRouter dataSourceRouter, String bucketName) 开启数据库文件储存会话(注意一定记得关闭会话)
<T> T	openGridFsSession(IDataSourceRouter dataSourceRouter, String bucketName, IGridFsSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
<T> T	openGridFsSession(IGridFsSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
IGridFsSession	openGridFsSession(IMongoConnectionHolder connectionHolder) 开启数据库文件储存会话(注意一定记得关闭会话)
<T> T	openGridFsSession(IMongoConnectionHolder connectionHolder, IGridFsSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
IGridFsSession	openGridFsSession(IMongoConnectionHolder connectionHolder, String bucketName) 开启数据库文件储存会话(注意一定记得关闭会话)
<T> T	openGridFsSession(IMongoConnectionHolder connectionHolder, String bucketName, IGridFsSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
IGridFsSession	openGridFsSession(String bucketName) 开启数据库文件储存会话(注意一定记得关闭会话)
<T> T	openGridFsSession(String bucketName, IGridFsSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
IGridFsSession	openGridFsSession(String dataSourceName, String bucketName) 开启数据库文件储存会话(注意一定记得关闭会话)
<T> T	openGridFsSession(String dataSourceName, String bucketName, IGridFsSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
<T> T	openSession(IDataSourceRouter dataSourceRouter, IMongoSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
<T> T	openSession(IMongoConnectionHolder connectionHolder, IMongoSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
<T> T	openSession(IMongoSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
<T> T	openSession(String dataSourceName, IMongoSessionExecutor<T> executor) 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
<T> T	openTransaction(AbstractTrade<T> trade) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
<T> T	openTransaction(AbstractTrade<T> trade, ClientSessionOptions clientSessionOptions) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
<T> T	openTransaction(IDataSourceRouter dataSourceRouter, AbstractTrade<T> trade) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
<T> T	openTransaction(IDataSourceRouter dataSourceRouter, AbstractTrade<T> trade, ClientSessionOptions clientSessionOptions) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
void	openTransaction(IDataSourceRouter dataSourceRouter, ITrade trade) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
void	openTransaction(IDataSourceRouter dataSourceRouter, ITrade trade, ClientSessionOptions clientSessionOptions) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
<T> T	openTransaction(IMongoConnectionHolder connectionHolder, AbstractTrade<T> trade) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
<T> T	openTransaction(IMongoConnectionHolder connectionHolder, AbstractTrade<T> trade, ClientSessionOptions clientSessionOptions) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
void	openTransaction(IMongoConnectionHolder connectionHolder, ITrade trade) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
void	openTransaction(IMongoConnectionHolder connectionHolder, ITrade trade, ClientSessionOptions clientSessionOptions) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
void	openTransaction(ITrade trade) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
void	openTransaction(ITrade trade, ClientSessionOptions clientSessionOptions) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
<T> T	openTransaction(String dataSourceName, AbstractTrade<T> trade) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
<T> T	openTransaction(String dataSourceName, AbstractTrade<T> trade, ClientSessionOptions clientSessionOptions) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
void	openTransaction(String dataSourceName, ITrade trade) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)
void	openTransaction(String dataSourceName, ITrade trade, ClientSessionOptions clientSessionOptions) 开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Methods inherited from interface net.ymate.platform.core.persistence.IPersistence

getConfig, getConnectionHolder, getDefaultConnectionHolder, getOwner, openSession, openSession, openSession, openSession, releaseConnectionHolder

Methods inherited from interface net.ymate.platform.core.support.IInitialization

initialize, isInitialized

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

MODULE_NAME

static final String MODULE_NAME

See Also:

Constant Field Values

Method Detail

getDefaultDataSourceAdapter

IMongoDataSourceAdapter getDefaultDataSourceAdapter()
                                             throws Exception

获取默认数据源适配器

Returns:

返回数据源适配器对象

Throws:

Exception - 可能产生的任何异常

getDataSourceAdapter

IMongoDataSourceAdapter getDataSourceAdapter(String dataSourceName)
                                      throws Exception

获取指定源数据源适配器

Parameters:

dataSourceName - 数据源名称

Returns:

返回数据源适配器对象

Throws:

Exception - 可能产生的任何异常

openSession

<T> T openSession(IMongoSessionExecutor<T> executor)
           throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openSession

<T> T openSession(IMongoConnectionHolder connectionHolder,
                  IMongoSessionExecutor<T> executor)
           throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

connectionHolder - 连接对象持有者

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openSession

<T> T openSession(String dataSourceName,
                  IMongoSessionExecutor<T> executor)
           throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

dataSourceName - 数据源名称

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openSession

<T> T openSession(IDataSourceRouter dataSourceRouter,
                  IMongoSessionExecutor<T> executor)
           throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

dataSourceRouter - 数据源路由对象

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openGridFsSession

<T> T openGridFsSession(IGridFsSessionExecutor<T> executor)
                 throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openGridFsSession

<T> T openGridFsSession(String bucketName,
                        IGridFsSessionExecutor<T> executor)
                 throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

bucketName - 桶名称

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openGridFsSession

<T> T openGridFsSession(String dataSourceName,
                        String bucketName,
                        IGridFsSessionExecutor<T> executor)
                 throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

dataSourceName - 数据源名称

bucketName - 桶名称

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openGridFsSession

<T> T openGridFsSession(IMongoConnectionHolder connectionHolder,
                        IGridFsSessionExecutor<T> executor)
                 throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

connectionHolder - 连接对象持有者

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openGridFsSession

<T> T openGridFsSession(IDataSourceRouter dataSourceRouter,
                        IGridFsSessionExecutor<T> executor)
                 throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

dataSourceRouter - 数据源路由对象

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openGridFsSession

<T> T openGridFsSession(IMongoConnectionHolder connectionHolder,
                        String bucketName,
                        IGridFsSessionExecutor<T> executor)
                 throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

connectionHolder - 连接对象持有者

bucketName - 桶名称

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openGridFsSession

<T> T openGridFsSession(IDataSourceRouter dataSourceRouter,
                        String bucketName,
                        IGridFsSessionExecutor<T> executor)
                 throws Exception

开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)

Type Parameters:

T - 执行结果对象类型

Parameters:

dataSourceRouter - 数据源路由对象

bucketName - 桶名称

executor - 会话执行器

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openGridFsSession

IGridFsSession openGridFsSession()
                          throws Exception

开启数据库文件储存会话(注意一定记得关闭会话)

Returns:

返回会话对象

Throws:

Exception - 可能产生的异常

openGridFsSession

IGridFsSession openGridFsSession(String bucketName)
                          throws Exception

开启数据库文件储存会话(注意一定记得关闭会话)

Parameters:

bucketName - 桶名称

Returns:

返回会话对象

Throws:

Exception - 可能产生的异常

openGridFsSession

IGridFsSession openGridFsSession(String dataSourceName,
                                 String bucketName)
                          throws Exception

开启数据库文件储存会话(注意一定记得关闭会话)

Parameters:

dataSourceName - 数据源名称

bucketName - 桶名称

Returns:

返回会话对象

Throws:

Exception - 可能产生的异常

openGridFsSession

IGridFsSession openGridFsSession(IMongoConnectionHolder connectionHolder,
                                 String bucketName)
                          throws Exception

开启数据库文件储存会话(注意一定记得关闭会话)

Parameters:

connectionHolder - 连接对象持有者

bucketName - 桶名称

Returns:

返回会话对象

Throws:

Exception - 可能产生的异常

openGridFsSession

IGridFsSession openGridFsSession(IMongoConnectionHolder connectionHolder)
                          throws Exception

开启数据库文件储存会话(注意一定记得关闭会话)

Parameters:

connectionHolder - 连接对象持有者

Returns:

返回会话对象

Throws:

Exception - 可能产生的异常

openGridFsSession

IGridFsSession openGridFsSession(IDataSourceRouter dataSourceRouter,
                                 String bucketName)
                          throws Exception

开启数据库文件储存会话(注意一定记得关闭会话)

Parameters:

dataSourceRouter - 数据源路由对象

bucketName - 桶名称

Returns:

返回会话对象

Throws:

Exception - 可能产生的异常

openGridFsSession

IGridFsSession openGridFsSession(IDataSourceRouter dataSourceRouter)
                          throws Exception

开启数据库文件储存会话(注意一定记得关闭会话)

Parameters:

dataSourceRouter - 数据源路由对象

Returns:

返回会话对象

Throws:

Exception - 可能产生的异常

openTransaction

void openTransaction(ITrade trade)
              throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Parameters:

trade - 事务业务操作对象

Throws:

Exception - 可能产生的任何异常

openTransaction

void openTransaction(ITrade trade,
                     ClientSessionOptions clientSessionOptions)
              throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Parameters:

trade - 事务业务操作对象

clientSessionOptions - 事务配置对象

Throws:

Exception - 可能产生的任何异常

openTransaction

void openTransaction(IMongoConnectionHolder connectionHolder,
                     ITrade trade)
              throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Parameters:

connectionHolder - 连接对象持有者

trade - 事务业务操作对象

Throws:

Exception - 可能产生的任何异常

openTransaction

void openTransaction(IMongoConnectionHolder connectionHolder,
                     ITrade trade,
                     ClientSessionOptions clientSessionOptions)
              throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Parameters:

connectionHolder - 连接对象持有者

trade - 事务业务操作对象

clientSessionOptions - 事务配置对象

Throws:

Exception - 可能产生的任何异常

openTransaction

void openTransaction(IDataSourceRouter dataSourceRouter,
                     ITrade trade)
              throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Parameters:

dataSourceRouter - 数据源路由对象

trade - 事务业务操作对象

Throws:

Exception - 可能产生的任何异常

openTransaction

void openTransaction(IDataSourceRouter dataSourceRouter,
                     ITrade trade,
                     ClientSessionOptions clientSessionOptions)
              throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Parameters:

dataSourceRouter - 数据源路由对象

trade - 事务业务操作对象

clientSessionOptions - 事务配置对象

Throws:

Exception - 可能产生的任何异常

openTransaction

void openTransaction(String dataSourceName,
                     ITrade trade)
              throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Parameters:

dataSourceName - 数据源名称

trade - 事务业务操作对象

Throws:

Exception - 可能产生的任何异常

openTransaction

void openTransaction(String dataSourceName,
                     ITrade trade,
                     ClientSessionOptions clientSessionOptions)
              throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Parameters:

dataSourceName - 数据源名称

trade - 事务业务操作对象

clientSessionOptions - 事务配置对象

Throws:

Exception - 可能产生的任何异常

openTransaction

<T> T openTransaction(AbstractTrade<T> trade)
               throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Type Parameters:

T - 执行结果对象类型

Parameters:

trade - 事务业务操作对象

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openTransaction

<T> T openTransaction(AbstractTrade<T> trade,
                      ClientSessionOptions clientSessionOptions)
               throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Type Parameters:

T - 执行结果对象类型

Parameters:

trade - 事务业务操作对象

clientSessionOptions - 事务配置对象

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openTransaction

<T> T openTransaction(IMongoConnectionHolder connectionHolder,
                      AbstractTrade<T> trade,
                      ClientSessionOptions clientSessionOptions)
               throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Type Parameters:

T - 执行结果对象类型

Parameters:

connectionHolder - 连接对象持有者

trade - 事务业务操作对象

clientSessionOptions - 事务配置对象

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openTransaction

<T> T openTransaction(IMongoConnectionHolder connectionHolder,
                      AbstractTrade<T> trade)
               throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Type Parameters:

T - 执行结果对象类型

Parameters:

connectionHolder - 连接对象持有者

trade - 事务业务操作对象

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openTransaction

<T> T openTransaction(IDataSourceRouter dataSourceRouter,
                      AbstractTrade<T> trade)
               throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Type Parameters:

T - 执行结果对象类型

Parameters:

dataSourceRouter - 数据源路由对象

trade - 事务业务操作对象

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openTransaction

<T> T openTransaction(IDataSourceRouter dataSourceRouter,
                      AbstractTrade<T> trade,
                      ClientSessionOptions clientSessionOptions)
               throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Type Parameters:

T - 执行结果对象类型

Parameters:

dataSourceRouter - 数据源路由对象

trade - 事务业务操作对象

clientSessionOptions - 事务配置对象

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openTransaction

<T> T openTransaction(String dataSourceName,
                      AbstractTrade<T> trade)
               throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Type Parameters:

T - 执行结果对象类型

Parameters:

dataSourceName - 数据源名称

trade - 事务业务操作对象

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常

openTransaction

<T> T openTransaction(String dataSourceName,
                      AbstractTrade<T> trade,
                      ClientSessionOptions clientSessionOptions)
               throws Exception

开启事务(执行完毕事务将自动关闭, 任何异常将导致事务回滚)

Type Parameters:

T - 执行结果对象类型

Parameters:

dataSourceName - 数据源名称

trade - 事务业务操作对象

clientSessionOptions - 事务配置对象

Returns:

返回执行结果

Throws:

Exception - 可能产生的任何异常