Интерфейс ResultSetMetaData

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

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

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

public interface ResultSetMetaData extends Wrapper

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


     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)`	Указывает возможность заполнения выделенного столбца значениями.
`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

Получает указанный размер столбца. Для числовых данных это максимальная точность. Для символьных данных это длина в символах. Для типов данных datetime это длина в символах строкового представления (исходя из максимальной разрешенной точности компонента дробных секунд). Для двоичных данных это длина в байтах. Для типа данных 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 - если произошла ошибка доступа к базе данных

См. также:

Types

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, 2021, 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/17/docs/api/java.sql/java/sql/ResultSetMetaData.html