MetaUtil (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.db.meta.MetaUtil

```
public class MetaUtil
extends Object
```
数据库元数据信息工具类
需要注意的是，此工具类在某些数据库（比如Oracle）下无效，此时需要手动在数据库配置中增加：
```
  remarks = true
  useInformationSchema = true
 
```
Author:

looly

Constructor Summary

Constructors
Constructor and Description

MetaUtil()

Constructors
Constructor and Description
`MetaUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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[]`	`getColumnNames(ResultSetMetaData metaData)` 获得结果集的所有列名
`static Map<String,IndexInfo>`	`getIndexInfo(DatabaseMetaData metaData, String catalog, String schema, String tableName)` 获取指定表的索引信息。
`static DatabaseMetaData`	`getMetaData(Connection conn)` 获取数据库连接的元数据信息。
`static Set<String>`	`getPrimaryKeys(DatabaseMetaData metaData, String catalog, String schema, String tableName)` 获取指定表的主键列名列表。
`static String`	`getRemarks(DatabaseMetaData metaData, String catalog, String schema, String tableName)` 获取指定表的备注信息。
`static String`	`getSchema(Connection conn)` 获取schema，获取失败返回`null`
`static Table`	`getTableMeta(Connection conn, String catalog, String schema, String tableName)` 获得表的元信息注意如果需要获取注释，某些数据库如MySQL，需要在配置中添加: remarks = true useInformationSchema = true
`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>`	`getTableNames(DataSource ds)` 获得所有表名
`static List<String>`	`getTableNames(DataSource ds, String catalog, String schema, String tableNamePattern, TableType... types)` 获得所有表名
`static List<String>`	`getTableNames(DataSource ds, String schema, String tableNamePattern, TableType... types)` 获得所有表名
`static List<String>`	`getTableNames(DataSource ds, String schema, TableType... types)` 获得所有表名
`static List<String>`	`getTableNames(DataSource ds, TableType... types)` 获得所有表名
`static boolean`	`isOracle(DatabaseMetaData metaData)` 判断当前数据库是否为Oracle。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MetaUtil
```
public MetaUtil()
```
- Method Detail
  - getTableNames
```
public static List<String> getTableNames(DataSource ds)
```
    获得所有表名
    
    Parameters:
    
    ds - 数据源
    
    Returns:
    
    表名列表
  - getTableNames
```
public static List<String> getTableNames(DataSource ds,
                                         TableType... types)
```
    获得所有表名
    
    Parameters:
    
    ds - 数据源
    
    types - 表类型
    
    Returns:
    
    表名列表
  - getTableNames
```
public static List<String> getTableNames(DataSource ds,
                                         String schema,
                                         TableType... types)
```
    获得所有表名
    
    Parameters:
    
    ds - 数据源
    
    schema - 要使用的数据库模式（在某些数据库系统中相当于命名空间，对于Oracle为用户名）
    
    types - 表类型
    
    Returns:
    
    表名列表
    
    Since:
    
    3.3.1
  - getTableNames
```
public static List<String> getTableNames(DataSource ds,
                                         String schema,
                                         String tableNamePattern,
                                         TableType... types)
```
    获得所有表名
    
    Parameters:
    
    ds - 数据源
    
    schema - 要使用的数据库模式（在某些数据库系统中相当于命名空间，对于Oracle为用户名）
    
    tableNamePattern - 表名匹配模式，null表示匹配所有表
    
    types - 表类型
    
    Returns:
    
    表名列表
    
    Since:
    
    3.3.1
  - getTableNames
```
public static List<String> getTableNames(DataSource ds,
                                         String catalog,
                                         String schema,
                                         String tableNamePattern,
                                         TableType... types)
```
    获得所有表名
    
    Parameters:
    
    ds - 数据源
    
    catalog - 要使用的数据库目录（在某些数据库系统中相当于数据库名称）
    
    schema - 要使用的数据库模式（在某些数据库系统中相当于命名空间，对于Oracle为用户名）
    
    tableNamePattern - 表名匹配模式，null表示匹配所有表
    
    types - 表类型
    
    Returns:
    
    表名列表
    
    Since:
    
    3.3.1
  - getColumnNames
```
public static String[] getColumnNames(ResultSet rs)
                               throws DbException
```
    获得结果集的所有列名
    
    Parameters:
    
    rs - 结果集
    
    Returns:
    
    列名数组
    
    Throws:
    
    DbException - SQL执行异常
  - getColumnNames
```
public static String[] getColumnNames(ResultSetMetaData metaData)
                               throws DbException
```
    获得结果集的所有列名
    
    Parameters:
    
    metaData - ResultSetMetaData
    
    Returns:
    
    列名数组
    
    Throws:
    
    DbException - SQL执行异常
  - getColumnNames
```
public static String[] getColumnNames(DataSource ds,
                                      String tableName)
```
    获得表的所有列名
    
    Parameters:
    
    ds - 数据源
    
    tableName - 表名
    
    Returns:
    
    列数组
    
    Throws:
    
    DbException - SQL执行异常
  - createLimitedEntity
```
public static Entity createLimitedEntity(DataSource ds,
                                         String tableName)
```
    创建带有字段限制的Entity对象
    此方法读取数据库中对应表的字段列表，加入到Entity中，当Entity被设置内容时，会忽略对应表字段外的所有KEY
    
    Parameters:
    
    ds - 数据源
    
    tableName - 表名
    
    Returns:
    
    Entity对象
  - getTableMeta
```
public static Table getTableMeta(DataSource ds,
                                 String tableName)
```
    获得表的元信息
    注意如果需要获取注释，某些数据库如MySQL，需要在配置中添加:
```
     remarks = true
     useInformationSchema = true
 
```
    Parameters:
    
    ds - 数据源
    
    tableName - 表名
    
    Returns:
    
    Table对象
  - getTableMeta
```
public static Table getTableMeta(DataSource ds,
                                 String catalog,
                                 String schema,
                                 String tableName)
```
    获得表的元信息
    注意如果需要获取注释，某些数据库如MySQL，需要在配置中添加:
```
     remarks = true
     useInformationSchema = true
 
```
    Parameters:
    
    ds - 数据源
    
    tableName - 表名
    
    catalog - catalog name，null表示自动获取，见：getCatalog(Connection)
    
    schema - a schema name pattern，null表示自动获取，见：getSchema(Connection)
    
    Returns:
    
    Table对象
    
    Since:
    
    5.7.22
  - getTableMeta
```
public static Table getTableMeta(Connection conn,
                                 String catalog,
                                 String schema,
                                 String tableName)
```
    获得表的元信息
    注意如果需要获取注释，某些数据库如MySQL，需要在配置中添加:
```
     remarks = true
     useInformationSchema = true
 
```
    Parameters:
    
    conn - 数据库连接对象，使用结束后不会关闭。
    
    tableName - 表名
    
    catalog - catalog name，null表示自动获取，见：getCatalog(Connection)
    
    schema - a schema name pattern，null表示自动获取，见：getSchema(Connection)
    
    Returns:
    
    Table对象
    
    Since:
    
    5.8.28
  - getCatalog
```
public static String getCatalog(Connection conn)
```
    获取catalog，获取失败返回null
    
    Parameters:
    
    conn - Connection 数据库连接，null时返回null
    
    Returns:
    
    catalog，获取失败返回null
    
    Since:
    
    5.7.23
  - getSchema
```
public static String getSchema(Connection conn)
```
    获取schema，获取失败返回null
    
    Parameters:
    
    conn - Connection 数据库连接，null时返回null
    
    Returns:
    
    schema，获取失败返回null
    
    Since:
    
    4.6.0
  - getMetaData
```
public static DatabaseMetaData getMetaData(Connection conn)
```
    获取数据库连接的元数据信息。
    
    Parameters:
    
    conn - 数据库连接对象。如果连接为null，则返回null。
    
    Returns:
    
    DatabaseMetaData 数据库元数据对象，如果获取失败或连接为null，则返回null。
    
    Since:
    
    5.8.28
  - getRemarks
```
public static String getRemarks(DatabaseMetaData metaData,
                                String catalog,
                                String schema,
                                String tableName)
```
    获取指定表的备注信息。
    
    Parameters:
    
    metaData - 数据库元数据，用于查询表信息。
    
    catalog - 目录名称，用于指定查询的数据库（可为null，表示任意目录）。
    
    schema - 方案名称，用于指定表所属的schema（可为null，表示任意schema）。
    
    tableName - 表名称，指定要查询备注信息的表。
    
    Returns:
    
    表的备注信息。未找到指定的表或查询成功但无结果，则返回null。
    
    Since:
    
    5.8.28
  - getPrimaryKeys
```
public static Set<String> getPrimaryKeys(DatabaseMetaData metaData,
                                         String catalog,
                                         String schema,
                                         String tableName)
```
    获取指定表的主键列名列表。
    
    Parameters:
    
    metaData - 数据库元数据，用于查询主键信息。
    
    catalog - 数据库目录，用于限定查询范围。
    
    schema - 数据库模式，用于限定查询范围。
    
    tableName - 表名，指定要查询主键的表。
    
    Returns:
    
    主键列名的列表。如果表没有主键，则返回空列表。
    
    Throws:
    
    DbException - 如果查询过程中发生SQLException，将抛出DbException。
    
    Since:
    
    5.8.28
  - getIndexInfo
```
public static Map<String,IndexInfo> getIndexInfo(DatabaseMetaData metaData,
                                                 String catalog,
                                                 String schema,
                                                 String tableName)
```
    获取指定表的索引信息。
    
    Parameters:
    
    metaData - 数据库元数据，用于查询索引信息。
    
    catalog - 数据库目录，用于限定查询范围。
    
    schema - 数据库模式，用于限定查询范围。
    
    tableName - 需要查询索引信息的表名。
    
    Returns:
    
    返回一个映射，其中包含表的索引信息。键是表名和索引名的组合，值是索引信息对象。
    
    Since:
    
    5.8.28
  - isOracle
```
public static boolean isOracle(DatabaseMetaData metaData)
                        throws DbException
```
    判断当前数据库是否为Oracle。
    
    Parameters:
    
    metaData - 数据库元数据，用于获取数据库产品名称。
    
    Returns:
    
    返回true表示当前数据库是Oracle，否则返回false。
    
    Throws:
    
    DbException - 如果获取数据库产品名称时发生SQLException，将抛出DbException。
    
    Since:
    
    5.8.28

Class MetaUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetaUtil

Method Detail

getTableNames

getTableNames

getTableNames

getTableNames

getTableNames

getColumnNames

getColumnNames

getColumnNames

createLimitedEntity

getTableMeta

getTableMeta

getTableMeta

getCatalog

getSchema

getMetaData

getRemarks

getPrimaryKeys

getIndexInfo

isOracle