getFunctions メソッド (SQLServerDatabaseMetaData)

システム関数およびユーザー関数の記述を取得します。

メモ :
この機能は、Microsoft SQL Server JDBC Driver Version 2.0 から導入されました。

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

catalog

データベース内のカタログの名前です。空の文字列 "" の場合、結果にはカタログのない関数が含まれます。null の場合、カタログ名は検索に使用されません。

schemaPattern

スキーマの名前です。空の文字列 "" の場合、結果にはスキーマのない関数が含まれます。null の場合、スキーマ名は検索に使用されません。

functionNamePattern

関数の名前です。

戻り値

SQLServerResultSet オブジェクトです。

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 で順序付けされます。