AbstractDBStyle (sql-core 3.14.2-RELEASE API)

java.lang.Object
- org.beetl.sql.core.db.AbstractDBStyle

所有已实现的接口:

DBAutoGeneratedSql, DBStyle

直接已知子类:

CassandraSqlStyle, ClickHouseStyle, CouchBaseStyle, DamengStyle, DB2SqlStyle, DerbyStyle, DrillStyle, DruidStyle, ElasticStyle, Gbase8sStyle, H2Style, HBaseStyle, HiveStyle, IgniteStyle, ImpalaStyle, IotDbStyle, MachbaseStyle, MySqlStyle, OracleStyle, PostgresStyle, PrestoStyle, ShenTongSqlStyle, SQLiteStyle, SqlServerStyle, TaosStyle
```
public abstract class AbstractDBStyle
extends Object
implements DBStyle
```
标识了sql的共性和不同

作者:

xiandafu

嵌套类概要

嵌套类
限定符和类型类和说明

static class AbstractDBStyle.MockXXX

嵌套类
限定符和类型	类和说明
`static class`	`AbstractDBStyle.MockXXX`

字段概要

字段
限定符和类型	字段和说明
`static AssignID`	`DEFAULT_ASSIGNID`
`protected KeyWordHandler`	`keyWordHandler`
`protected String`	`lineSeparator`
`protected MetadataManager`	`metadataManager`
`protected NameConversion`	`nameConversion`
`boolean`	`offsetStartZero`
`protected SQLManager`	`sqlManager`

从接口继承的字段 org.beetl.sql.core.db.DBAutoGeneratedSql
OFFSET, ORDER_BY, PAGE, PAGE_END, PAGE_SIZE

构造器概要

构造器
构造器和说明

AbstractDBStyle()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`appendExpress(String express)`
`protected void`	`appendIdCondition(Class<?> cls, WhereNode node)` 生成主键条件子句（示例 whrer 1=1 and id=${id}）
`protected void`	`appendJoinInIdsCondition(Class<?> cls, WhereNode node)`
`protected void`	`appendLogicFlagCondition(Class<?> cls, WhereNode node)`
`protected void`	`appendVersion(ClassDesc desc, WhereNode node)`
`SQLExecutor`	`buildExecutor(ExecuteContext executeContext)` 得到一个SQL执行类`SQLExecutor`,它是系统的核心类之一
`protected void`	`checkId(Collection colsId, Collection attrsId, String clsName)`
`void`	`config(SQLManager sqlManager)` 在SQLManager配置好后，会调用此方法，最后对sqlmanager进行修改配置
`protected ConcatContext`	`createConcatContext()`
`SQLSource`	`genDeleteById(Class<?> cls)`
`protected SQLSource`	`generalInsert(Class<?> cls, boolean template)`
`SQLSource`	`genExistSql(Class<?> cls)`
`SQLSource`	`genInsert(Class<?> cls)`
`SQLSource`	`genInsertTemplate(Class<?> cls)`
`SQLSource`	`genSelectAll(Class<?> cls, Class viewType)`
`SQLSource`	`genSelectById(Class<?> cls, Class viewType)`
`SQLSource`	`genSelectByIdForUpdate(Class<?> cls, Class viewType)`
`SQLSource`	`genSelectByIds(Class<?> cls, Class viewType)`
`SQLSource`	`genSelectByTemplate(Class<?> cls, Class viewType)`
`SQLSource`	`genSelectCountByTemplate(Class<?> cls)`
`SQLSource`	`genUpdateAbsolute(Class<?> cls)`
`SQLSource`	`genUpdateAll(Class<?> cls)`
`SQLSource`	`genUpdateById(Class<?> cls)`
`SQLSource`	`genUpdateRawById(Class<?> cls)`
`SQLSource`	`genUpdateTemplate(Class<?> cls)`
`String`	`getDefaultSchema()` 通过jdbc connection可以得到 schema和catalog，但可能低版本驱动不支持，这里提供数据库默认的
`int`	`getIdType(Class c, String idProperty)` 根据注解来决定主键采用哪种方式生成。
`KeyWordHandler`	`getKeyWordHandler()`
`NameConversion`	`getNameConversion()` 获取命名转换器
`String`	`getOrderBy()`
`protected Update`	`getRawUpdate(Class<?> cls)`
`protected void`	`getSelectTemplate(Class<?> cls, WhereNode whereNode)`
`String`	`getSeqValue(String seqName)` 通过序列名字返回获取序列值的sql片段
`SQLTemplateEngine`	`getSQLTemplateEngine()`
`protected Update`	`getUpdate(Class<?> cls)`
`void`	`init(SQLTemplateEngine sqlTemplateEngine, Properties ps)` 初始化DBStyle
`MetadataManager`	`initMetadataManager(ConnectionSource cs)` 初始化元数据管理器
`MetadataManager`	`initMetadataManager(ConnectionSource cs, String defaultSchema, String defalutCatalog)`
`boolean`	`isOffsetStartZero()`
`void`	`setKeyWordHandler(KeyWordHandler keyWordHandler)` sql中的关键字处理
`void`	`setNameConversion(NameConversion nameConversion)`
`void`	`setOffsetStartZero(boolean offsetStartZero)` 设置分页语句的起始偏移为0
`String`	`wrapStatementValue(Object value)` 如果不支持preparedStatement，在直接使用Statement的时候，返回输出变量到sql语句里，例如，当变量是字符串a"bc 应该输出`"a\"bc"`，注意，需要考虑SQL注入漏洞

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

从接口继承的方法 org.beetl.sql.core.db.DBStyle
batchGeneratedKeysSupport, getDBType, getMaxBatchCount, getName, getRangeSql, isNoSql, metadataSupport, preparedStatementSupport, streamConfig

字段详细资料

offsetStartZero
```
public boolean offsetStartZero
```

nameConversion

protected NameConversion nameConversion

metadataManager

protected MetadataManager metadataManager

lineSeparator
```
protected String lineSeparator
```

keyWordHandler

protected KeyWordHandler keyWordHandler

sqlManager
```
protected SQLManager sqlManager
```

DEFAULT_ASSIGNID

public static AssignID DEFAULT_ASSIGNID

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

方法详细资料
- init
```
public void init(SQLTemplateEngine sqlTemplateEngine,
                 Properties ps)
```
  从接口复制的说明: DBStyle
  
  初始化DBStyle
  
  指定者:
  
  init 在接口中 DBStyle
  
  参数:
  
  sqlTemplateEngine - 执行SQL模板的引擎，默认beetl
  
  ps - beetlsql配置信息
- getNameConversion
```
public NameConversion getNameConversion()
```
  从接口复制的说明: DBAutoGeneratedSql
  
  获取命名转换器
  
  指定者:
  
  getNameConversion 在接口中 DBAutoGeneratedSql
- setNameConversion
```
public void setNameConversion(NameConversion nameConversion)
```
  指定者:
  
  setNameConversion 在接口中 DBAutoGeneratedSql
- genSelectById
```
public SQLSource genSelectById(Class<?> cls,
                               Class viewType)
```
  指定者:
  
  genSelectById 在接口中 DBAutoGeneratedSql
- genSelectByIds
```
public SQLSource genSelectByIds(Class<?> cls,
                                Class viewType)
```
  指定者:
  
  genSelectByIds 在接口中 DBAutoGeneratedSql
- genExistSql
```
public SQLSource genExistSql(Class<?> cls)
```
  指定者:
  
  genExistSql 在接口中 DBAutoGeneratedSql
- genSelectByIdForUpdate
```
public SQLSource genSelectByIdForUpdate(Class<?> cls,
                                        Class viewType)
```
  指定者:
  
  genSelectByIdForUpdate 在接口中 DBAutoGeneratedSql
- genSelectByTemplate
```
public SQLSource genSelectByTemplate(Class<?> cls,
                                     Class viewType)
```
  指定者:
  
  genSelectByTemplate 在接口中 DBAutoGeneratedSql
- genSelectCountByTemplate
```
public SQLSource genSelectCountByTemplate(Class<?> cls)
```
  指定者:
  
  genSelectCountByTemplate 在接口中 DBAutoGeneratedSql
- genDeleteById
```
public SQLSource genDeleteById(Class<?> cls)
```
  指定者:
  
  genDeleteById 在接口中 DBAutoGeneratedSql
- genSelectAll
```
public SQLSource genSelectAll(Class<?> cls,
                              Class viewType)
```
  指定者:
  
  genSelectAll 在接口中 DBAutoGeneratedSql
- genUpdateById
```
public SQLSource genUpdateById(Class<?> cls)
```
  指定者:
  
  genUpdateById 在接口中 DBAutoGeneratedSql
- genUpdateRawById
```
public SQLSource genUpdateRawById(Class<?> cls)
```
  指定者:
  
  genUpdateRawById 在接口中 DBAutoGeneratedSql
- genUpdateAbsolute
```
public SQLSource genUpdateAbsolute(Class<?> cls)
```
  指定者:
  
  genUpdateAbsolute 在接口中 DBAutoGeneratedSql
- genUpdateTemplate
```
public SQLSource genUpdateTemplate(Class<?> cls)
```
  指定者:
  
  genUpdateTemplate 在接口中 DBAutoGeneratedSql
- genUpdateAll
```
public SQLSource genUpdateAll(Class<?> cls)
```
  指定者:
  
  genUpdateAll 在接口中 DBAutoGeneratedSql
- genInsert
```
public SQLSource genInsert(Class<?> cls)
```
  指定者:
  
  genInsert 在接口中 DBAutoGeneratedSql
- genInsertTemplate
```
public SQLSource genInsertTemplate(Class<?> cls)
```
  指定者:
  
  genInsertTemplate 在接口中 DBAutoGeneratedSql
- generalInsert
```
protected SQLSource generalInsert(Class<?> cls,
                                  boolean template)
```
- getSelectTemplate
```
protected void getSelectTemplate(Class<?> cls,
                                 WhereNode whereNode)
```
- getUpdate
```
protected Update getUpdate(Class<?> cls)
```
- getRawUpdate
```
protected Update getRawUpdate(Class<?> cls)
```
- appendVersion
```
protected void appendVersion(ClassDesc desc,
                             WhereNode node)
```
- appendIdCondition
```
protected void appendIdCondition(Class<?> cls,
                                 WhereNode node)
```
  生成主键条件子句（示例 whrer 1=1 and id=${id}）
  
  参数:
  
  cls -
- appendLogicFlagCondition
```
protected void appendLogicFlagCondition(Class<?> cls,
                                        WhereNode node)
```
- appendJoinInIdsCondition
```
protected void appendJoinInIdsCondition(Class<?> cls,
                                        WhereNode node)
```
- checkId
```
protected void checkId(Collection colsId,
                       Collection attrsId,
                       String clsName)
```
- getOrderBy
```
public String getOrderBy()
```
- appendExpress
```
public String appendExpress(String express)
```
- getIdType
```
public int getIdType(Class c,
                     String idProperty)
```
  根据注解来决定主键采用哪种方式生成。在跨数据库应用中，可以为一个id指定多个注解方式，如mysql，postgres 用auto，oracle 用seq
  
  指定者:
  
  getIdType 在接口中 DBStyle
  
  另请参阅:
  
  DBType.ID_AUTO
- getKeyWordHandler
```
public KeyWordHandler getKeyWordHandler()
```
  指定者:
  
  getKeyWordHandler 在接口中 DBStyle
- setKeyWordHandler
```
public void setKeyWordHandler(KeyWordHandler keyWordHandler)
```
  从接口复制的说明: DBStyle
  
  sql中的关键字处理
  
  指定者:
  
  setKeyWordHandler 在接口中 DBStyle
- getSeqValue
```
public String getSeqValue(String seqName)
```
  从接口复制的说明: DBStyle
  
  通过序列名字返回获取序列值的sql片段
  
  指定者:
  
  getSeqValue 在接口中 DBStyle
  
  参数:
  
  seqName - 序列名称
  
  返回:
  
  返回使用序列的SQL语法
  
  另请参阅:
  
  SeqID, OracleStyle.getSeqValue(String)
- buildExecutor
```
public SQLExecutor buildExecutor(ExecuteContext executeContext)
```
  从接口复制的说明: DBStyle
  
  得到一个SQL执行类SQLExecutor,它是系统的核心类之一
  
  指定者:
  
  buildExecutor 在接口中 DBStyle
- initMetadataManager
```
public MetadataManager initMetadataManager(ConnectionSource cs)
```
  从接口复制的说明: DBStyle
  
  初始化元数据管理器
  
  指定者:
  
  initMetadataManager 在接口中 DBStyle
  
  参数:
  
  cs - 数据链接源
- initMetadataManager
```
public MetadataManager initMetadataManager(ConnectionSource cs,
                                           String defaultSchema,
                                           String defalutCatalog)
```
  指定者:
  
  initMetadataManager 在接口中 DBStyle
- wrapStatementValue
```
public String wrapStatementValue(Object value)
```
  从接口复制的说明: DBStyle
  
  如果不支持preparedStatement，在直接使用Statement的时候，返回输出变量到sql语句里，例如，当变量是字符串a"bc 应该输出"a\"bc"，注意，需要考虑SQL注入漏洞
  
  指定者:
  
  wrapStatementValue 在接口中 DBStyle
  
  参数:
  
  value - 原值
  
  返回:
  
  转义后字符
- createConcatContext
```
protected ConcatContext createConcatContext()
```
- isOffsetStartZero
```
public boolean isOffsetStartZero()
```
- setOffsetStartZero
```
public void setOffsetStartZero(boolean offsetStartZero)
```
  从接口复制的说明: DBStyle
  
  设置分页语句的起始偏移为0
  
  指定者:
  
  setOffsetStartZero 在接口中 DBStyle
- getDefaultSchema
```
public String getDefaultSchema()
```
  从接口复制的说明: DBStyle
  
  通过jdbc connection可以得到 schema和catalog，但可能低版本驱动不支持，这里提供数据库默认的
  
  指定者:
  
  getDefaultSchema 在接口中 DBStyle
- getSQLTemplateEngine
```
public SQLTemplateEngine getSQLTemplateEngine()
```
  指定者:
  
  getSQLTemplateEngine 在接口中 DBStyle
- config
```
public void config(SQLManager sqlManager)
```
  从接口复制的说明: DBStyle
  
  在SQLManager配置好后，会调用此方法，最后对sqlmanager进行修改配置
  
  指定者:
  
  config 在接口中 DBStyle
  
  另请参阅:
  
  ClickHouseStyle

类 AbstractDBStyle

嵌套类概要

字段概要

从接口继承的字段 org.beetl.sql.core.db.DBAutoGeneratedSql

构造器概要

方法概要

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

从接口继承的方法 org.beetl.sql.core.db.DBStyle

字段详细资料

offsetStartZero

nameConversion

metadataManager

lineSeparator

keyWordHandler

sqlManager

DEFAULT_ASSIGNID

构造器详细资料

AbstractDBStyle

方法详细资料

init

getNameConversion

setNameConversion

genSelectById

genSelectByIds

genExistSql

genSelectByIdForUpdate

genSelectByTemplate

genSelectCountByTemplate

genDeleteById

genSelectAll

genUpdateById

genUpdateRawById

genUpdateAbsolute

genUpdateTemplate

genUpdateAll

genInsert

genInsertTemplate

generalInsert

getSelectTemplate

getUpdate

getRawUpdate

appendVersion

appendIdCondition

appendLogicFlagCondition

appendJoinInIdsCondition

checkId

getOrderBy

appendExpress

getIdType

getKeyWordHandler

setKeyWordHandler

getSeqValue

buildExecutor

initMetadataManager

initMetadataManager

wrapStatementValue

createConcatContext

isOffsetStartZero

setOffsetStartZero

getDefaultSchema

getSQLTemplateEngine

config