JDBC之DatabaseMetaData之获取表的所有列名

曾宏毅
2023-12-01
获取数据库指定表的所有列及相应的信息:
(以MySQL和Oracle为例,其他类型的数据库接触不多,不做解释)
Connection接口中提供了DatabaseMetaData接口:
提供:getColumns()方法,该方法需要传进4个参数:
第一个是数据库名称,对于MySQL,则对应相应的数据库,对于Oracle来说,则是对应相应的数据库实例,可以不填,也可以直接使用Connection的实例对象中的getCatalog()方法返回的值填充;
第二个是模式,可以理解为数据库的登录名,而对于Oracle也可以理解成对该数据库操作的所有者的登录名。对于Oracle要特别注意,其登陆名必须是大写,不然的话是无法获取到相应的数据,而MySQL则不做强制要求。
第三个是表名称,用于传进想要查找的表
第四个是列类型,为空时,获取表对应的所有列,当不为空的时候获取该值的列的所有信息。
它返回一个ResultSet对象,有23列,详细的显示了表的类型:
TABLE_CAT String => 表类别(可为 null)
TABLE_SCHEM String => 表模式(可为 null)
TABLE_NAME String => 表名称
COLUMN_NAME String => 列名称
DATA_TYPE int => 来自 java.sql.Types 的 SQL 类型
TYPE_NAME String => 数据源依赖的类型名称,对于 UDT,该类型名称是完全限定的
COLUMN_SIZE int => 列的大小。
BUFFER_LENGTH 未被使用。
DECIMAL_DIGITS int => 小数部分的位数。对于 DECIMAL_DIGITS 不适用的数据类型,则返回 Null。
NUM_PREC_RADIX int => 基数(通常为 10 或 2)
NULLABLE int => 是否允许使用 NULL。
columnNoNulls - 可能不允许使用 NULL 值
columnNullable - 明确允许使用 NULL 值
columnNullableUnknown - 不知道是否可使用 null
REMARKS String => 描述列的注释(可为 null)
COLUMN_DEF String => 该列的默认值,当值在单引号内时应被解释为一个字符串(可为 null)
SQL_DATA_TYPE int => 未使用
SQL_DATETIME_SUB int => 未使用
CHAR_OCTET_LENGTH int => 对于 char 类型,该长度是列中的最大字节数
ORDINAL_POSITION int => 表中的列的索引(从 1 开始)
IS_NULLABLE String => ISO 规则用于确定列是否包括 null。
YES --- 如果参数可以包括 NULL
NO --- 如果参数不可以包括 NULL
空字符串 --- 如果不知道参数是否可以包括 null
SCOPE_CATLOG String => 表的类别,它是引用属性的作用域(如果 DATA_TYPE 不是 REF,则为 null)
SCOPE_SCHEMA String => 表的模式,它是引用属性的作用域(如果 DATA_TYPE 不是 REF,则为 null)
SCOPE_TABLE String => 表名称,它是引用属性的作用域(如果 DATA_TYPE 不是 REF,则为 null)
SOURCE_DATA_TYPE short => 不同类型或用户生成 Ref 类型、来自 java.sql.Types 的 SQL 类型的源类型(如果 DATA_TYPE 不是 DISTINCT 或用户生成的 REF,则为 null)
IS_AUTOINCREMENT String => 指示此列是否自动增加
YES --- 如果该列自动增加
NO --- 如果该列不自动增加
空字符串 --- 如果不能确定该列是否是自动增加参数
可根据需要使用
示例:
DatabaseMetaData metaData = conn.getMetaData();
// ResultSet rs = metaData.getColumns (conn.getCatalog(), "SCOTT", "EMP", "SAL");
ResultSet rs = metaData.getColumns(conn.getCatalog(), "root", "book", "book_id");
   while(rs.next()) {     System.out.println(rs.getString("COLUMN_NAME"));
   }

在使用的时候,我的建议是参数全部使用大写,这样可以屏蔽各个数据库的差异



随着项目的需要,对于数据库支持要求越多越好,最好是Generic JDBC Connection。为此,笔者要求项目程序内只允许使用JDBC接口。在此条件下如何获取表的字段信息?有哪几种方式?都适用吗?


字段信息     


       字段在表里就是一个Column,关于Column在JDBC里面有20多个参数来描述它,称为元数据,Metadata。包括:


1.                TABLE_CAT String => table catalog (may be null)


2.                TABLE_SCHEM String => table schema (may be null)


3.                TABLE_NAME String => table name


4.                COLUMN_NAME String => column name


5.                DATA_TYPE int => SQL type from java.sql.Types


6.                TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified


7.                COLUMN_SIZE int => column size.


8.                BUFFER_LENGTH is not used.


9.                DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.


10.            NUM_PREC_RADIX int => Radix (typically either 10 or 2)


11.            NULLABLE int => is NULL allowed.


o                                            columnNoNulls - might not allow NULL values


o                                            columnNullable - definitely allows NULL values


o                                            columnNullableUnknown - nullability unknown


12.            REMARKS String => comment describing column (may be null)


13.            COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)


14.            ……


    通常关注的是COLUMN_NAME、DATA_TYPE、TYPE_NAME等。


getColumns()获取字段信息


       JDBC里有DatabaseMetadata接口,通过它可以拿到数据库的元数据,也就是数据库的相关描述信息。果然,getColumns()就可以拿到表所有的字段信息:


Connection conn = dbms.getConnection();


DatabaseMetaData dmd = conn.getMetaData();


ResultSet rs = dmd.getColumns( null, “%”, strTableName, “%”);


Whiel( rs.next() )


{


    String strFieldName = Rs.getString( 4 );


    String strFieldType = Rs.getString( 5 );


}


       这种方式的特点是不需要去访问表内数据,看上去也很简洁。在mysql, postgresql中都很顺利,但很可惜,在连Oracle(JDBC 10.2.0.4)的时候,rs.next()为false了。查看Oracle JDBC的doc,这也是支持的该接口的,并没有任何特别的说明。那奇怪了。再在OracleJDBC的文档上看到该版本Bug列表


The following table lists the JDBC bugs addressed in this patch set:


5892966


No columns from getColumns() when includeSynonyms=true


原来这里有个特殊的,当includeSysonyms设为true时, getColumns是没有返回的。这个OracleOracle就有点不太符合JDBC的标准了。Oracle文档有这一段话:


By default, the getColumns method does not retrieve information about the columns if a synonym is specified. To enable the retrieval of information if a synonym is specified, you must call the setIncludeSynonyms method on the connection as follows:


( (oracle.jdbc.driver.OracleConnection)conn ).setIncludeSynonyms(true)


This will cause all subsequent getColumns method call on the connection to include synonyms. This is similar to setRemarksReporting. Alternatively, you can set the includeSynonymsconnection property. This is similar to the remarksReporting connection property.


这段话基本上也是讲了这个问题。针对Oracle特别的设置这是项目所不允许的,怎么办?


 


ResultSetMetaData获取字段信息


除了直接查看数据库元数据,还可以通过访问表数据来获取记录集元数据。利用ResultMetaData来获取字段信息是比较好的方式,无论表内是否有数据都可返回字段信息,同时测试①发现在实验数据库当中都是可行的。


       Connection conn = dbms.getConnection();


       DatabaseMetaData dmd = conn.getMetaData();


      


       Statement st = conn.createStatement();


       String sql = "SELECT * FROM "+table;


       ResultSet rs = st.executeQuery(sql);


       ResultSetMetaData rsmd = rs.getMetaData();


             


       for( int i=1; i<=rsmd.getColumnCount(); i++ )


       {


           String field = rsmd.getColumnName(i);


           fields.add( field );


          


           String type = Integer.toString( rsmd.getColumnType(i) ); //5--DATA_TYPE int => SQL type from java.sql.Types


           SqlType sqlT = SqlMapper.mapId( type );


           type = sqlT.sName;


           fieldTypes.add( type );


       }


 


 


注:


①测试数据库:Mckoi 1.0.3, MySQL 5.0, PostgreSQL 8.3, Oracle 10g r2, Oracle 10g XE

 类似资料: