Интерфейс ParameterMetaData

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

public interface ParameterMetaData extends Wrapper

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

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

С момента:: 1.4

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`parameterModeIn`	Константа, указывающая, что режим параметра — ВХОД (IN).
`static final int`	`parameterModeInOut`	Константа, указывающая, что режим параметра — ВХОД/ВЫХОД (INOUT).
`static final int`	`parameterModeOut`	Константа, указывающая, что режим параметра — ВЫХОД (OUT).
`static final int`	`parameterModeUnknown`	Константа, указывающая, что режим параметра неизвестен.
`static final int`	`parameterNoNulls`	Константа, указывающая, что параметр не позволит значения `NULL`.
`static final int`	`parameterNullable`	Константа, указывающая, что параметр позволит значения `NULL`.
`static final 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

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

Параметры:: param - первый параметр - 1, второй - 2 и т.д.
Возвращает:: статус возможности использования нулевых значений для данного параметра; одно из 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

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

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

См. также:

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, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.sql/java/sql/ParameterMetaData.html