java.sql
接口 ParameterMetaData

所有超级接口：

Wrapper

public interface ParameterMetaData
extends Wrapper

可用于获取关于 PreparedStatement 对象中每个参数标记的类型和属性信息的对象。对于某些查询和驱动程序实现，由 ParameterMetaData 对象返回的数据在 PreparedStatement 执行前可能不可用。

某些驱动程序实现无法提供关于 CallableStatement 对象中每个参数标记的类型和属性的信息。

从以下版本开始：

1.4

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

获取指定参数的指定列大小。

返回值表示给定参数的最大列大小。对于数值数据，这是最大精度。对于字符数据，这是字符长度。对于日期时间数据类型，这是 String 表示形式的字符长度（假定允许的最大小数秒组件的精度）。对于二进制数据，这是字节长度。对于 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，……

返回：

来自 java.sql.Types 的 SQL 类型

抛出：

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

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。