Интерфейс ParameterMetaData

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

public interface ParameterMetaData
extends Wrapper

Объект, который можно использовать для получения информации о типах и свойствах каждого маркера параметра в объекте PreparedStatement. Для некоторых запросов и реализаций драйверов данные, которые должны быть возвращены объектом ParameterMetaData, могут быть недоступны до тех пор, пока не будет выполнен PreparedStatement.

Некоторые реализации драйверов могут не предоставлять информацию о типах и свойствах каждого маркера параметра в объекте CallableStatement.

С тех пор:: 1.4

Поля

Модификатор и тип	Поле	Описание
`static int`	`parameterModeIn`	Константа, указывающая, что режим параметра - ВХОД.
`static int`	`parameterModeInOut`	Константа, указывающая, что режим параметра - ВХОД/ВЫХОД.
`static int`	`parameterModeOut`	Константа, указывающая, что режим параметра - ВЫХОД.
`static int`	`parameterModeUnknown`	Константа, указывающая, что режим параметра неизвестен.
`static int`	`parameterNoNulls`	Константа, указывающая, что параметр не будет допускать `NULL` значений.
`static int`	`parameterNullable`	Константа, указывающая, что параметр будет допускать `NULL` значения.
`static int`	`parameterNullableUnknown`	Константа, указывающая, что возможность использования NULL в параметре неизвестна.

Методы

Модификатор и тип	Метод	Описание
`String`	`getParameterClassName(int param)`	Возвращает полное имя Java класса, экземпляры которого должны быть переданы методу `PreparedStatement.setObject`.
`int`	`getParameterCount()`	Возвращает количество параметров в объекте `PreparedStatement`, для которых этот объект `ParameterMetaData` содержит информацию.
`int`	`getParameterMode(int param)`	Возвращает режим указанного параметра.
`int`	`getParameterType(int param)`	Возвращает SQL тип указанного параметра.
`String`	`getParameterTypeName(int param)`	Возвращает имя типа параметра, специфичное для базы данных.
`int`	`getPrecision(int param)`	Возвращает заданный размер столбца параметра.
`int`	`getScale(int param)`	Возвращает количество цифр после запятой для указанного параметра. 0 возвращается для типов данных, где масштаб не применим.
`int`	`isNullable(int param)`	Возвращает, разрешены ли значения NULL для указанного параметра.
`boolean`	`isSigned(int param)`	Возвращает, могут ли значения для указанного параметра быть числами со знаком.

Методы, объявленные в интерфейсе java.sql.Wrapper

isWrapperFor, unwrap

Поля

parameterNoNulls

static final int parameterNoNulls

Постоянная, указывающая, что параметр не допускает значений NULL.

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

parameterNullable

static final int parameterNullable

Постоянная, указывающая, что параметр допускает значения NULL.

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

parameterNullableUnknown

static final int parameterNullableUnknown

Постоянная, указывающая, что разрешимость значения параметра неизвестна.

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

parameterModeUnknown

static final int parameterModeUnknown

Постоянная, указывающая, что режим параметра неизвестен.

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

parameterModeIn

static final int parameterModeIn

Постоянная, указывающая, что режим параметра — ВХОД (IN).

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

parameterModeInOut

static final int parameterModeInOut

Постоянная, указывающая, что режим параметра — ВХОД/ВЫХОД (INOUT).

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

parameterModeOut

static final int parameterModeOut

Постоянная, указывающая, что режим параметра — ВЫХОД (OUT).

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

Методы

getParameterCount

int getParameterCount()
               throws SQLException

Возвращает количество параметров в объекте PreparedStatement, для которого этот объект ParameterMetaData содержит информацию.

Возвращает:: количество параметров
Исключения:: SQLException - если произошла ошибка доступа к базе данных
С тех пор:: 1.4

isNullable

int isNullable(int param)
        throws SQLException

Возвращает, разрешены ли значения NULL для указанного параметра.

Параметры:: param - первый параметр — 1, второй — 2 и т.д.
Возвращает:: статус разрешения значения NULL для данного параметра; один из ParameterMetaData.parameterNoNulls, ParameterMetaData.parameterNullable, или ParameterMetaData.parameterNullableUnknown
Исключения:: SQLException - если произошла ошибка доступа к базе данных
С тех пор:: 1.4

isSigned

boolean isSigned(int param)
          throws SQLException

Возвращает, могут ли значения для указанного параметра быть знаковыми числами.

Параметры:: param - первый параметр — 1, второй — 2 и т.д.
Возвращает:: true если да; false в противном случае
Исключения:: SQLException - если произошла ошибка доступа к базе данных
С тех пор:: 1.4

getPrecision

int getPrecision(int param)
          throws SQLException

Возвращает заданный размер столбца для указанного параметра.

Возвращаемое значение представляет максимальный размер столбца для данного параметра. Для числовых данных это максимальная точность. Для символьных данных это длина в символах. Для типов данных даты/времени это длина в символах строкового представления (предполагая максимальную разрешённую точность компонента дробных секунд). Для двоичных данных это длина в байтах. Для типа данных ROWID это длина в байтах. 0 возвращается для типов данных, где размер столбца не применим.

Параметры:: param - первый параметр — 1, второй — 2 и т.д.
Возвращает:: точность
Исключения:: SQLException - если произошла ошибка доступа к базе данных
С тех пор:: 1.4

getScale

int getScale(int param)
      throws SQLException

Возвращает количество цифр справа от десятичной точки для указанного параметра. 0 возвращается для типов данных, где масштаб не применим.

Параметры:: param - первый параметр — 1, второй — 2 и т.д.
Возвращает:: масштаб
Исключения:: SQLException - если произошла ошибка доступа к базе данных
С тех пор:: 1.4

getParameterType

int getParameterType(int param)
              throws SQLException

Возвращает SQL-тип указанного параметра.

Параметры:: param - первый параметр — 1, второй — 2 и т.д.
Возвращает:: SQL-тип из java.sql.Types
Исключения:: SQLException - если произошла ошибка доступа к базе данных
С тех пор:: 1.4
См. также:: Types

getParameterTypeName

String getParameterTypeName(int param)
                     throws SQLException

Возвращает имя типа, специфичное для базы данных, для указанного параметра.

Параметры:: param - первый параметр — 1, второй — 2 и т.д.
Возвращает:: имя типа, используемое базой данных. Если тип параметра является пользовательским типом, то возвращается полностью квалифицированное имя типа.
Исключения:: SQLException - если произошла ошибка доступа к базе данных
С тех пор:: 1.4

getParameterClassName

String getParameterClassName(int param)
                      throws SQLException

Возвращает полностью квалифицированное имя Java-класса, экземпляры которого должны передаваться методу PreparedStatement.setObject.

Параметры:: param - первый параметр — 1, второй — 2 и т.д.
Возвращает:: полностью квалифицированное имя класса в языке программирования Java, которое будет использоваться методом PreparedStatement.setObject для установки значения в указанном параметре. Это имя класса используется для пользовательского сопоставления.
Исключения:: SQLException - если произошла ошибка доступа к базе данных
С тех пор:: 1.4

getParameterMode

int getParameterMode(int param)
              throws SQLException

Возвращает режим указанного параметра.

Параметры:: param - первый параметр — 1, второй — 2 и т.д.
Возвращает:: режим параметра; один из ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, или ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown.
Исключения:: SQLException - если произошла ошибка доступа к базе данных
С тех пор:: 1.4

© 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/ParameterMetaData.html