sf.database.dbinfo

Class DBMetaData

java.lang.Object

sf.database.dbinfo.DBMetaData

public class DBMetaData
extends Object

Method Summary

Modifier and Type	Method and Description
static <T extends DBObject> boolean	createTable(Connection conn, Class<T> clz) 创建表
static boolean	createTable(Connection conn, TableMapping meta) 创建表
static boolean	createTable(Connection conn, TableMapping meta, String tablename) 创建表
boolean	existsFunction(Connection conn, String schema, String name) 返回指定名称的函数是否存在(需要支持JDBC 4.0的驱动才可执行)
boolean	existsInSchema(Connection conn, ObjectType type, String schema, String objectName) 判断对象是否存在于指定的schema下
boolean	existsProcdure(Connection conn, String schema, String objectName) 检查是否存在指定的存储过程
boolean	existTable(Connection conn, String tableName)
DatabaseMetaData	get(Connection conn) Deprecated. not recommended
String	getCatalog(Connection conn) 获取当前连接的catalog
String[]	getCatalogs(Connection conn) 获取数据库中所有的catalog
ColumnInfo	getColumn(Connection conn, String tableName, String column) 返回指定的列的信息，如果没有找到该列返回null
Map<DBField,ColumnMapping>	getColumnMap(TableMapping meta)
List<ColumnInfo>	getColumns(Connection conn, String tableName) 得到指定表的所有列
List<TableInfo>	getDatabaseObject(Connection conn, ObjectType type, String catalog, String schema, String matchName, Operator oper)
String	getExists(Connection conn, ObjectType type, String objectName) 判断对象是否存在
String	getExistTable(Connection conn, String tableName) 判断一张表是否存在
List<Function>	getFunctions(Connection conn, String schema) 返回所有自定义数据库函数
Collection<Index>	getIndexes(Connection conn, String tableName) 得到指定表的所有索引
static DBMetaData	getInstance()
MetadataFeature	getMetadataFeature(Connection conn)
List<Function>	getProcedures(Connection conn, String schema) 得到数据库中的当前用户的存储过程
String[]	getSchemas(Connection conn) 获得所有的Schema
String	getSQLKeywords(Connection conn) 得到由JDBC驱动提供的所有数据库关键字
String	getSystemFunctions(Connection conn) 得到内建其他函数名
List<String>	getTableNames(Connection conn, String catalog, String schema, ObjectType... types) 返回当前schema下的所有数据库表名
static void	refreshTable(Connection conn, Class<?> clz) 检查并修改数据库中的表，使其和传入的实体模型保持一致。
static void	refreshTable(Connection conn, TableMapping meta, MetadataEventListener event) 检查并修改数据库中的表，使其和传入的实体模型保持一致。
static void	refreshTable(Connection conn, TableMapping meta, MetadataEventListener event, boolean modifyConstraint, boolean modifyIndexes) 检查并修改数据库中的表，使其和传入的实体模型保持一致。
static void	refreshTable(Connection conn, TableMapping meta, String tablename, MetadataEventListener event, boolean modifyConstraint, boolean modifyIndex) 更新表。此操作核对输入的元模型和数据库中表的差异，并且通过create table或alter table等语句尽可能将其修改得和元模型一直。
boolean	supportsTransactionIsolationLevel(Connection conn, int level) 判断，是否支持指定的事务隔离级别
void	truncate(Connection conn, TableMapping meta, List<String> tablename) 清除表中的所有数据。truncate是DDL不能回滚。

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DBMetaData getInstance()

getColumnMap

public Map<DBField,ColumnMapping> getColumnMap(TableMapping meta)

getMetadataFeature

public MetadataFeature getMetadataFeature(Connection conn)

getColumn

public ColumnInfo getColumn(Connection conn,
                            String tableName,
                            String column)
                     throws SQLException

返回指定的列的信息，如果没有找到该列返回null

Parameters:

tableName - 表名

column - 列名

Returns:

如果没有找到该列返回null

Throws:

SQLException

existsInSchema

public boolean existsInSchema(Connection conn,
                              ObjectType type,
                              String schema,
                              String objectName)
                       throws SQLException

判断对象是否存在于指定的schema下

Parameters:

type - 要查找的对象类型

schema - 所属schema

objectName - 对象名称

Returns:

true如果对象存在。否则false

Throws:

SQLException

See Also:

ObjectType

getColumns

public List<ColumnInfo> getColumns(Connection conn,
                                   String tableName)
                            throws SQLException

得到指定表的所有列

Parameters:

tableName - 表名

Returns:

表中的列。 A collection of columns.

Throws:

SQLException

See Also:

ColumnInfo

getIndexes

public Collection<Index> getIndexes(Connection conn,
                                    String tableName)
                             throws SQLException

得到指定表的所有索引

Parameters:

tableName - 表名

Returns:

索引信息

Throws:

SQLException

See Also:

Index

getDatabaseObject

public List<TableInfo> getDatabaseObject(Connection conn,
                                         ObjectType type,
                                         String catalog,
                                         String schema,
                                         String matchName,
                                         Operator oper)
                                  throws SQLException

Parameters:

type - 要查询的对象类型 "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".

schema - Schema

matchName - 匹配名称

oper - 操作符，可以为null，为null时表示等于条件

Returns:

表/视图等数据库对象的信息

Throws:

SQLException

See Also:

Operator

getTableNames

public List<String> getTableNames(Connection conn,
                                  String catalog,
                                  String schema,
                                  ObjectType... types)
                           throws SQLException

返回当前schema下的所有数据库表名

Parameters:

types - 取以下参数ObjectType。可以省略，省略的情况下取Table

Returns:

所有表名

Throws:

SQLException

existTable

public boolean existTable(Connection conn,
                          String tableName)
                   throws SQLException

Throws:

SQLException

getExistTable

public String getExistTable(Connection conn,
                            String tableName)
                     throws SQLException

判断一张表是否存在

Parameters:

tableName - 表名

Returns:

表存在返回表名，表不存在返回null

Throws:

SQLException

getExists

public String getExists(Connection conn,
                        ObjectType type,
                        String objectName)
                 throws SQLException

判断对象是否存在

Parameters:

type - 要查找的对象类型

objectName - 对象名称

Returns:

true如果对象存在返回对象名称。否则返回null

Throws:

SQLException

See Also:

ObjectType

getCatalog

public String getCatalog(Connection conn)
                  throws SQLException

获取当前连接的catalog

Parameters:

conn -

Returns:

Throws:

SQLException

getCatalogs

public String[] getCatalogs(Connection conn)
                     throws SQLException

获取数据库中所有的catalog

Returns:

所有catalog

Throws:

SQLException

getSchemas

public String[] getSchemas(Connection conn)
                    throws SQLException

获得所有的Schema

Returns:

所有的Schema

Throws:

SQLException

get

public DatabaseMetaData get(Connection conn)
                     throws SQLException

Deprecated. not recommended

Returns:

the JDBC 'DatabaseMetaData' object

Throws:

SQLException

existsProcdure

public boolean existsProcdure(Connection conn,
                              String schema,
                              String objectName)
                       throws SQLException

检查是否存在指定的存储过程

Parameters:

schema - 所在schema

objectName - 存储过程名

Returns:

存储过程存在返回true，否则false

Throws:

SQLException

existsFunction

public boolean existsFunction(Connection conn,
                              String schema,
                              String name)
                       throws SQLException

返回指定名称的函数是否存在(需要支持JDBC 4.0的驱动才可执行)

Parameters:

schema - 所在schema

name - 函数名

Returns:

函数存在返回true, 否则false

Throws:

SQLException - 检测用户函数功能在 JDBC 4.0 (JDK 6)中定义，很多旧版本驱动都不支持，会抛出此异常

Since:

1.7.1

getProcedures

public List<Function> getProcedures(Connection conn,
                                    String schema)
                             throws SQLException

得到数据库中的当前用户的存储过程

Parameters:

schema - 数据库schema，传入null表示当前schema

Returns:

存储过程

Throws:

SQLException

getFunctions

public List<Function> getFunctions(Connection conn,
                                   String schema)
                            throws SQLException

返回所有自定义数据库函数

Parameters:

schema - 数据库schema，传入null表示当前schema

Returns:

自定义函数

Throws:

SQLException

getSystemFunctions

public String getSystemFunctions(Connection conn)
                          throws SQLException

得到内建其他函数名

Returns:

其他函数名（逗号分隔）

Throws:

SQLException

getSQLKeywords

public String getSQLKeywords(Connection conn)
                      throws SQLException

得到由JDBC驱动提供的所有数据库关键字

Returns:

关键字列表(逗号分隔)

Throws:

SQLException

supportsTransactionIsolationLevel

public boolean supportsTransactionIsolationLevel(Connection conn,
                                                 int level)
                                          throws SQLException

判断，是否支持指定的事务隔离级别

Parameters:

level -

Returns:

Throws:

SQLException

refreshTable

public static void refreshTable(Connection conn,
                                Class<?> clz)
                         throws SQLException

检查并修改数据库中的表，使其和传入的实体模型保持一致。

Parameters:

clz - 要更新的表对应的类

Throws:

SQLException

refreshTable

public static void refreshTable(Connection conn,
                                TableMapping meta,
                                MetadataEventListener event)
                         throws SQLException

检查并修改数据库中的表，使其和传入的实体模型保持一致。

Parameters:

meta - 要更新的表的元数据

event - 事件监听器，可以监听刷新过程的事件

Throws:

SQLException

refreshTable

public static void refreshTable(Connection conn,
                                TableMapping meta,
                                MetadataEventListener event,
                                boolean modifyConstraint,
                                boolean modifyIndexes)
                         throws SQLException

检查并修改数据库中的表，使其和传入的实体模型保持一致。

Parameters:

meta - 要更新的表的元数据

event - 事件监听器，可以监听刷新过程的事件

modifyConstraint - 更改约束

modifyIndexes - 更改索引

Throws:

SQLException

See Also:

MetadataEventListener

refreshTable

public static void refreshTable(Connection conn,
                                TableMapping meta,
                                String tablename,
                                MetadataEventListener event,
                                boolean modifyConstraint,
                                boolean modifyIndex)
                         throws SQLException

更新表。此操作核对输入的元模型和数据库中表的差异，并且通过create table或alter table等语句尽可能将其修改得和元模型一直。

注意

由于ALTER TABLE有很多限制，因此这个方法执行有很多可能会抛出错误。

此外，由于ALTER TABLE语句是DDL，因此多个DDL执行中出现错误时，已经执行过的语句将不会被回滚。所以请尽可能通过 监听器 的监听事件来把握表变更的进度情况。

Parameters:

meta - 元模型

tablename - 表名

event - 事件监听器，可以捕捉表对比、SQL语句执行前后等事件

Throws:

SQLException - 修改表失败时抛出

See Also:

变更监听器

truncate

public void truncate(Connection conn,
                     TableMapping meta,
                     List<String> tablename)
              throws SQLException

清除表中的所有数据。truncate是DDL不能回滚。

Parameters:

meta - 要清除的表的元数据

tablename - 表名

Throws:

SQLException

createTable

public static <T extends DBObject> boolean createTable(Connection conn,
                                                       Class<T> clz)
                                                throws SQLException

创建表

Parameters:

clz - 建表的CLass

Returns:

true建表成功，false表已存在

Throws:

SQLException

createTable

public static boolean createTable(Connection conn,
                                  TableMapping meta)
                           throws SQLException

创建表

Parameters:

meta - 表结构描述。 The metadata of the table.

Returns:

Ture if the table created successful, or vv.

Throws:

SQLException

createTable

public static boolean createTable(Connection conn,
                                  TableMapping meta,
                                  String tablename)
                           throws SQLException

创建表

Parameters:

meta - 表结构描述。 The metadata of the table.

tablename - 表名。 The name of the table.

Returns:

如果表被创建返回true，如果表已存在返回false。
Ture if the table created successful, or vv.

Throws:

SQLException

See Also:

TableMapping}