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

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

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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.sql/java/sql/ParameterMetaData.html