sf.database.dialect

Class DBDialect

java.lang.Object

sf.database.dialect.DBDialect

All Implemented Interfaces:

IDBDialect

Direct Known Subclasses:

CubridDialect, DB2Dialect, DefaultDBDialect, DerbyDialect, FirebirdDialect, H2Dialect, HsqldbDialect, MySqlDialect, OracleDialect, PostgreSqlDialect, SqliteDialect, SqlServerDialect

public abstract class DBDialect
extends Object
implements IDBDialect

See Also:

precision和scale precision属性和scale属性表示精度，当字段类型为double时，precision表示数值的总长度，scale表示小数点所占的位数。

Field Summary

Fields

Modifier and Type	Field and Description
protected Case	caseHandler case Handler
protected Set<Feature>	features 各种Boolean特性
protected Set<String>	keywords 数据库关键字
protected char	quoteChar

Constructor Summary

Constructors

Constructor and Description
DBDialect()

Method Summary

Modifier and Type	Method and Description
void	accept(Connection conn) 初始化方言，根据JDBC接口进一步嗅探出数据库版本和JDBC驱动信息，从而让方言更加适配数据库操作。 当有一个数据库实例连接初次创建时调用.
void	addComment(Connection con, TableMapping en)
boolean	containKeyword(String name) 检查数据库是否包含指定的关键字，用来进行检查的对象名称都是按照getColumnNameIncase转换后的，因此对于大小写统一的数据库， 这里无需考虑传入的大小写问题。
String	createAddColumnSql(TableMapping en, ColumnMapping mf)
abstract boolean	createEntity(Connection conn, TableMapping en) 根据实体信息，返回某实体的建表语句
List<String>	createIndexSql(TableMapping tm) 创建索引,一组(与hibernate保持一致)
protected List<String>	createRelation(Connection conn, ColumnMapping en)
void	createRelation(Connection conn, TableMapping en)
protected String	createResultSetMetaSql(TableMapping en)
List<String>	createUniqueSql(TableMapping tm) 创建唯一约束,一组(与hibernate保持一致)
boolean	dropEntity(Connection conn, TableMapping en)
void	dropRelation(Connection conn, TableMapping en)
protected String	escapeSqlValue(String value) SQL 语句中的字符串值，默认编码单引号(')为双单引号(')
String	evalFieldType(ColumnMapping mf)
protected void	execute(List<String> sqls, Connection conn)
protected boolean	execute(String sql, Connection conn)
boolean	existsTables(Connection conn, String tableName) 该表是否存在
String	getCatalog(String catalog) 像Oracle，其Catlog是不用的，那么返回null mySQL没有Schema，每个database是一个catlog，那么返回值
long	getColumnAutoIncreamentValue(ColumnMapping mapping, Connection db)
static String	getColumnDefinition(ColumnMapping mf)
static int	getColumnLength(ColumnMapping mf)
String	getColumnNameToUse(ColumnMapping column) 获得大小写正确的列名
static int	getColumnPrecision(ColumnMapping mf)
static int	getColumnScale(ColumnMapping mf)
String	getDefaultSchema() 不同数据库登录后，所在的默认schema是不一样的 Oracle是以登录的用户名作为schema的。 mysql是只有catlog不区分schema的。 derby支持匿名访问，此时好像是位于APP这个schema下。 SQL Server默认是在dbo这个schema下 因此对于无法确定当前schema的场合，使用这里提供的schema名称作为当前schema
String	getDriverClass(String url) 获取数据库的默认驱动类
abstract String	getHibernateDialect() 返回对应的 Hibernate 的 Dialect
List<String>	getIndexNames(TableMapping en, Connection conn)
abstract String	getName()
String	getNvlFunction(String val1, String val2) 去除空值的判断方法
String	getObjectNameToUse(String name) Oracle会将所有未加引号的数据库对象名称都按照大写对象名来处理;MySQL则对表名一律转小写，列名则保留原来的大小写。 为了体现这一数据库策略的不同，这里处理大小写的问题。
protected String	getPrimaryKeySql(String tablename, List<String> pkColumnsEntity)
String	getProperty(DBProperty key)
String	getProperty(DBProperty key, String defaultValue)
int	getPropertyInt(DBProperty key)
long	getPropertyLong(DBProperty key)
char	getQuoteChar()
String	getSchema(String schema) 对于表名前缀的XX.
String	getSeqNextValSql(String seqName) 获取下一个序列值得sql语句
List<SequenceInfo>	getSequenceInfo(Connection conn, String schema, String seqName)
String	getSqlStatmentSeparator() 批量运行多个SQL语句之间的分隔符。
protected static String	gSQL(String ptn, String table, String field)
boolean	has(Feature feature) 判断数据库是否支持某项特性
boolean	isCaseSensitive() 数据库对象是否为大小写敏感的 一般来说对应引号中的表名列名都是大小写敏感的。此处仅指没有引号的情况下是否大小写敏感
boolean	notHas(Feature feature) 判断数据库是否不支持某项特性
protected void	setProperty(DBProperty key, String value)
void	setupEntityField(Connection conn, TableMapping en) 设置tablemapping信息
abstract String	sqlColumnAdd(String table, String column_definition, String column_position)
abstract String	sqlColumnDrop(String table, String column)
abstract String	sqlColumnModify(String table, String column_definition, String column_position)
String	sqlPageList(String sql, long offset, int limit) 生成分页sql
abstract String	sqlTableDrop(String table)
abstract String	sqlTableRename(String oldName, String newName)
boolean	supportsColumnPosition() 是否支持在添加字段的时候，指定字段位置
abstract String	uniqueSql(String tableName, String name, String[] columnNames) 生成unique 语句.
protected String	unwrapper(String name) 去除包含的符号和getQuotedIdentifier相反
String	wrapKeyword(Connection conn, String name) 将字段名/表名与SQL保留字冲突的名称进行 Wrapper
String	wrapKeyword(String name) 将字段名/表名与SQL保留字冲突的名称进行 Wrapper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface sf.database.dialect.IDBDialect

getJooqDialect, getQueryDslDialect

Field Detail

features

protected Set<Feature> features

各种Boolean特性

keywords

protected final Set<String> keywords

数据库关键字

caseHandler

protected Case caseHandler

case Handler

quoteChar

protected char quoteChar

Constructor Detail

DBDialect

public DBDialect()

Method Detail

getObjectNameToUse

public String getObjectNameToUse(String name)

Description copied from interface: IDBDialect

Oracle会将所有未加引号的数据库对象名称都按照大写对象名来处理;MySQL则对表名一律转小写，列名则保留原来的大小写。 为了体现这一数据库策略的不同，这里处理大小写的问题。

目前的原则是：凡是涉及 schema/table/view/sequence/dbname等转换的，都是用此方法，凡是涉及列名转换，列别名定义的都用 IDBDialect.getColumnNameToUse(sf.database.meta.ColumnMapping)方法

Specified by:

getObjectNameToUse in interface IDBDialect

Returns:

getColumnNameToUse

public String getColumnNameToUse(ColumnMapping column)

Description copied from interface: IDBDialect

获得大小写正确的列名

Specified by:

getColumnNameToUse in interface IDBDialect

Returns:

getCatalog

public String getCatalog(String catalog)

像Oracle，其Catlog是不用的，那么返回null mySQL没有Schema，每个database是一个catlog，那么返回值

Specified by:

getCatalog in interface IDBDialect

Parameters:

catalog -

Returns:

getSchema

public String getSchema(String schema)

Description copied from interface: IDBDialect

对于表名前缀的XX. MYSQL是作为catlog的，不是作为schema的 同时修正返回的大小写

Specified by:

getSchema in interface IDBDialect

Returns:

getDriverClass

public String getDriverClass(String url)

Description copied from interface: IDBDialect

获取数据库的默认驱动类

Specified by:

getDriverClass in interface IDBDialect

Parameters:

url - Derby根据连接方式的不同，会有两种不同的DriverClass，因此需要传入url

Returns:

驱动类

getDefaultSchema

public String getDefaultSchema()

Description copied from interface: IDBDialect

不同数据库登录后，所在的默认schema是不一样的

• Oracle是以登录的用户名作为schema的。
• mysql是只有catlog不区分schema的。
• derby支持匿名访问，此时好像是位于APP这个schema下。
• SQL Server默认是在dbo这个schema下

因此对于无法确定当前schema的场合，使用这里提供的schema名称作为当前schema

Specified by:

getDefaultSchema in interface IDBDialect

Returns:

当前RDBMS的缺省Schema

accept

public void accept(Connection conn)

Description copied from interface: IDBDialect

初始化方言，根据JDBC接口进一步嗅探出数据库版本和JDBC驱动信息，从而让方言更加适配数据库操作。 当有一个数据库实例连接初次创建时调用. Dialect可以通过直接连接数据库判断版本、函数等，调整Dialect内部的一些配置和数据。

Specified by:

accept in interface IDBDialect

isCaseSensitive

public boolean isCaseSensitive()

Description copied from interface: IDBDialect

数据库对象是否为大小写敏感的 一般来说对应引号中的表名列名都是大小写敏感的。此处仅指没有引号的情况下是否大小写敏感

Specified by:

isCaseSensitive in interface IDBDialect

Returns:

setProperty

protected void setProperty(DBProperty key,
                           String value)

getProperty

public String getProperty(DBProperty key)

getProperty

public String getProperty(DBProperty key,
                          String defaultValue)

getPropertyInt

public int getPropertyInt(DBProperty key)

getPropertyLong

public long getPropertyLong(DBProperty key)

getName

public abstract String getName()

Specified by:

getName in interface IDBDialect

Returns:

当前数据库类型，名称参见 DB 这个枚举类型

See Also:

RDBMS

getHibernateDialect

public abstract String getHibernateDialect()

返回对应的 Hibernate 的 Dialect

supportsColumnPosition

public boolean supportsColumnPosition()

是否支持在添加字段的时候，指定字段位置

wrapKeyword

public final String wrapKeyword(String name)

将字段名/表名与SQL保留字冲突的名称进行 Wrapper

Parameters:

name -

Returns:

wrapKeyword

public final String wrapKeyword(Connection conn,
                                String name)

将字段名/表名与SQL保留字冲突的名称进行 Wrapper

Parameters:

conn - 为解决mysql标识符可以为:"或`的问题(无用).

name -

Returns:

unwrapper

protected String unwrapper(String name)

去除包含的符号和getQuotedIdentifier相反

Parameters:

name -

Returns:

escapeSqlValue

protected String escapeSqlValue(String value)

SQL 语句中的字符串值，默认编码单引号(')为双单引号(')

getSqlStatmentSeparator

public String getSqlStatmentSeparator()

批量运行多个SQL语句之间的分隔符。

sqlTableDrop

public abstract String sqlTableDrop(String table)

sqlTableRename

public abstract String sqlTableRename(String oldName,
                                      String newName)

sqlColumnAdd

public abstract String sqlColumnAdd(String table,
                                    String column_definition,
                                    String column_position)

sqlColumnModify

public abstract String sqlColumnModify(String table,
                                       String column_definition,
                                       String column_position)

sqlColumnDrop

public abstract String sqlColumnDrop(String table,
                                     String column)

getSequenceInfo

public List<SequenceInfo> getSequenceInfo(Connection conn,
                                          String schema,
                                          String seqName)
                                   throws SQLException

Throws:

SQLException

getSeqNextValSql

public String getSeqNextValSql(String seqName)

获取下一个序列值得sql语句

Parameters:

seqName - 序列名称

Returns:

notHas

public boolean notHas(Feature feature)

Description copied from interface: IDBDialect

判断数据库是否不支持某项特性

Specified by:

notHas in interface IDBDialect

Returns:

has

public boolean has(Feature feature)

Description copied from interface: IDBDialect

判断数据库是否支持某项特性

Specified by:

has in interface IDBDialect

Returns:

sqlPageList

public String sqlPageList(String sql,
                          long offset,
                          int limit)

生成分页sql

Parameters:

sql - 原始sql

offset - 开始位置，从0开始 （= (Page-1)*PageSize）

limit - 返回的限制大小（= 分页大小 PageSize）

Returns:

如果不支持，返回 null

createResultSetMetaSql

protected String createResultSetMetaSql(TableMapping en)

containKeyword

public boolean containKeyword(String name)

Description copied from interface: IDBDialect

检查数据库是否包含指定的关键字，用来进行检查的对象名称都是按照getColumnNameIncase转换后的，因此对于大小写统一的数据库， 这里无需考虑传入的大小写问题。

Specified by:

containKeyword in interface IDBDialect

Returns:

setupEntityField

public void setupEntityField(Connection conn,
                             TableMapping en)

设置tablemapping信息

Parameters:

conn -

en -

createEntity

public abstract boolean createEntity(Connection conn,
                                     TableMapping en)

根据实体信息，返回某实体的建表语句

Parameters:

en - 实体

Returns:

是否创建成功

evalFieldType

public String evalFieldType(ColumnMapping mf)

dropEntity

public boolean dropEntity(Connection conn,
                          TableMapping en)

createRelation

public void createRelation(Connection conn,
                           TableMapping en)

createRelation

protected List<String> createRelation(Connection conn,
                                      ColumnMapping en)

dropRelation

public void dropRelation(Connection conn,
                         TableMapping en)

existsTables

public boolean existsTables(Connection conn,
                            String tableName)

该表是否存在

Parameters:

conn -

tableName -

Returns:

createIndexSql

public List<String> createIndexSql(TableMapping tm)

创建索引,一组(与hibernate保持一致)

Parameters:

tm -

Returns:

createUniqueSql

public final List<String> createUniqueSql(TableMapping tm)

创建唯一约束,一组(与hibernate保持一致)

Parameters:

tm -

Returns:

uniqueSql

public abstract String uniqueSql(String tableName,
                                 String name,
                                 String[] columnNames)

生成unique 语句.

Parameters:

tableName - 表名

name - 名称

columnNames - 表的列名,

Returns:

addComment

public void addComment(Connection con,
                       TableMapping en)

getPrimaryKeySql

protected String getPrimaryKeySql(String tablename,
                                  List<String> pkColumnsEntity)

getColumnLength

public static int getColumnLength(ColumnMapping mf)

getColumnPrecision

public static int getColumnPrecision(ColumnMapping mf)

getColumnScale

public static int getColumnScale(ColumnMapping mf)

getColumnDefinition

public static String getColumnDefinition(ColumnMapping mf)

gSQL

protected static String gSQL(String ptn,
                             String table,
                             String field)

createAddColumnSql

public String createAddColumnSql(TableMapping en,
                                 ColumnMapping mf)

getIndexNames

public List<String> getIndexNames(TableMapping en,
                                  Connection conn)
                           throws SQLException

Throws:

SQLException

execute

protected boolean execute(String sql,
                          Connection conn)

execute

protected void execute(List<String> sqls,
                       Connection conn)

getColumnAutoIncreamentValue

public long getColumnAutoIncreamentValue(ColumnMapping mapping,
                                         Connection db)

Specified by:

getColumnAutoIncreamentValue in interface IDBDialect

getQuoteChar

public char getQuoteChar()

getNvlFunction

public String getNvlFunction(String val1,
                             String val2)

去除空值的判断方法

Returns: