APIdia Launch Partner
Top Description Fields Methods
java.sql

public Interface ResultSetMetaData

extends Wrapper
Known Direct Subinterfaces
javax.sql.RowSetMetaData

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);

Since
1.1

Field Summary

Modifier and TypeField and Description
public static final int
columnNoNulls

The constant indicating that a column does not allow NULL values.

public static final int
columnNullable

The constant indicating that a column allows NULL values.

public static final int
columnNullableUnknown

The constant indicating that the nullability of a column's values is unknown.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the name of the catalog for the table in which the given column appears or "" if not applicable
getCatalogName
(int
the first column is 1, the second is 2, ...
column
)

Gets the designated column's table's catalog name.

public String

Returns:

the fully-qualified name of the class in the Java programming language that would be used by the method ResultSet.getObject to retrieve the value in the specified column. This is the class name used for custom mapping.
getColumnClassName
(int
the first column is 1, the second is 2, ...
column
)

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.

public int

Returns:

the number of columns
getColumnCount
()

Returns the number of columns in this ResultSet object.

public int

Returns:

the normal maximum number of characters allowed as the width of the designated column
getColumnDisplaySize
(int
the first column is 1, the second is 2, ...
column
)

Indicates the designated column's normal maximum width in characters.

public String

Returns:

the suggested column title
getColumnLabel
(int
the first column is 1, the second is 2, ...
column
)

Gets the designated column's suggested title for use in printouts and displays.

public String

Returns:

column name
getColumnName
(int
the first column is 1, the second is 2, ...
column
)

Get the designated column's name.

public int

Returns:

SQL type from java.sql.Types
getColumnType
(int
the first column is 1, the second is 2, ...
column
)

Retrieves the designated column's SQL type.

public String

Returns:

type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned.
getColumnTypeName
(int
the first column is 1, the second is 2, ...
column
)

Retrieves the designated column's database-specific type name.

public int

Returns:

precision
getPrecision
(int
the first column is 1, the second is 2, ...
column
)

Get the designated column's specified column size.

public int

Returns:

scale
getScale
(int
the first column is 1, the second is 2, ...
column
)

Gets the designated column's number of digits to right of the decimal point.

public String

Returns:

schema name or "" if not applicable
getSchemaName
(int
the first column is 1, the second is 2, ...
column
)

Get the designated column's table's schema.

public String

Returns:

table name or "" if not applicable
getTableName
(int
the first column is 1, the second is 2, ...
column
)

Gets the designated column's table name.

public boolean

Returns:

true if so; false otherwise
isAutoIncrement
(int
the first column is 1, the second is 2, ...
column
)

Indicates whether the designated column is automatically numbered.

public boolean

Returns:

true if so; false otherwise
isCaseSensitive
(int
the first column is 1, the second is 2, ...
column
)

Indicates whether a column's case matters.

public boolean

Returns:

true if so; false otherwise
isCurrency
(int
the first column is 1, the second is 2, ...
column
)

Indicates whether the designated column is a cash value.

public boolean

Returns:

true if so; false otherwise
isDefinitelyWritable
(int
the first column is 1, the second is 2, ...
column
)

Indicates whether a write on the designated column will definitely succeed.

public int

Returns:

the nullability status of the given column; one of columnNoNulls, columnNullable or columnNullableUnknown
isNullable
(int
the first column is 1, the second is 2, ...
column
)

Indicates the nullability of values in the designated column.

public boolean

Returns:

true if so; false otherwise
isReadOnly
(int
the first column is 1, the second is 2, ...
column
)

Indicates whether the designated column is definitely not writable.

public boolean

Returns:

true if so; false otherwise
isSearchable
(int
the first column is 1, the second is 2, ...
column
)

Indicates whether the designated column can be used in a where clause.

public boolean

Returns:

true if so; false otherwise
isSigned
(int
the first column is 1, the second is 2, ...
column
)

Indicates whether values in the designated column are signed numbers.

public boolean

Returns:

true if so; false otherwise
isWritable
(int
the first column is 1, the second is 2, ...
column
)

Indicates whether it is possible for a write on the designated column to succeed.

Inherited from java.sql.Wrapper:
isWrapperForunwrap

Field Detail

columnNoNullsback to summary
public static final int columnNoNulls

The constant indicating that a column does not allow NULL values.

columnNullableback to summary
public static final int columnNullable

The constant indicating that a column allows NULL values.

columnNullableUnknownback to summary
public static final int columnNullableUnknown

The constant indicating that the nullability of a column's values is unknown.

Method Detail

getCatalogNameback to summary
public String getCatalogName(int column) throws SQLException

Gets the designated column's table's catalog name.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:String

the name of the catalog for the table in which the given column appears or "" if not applicable

Exceptions
SQLException:
if a database access error occurs
getColumnClassNameback to summary
public String 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.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:String

the fully-qualified name of the class in the Java programming language that would be used by the method ResultSet.getObject to retrieve the value in the specified column. This is the class name used for custom mapping.

Exceptions
SQLException:
if a database access error occurs
Since
1.2
getColumnCountback to summary
public int getColumnCount() throws SQLException

Returns the number of columns in this ResultSet object.

Returns:int

the number of columns

Exceptions
SQLException:
if a database access error occurs
getColumnDisplaySizeback to summary
public int getColumnDisplaySize(int column) throws SQLException

Indicates the designated column's normal maximum width in characters.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:int

the normal maximum number of characters allowed as the width of the designated column

Exceptions
SQLException:
if a database access error occurs
getColumnLabelback to summary
public String 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.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:String

the suggested column title

Exceptions
SQLException:
if a database access error occurs
getColumnNameback to summary
public String getColumnName(int column) throws SQLException

Get the designated column's name.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:String

column name

Exceptions
SQLException:
if a database access error occurs
getColumnTypeback to summary
public int getColumnType(int column) throws SQLException

Retrieves the designated column's SQL type.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:int

SQL type from java.sql.Types

Exceptions
SQLException:
if a database access error occurs
See Also
Types
getColumnTypeNameback to summary
public String getColumnTypeName(int column) throws SQLException

Retrieves the designated column's database-specific type name.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:String

type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned.

Exceptions
SQLException:
if a database access error occurs
getPrecisionback to summary
public int 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.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:int

precision

Exceptions
SQLException:
if a database access error occurs
getScaleback to summary
public int 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.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:int

scale

Exceptions
SQLException:
if a database access error occurs
getSchemaNameback to summary
public String getSchemaName(int column) throws SQLException

Get the designated column's table's schema.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:String

schema name or "" if not applicable

Exceptions
SQLException:
if a database access error occurs
getTableNameback to summary
public String getTableName(int column) throws SQLException

Gets the designated column's table name.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:String

table name or "" if not applicable

Exceptions
SQLException:
if a database access error occurs
isAutoIncrementback to summary
public boolean isAutoIncrement(int column) throws SQLException

Indicates whether the designated column is automatically numbered.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isCaseSensitiveback to summary
public boolean isCaseSensitive(int column) throws SQLException

Indicates whether a column's case matters.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isCurrencyback to summary
public boolean isCurrency(int column) throws SQLException

Indicates whether the designated column is a cash value.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isDefinitelyWritableback to summary
public boolean isDefinitelyWritable(int column) throws SQLException

Indicates whether a write on the designated column will definitely succeed.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isNullableback to summary
public int isNullable(int column) throws SQLException

Indicates the nullability of values in the designated column.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:int

the nullability status of the given column; one of columnNoNulls, columnNullable or columnNullableUnknown

Exceptions
SQLException:
if a database access error occurs
isReadOnlyback to summary
public boolean isReadOnly(int column) throws SQLException

Indicates whether the designated column is definitely not writable.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isSearchableback to summary
public boolean isSearchable(int column) throws SQLException

Indicates whether the designated column can be used in a where clause.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isSignedback to summary
public boolean isSigned(int column) throws SQLException

Indicates whether values in the designated column are signed numbers.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isWritableback to summary
public boolean isWritable(int column) throws SQLException

Indicates whether it is possible for a write on the designated column to succeed.

Parameters
column:int

the first column is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs