Spec-Zone.ru › OpenJDK 8

Интерфейс ParameterMetaData

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

public interface ParameterMetaData
extends Wrapper

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

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

С момента:
1.4

Поля

Модификатор и тип Поле и описание
static int parameterModeIn

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

static int parameterModeInOut

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

static int parameterModeOut

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

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)

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

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

Константа, указывающая, что возможность использования значения 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
См. также:
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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API