ReplicaActiveRecordPlugin (Java Database 1.4.9 API)

java.lang.Object
- com.litongjava.db.activerecord.ReplicaActiveRecordPlugin

所有已实现的接口:

IPlugin
```
public class ReplicaActiveRecordPlugin
extends Object
implements IPlugin
```
ActiveRecord plugin.
ActiveRecord plugin not support mysql type year, you can use int instead of year. Mysql error message for type year when insert a record: Data truncated for column 'xxx' at row 1

字段概要

字段
限定符和类型	字段和说明
`protected List<Config>`	`configs`
`protected List<IDataSourceProvider>`	`dataSourceProviders`
`protected Boolean`	`devMode`
`protected boolean`	`isStarted`
`protected TableBuilder`	`tableBuilder`
`protected List<Table>`	`tableList`

构造器概要

构造器
构造器和说明
`ReplicaActiveRecordPlugin(Config config)`
`ReplicaActiveRecordPlugin(DataSource dataSource)`
`ReplicaActiveRecordPlugin(DataSource dataSource, int transactionLevel)`
`ReplicaActiveRecordPlugin(IDataSourceProvider dataSourceProvider)`
`ReplicaActiveRecordPlugin(IDataSourceProvider dataSourceProvider, int transactionLevel)`
`ReplicaActiveRecordPlugin(List<DataSource> datasources)`
`ReplicaActiveRecordPlugin(String configName, DataSource dataSource)`
`ReplicaActiveRecordPlugin(String configName, DataSource dataSource, int transactionLevel)`
`ReplicaActiveRecordPlugin(String configName, IDataSourceProvider dataSourceProvider)`
`ReplicaActiveRecordPlugin(String configName, IDataSourceProvider dataSourceProvider, int transactionLevel)`
`ReplicaActiveRecordPlugin(String configName, List<IDataSourceProvider> dataSourceProviders, int transactionLevel)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`ReplicaActiveRecordPlugin`	`addMapping(String tableName, Class<? extends Model<?>> modelClass)`
`ReplicaActiveRecordPlugin`	`addMapping(String tableName, String primaryKey, Class<? extends Model<?>> modelClass)`
`ReplicaActiveRecordPlugin`	`addSqlTemplate(com.jfinal.template.source.ISource sqlTemplate)`
`ReplicaActiveRecordPlugin`	`addSqlTemplate(String sqlTemplate)`
`Config`	`getConfig(int i)`
`Boolean`	`getDevMode()`
`com.jfinal.template.Engine`	`getEngine(int i)`
`SqlKit`	`getSqlKit(int i)`
`TableBuilder`	`getTableBuilder()` 一般用于配置 TableBuilder 内的 JavaType 例如： ActiveRecordPlugin arp = ...; JavaType jt = arp.getTableBuilder().getJavaType(); jt.addType(org.postgresql.geometric.PGpoint.class); jt.addType(org.postgresql.geometric.PGbox.class); jt.addType(org.postgresql.geometric.PGcircle.class); jt.addType(org.postgresql.geometric.PGline.class); jt.addType(org.postgresql.geometric.PGlseg.class); jt.addType(org.postgresql.geometric.PGpath.class); jt.addType(org.postgresql.geometric.PGpolygon.class);
`ReplicaActiveRecordPlugin`	`setBaseSqlTemplatePath(String baseSqlTemplatePath)`
`ReplicaActiveRecordPlugin`	`setCache(com.litongjava.cache.IDbCache cache)`
`ReplicaActiveRecordPlugin`	`setContainerFactory(IContainerFactory containerFactory)`
`ReplicaActiveRecordPlugin`	`setDbProFactory(IDbProFactory dbProFactory)`
`ReplicaActiveRecordPlugin`	`setDevMode(boolean devMode)`
`ReplicaActiveRecordPlugin`	`setDialect(Dialect dialect)`
`void`	`setPrimaryKey(String tableName, String primaryKey)` 当使用 create table 语句创建用于开发使用的数据表副本时，假如create table 中使用的复合主键次序不同，那么MappingKitGeneretor 反射生成的复合主键次序也会不同。
`ReplicaActiveRecordPlugin`	`setShowSql(boolean showSql)`
`ReplicaActiveRecordPlugin`	`setTableBuilder(TableBuilder tableBuilder)` 可用于切换 TableBuilder 实现类
`ReplicaActiveRecordPlugin`	`setTransactionLevel(int transactionLevel)` Set transaction level define in java.sql.Connection
`boolean`	`start()`
`boolean`	`stop()`
`static void`	`useAsDataTransfer()` 分布式场景下默认使用 MysqlDialect、 IContainerFactory.defaultContainerFactory、EhCache
`static void`	`useAsDataTransfer(Dialect dialect)` 分布式场景下指定 Dialect、并默认使用 IContainerFactory.defaultContainerFactory、EhCache
`static void`	`useAsDataTransfer(Dialect dialect, IContainerFactory containerFactory)` 分布式场景下指定 Dialect、IContainerFactory，并默认使用 EhCache
`static void`	`useAsDataTransfer(Dialect dialect, IContainerFactory containerFactory, com.litongjava.cache.IDbCache cache)` 用于分布式场景，当某个分布式节点只需要用 Model 承载和传输数据，而不需要实际操作数据库时调用本方法可保障 IContainerFactory、Dialect、ICache 的一致性本用法更加适用于 Generator 生成的继承自 base model的 Model，更加便于传统第三方工具对带有 getter、setter 的 model 进行各种处理警告：Dialect、IContainerFactory、ICache 三者一定要与集群中其它节点保持一致，以免程序出现不一致行为
`static void`	`useAsDataTransfer(IContainerFactory containerFactory)` 分布式场景下指定 IContainerFactory，并默认使用 MysqlDialect、EhCache

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

tableBuilder
```
protected TableBuilder tableBuilder
```

dataSourceProviders

protected List<IDataSourceProvider> dataSourceProviders

devMode
```
protected Boolean devMode
```

configs
```
protected List<Config> configs
```

isStarted
```
protected volatile boolean isStarted
```

tableList
```
protected List<Table> tableList
```

构造器详细资料

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(List<DataSource> datasources)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(String configName,
                                 DataSource dataSource,
                                 int transactionLevel)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(DataSource dataSource)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(String configName,
                                 DataSource dataSource)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(DataSource dataSource,
                                 int transactionLevel)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(String configName,
                                 IDataSourceProvider dataSourceProvider,
                                 int transactionLevel)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(String configName,
                                 List<IDataSourceProvider> dataSourceProviders,
                                 int transactionLevel)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(IDataSourceProvider dataSourceProvider)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(String configName,
                                 IDataSourceProvider dataSourceProvider)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(IDataSourceProvider dataSourceProvider,
                                 int transactionLevel)

ReplicaActiveRecordPlugin

public ReplicaActiveRecordPlugin(Config config)

方法详细资料

addMapping

public ReplicaActiveRecordPlugin addMapping(String tableName,
                                            String primaryKey,
                                            Class<? extends Model<?>> modelClass)

addMapping

public ReplicaActiveRecordPlugin addMapping(String tableName,
                                            Class<? extends Model<?>> modelClass)

addSqlTemplate

public ReplicaActiveRecordPlugin addSqlTemplate(String sqlTemplate)

addSqlTemplate

public ReplicaActiveRecordPlugin addSqlTemplate(com.jfinal.template.source.ISource sqlTemplate)

setBaseSqlTemplatePath

public ReplicaActiveRecordPlugin setBaseSqlTemplatePath(String baseSqlTemplatePath)

getSqlKit
```
public SqlKit getSqlKit(int i)
```

getEngine

public com.jfinal.template.Engine getEngine(int i)

setTransactionLevel
```
public ReplicaActiveRecordPlugin setTransactionLevel(int transactionLevel)
```
Set transaction level define in java.sql.Connection

参数:

transactionLevel - only be 0, 1, 2, 4, 8

setCache

public ReplicaActiveRecordPlugin setCache(com.litongjava.cache.IDbCache cache)

setShowSql

public ReplicaActiveRecordPlugin setShowSql(boolean showSql)

setDevMode

public ReplicaActiveRecordPlugin setDevMode(boolean devMode)

getDevMode
```
public Boolean getDevMode()
```

setDialect

public ReplicaActiveRecordPlugin setDialect(Dialect dialect)

setContainerFactory

public ReplicaActiveRecordPlugin setContainerFactory(IContainerFactory containerFactory)

setDbProFactory

public ReplicaActiveRecordPlugin setDbProFactory(IDbProFactory dbProFactory)

setPrimaryKey
```
public void setPrimaryKey(String tableName,
                          String primaryKey)
```
当使用 create table 语句创建用于开发使用的数据表副本时，假如create table 中使用的复合主键次序不同，那么MappingKitGeneretor 反射生成的复合主键次序也会不同。而程序中类似于 model.deleteById(id1, id2) 方法中复合主键次序与需要与映射时的次序保持一致，可以在MappingKit 映射完成以后通过调用此方法再次强制指定复合主键次序
```
 Example:
 ActiveRecrodPlugin arp = new ActiveRecordPlugin(...);
 _MappingKit.mapping(arp);
 arp.setPrimaryKey("account_role", "account_id, role_id");
 me.add(arp);
 
```

start
```
public boolean start()
```
指定者:

start 在接口中 IPlugin

stop
```
public boolean stop()
```
指定者:

stop 在接口中 IPlugin

useAsDataTransfer

public static void useAsDataTransfer(Dialect dialect,
                                     IContainerFactory containerFactory,
                                     com.litongjava.cache.IDbCache cache)

用于分布式场景，当某个分布式节点只需要用 Model 承载和传输数据，而不需要实际操作数据库时调用本方法可保障 IContainerFactory、Dialect、ICache 的一致性本用法更加适用于 Generator 生成的继承自 base model的 Model，更加便于传统第三方工具对带有 getter、setter 的 model 进行各种处理

 警告：Dialect、IContainerFactory、ICache 三者一定要与集群中其它节点保持一致，
     以免程序出现不一致行为

useAsDataTransfer
```
public static void useAsDataTransfer(IContainerFactory containerFactory)
```
分布式场景下指定 IContainerFactory，并默认使用 MysqlDialect、EhCache

另请参阅:

useAsDataTransfer(Dialect, IContainerFactory, IDbCache)

useAsDataTransfer

public static void useAsDataTransfer(Dialect dialect,
                                     IContainerFactory containerFactory)

分布式场景下指定 Dialect、IContainerFactory，并默认使用 EhCache

另请参阅:: useAsDataTransfer(Dialect, IContainerFactory, IDbCache)

useAsDataTransfer
```
public static void useAsDataTransfer(Dialect dialect)
```
分布式场景下指定 Dialect、并默认使用 IContainerFactory.defaultContainerFactory、EhCache

另请参阅:

useAsDataTransfer(Dialect, IContainerFactory, IDbCache)

useAsDataTransfer
```
public static void useAsDataTransfer()
```
分布式场景下默认使用 MysqlDialect、 IContainerFactory.defaultContainerFactory、EhCache

另请参阅:

useAsDataTransfer(Dialect, IContainerFactory, IDbCache)

getConfig
```
public Config getConfig(int i)
```

getTableBuilder

public TableBuilder getTableBuilder()

一般用于配置 TableBuilder 内的 JavaType

 例如：
    ActiveRecordPlugin arp = ...;
    JavaType jt = arp.getTableBuilder().getJavaType();
    
    jt.addType(org.postgresql.geometric.PGpoint.class);
    jt.addType(org.postgresql.geometric.PGbox.class);
    jt.addType(org.postgresql.geometric.PGcircle.class);
    jt.addType(org.postgresql.geometric.PGline.class);
    jt.addType(org.postgresql.geometric.PGlseg.class);
    jt.addType(org.postgresql.geometric.PGpath.class);
    jt.addType(org.postgresql.geometric.PGpolygon.class);

setTableBuilder

public ReplicaActiveRecordPlugin setTableBuilder(TableBuilder tableBuilder)

可用于切换 TableBuilder 实现类

类 ReplicaActiveRecordPlugin

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

tableBuilder

dataSourceProviders

devMode

configs

isStarted

tableList

构造器详细资料

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

ReplicaActiveRecordPlugin

方法详细资料

addMapping

addMapping

addSqlTemplate

addSqlTemplate

setBaseSqlTemplatePath

getSqlKit

getEngine

setTransactionLevel

setCache

setShowSql

setDevMode

getDevMode

setDialect

setContainerFactory

setDbProFactory

setPrimaryKey

start

stop

useAsDataTransfer

useAsDataTransfer

useAsDataTransfer

useAsDataTransfer

useAsDataTransfer

getConfig

getTableBuilder

setTableBuilder