Интерфейс ResultSetMetaData

Все суперинтерфейсы:: Wrapper

Все известные подинтерфейсы:: RowSetMetaData

Все известные реализующие классы:: RowSetMetaDataImpl

public interface ResultSetMetaData extends Wrapper

Объект, который можно использовать для получения информации о типах и свойствах столбцов объекта ResultSet. Следующий фрагмент кода создает объект ResultSet rs, создает объект ResultSetMetaData rsmd и использует rsmd, чтобы узнать, сколько столбцов содержит rs и можно ли использовать первый столбец rs в предложении WHERE.


    ResultSet rs = stmt.executeQuery("SELECT a, b, c FROM TABLE2");
    ResultSetMetaData rsmd = rs.getMetaData();
    int numberOfColumns = rsmd.getColumnCount();
    boolean b = rsmd.isSearchable(1);

Начиная с:: 1.1

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`columnNoNulls`	Константа, указывающая, что столбец не допускает значения `NULL`.
`static final int`	`columnNullable`	Константа, указывающая, что столбец допускает значения `NULL`.
`static final int`	`columnNullableUnknown`	Константа, указывающая, что допустимость значений NULL для столбца неизвестна.

Краткое описание методов

Модификатор и тип	Метод	Описание
`String`	`getCatalogName(int column)`	Возвращает имя каталога таблицы заданного столбца.
`String`	`getColumnClassName(int column)`	Возвращает полное имя класса Java, экземпляры которого создаются при вызове метода `ResultSet.getObject` для получения значения из столбца.
`int`	`getColumnCount()`	Возвращает количество столбцов в этом объекте `ResultSet`.
`int`	`getColumnDisplaySize(int column)`	Указывает обычную максимальную ширину заданного столбца в символах.
`String`	`getColumnLabel(int column)`	Возвращает рекомендуемый заголовок заданного столбца для использования в распечатках и на экране.
`String`	`getColumnName(int column)`	Возвращает имя заданного столбца.
`int`	`getColumnType(int column)`	Возвращает тип SQL заданного столбца.
`String`	`getColumnTypeName(int column)`	Возвращает специфичное для базы данных имя типа заданного столбца.
`int`	`getPrecision(int column)`	Возвращает заданный размер указанного столбца.
`int`	`getScale(int column)`	Возвращает количество цифр справа от десятичной точки для заданного столбца. Для типов данных, к которым масштаб не применим, возвращается 0.
`String`	`getSchemaName(int column)`	Возвращает схему таблицы заданного столбца.
`String`	`getTableName(int column)`	Возвращает имя таблицы заданного столбца.
`boolean`	`isAutoIncrement(int column)`	Указывает, нумеруется ли заданный столбец автоматически.
`boolean`	`isCaseSensitive(int column)`	Указывает, имеет ли значение регистр символов в столбце.
`boolean`	`isCurrency(int column)`	Указывает, содержит ли заданный столбец денежное значение.
`boolean`	`isDefinitelyWritable(int column)`	Указывает, гарантированно ли завершится успешно запись в заданный столбец.
`int`	`isNullable(int column)`	Указывает, допускают ли значения заданного столбца NULL.
`boolean`	`isReadOnly(int column)`	Указывает, является ли заданный столбец заведомо недоступным для записи.
`boolean`	`isSearchable(int column)`	Указывает, можно ли использовать заданный столбец в предложении WHERE.
`boolean`	`isSigned(int column)`	Указывает, являются ли значения заданного столбца числами со знаком.
`boolean`	`isWritable(int column)`	Указывает, может ли запись в заданный столбец завершиться успешно.

Методы, объявленные в интерфейсе Wrapper

isWrapperFor, unwrap

Подробное описание полей

columnNoNulls

static final int columnNoNulls

Константа, указывающая, что столбец не допускает значения NULL.

См. также:

columnNullable

static final int columnNullable

Константа, указывающая, что столбец допускает значения NULL.

См. также:

columnNullableUnknown

static final int columnNullableUnknown

Константа, указывающая, что допустимость значений NULL для столбца неизвестна.

См. также:

Подробное описание методов

getColumnCount

int getColumnCount() throws SQLException

Возвращает количество столбцов в этом объекте ResultSet.

Возвращает:: количество столбцов
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

isAutoIncrement

boolean isAutoIncrement(int column) throws SQLException

Указывает, нумеруется ли заданный столбец автоматически.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: true, если да; false в противном случае
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

isCaseSensitive

boolean isCaseSensitive(int column) throws SQLException

Указывает, имеет ли значение регистр символов в столбце.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: true, если да; false в противном случае
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

isSearchable

boolean isSearchable(int column) throws SQLException

Указывает, можно ли использовать заданный столбец в предложении WHERE.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: true, если да; false в противном случае
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

isCurrency

boolean isCurrency(int column) throws SQLException

Указывает, содержит ли заданный столбец денежное значение.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: true, если да; false в противном случае
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

isNullable

int isNullable(int column) throws SQLException

Указывает, допускают ли значения заданного столбца NULL.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: статус допустимости значений NULL для указанного столбца; одно из значений columnNoNulls, columnNullable или columnNullableUnknown
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

isSigned

boolean isSigned(int column) throws SQLException

Указывает, являются ли значения заданного столбца числами со знаком.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: true, если да; false в противном случае
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getColumnDisplaySize

int getColumnDisplaySize(int column) throws SQLException

Указывает обычную максимальную ширину заданного столбца в символах.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: обычное максимальное количество символов, допустимое для ширины заданного столбца
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getColumnLabel

String getColumnLabel(int column) throws SQLException

Возвращает рекомендуемый заголовок заданного столбца для использования в распечатках и на экране. Рекомендуемый заголовок обычно задается предложением SQL AS. Если предложение SQL AS не указано, значение, возвращаемое методом getColumnLabel, будет таким же, как значение, возвращаемое методом getColumnName.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: рекомендуемый заголовок столбца
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getColumnName

String getColumnName(int column) throws SQLException

Возвращает имя заданного столбца.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: имя столбца
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getSchemaName

String getSchemaName(int column) throws SQLException

Возвращает схему таблицы заданного столбца.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: имя схемы или "", если неприменимо
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getPrecision

int getPrecision(int column) throws SQLException

Возвращает заданный размер указанного столбца. Для числовых данных это максимальная точность. Для символьных данных это длина в символах. Для типов данных даты и времени это длина строкового представления в символах (при условии максимально допустимой точности дробной части секунд). Для двоичных данных это длина в байтах. Для типа данных ROWID это длина в байтах. Для типов данных, к которым размер столбца неприменим, возвращается 0.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: точность
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getScale

int getScale(int column) throws SQLException

Возвращает количество цифр справа от десятичной точки для заданного столбца. Для типов данных, к которым масштаб не применим, возвращается 0.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: масштаб
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getTableName

String getTableName(int column) throws SQLException

Возвращает имя таблицы заданного столбца.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: имя таблицы или "", если неприменимо
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getCatalogName

String getCatalogName(int column) throws SQLException

Возвращает имя каталога таблицы заданного столбца.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: имя каталога таблицы, в которой находится указанный столбец, или "", если неприменимо
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getColumnType

int getColumnType(int column) throws SQLException

Возвращает тип SQL заданного столбца.

Параметры:

column - первый столбец имеет номер 1, второй — 2 и т. д.

Возвращает:

тип SQL из java.sql.Types

Вызывает исключение:

SQLException - если произошла ошибка доступа к базе данных

См. также:

getColumnTypeName

String getColumnTypeName(int column) throws SQLException

Возвращает специфичное для базы данных имя типа заданного столбца.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: имя типа, используемое базой данных. Если тип столбца является пользовательским, возвращается его полное имя.
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

isReadOnly

boolean isReadOnly(int column) throws SQLException

Указывает, является ли заданный столбец заведомо недоступным для записи.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: true, если да; false в противном случае
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

isWritable

boolean isWritable(int column) throws SQLException

Указывает, может ли запись в заданный столбец завершиться успешно.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: true, если да; false в противном случае
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

isDefinitelyWritable

boolean isDefinitelyWritable(int column) throws SQLException

Указывает, гарантированно ли завершится успешно запись в заданный столбец.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: true, если да; false в противном случае
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных

getColumnClassName

String getColumnClassName(int column) throws SQLException

Возвращает полное имя класса Java, экземпляры которого создаются при вызове метода ResultSet.getObject для получения значения из столбца. Метод ResultSet.getObject может возвращать подкласс класса, возвращаемого этим методом.

Параметры:: column - первый столбец имеет номер 1, второй — 2 и т. д.
Возвращает:: полное имя класса языка программирования Java, который использовался бы методом ResultSet.getObject для получения значения из указанного столбца. Это имя класса используется для пользовательского сопоставления.
Вызывает исключение:: SQLException - если произошла ошибка доступа к базе данных
Начиная с:: 1.2

© 1993, 2025, 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.sql/java/sql/ResultSetMetaData.html