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

Получение указанного размера столбца. Для числовых данных это максимальная точность. Для символьных данных - длина в символах. Для типов данных 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, 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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.sql/java/sql/ResultSetMetaData.html