public interface ResultSetMetaData extends Wrapper
An object that can be used to get information about the types and properties of the columns in a ResultSet
object. The following code fragment creates the ResultSet
object rs, creates the ResultSetMetaData
object rsmd, and uses rsmd to find out how many columns rs has and whether the first column in rs can be used in a WHERE
clause.
ResultSet rs = stmt.executeQuery("SELECT a, b, c FROM TABLE2"); ResultSetMetaData rsmd = rs.getMetaData(); int numberOfColumns = rsmd.getColumnCount(); boolean b = rsmd.isSearchable(1);
static final int columnNoNulls
The constant indicating that a column does not allow NULL
values.
static final int columnNullable
The constant indicating that a column allows NULL
values.
static final int columnNullableUnknown
The constant indicating that the nullability of a column's values is unknown.
int getColumnCount() throws SQLException
Returns the number of columns in this ResultSet
object.
SQLException
- if a database access error occursboolean isAutoIncrement(int column) throws SQLException
Indicates whether the designated column is automatically numbered.
column
- the first column is 1, the second is 2, ...true
if so; false
otherwiseSQLException
- if a database access error occursboolean isCaseSensitive(int column) throws SQLException
Indicates whether a column's case matters.
column
- the first column is 1, the second is 2, ...true
if so; false
otherwiseSQLException
- if a database access error occursboolean isSearchable(int column) throws SQLException
Indicates whether the designated column can be used in a where clause.
column
- the first column is 1, the second is 2, ...true
if so; false
otherwiseSQLException
- if a database access error occursboolean isCurrency(int column) throws SQLException
Indicates whether the designated column is a cash value.
column
- the first column is 1, the second is 2, ...true
if so; false
otherwiseSQLException
- if a database access error occursint isNullable(int column) throws SQLException
Indicates the nullability of values in the designated column.
column
- the first column is 1, the second is 2, ...columnNoNulls
, columnNullable
or columnNullableUnknown
SQLException
- if a database access error occursboolean isSigned(int column) throws SQLException
Indicates whether values in the designated column are signed numbers.
column
- the first column is 1, the second is 2, ...true
if so; false
otherwiseSQLException
- if a database access error occursint getColumnDisplaySize(int column) throws SQLException
Indicates the designated column's normal maximum width in characters.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursString getColumnLabel(int column) throws SQLException
Gets the designated column's suggested title for use in printouts and displays. The suggested title is usually specified by the SQL AS
clause. If a SQL AS
is not specified, the value returned from getColumnLabel
will be the same as the value returned by the getColumnName
method.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursString getColumnName(int column) throws SQLException
Get the designated column's name.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursString getSchemaName(int column) throws SQLException
Get the designated column's table's schema.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursint getPrecision(int column) throws SQLException
Get the designated column's specified column size. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursint getScale(int column) throws SQLException
Gets the designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursString getTableName(int column) throws SQLException
Gets the designated column's table name.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursString getCatalogName(int column) throws SQLException
Gets the designated column's table's catalog name.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursint getColumnType(int column) throws SQLException
Retrieves the designated column's SQL type.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursTypes
String getColumnTypeName(int column) throws SQLException
Retrieves the designated column's database-specific type name.
column
- the first column is 1, the second is 2, ...SQLException
- if a database access error occursboolean isReadOnly(int column) throws SQLException
Indicates whether the designated column is definitely not writable.
column
- the first column is 1, the second is 2, ...true
if so; false
otherwiseSQLException
- if a database access error occursboolean isWritable(int column) throws SQLException
Indicates whether it is possible for a write on the designated column to succeed.
column
- the first column is 1, the second is 2, ...true
if so; false
otherwiseSQLException
- if a database access error occursboolean isDefinitelyWritable(int column) throws SQLException
Indicates whether a write on the designated column will definitely succeed.
column
- the first column is 1, the second is 2, ...true
if so; false
otherwiseSQLException
- if a database access error occursString getColumnClassName(int column) throws SQLException
Returns the fully-qualified name of the Java class whose instances are manufactured if the method ResultSet.getObject
is called to retrieve a value from the column. ResultSet.getObject
may return a subclass of the class returned by this method.
column
- the first column is 1, the second is 2, ...ResultSet.getObject
to retrieve the value in the specified column. This is the class name used for custom mapping.SQLException
- if a database access error occurs
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.