getFunctions 方法 (SQLServerDatabaseMetaData)

下载 JDBC 驱动程序

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

语法

  
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 方法指定的。

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

重要

返回的结果集可包含调用用户无权执行的函数。

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

名称 Type 说明
FUNCTION_CAT 字符串 函数所在的数据库的名称。
FUNCTION_SCHEM 字符串 函数所在的架构的名称。
FUNCTION_NAME 字符串 函数的名称。
NUM_INPUT_PARAMS int 保留以供将来使用,当前返回 -1 值。
NUM_OUTPUT_PARAMS int 保留以供将来使用,当前返回 -1 值。
NUM_RESULT_SETS int 保留以供将来使用,当前返回 -1 值。
REMARKS 字符串 有关函数的注释。
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 类