Интерфейс 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)`	Указывает, возможно ли успех записи в указанный столбец.

Методы, объявленные в интерфейсе java.sql.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://download.java.net/java/early_access/jdk24/docs/api/java.sql/java/sql/ResultSetMetaData.html