DBStyle (sql-core 3.14.2-RELEASE API)

所有超级接口:

DBAutoGeneratedSql

所有已知实现类:

AbstractDBStyle, CassandraSqlStyle, ClickHouseStyle, CouchBaseStyle, DamengStyle, DB2SqlStyle, DerbyStyle, DrillStyle, DruidStyle, ElasticStyle, Gbase8sStyle, GreatSqlStyle, GreenplumDBStyle, H2Style, HBaseStyle, HiveStyle, IgniteStyle, ImpalaStyle, IotDbStyle, KingbaseStyle, MachbaseStyle, MySqlStyle, OpenGaussStyle, OracleStyle, PolarDBStyle, PostgresStyle, PrestoStyle, ShenTongSqlStyle, SQLiteStyle, SqlServer2012Style, SqlServerStyle, TaosStyle
```
public interface DBStyle
extends DBAutoGeneratedSql
```
用来描述数据库差异，主键生成，sql语句，翻页等，有一部分元数据的差异在SchemaMetadataManager

作者:

xiandafu

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

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`default boolean`	`batchGeneratedKeysSupport()` 批量插入或者更新的时候聚，数据库是否支持自动生成值，如自增
`SQLExecutor`	`buildExecutor(ExecuteContext executeContext)` 得到一个SQL执行类`SQLExecutor`,它是系统的核心类之一
`void`	`config(SQLManager sqlManager)` 在SQLManager配置好后，会调用此方法，最后对sqlmanager进行修改配置
`int`	`getDBType()` 返回一个DBStyle代码
`String`	`getDefaultSchema()` 通过jdbc connection可以得到 schema和catalog，但可能低版本驱动不支持，这里提供数据库默认的
`int`	`getIdType(Class c, String idProperty)` 获取数据表id字段的类型：自增、序列、
`KeyWordHandler`	`getKeyWordHandler()`
`default int`	`getMaxBatchCount()` jdbc 的 batch 个数在数据库收到限制，beetlsql会把批处理数据分批处理这里配置了一个数据库允许的最大批处理个数，默认1000个
`String`	`getName()` 返回DBStyle名称
`RangeSql`	`getRangeSql()` 翻页语句实现
`String`	`getSeqValue(String seqName)` 通过序列名字返回获取序列值的sql片段
`SQLTemplateEngine`	`getSQLTemplateEngine()`
`void`	`init(SQLTemplateEngine sqlTemplateEngine, Properties ps)` 初始化DBStyle
`MetadataManager`	`initMetadataManager(ConnectionSource cs)` 初始化元数据管理器
`MetadataManager`	`initMetadataManager(ConnectionSource cs, String defaultSchema, String defaultCatalog)`
`default boolean`	`isNoSql()` 是否是NoSql数据库
`default boolean`	`metadataSupport()` 对应的数据库是否支持jdbc metadata
`default boolean`	`preparedStatementSupport()` 是否支持PreparedStatement，对于数据库来说，几乎都支持，对于Nosql，则不一定支持
`void`	`setKeyWordHandler(KeyWordHandler keyWordHandler)` sql中的关键字处理
`void`	`setOffsetStartZero(boolean offsetStartZero)` 设置分页语句的起始偏移为0
`default void`	`streamConfig(ResultSet resultSet)`
`String`	`wrapStatementValue(Object value)` 如果不支持preparedStatement，在直接使用Statement的时候，返回输出变量到sql语句里，例如，当变量是字符串a"bc 应该输出`"a\"bc"`，注意，需要考虑SQL注入漏洞

从接口继承的方法 org.beetl.sql.core.db.DBAutoGeneratedSql
genDeleteById, genExistSql, genInsert, genInsertTemplate, genSelectAll, genSelectById, genSelectByIdForUpdate, genSelectByIds, genSelectByTemplate, genSelectCountByTemplate, genUpdateAbsolute, genUpdateAll, genUpdateById, genUpdateRawById, genUpdateTemplate, getNameConversion, setNameConversion

- 方法详细资料
  - getName
```
String getName()
```
    返回DBStyle名称
  - getDBType
```
int getDBType()
```
    返回一个DBStyle代码
    
    另请参阅:
    
    DBType.DB_MYSQL
  - getRangeSql
```
RangeSql getRangeSql()
```
    翻页语句实现
  - getIdType
```
int getIdType(Class c,
              String idProperty)
```
    获取数据表id字段的类型：自增、序列、
    
    另请参阅:
    
    DBType.ID_AUTO
  - getKeyWordHandler
```
KeyWordHandler getKeyWordHandler()
```
  - getSeqValue
```
String getSeqValue(String seqName)
```
    通过序列名字返回获取序列值的sql片段
    
    参数:
    
    seqName - 序列名称
    
    返回:
    
    返回使用序列的SQL语法
    
    另请参阅:
    
    SeqID, OracleStyle.getSeqValue(String)
  - setKeyWordHandler
```
void setKeyWordHandler(KeyWordHandler keyWordHandler)
```
    sql中的关键字处理
    
    参数:
    
    keyWordHandler -
  - getMaxBatchCount
```
default int getMaxBatchCount()
```
    jdbc 的 batch 个数在数据库收到限制，beetlsql会把批处理数据分批处理这里配置了一个数据库允许的最大批处理个数，默认1000个
  - isNoSql
```
default boolean isNoSql()
```
    是否是NoSql数据库
  - metadataSupport
```
default boolean metadataSupport()
```
    对应的数据库是否支持jdbc metadata
  - preparedStatementSupport
```
default boolean preparedStatementSupport()
```
    是否支持PreparedStatement，对于数据库来说，几乎都支持，对于Nosql，则不一定支持
  - batchGeneratedKeysSupport
```
default boolean batchGeneratedKeysSupport()
```
    批量插入或者更新的时候聚，数据库是否支持自动生成值，如自增
  - streamConfig
```
default void streamConfig(ResultSet resultSet)
```
  - wrapStatementValue
```
String wrapStatementValue(Object value)
```
    如果不支持preparedStatement，在直接使用Statement的时候，返回输出变量到sql语句里，例如，当变量是字符串a"bc 应该输出"a\"bc"，注意，需要考虑SQL注入漏洞
    
    参数:
    
    value - 原值
    
    返回:
    
    转义后字符
  - buildExecutor
```
SQLExecutor buildExecutor(ExecuteContext executeContext)
```
    得到一个SQL执行类SQLExecutor,它是系统的核心类之一
  - initMetadataManager
```
MetadataManager initMetadataManager(ConnectionSource cs)
```
    初始化元数据管理器
    
    参数:
    
    cs - 数据链接源
  - initMetadataManager
```
MetadataManager initMetadataManager(ConnectionSource cs,
                                    String defaultSchema,
                                    String defaultCatalog)
```
  - init
```
void init(SQLTemplateEngine sqlTemplateEngine,
          Properties ps)
```
    初始化DBStyle
    
    参数:
    
    sqlTemplateEngine - 执行SQL模板的引擎，默认beetl
    
    ps - beetlsql配置信息
  - getDefaultSchema
```
String getDefaultSchema()
```
    通过jdbc connection可以得到 schema和catalog，但可能低版本驱动不支持，这里提供数据库默认的
  - setOffsetStartZero
```
void setOffsetStartZero(boolean offsetStartZero)
```
    设置分页语句的起始偏移为0
  - getSQLTemplateEngine
```
SQLTemplateEngine getSQLTemplateEngine()
```
  - config
```
void config(SQLManager sqlManager)
```
    在SQLManager配置好后，会调用此方法，最后对sqlmanager进行修改配置
    
    另请参阅:
    
    ClickHouseStyle

接口 DBStyle

字段概要

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

方法概要

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

方法详细资料

getName

getDBType

getRangeSql

getIdType

getKeyWordHandler

getSeqValue

setKeyWordHandler

getMaxBatchCount

isNoSql

metadataSupport

preparedStatementSupport

batchGeneratedKeysSupport

streamConfig

wrapStatementValue

buildExecutor

initMetadataManager

initMetadataManager

init

getDefaultSchema

setOffsetStartZero

getSQLTemplateEngine

config