Connection获取数据库、表、字段元数据

文章目录前言一、获取数据库元数据二、获取数据表元数据三、获取数据表字段元数据总结前言使用JDBC Connection 获取数据库信息，表信息和字段信息元数据。提示：这里我使用 JDBC连接 ES 作为样例，其他数据源一样一、获取数据库元数据数据库元数据使用 connection.getMetaData().getCatalogs();查看源码如下，可看到字段为 TABLE_CAT/*** Ret

林志鹏JAVA

5424人浏览 · 2021-07-04 10:47:57

林志鹏JAVA · 2021-07-04 10:47:57 发布

文章目录

前言
一、获取数据库元数据
二、获取数据表元数据
三、获取数据表字段元数据
总结

前言

使用JDBC Connection 获取数据库信息，表信息和字段信息元数据。

提示：这里我使用 JDBC连接 ES 作为样例，其他数据源一样

一、获取数据库元数据

数据库元数据使用 connection.getMetaData().getCatalogs();

查看源码如下，可看到字段为 TABLE_CAT

    /**
     * Retrieves the catalog names available in this database.  The results
     * are ordered by catalog name.
     *
     * <P>The catalog column is:
     *  <OL>
     *  <LI><B>TABLE_CAT</B> String {@code =>} catalog name
     *  </OL>
     *
     * @return a <code>ResultSet</code> object in which each row has a
     *         single <code>String</code> column that is a catalog name
     * @exception SQLException if a database access error occurs
     */
    ResultSet getCatalogs() throws SQLException;

使用Connection 获取，代码如下，这里打印出所有数据库信息

    /**
     * 查看所有数据库.
     *
     * @param connection
     * @throws Exception
     */
    public static void showDatabases(Connection connection) throws Exception{
        ResultSet schemas = connection.getMetaData().getCatalogs();
        while (schemas.next()){
            System.out.println(schemas.getObject("TABLE_CAT"));
        }
    }

二、获取数据表元数据

查看表的元数据，是为了查询数据库里所有的表信息，如表名、表描述等等

方法是 connection.getMetaData().getTables，查看源码如下：

/**
     * Retrieves a description of the tables available in the given catalog.
     * Only table descriptions matching the catalog, schema, table
     * name and type criteria are returned.  They are ordered by
     * <code>TABLE_TYPE</code>, <code>TABLE_CAT</code>,
     * <code>TABLE_SCHEM</code> and <code>TABLE_NAME</code>.
     * <P>
     * Each table description has the following columns:
     *  <OL>
     *  <LI><B>TABLE_CAT</B> String {@code =>} table catalog (may be <code>null</code>)
     *  <LI><B>TABLE_SCHEM</B> String {@code =>} table schema (may be <code>null</code>)
     *  <LI><B>TABLE_NAME</B> String {@code =>} table name
     *  <LI><B>TABLE_TYPE</B> String {@code =>} table type.  Typical types are "TABLE",
     *                  "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY",
     *                  "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
     *  <LI><B>REMARKS</B> String {@code =>} explanatory comment on the table
     *  <LI><B>TYPE_CAT</B> String {@code =>} the types catalog (may be <code>null</code>)
     *  <LI><B>TYPE_SCHEM</B> String {@code =>} the types schema (may be <code>null</code>)
     *  <LI><B>TYPE_NAME</B> String {@code =>} type name (may be <code>null</code>)
     *  <LI><B>SELF_REFERENCING_COL_NAME</B> String {@code =>} name of the designated
     *                  "identifier" column of a typed table (may be <code>null</code>)
     *  <LI><B>REF_GENERATION</B> String {@code =>} specifies how values in
     *                  SELF_REFERENCING_COL_NAME are created. Values are
     *                  "SYSTEM", "USER", "DERIVED". (may be <code>null</code>)
     *  </OL>
     *
     * <P><B>Note:</B> Some databases may not return information for
     * all tables.
     *
     * @param catalog a catalog name; must match the catalog name as it
     *        is stored in the database; "" retrieves those without a catalog;
     *        <code>null</code> means that the catalog name should not be used to narrow
     *        the search
     * @param schemaPattern a schema name pattern; must match the schema name
     *        as it is stored in the database; "" retrieves those without a schema;
     *        <code>null</code> means that the schema name should not be used to narrow
     *        the search
     * @param tableNamePattern a table name pattern; must match the
     *        table name as it is stored in the database
     * @param types a list of table types, which must be from the list of table types
     *         returned from {@link #getTableTypes},to include; <code>null</code> returns
     * all types
     * @return <code>ResultSet</code> - each row is a table description
     * @exception SQLException if a database access error occurs
     * @see #getSearchStringEscape
     */
    ResultSet getTables(String catalog, String schemaPattern,
                        String tableNamePattern, String types[]) throws SQLException;

如上可知，每个表格描述包含以下列：

TABLE_CAT 字符串=>表目录（可能为null ）
TABLE_SCHEM 字符串=>表格式（可能为null ）
TABLE_NAME 字符串=>表名
TABLE_TYPE 字符串=>表类型。典型的类型是“TABLE”，“VIEW”，“SYSTEM TABLE”，“GLOBAL TEMPORARY”，“LOCAL TEMPORARY”，“ALIAS”，“SYNONYM”。
REMARKS 字符串 =>对表的解释性评论
TYPE_CAT 字符串=>类型目录（可能为null ）
TYPE_SCHEM 字符串=>类型模式（可能是null ）
TYPE_NAME 字符串=>类型名称（可能为null ）
SELF_REFERENCING_COL_NAME 字符串=>类型表的指定“标识符”列的名称（可能为null ）
REF_GENERATION String =>指定如何创建SELF_REFERENCING_COL_NAME中的值。值为“SYSTEM”，“USER”，“DERIVED”。（可能是null ）

获取代码如下，查看数据库所有表信息

    /**
     * 查看数据库所有表.
     *
     * @param connection
     * @throws Exception
     */
    public static void showTables(Connection connection) throws Exception{
        ResultSet tables = connection.getMetaData().getTables(null, null, null, null);
        while (tables.next()) {
//            System.out.println(tables.getString("TABLE_NAME"));
            String TABLE_CAT = tables.getString("TABLE_CAT");
            String TABLE_SCHEM = tables.getString("TABLE_SCHEM");
            String TABLE_NAME = tables.getString("TABLE_NAME");
            String TABLE_TYPE = tables.getString("TABLE_TYPE");
            String REMARKS = tables.getString("REMARKS");
            log.info("表类别：{}、表模式：{}、表名称：{}、表类型：{}、表描述：{}", TABLE_CAT, TABLE_SCHEM, TABLE_NAME, TABLE_TYPE, REMARKS);
        }
    }

三、获取数据表字段元数据

获取数据库表字段元数据可以使用 connection.getMetaData().getColumns方法

每列描述具有以下列：

TABLE_CAT字符串=>表目录（可能为null ）
TABLE_SCHEM字符串=>表格式（可能是null ）
TABLE_NAME String =>表名
COLUMN_NAME字符串=>列名
DATA_TYPE int => SQL类型
TYPE_NAME String =>数据源相关类型名称，对于UDT，类型名称是完全限定的
COLUMN_SIZE int =>列大小。
不使用BUFFER_LENGTH 。
DECIMAL_DIGITS int =>小数位数。对于DECIMAL_DIGITS不适用的数据类型，返回空值。
NUM_PREC_RADIX int =>基数（通常为10或2）
NULLABLE int =>允许NULL。
columnNoNulls - 可能不允许NULL值
columnNullable - 绝对允许NULL值
columnNullableUnknown - 可空性未知
REMARKS 字符串=>注释描述列（可能为null ）
COLUMN_DEF字符串=>列的默认值，当值以单引号括起时，应将其解释为字符串（可能为null ）
未使用SQL_DATA_TYPE int =>
SQL_DATETIME_SUB int =>未使用
CHAR_OCTET_LENGTH int =>用于char类型列中最大字节数
ORDINAL_POSITION int =>表中的列索引（从1开始）
IS_NULLABLE字符串=> ISO规则用于确定列的可空性。
YES —如果列可以包含NULL
否—如果列不能包含NULL
空字符串—如果列的可空性是未知的
SCOPE_CATALOG字符串=>目录表的，它是引用属性的范围（ null如果DATA_TYPE不是REF）
SCOPE_SCHEMA字符串=>作为参考属性范围的表格（ null如果DATA_TYPE不是REF）
SCOPE_TABLE字符串=>表名称，该引用属性的（范围null如果DATA_TYPE不是REF）
SOURCE_DATA_TYPE短=>源类型来自java.sql.Types的独特的类型或用户生成Ref类型，SQL型的（ null如果DATA_TYPE不是DISTINCT或用户生成的REF）
IS_AUTOINCREMENT字符串=>指示此列是否自动递增
YES —如果列自动递增
否—如果列不自动递增
空字符串—如果无法确定列是否自动递增
IS_GENERATEDCOLUMN字符串=>指示这是否是生成的列
是—如果这是一个生成的列
否—如果这不是一个生成的列
空字符串—如果无法确定这是否是生成的列

COLUMN_SIZE列指定给定列的列大小。对于数值数据，这是最大精度。对于字符数据，这是字符长度。对于datetime数据类型，这是String表示形式的长度（假定分数秒分量的最大允许精度）。对于二进制数据，这是以字节为单位的长度。对于ROWID数据类型，这是以字节为单位的长度。对于列大小不适用的数据类型，返回空值。

使用代码获取所有字段，例如：这里查询 ‘test_index’ 表的所有字段

    /**
     * 查看表所有字段.
     *
     * @param connection
     * @throws Exception
     */
    public static void showColumns(Connection connection) throws Exception{
        ResultSet tables = connection.getMetaData().getColumns(null, null, "test_index", null);
        while (tables.next()) {
            String TABLE_CAT = tables.getString("TABLE_CAT");
            String TABLE_SCHEM = tables.getString("TABLE_SCHEM");
            String TABLE_NAME = tables.getString("TABLE_NAME");
            String columnName = tables.getString("COLUMN_NAME");
            String typeName = tables.getString("TYPE_NAME");
            String columnSize = tables.getString("COLUMN_SIZE");
            String REMARKS = tables.getString("REMARKS");
            log.info("表类别：{}、表模式：{}、表名称：{}、字段名称：{}、字段类型：{}、字段大小：{}、字段描述：{}",
                    TABLE_CAT, TABLE_SCHEM, TABLE_NAME, columnName, typeName, columnSize, REMARKS);
        }
    }

输出如下

表类别：my-application、表模式：null、表名称：test_index、字段名称：hh、字段类型：TEXT、字段大小：2147483647、字段描述：null
表类别：my-application、表模式：null、表名称：test_index、字段名称：hh.keyword、字段类型：KEYWORD、字段大小：32766、字段描述：null
表类别：my-application、表模式：null、表名称：test_index、字段名称：msg、字段类型：TEXT、字段大小：2147483647、字段描述：null
表类别：my-application、表模式：null、表名称：test_index、字段名称：msg.keyword、字段类型：KEYWORD、字段大小：32766、字段描述：null
表类别：my-application、表模式：null、表名称：test_index、字段名称：msg2、字段类型：TEXT、字段大小：2147483647、字段描述：null
表类别：my-application、表模式：null、表名称：test_index、字段名称：msg2.keyword、字段类型：KEYWORD、字段大小：32766、字段描述：null