org.dromara.hutool.db.meta

类 MetaUtil

java.lang.Object

org.dromara.hutool.db.meta.MetaUtil

public class MetaUtil
extends Object

数据库元数据信息工具类

需要注意的是，此工具类在某些数据库（比如Oracle）下无效，此时需要手动在数据库配置中增加：

  remarks = true
  useInformationSchema = true
 

作者:

looly

构造器概要

构造器

构造器和说明
MetaUtil()

方法概要

限定符和类型	方法和说明
static Entity	createLimitedEntity(DataSource ds, String tableName) 创建带有字段限制的Entity对象 此方法读取数据库中对应表的字段列表，加入到Entity中，当Entity被设置内容时，会忽略对应表字段外的所有KEY
static String	getCatalog(Connection conn) 获取catalog，获取失败返回null
static String[]	getColumnNames(DataSource ds, String tableName) 获得表的所有列名
static String[]	getColumnNames(ResultSet rs) 获得结果集的所有列名
static String	getSchema(Connection conn) 获取schema，获取失败返回null
static Table	getTableMeta(DataSource ds, String tableName) 获得表的元信息 注意如果需要获取注释，某些数据库如MySQL，需要在配置中添加: remarks = true useInformationSchema = true
static Table	getTableMeta(DataSource ds, String catalog, String schema, String tableName) 获得表的元信息 注意如果需要获取注释，某些数据库如MySQL，需要在配置中添加: remarks = true useInformationSchema = true
static List<String>	getTables(DataSource ds) 获得所有表名
static List<String>	getTables(DataSource ds, String schema, String tableName, TableType... types) 获得所有表名
static List<String>	getTables(DataSource ds, String schema, TableType... types) 获得所有表名
static List<String>	getTables(DataSource ds, TableType... types) 获得所有表名

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

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

构造器详细资料

MetaUtil

public MetaUtil()

方法详细资料

getTables

public static List<String> getTables(DataSource ds)

获得所有表名

参数:

ds - 数据源

返回:

表名列表

getTables

public static List<String> getTables(DataSource ds,
                                     TableType... types)

获得所有表名

参数:

ds - 数据源

types - 表类型

返回:

表名列表

getTables

public static List<String> getTables(DataSource ds,
                                     String schema,
                                     TableType... types)

获得所有表名

参数:

ds - 数据源

schema - 表数据库名，对于Oracle为用户名

types - 表类型

返回:

表名列表

从以下版本开始:

3.3.1

getTables

public static List<String> getTables(DataSource ds,
                                     String schema,
                                     String tableName,
                                     TableType... types)

获得所有表名

参数:

ds - 数据源

schema - 表数据库名，对于Oracle为用户名

tableName - 表名

types - 表类型

返回:

表名列表

从以下版本开始:

3.3.1

getColumnNames

public static String[] getColumnNames(ResultSet rs)
                               throws DbRuntimeException

获得结果集的所有列名

参数:

rs - 结果集

返回:

列名数组

抛出:

DbRuntimeException - SQL执行异常

getColumnNames

public static String[] getColumnNames(DataSource ds,
                                      String tableName)

获得表的所有列名

参数:

ds - 数据源

tableName - 表名

返回:

列数组

抛出:

DbRuntimeException - SQL执行异常

createLimitedEntity

public static Entity createLimitedEntity(DataSource ds,
                                         String tableName)

创建带有字段限制的Entity对象
此方法读取数据库中对应表的字段列表，加入到Entity中，当Entity被设置内容时，会忽略对应表字段外的所有KEY

参数:

ds - 数据源

tableName - 表名

返回:

Entity对象

getTableMeta

public static Table getTableMeta(DataSource ds,
                                 String tableName)

获得表的元信息
注意如果需要获取注释，某些数据库如MySQL，需要在配置中添加:

     remarks = true
     useInformationSchema = true
 

参数:

ds - 数据源

tableName - 表名

返回:

Table对象

getTableMeta

public static Table getTableMeta(DataSource ds,
                                 String catalog,
                                 String schema,
                                 String tableName)

获得表的元信息
注意如果需要获取注释，某些数据库如MySQL，需要在配置中添加:

     remarks = true
     useInformationSchema = true
 

参数:

ds - 数据源

tableName - 表名

catalog - catalog name，null表示自动获取，见：getCatalog(Connection)

schema - a schema name pattern，null表示自动获取，见：getSchema(Connection)

返回:

Table对象

从以下版本开始:

5.7.22

getCatalog

public static String getCatalog(Connection conn)

获取catalog，获取失败返回null

参数:

conn - Connection 数据库连接，null时返回null

返回:

catalog，获取失败返回null

从以下版本开始:

5.7.23

getSchema

public static String getSchema(Connection conn)

获取schema，获取失败返回null

参数:

conn - Connection 数据库连接，null时返回null

返回:

schema，获取失败返回null

从以下版本开始:

4.6.0