SqlToyContext (sagacity-sqltoy 5.2.55 API)

java.lang.Object
- org.sagacity.sqltoy.SqlToyContext

```
public class SqlToyContext
extends Object
```
版本:

v1.0,Date:2009-12-11

作者:

zhongxuchen

字段概要

字段
限定符和类型字段和说明

protected org.slf4j.Logger logger
定义日志

字段
限定符和类型	字段和说明
`protected org.slf4j.Logger`	`logger` 定义日志

构造器概要

构造器
构造器和说明

SqlToyContext()

构造器
构造器和说明
`SqlToyContext()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`destroy()`
`AppContext`	`getAppContext()`
`int`	`getBatchSize()`
`Object`	`getBean(Object beanName)`
`String`	`getColumnLabelUpperOrLower()`
`Connection`	`getConnection(DataSource datasource)`
`FilterHandler`	`getCustomFilterHandler()`
`DataSource`	`getDataSourceBean(String dataSourceName)`
`DataSourceSelector`	`getDataSourceSelector()`
`DataSource`	`getDefaultDataSource()`
`String`	`getDefaultElastic()`
`DesensitizeProvider`	`getDesensitizeProvider()`
`String`	`getDialect()`
`String`	`getDistributeIdGeneratorClass()`
`ElasticEndpoint`	`getElasticEndpoint(String id)`
`EntityManager`	`getEntityManager()`
`EntityMeta`	`getEntityMeta(Class<?> entityClass)`
`EntityMeta`	`getEntityMeta(String tableName)`
`int`	`getFetchSize()`
`FieldsSecureProvider`	`getFieldsSecureProvider()`
`String`	`getMongoQueryClass()`
`Boolean`	`getOverPageToFirst()`
`OverTimeSqlHandler`	`getOverTimeSqlHandler()`
`int`	`getPageFetchSizeLimit()`
`int`	`getPrintSqlTimeoutMillis()`
`String[]`	`getRedoDataSources()`
`SqlScriptLoader`	`getScriptLoader()`
`Object`	`getServiceData(String beanName, String method, Object[] args)`
`ShardingStrategy`	`getShardingStrategy(String strategyName)`
`List<OverTimeSql>`	`getSlowestSql(int size, boolean hasSqlId)`
`List<SqlInterceptor>`	`getSqlInterceptors()`
`SqlToyConfig`	`getSqlToyConfig(QueryExecutor queryExecutor, SqlType sqlType, String dialect)`
`SqlToyConfig`	`getSqlToyConfig(String sqlKey)`
`SqlToyConfig`	`getSqlToyConfig(String sqlKey, SqlType sqlType, String dialect)`
`Executor`	`getTaskExecutor()`
`TranslateManager`	`getTranslateManager()`
`TypeHandler`	`getTypeHandler()`
`IUnifyFieldsHandler`	`getUnifyFieldsHandler()`
`int`	`getUpdateTipCount()`
`boolean`	`hasSqlInterceptors()`
`void`	`initDefaultDataSource()`
`void`	`initialize()`
`boolean`	`isDebug()`
`boolean`	`isDefaultPageOffset()`
`boolean`	`isEntity(Class<?> entityClass)`
`boolean`	`isExecuteSqlBlankToNull()`
`boolean`	`isHumpMapResultTypeLabel()`
`boolean`	`isSplitMergeInto()`
`void`	`parseSqlFile(Object sqlFile)`
`SqlToyConfig`	`parseSqlSegment(Object sqlSegment)` 1、第一步调用解析，注意是单个sqlId的片段 2、根据业务情况，调整id,sqlToyConfig.setId(),注意:这步并非必要,当报表平台时,报表里面多个sql,每个id在本报表范围内唯一，当很多个报表时会冲突，所以需要整合rptId+sqlId 3、putSqlToyConfig(SqlToyConfig sqlToyConfig) 放入交由sqltoy统一管理
`void`	`putSqlToyConfig(SqlToyConfig sqlToyConfig)`
`void`	`releaseConnection(Connection conn, DataSource dataSource)`
`void`	`setAnnotatedClasses(String[] annotatedClasses)`
`void`	`setAppContext(AppContext appContext)`
`void`	`setBatchSize(int batchSize)`
`void`	`setBreakWhenSqlRepeat(boolean breakWhenSqlRepeat)`
`void`	`setCacheType(String cacheType)`
`void`	`setColumnLabelUpperOrLower(String columnLabelUpperOrLower)`
`void`	`setConnectionFactory(ConnectionFactory connectionFactory)`
`void`	`setCustomFilterHandler(FilterHandler customFilterHandler)`
`void`	`setDataCenterId(Integer dataCenterId)`
`void`	`setDataSourceSelector(DataSourceSelector dataSourceSelector)`
`void`	`setDebug(boolean debug)`
`void`	`setDefaultDataSource(DataSource defaultDataSource)`
`void`	`setDefaultDataSourceName(String defaultDataSourceName)`
`void`	`setDefaultElastic(String defaultElastic)`
`void`	`setDefaultPageOffset(boolean defaultPageOffset)`
`void`	`setDefaultPageSize(int defaultPageSize)`
`void`	`setDelayCheckSeconds(int delayCheckSeconds)`
`void`	`setDesensitizeProvider(DesensitizeProvider desensitizeProvider)`
`void`	`setDialect(String dialect)`
`void`	`setDialectConfig(Map<String,String> dialectConfig)`
`void`	`setDistributeIdGeneratorClass(String distributeIdGeneratorClass)`
`void`	`setElasticEndpoints(List<ElasticEndpoint> elasticEndpointList)`
`void`	`setEncoding(String encoding)`
`void`	`setExecuteSqlBlankToNull(boolean executeSqlBlankToNull)`
`void`	`setFetchSize(int fetchSize)`
`void`	`setFieldsSecureProvider(FieldsSecureProvider fieldsSecureProvider)`
`void`	`setFunctionConverts(Object functionConverts)` functionConverts=close表示关闭
`void`	`setHumpMapResultTypeLabel(boolean humpMapResultTypeLabel)`
`void`	`setKeywordSign(String keywordSign)`
`void`	`setMongoQueryClass(String mongoQueryClass)`
`void`	`setOverPageToFirst(Boolean overPageToFirst)`
`void`	`setOverTimeSqlHandler(OverTimeSqlHandler overTimeSqlHandler)`
`void`	`setPackagesToScan(String[] packagesToScan)`
`void`	`setPageFetchSizeLimit(int pageFetchSizeLimit)`
`void`	`setPrintSqlTimeoutMillis(int printSqlTimeoutMillis)`
`void`	`setRecursive(boolean recursive)`
`void`	`setRedoDataSources(String[] redoDataSources)`
`void`	`setReservedWords(String reservedWords)`
`void`	`setScriptCheckIntervalSeconds(int scriptCheckIntervalSeconds)`
`void`	`setSecurePrivateKey(String securePrivateKey)`
`void`	`setSecurePublicKey(String securePublicKey)`
`void`	`setServerId(Integer serverId)`
`void`	`setShardingStrategys(HashMap<String,ShardingStrategy> shardingStrategys)`
`void`	`setSplitMergeInto(boolean splitMergeInto)`
`void`	`setSqlFormater(SqlFormater sqlFormater)`
`void`	`setSqlInterceptors(List<SqlInterceptor> sqlInterceptors)`
`void`	`setSqlResources(List<String> sqlResources)`
`void`	`setSqlResourcesDir(String sqlResourcesDir)`
`void`	`setTaskExecutor(Executor taskExecutor)`
`void`	`setTaskExecutorName(String taskExecutorName)`
`void`	`setTranslateCacheManager(TranslateCacheManager translateCacheManager)`
`void`	`setTranslateCaffeineManagerClass(String translateCaffeineManagerClass)`
`void`	`setTranslateConfig(String translateConfig)`
`void`	`setTypeHandler(TypeHandler typeHandler)`
`void`	`setUncachedKeyResult(String uncachedKeyResult)`
`void`	`setUnifyFieldsHandler(IUnifyFieldsHandler unifyFieldsHandler)`
`void`	`setUpdateTipCount(int updateTipCount)`
`void`	`setWorkerId(Integer workerId)`

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

字段详细资料

logger

protected final org.slf4j.Logger logger

定义日志

构造器详细资料
- SqlToyContext
```
public SqlToyContext()
```

方法详细资料

setUnifyFieldsHandler

public void setUnifyFieldsHandler(IUnifyFieldsHandler unifyFieldsHandler)

参数:: unifyFieldsHandler - the unifyFieldsHandler to set

getUnifyFieldsHandler

public IUnifyFieldsHandler getUnifyFieldsHandler()

返回:: the unifyFieldsHandler

getTranslateManager

public TranslateManager getTranslateManager()

返回:: the translateManager

initialize

public void initialize()
                throws Exception

抛出:: Exception

getServiceData

public Object getServiceData(String beanName,
                             String method,
                             Object[] args)

参数:: beanName -; method -; args -
返回:

getBean

public Object getBean(Object beanName)

参数:: beanName -
返回:

getDataSourceBean

public DataSource getDataSourceBean(String dataSourceName)

参数:: dataSourceName -
返回:

getSqlToyConfig

public SqlToyConfig getSqlToyConfig(String sqlKey)

参数:: sqlKey -
返回:

getSqlToyConfig

public SqlToyConfig getSqlToyConfig(String sqlKey,
                                    SqlType sqlType,
                                    String dialect)

参数:: sqlKey -; sqlType -; dialect -
返回:

getSqlToyConfig

public SqlToyConfig getSqlToyConfig(QueryExecutor queryExecutor,
                                    SqlType sqlType,
                                    String dialect)

getScriptLoader

public SqlScriptLoader getScriptLoader()

返回:: the scriptLoader

setWorkerId
```
public void setWorkerId(Integer workerId)
```
参数:

workerId - the workerId to set

setDataCenterId
```
public void setDataCenterId(Integer dataCenterId)
```
参数:

dataCenterId - the dataCenterId to set

setServerId
```
public void setServerId(Integer serverId)
```
参数:

serverId - the serverId to set

getBatchSize
```
public int getBatchSize()
```
返回:

the batchSize

setBatchSize
```
public void setBatchSize(int batchSize)
```
参数:

batchSize - the batchSize to set

getShardingStrategy

public ShardingStrategy getShardingStrategy(String strategyName)

参数:: strategyName -
返回:

setShardingStrategys

public void setShardingStrategys(HashMap<String,ShardingStrategy> shardingStrategys)

参数:: shardingStrategys - the shardingStrategys to set

getEntityManager

public EntityManager getEntityManager()

返回:: the entityManager

getEntityMeta

public EntityMeta getEntityMeta(Class<?> entityClass)

getEntityMeta

public EntityMeta getEntityMeta(String tableName)

参数:: tableName -
返回:

isEntity

public boolean isEntity(Class<?> entityClass)

参数:: entityClass -
返回:

parseSqlSegment

public SqlToyConfig parseSqlSegment(Object sqlSegment)
                             throws Exception

1、第一步调用解析，注意是单个sqlId的片段
2、根据业务情况，调整id,sqlToyConfig.setId(),注意:这步并非必要,当报表平台时,报表里面多个sql,每个id在本报表范围内唯一，当很多个报表时会冲突，所以需要整合rptId+sqlId
3、putSqlToyConfig(SqlToyConfig sqlToyConfig) 放入交由sqltoy统一管理

参数:: sqlSegment -
返回:
抛出:: Exception

putSqlToyConfig

public void putSqlToyConfig(SqlToyConfig sqlToyConfig)
                     throws Exception

参数:: sqlToyConfig -
抛出:: Exception

parseSqlFile

public void parseSqlFile(Object sqlFile)
                  throws Exception

参数:: sqlFile -
抛出:: Exception

getDialect
```
public String getDialect()
```
返回:

the dialect

setDialect
```
public void setDialect(String dialect)
```
参数:

dialect - the dialect to set

isDebug
```
public boolean isDebug()
```
返回:

the debug

setDebug
```
public void setDebug(boolean debug)
```
参数:

debug - the debug to set

setPackagesToScan
```
public void setPackagesToScan(String[] packagesToScan)
```
参数:

packagesToScan - the packagesToScan to set

getPageFetchSizeLimit
```
public int getPageFetchSizeLimit()
```
返回:

the pageFetchSizeLimit

setPageFetchSizeLimit
```
public void setPageFetchSizeLimit(int pageFetchSizeLimit)
```
参数:

pageFetchSizeLimit - the pageFetchSizeLimit to set

setRecursive
```
public void setRecursive(boolean recursive)
```
参数:

recursive - the recursive to set

setAnnotatedClasses
```
public void setAnnotatedClasses(String[] annotatedClasses)
```
参数:

annotatedClasses - the annotatedClasses to set

setDialectConfig

public void setDialectConfig(Map<String,String> dialectConfig)

setSqlResourcesDir

public void setSqlResourcesDir(String sqlResourcesDir)

setSqlResources

public void setSqlResources(List<String> sqlResources)

setEncoding

public void setEncoding(String encoding)

setFunctionConverts
```
public void setFunctionConverts(Object functionConverts)
```
functionConverts=close表示关闭

参数:

functionConverts - the functionConverts to set

setTranslateConfig
```
public void setTranslateConfig(String translateConfig)
```
参数:

translateConfig - the translateConfig to set

setUncachedKeyResult
```
public void setUncachedKeyResult(String uncachedKeyResult)
```
参数:

uncachedKeyResult - the nocacheKeyResult to set

getAppContext
```
public AppContext getAppContext()
```

setAppContext

public void setAppContext(AppContext appContext)

initDefaultDataSource
```
public void initDefaultDataSource()
```

getDefaultDataSource

public DataSource getDefaultDataSource()

setElasticEndpoints

public void setElasticEndpoints(List<ElasticEndpoint> elasticEndpointList)

参数:: elasticEndpointList - the elasticConfigs to set

getElasticEndpoint

public ElasticEndpoint getElasticEndpoint(String id)

getPrintSqlTimeoutMillis
```
public int getPrintSqlTimeoutMillis()
```
返回:

the printSqlTimeoutMillis

setPrintSqlTimeoutMillis
```
public void setPrintSqlTimeoutMillis(int printSqlTimeoutMillis)
```
参数:

printSqlTimeoutMillis - the printSqlTimeoutMillis to set

setKeywordSign
```
public void setKeywordSign(String keywordSign)
```
参数:

keywordSign - the keywordSign to set

setScriptCheckIntervalSeconds
```
public void setScriptCheckIntervalSeconds(int scriptCheckIntervalSeconds)
```
参数:

scriptCheckIntervalSeconds - the scriptCheckIntervalSeconds to set

setDelayCheckSeconds

public void setDelayCheckSeconds(int delayCheckSeconds)

setTranslateCacheManager

public void setTranslateCacheManager(TranslateCacheManager translateCacheManager)

getDefaultElastic
```
public String getDefaultElastic()
```

setDefaultElastic

public void setDefaultElastic(String defaultElastic)

setReservedWords
```
public void setReservedWords(String reservedWords)
```
参数:

reservedWords - the reservedWords to set

getTypeHandler
```
public TypeHandler getTypeHandler()
```
返回:

the typeHandler

setTypeHandler

public void setTypeHandler(TypeHandler typeHandler)

参数:: typeHandler - the typeHandler to set

setCacheType
```
public void setCacheType(String cacheType)
```
参数:

cacheType - the cacheType to set

destroy
```
public void destroy()
```

getDataSourceSelector

public DataSourceSelector getDataSourceSelector()

返回:: the dataSourceSelector

setDataSourceSelector

public void setDataSourceSelector(DataSourceSelector dataSourceSelector)

参数:: dataSourceSelector - the dataSourceSelector to set

getFetchSize
```
public int getFetchSize()
```
返回:

the fetchSize

setFetchSize
```
public void setFetchSize(int fetchSize)
```
参数:

fetchSize - the fetchSize to set

setDefaultDataSource

public void setDefaultDataSource(DataSource defaultDataSource)

setDefaultDataSourceName

public void setDefaultDataSourceName(String defaultDataSourceName)

setConnectionFactory

public void setConnectionFactory(ConnectionFactory connectionFactory)

getConnection

public Connection getConnection(DataSource datasource)

releaseConnection

public void releaseConnection(Connection conn,
                              DataSource dataSource)

setBreakWhenSqlRepeat

public void setBreakWhenSqlRepeat(boolean breakWhenSqlRepeat)

setSecurePrivateKey

public void setSecurePrivateKey(String securePrivateKey)

setSecurePublicKey

public void setSecurePublicKey(String securePublicKey)

setFieldsSecureProvider

public void setFieldsSecureProvider(FieldsSecureProvider fieldsSecureProvider)

getFieldsSecureProvider

public FieldsSecureProvider getFieldsSecureProvider()

getDesensitizeProvider

public DesensitizeProvider getDesensitizeProvider()

setDesensitizeProvider

public void setDesensitizeProvider(DesensitizeProvider desensitizeProvider)

getCustomFilterHandler

public FilterHandler getCustomFilterHandler()

setCustomFilterHandler

public void setCustomFilterHandler(FilterHandler customFilterHandler)

setTranslateCaffeineManagerClass

public void setTranslateCaffeineManagerClass(String translateCaffeineManagerClass)

getDistributeIdGeneratorClass

public String getDistributeIdGeneratorClass()

setDistributeIdGeneratorClass

public void setDistributeIdGeneratorClass(String distributeIdGeneratorClass)

getMongoQueryClass
```
public String getMongoQueryClass()
```

setMongoQueryClass

public void setMongoQueryClass(String mongoQueryClass)

getOverTimeSqlHandler

public OverTimeSqlHandler getOverTimeSqlHandler()

setOverTimeSqlHandler

public void setOverTimeSqlHandler(OverTimeSqlHandler overTimeSqlHandler)

getSlowestSql
```
public List<OverTimeSql> getSlowestSql(int size,
                                       boolean hasSqlId)
```
参数:

size - 提取记录数量

hasSqlId - 是否是xml中定义含id的sql(另外一种就是代码中直接写的sql)

返回:

getColumnLabelUpperOrLower

public String getColumnLabelUpperOrLower()

setColumnLabelUpperOrLower

public void setColumnLabelUpperOrLower(String columnLabelUpperOrLower)

getRedoDataSources
```
public String[] getRedoDataSources()
```

setRedoDataSources

public void setRedoDataSources(String[] redoDataSources)

getSqlInterceptors

public List<SqlInterceptor> getSqlInterceptors()

hasSqlInterceptors
```
public boolean hasSqlInterceptors()
```

setSqlInterceptors

public void setSqlInterceptors(List<SqlInterceptor> sqlInterceptors)

isSplitMergeInto
```
public boolean isSplitMergeInto()
```

setSplitMergeInto

public void setSplitMergeInto(boolean splitMergeInto)

isHumpMapResultTypeLabel

public boolean isHumpMapResultTypeLabel()

setHumpMapResultTypeLabel

public void setHumpMapResultTypeLabel(boolean humpMapResultTypeLabel)

getUpdateTipCount
```
public int getUpdateTipCount()
```

setUpdateTipCount

public void setUpdateTipCount(int updateTipCount)

isExecuteSqlBlankToNull

public boolean isExecuteSqlBlankToNull()

setExecuteSqlBlankToNull

public void setExecuteSqlBlankToNull(boolean executeSqlBlankToNull)

getOverPageToFirst
```
public Boolean getOverPageToFirst()
```

setOverPageToFirst

public void setOverPageToFirst(Boolean overPageToFirst)

setTaskExecutorName

public void setTaskExecutorName(String taskExecutorName)

getTaskExecutor
```
public Executor getTaskExecutor()
```

setTaskExecutor

public void setTaskExecutor(Executor taskExecutor)

setSqlFormater

public void setSqlFormater(SqlFormater sqlFormater)

参数:: sqlFormater - the sqlFormater to set

setDefaultPageSize

public void setDefaultPageSize(int defaultPageSize)

isDefaultPageOffset
```
public boolean isDefaultPageOffset()
```

setDefaultPageOffset

public void setDefaultPageOffset(boolean defaultPageOffset)

类 SqlToyContext

字段概要

构造器概要

方法概要

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

字段详细资料

logger

构造器详细资料

SqlToyContext

方法详细资料

setUnifyFieldsHandler

getUnifyFieldsHandler

getTranslateManager

initialize

getServiceData

getBean

getDataSourceBean

getSqlToyConfig

getSqlToyConfig

getSqlToyConfig

getScriptLoader

setWorkerId

setDataCenterId

setServerId

getBatchSize

setBatchSize

getShardingStrategy

setShardingStrategys

getEntityManager

getEntityMeta

getEntityMeta

isEntity

parseSqlSegment

putSqlToyConfig

parseSqlFile

getDialect

setDialect

isDebug

setDebug

setPackagesToScan

getPageFetchSizeLimit

setPageFetchSizeLimit

setRecursive

setAnnotatedClasses

setDialectConfig

setSqlResourcesDir

setSqlResources

setEncoding

setFunctionConverts

setTranslateConfig

setUncachedKeyResult

getAppContext

setAppContext

initDefaultDataSource

getDefaultDataSource

setElasticEndpoints

getElasticEndpoint

getPrintSqlTimeoutMillis

setPrintSqlTimeoutMillis

setKeywordSign

setScriptCheckIntervalSeconds

setDelayCheckSeconds

setTranslateCacheManager

getDefaultElastic

setDefaultElastic

setReservedWords

getTypeHandler

setTypeHandler

setCacheType

destroy

getDataSourceSelector

setDataSourceSelector

getFetchSize

setFetchSize

setDefaultDataSource

setDefaultDataSourceName

setConnectionFactory

getConnection

releaseConnection

setBreakWhenSqlRepeat