检索系统函数和用户函数的说明。

注意: 从 Microsoft SQL Server JDBC Driver 2.0 版开始引入此功能。

语法

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

参数

catalog

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

schemaPattern

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

functionNamePattern

函数的名称。

返回值

SQLServerResultSet 对象。

异常

SQLServerException

备注

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

此方法只返回与指定架构和函数名称匹配的系统函数和用户函数。

重要提示: 返回的结果集可包含调用用户无权执行的函数。

每个函数说明都包括以下列:

名称 类型 说明

FUNCTION_CAT

String

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

FUNCTION_SCHEM

String

函数所在的架构的名称。

FUNCTION_NAME

String

函数的名称。

NUM_INPUT_PARAMS

int

保留以供将来使用,当前返回 -1 值。

NUM_OUTPUT_PARAMS

int

保留以供将来使用,当前返回 -1 值。

NUM_RESULT_SETS

int

保留以供将来使用,当前返回 -1 值。

REMARKS

String

有关函数的注释。

FUNCTION_TYPE

short

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

SQL_PT_UNKNOWN (0)

SQL_PT_PROCEDURE (1)

SQL_PT_FUNCTION (2)

返回的结果集中的所有说明都按 FUNCTION_CAT、FUNCTION_SCHEM、FUNCTION_NAME 和 SPECIFIC_NAME 排序。

请参阅

SQLServerDatabaseMetaData 类
SQLServerDatabaseMetaData 成员