Интерфейс 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);

Поля

Модификатор и тип	Поле и описание
`static int`	`columnNoNulls` Константа, указывающая, что столбец не допускает `NULL` значений.
`static int`	`columnNullable` Константа, указывающая, что столбец допускает `NULL` значения.
`static 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)` Получает количество цифр справа от десятичной точки в указанном столбце.
`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

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

См. также:: Значения константных полей

Методы

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 - если произошла ошибка доступа к базе данных
См. также:: 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, 2020, 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.