检索关于指定目录的系统函数或用户函数参数和返回类型的说明。

注意: 此功能始于 Microsoft SQL Server JDBC Driver 2.0 版。

语法

public ResultSet getFunctionColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String functionNamePattern
java.lang.String columnNamePattern)

参数

catalog

包含目录名称的 String。如果该名称为空字符串 "",则结果将包括无目录的函数。如果该名称为 null,则目录名称不用于搜索。

schemaPattern

包含架构名称模式的 String。如果该名称为空字符串 "",则结果将包括无架构的函数。如果该名称为 null,则架构名称不用于搜索。

functionNamePattern

包含函数名称的 String

columnNamePattern

包含参数名称的 String

返回值

SQLServerResultSet 对象。

异常

SQLServerException

备注

getFunctionColumns 方法由 java.sql.DatabaseMetaData 接口中的 getFunctionColumns 方法指定。

此方法只返回与指定目录内的指定架构、函数名称和参数名称相匹配的函数和参数。

结果集中的各行均包括针对参数说明、列说明或返回类型的以下列:

名称 类型 说明

FUNCTION_CAT

String

函数所在的数据库的名称。

FUNCTION_SCHEM

String

函数的架构。

FUNCTION_NAME

String

函数的名称。

COLUMN_NAME

String

参数或列的名称。

COLUMN_TYPE

short

列的类型。可以是下列值之一:

  • functionColumnUnknown (0):未知类型。
  • functionColumnIn (1):输入参数。
  • functionColumnInOut (2):输入/输出参数。
  • functionColumnOut (3):输出参数。
  • functionReturn (4):函数返回值。
  • functionColumnResult (5):参数或列是结果集中的列。

DATA_TYPE

smallint

来自 Java.sql.Types 的 SQL 数据类型。

TYPE_NAME

String

数据类型的名称。

PRECISION

int

有效数字总个数。

LENGTH

int

数据的长度(字节)。

SCALE

short

小数点右边的数字位数。

RADIX

short

数值类型的基数。

NULLABLE

short

指示参数或返回值是否可包括 null 值。

可以是下列值之一:

  • functionNoNulls (0):不允许为 NULL 值。
  • functionNullable (1):允许为 NULL 值。
  • functionNullableUnknown (2):未知。

REMARKS

String

有关列或参数的注释。

COLUMN_DEF

String

列的默认值。

注意: 此信息可在 SQL Server 中使用,且特定于 JDBC 驱动程序。

SQL_DATA_TYPE

smallint

此列与 DATA_TYPE 列相同,但 datetime 和 ISO interval 数据类型除外。

注意: 此信息可在 SQL Server 中使用,且特定于 JDBC 驱动程序。

SQL_DATETIME_SUB

smallint

如果 SQL_DATA_TYPE 的值为 SQL_DATETIMESQL_INTERVAL,则为 datetime ISO interval 子代码。对于 datetime 和 ISO interval 以外的数据类型,此列为 NULL。

注意: 此信息可在 SQL Server 中使用,且特定于 JDBC 驱动程序。

CHAR_OCTET_LENGTH

int

基于二进制和字符的最大长度的参数或列。对于其他数据类型,该值为 NULL。

ORDINAL_POSITION

int

对于输入和输出参数,它表示从 1 开始的位置。

对于结果集列,它指从 1 开始的结果集的列的位置。

对于返回值,该值为 0。

IS_NULLABLE

String

确定参数或列的可为 Null 性。

可以是下列值之一:

YES:参数或列可包括 NULL 值。

NO:参数或列不可包括 NULL 值。

空字符串 (""):未知。

SS_TYPE_CATALOG_NAME

String

包含用户定义类型 (UDT) 的目录名称。

SS_TYPE_SCHEMA_NAME

String

包含用户定义类型 (UDT) 的架构名称。

SS_UDT_CATALOG_NAME

String

采用完全限定名称的用户定义类型 (UDT)。

SS_UDT_SCHEMA_NAME

String

在其中定义 XML 架构集合名称的目录的名称。如果找不到目录名称,则此变量包含空字符串。

SS_UDT_ASSEMBLY_TYPE_NAME

String

在其中定义 XML 架构集合名称的架构的名称。如果找不到架构名称,则为空字符串。

SS_XML_SCHEMACOLLECTION_CATALOG_NAME

String

XML 架构集合的名称。如果找不到名称,则为空字符串。

SS_XML_SCHEMACOLLECTION_SCHEMA_NAME

String

包含用户定义类型 (UDT) 的目录名称。

SS_XML_SCHEMACOLLECTION_NAME

String

包含用户定义类型 (UDT) 的架构名称。

SS_DATA_TYPE

tinyint

扩展存储过程使用的 SQL Server 数据类型。

注意   有关 SQL Server 返回的数据类型的详细信息,请参阅 SQL Server 联机丛书中的“数据类型 (Transact-SQL)”。

请参阅

SQLServerDatabaseMetaData 类
SQLServerDatabaseMetaData 成员