Module java.sql
Package java.sql

Interface ParameterMetaData

所有超级接口:
Wrapper

public interface ParameterMetaData extends Wrapper
一个对象,可用于获取PreparedStatement对象中每个参数标记的类型和属性信息。对于某些查询和驱动程序实现,只有在执行PreparedStatement之后,才能获取ParameterMetaData对象返回的数据。

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

自 JDK 版本:
1.4
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    表示参数模式为 IN 的常量。
    static final int
    表示参数模式为 INOUT 的常量。
    static final int
    表示参数模式为 OUT 的常量。
    static final int
    表示参数模式未知的常量。
    static final int
    表示参数不允许NULL值的常量。
    static final int
    表示参数允许NULL值的常量。
    static final int
    表示参数的可空性未知的常量。
  • Method Summary

    Modifier and Type
    Method
    Description
    getParameterClassName(int param)
    检索应传递给方法PreparedStatement.setObject的 Java 类的完全限定名称。
    int
    检索ParameterMetaData对象包含信息的PreparedStatement对象中的参数数量。
    int
    getParameterMode(int param)
    检索指定参数的模式。
    int
    getParameterType(int param)
    检索指定参数的 SQL 类型。
    getParameterTypeName(int param)
    检索指定参数的数据库特定类型名称。
    int
    getPrecision(int param)
    检索指定参数的指定列大小。
    int
    getScale(int param)
    检索指定参数小数点右侧的数字个数。对于不适用比例的数据类型,返回 0。
    int
    isNullable(int param)
    检索指定参数是否允许空值。
    boolean
    isSigned(int param)
    检索指定参数的值是否可以是有符号数字。

    Methods declared in interface java.sql.Wrapper

    isWrapperFor, unwrap
  • Field Details

    • 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 的常量。
      参见:
  • Method Details

    • getParameterCount

      int getParameterCount() throws SQLException
      检索ParameterMetaData对象包含信息的PreparedStatement对象中的参数数量。
      返回:
      参数数量
      抛出:
      SQLException - 如果发生数据库访问错误
      自 JDK 版本:
      1.4
    • isNullable

      int isNullable(int param) throws SQLException
      检索指定参数是否允许空值。
      参数:
      param - 第一个参数为 1,第二个为 2,...
      返回:
      给定参数的可空性状态;可以是ParameterMetaData.parameterNoNullsParameterMetaData.parameterNullableParameterMetaData.parameterNullableUnknown之一
      抛出:
      SQLException - 如果发生数据库访问错误
      自 JDK 版本:
      1.4
    • isSigned

      boolean isSigned(int param) throws SQLException
      检索指定参数的值是否可以是有符号数字。
      参数:
      param - 第一个参数为 1,第二个为 2,...
      返回:
      如果是,则返回true;否则返回false
      抛出:
      SQLException - 如果发生数据库访问错误
      自 JDK 版本:
      1.4
    • getPrecision

      int getPrecision(int param) throws SQLException
      检索指定参数的指定列大小。

      返回值表示给定参数的最大列大小。对于数字数据,这是最大精度。对于字符数据,这是字符长度。对于日期时间数据类型,这是字符串表示的字符长度(假设小数秒组件的最大允许精度)。对于二进制数据,这是字节长度。对于 ROWID 数据类型,这是字节长度。对于不适用列大小的数据类型,返回 0。

      参数:
      param - 第一个参数为 1,第二个为 2,...
      返回:
      精度
      抛出:
      SQLException - 如果发生数据库访问错误
      自 JDK 版本:
      1.4
    • getScale

      int getScale(int param) throws SQLException
      检索指定参数小数点右侧的数字个数。对于不适用比例的数据类型,返回 0。
      参数:
      param - 第一个参数为 1,第二个为 2,...
      返回:
      比例
      抛出:
      SQLException - 如果发生数据库访问错误
      自 JDK 版本:
      1.4
    • getParameterType

      int getParameterType(int param) throws SQLException
      检索指定参数的 SQL 类型。
      参数:
      param - 第一个参数为 1,第二个为 2,...
      返回:
      来自java.sql.Types的 SQL 类型
      抛出:
      SQLException - 如果发生数据库访问错误
      自 JDK 版本:
      1.4
      参见:
    • getParameterTypeName

      String getParameterTypeName(int param) throws SQLException
      检索指定参数的数据库特定类型名称。
      参数:
      param - 第一个参数为 1,第二个为 2,...
      返回:
      数据库使用的类型名称。如果参数类型是用户定义类型,则返回完全限定类型名称。
      抛出:
      SQLException - 如果发生数据库访问错误
      自 JDK 版本:
      1.4
    • getParameterClassName

      String getParameterClassName(int param) throws SQLException
      检索应传递给方法PreparedStatement.setObject的 Java 类的完全限定名称。
      参数:
      param - 第一个参数为 1,第二个为 2,...
      返回:
      用于自定义映射的方法PreparedStatement.setObject中设置指定参数的值的 Java 编程语言中的类的完全限定名称。这是用于自定义映射的类名。
      抛出:
      SQLException - 如果发生数据库访问错误
      自 JDK 版本:
      1.4
    • getParameterMode

      int getParameterMode(int param) throws SQLException
      检索指定参数的模式。
      参数:
      param - 第一个参数为 1,第二个为 2,...
      返回:
      参数的模式;可以是ParameterMetaData.parameterModeInParameterMetaData.parameterModeOutParameterMetaData.parameterModeInOutParameterMetaData.parameterModeUnknown之一。
      抛出:
      SQLException - 如果发生数据库访问错误
      自 JDK 版本:
      1.4