Интерфейс 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)`	Возвращает сведения о том, могут ли значения указанного параметра быть числами со знаком.

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

isWrapperFor, unwrap

Модификатор и тип	Метод	Описание
`boolean`	`isWrapperFor(Class<?> iface)`	Возвращает true, если этот объект реализует интерфейс из аргумента или прямо либо косвенно является оболочкой объекта, который его реализует.
`<T> T`	`unwrap(Class<T> iface)`	Возвращает объект, реализующий заданный интерфейс, чтобы обеспечить доступ к нестандартным методам или стандартным методам, недоступным через прокси.

Подробное описание полей

parameterNoNulls

static final int parameterNoNulls

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

См. также:

parameterNullable

static final int parameterNullable

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

См. также:

parameterNullableUnknown

static final int parameterNullableUnknown

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

См. также:

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

См. также:

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.