Интерфейс 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`	Константа, указывающая, что допустимость значений столбца неизвестна.

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

Модификатор и тип	Метод	Описание
`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

Постоянная, указывающая, что разрешённость значений столбца неизвестна.

См. также:

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

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

Указывает разрешённость значений в указанном столбце.

Параметры:: column - первый столбец равен 1, второй - 2 и т.д.
Возвращает:: статус разрешённости данного столбца; одно из 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, 2023, 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/21/docs/api/java.sql/java/sql/ResultSetMetaData.html