getFunctionColumns メソッド (SQLServerDatabaseMetaData)
指定されたカタログのシステム関数またはユーザー関数のパラメーターと戻り値の型に関する記述を取得します。
構文
public ResultSet getFunctionColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String functionNamePattern
java.lang.String columnNamePattern)
パラメーター
catalog
カタログ名を含む文字列です。 空の文字列 "" の場合、結果にはカタログのない関数が含まれます。 null の場合、カタログ名は検索に使用されません。
schemaPattern
スキーマ名のパターンを含む文字列です。 空の文字列 "" の場合、結果にはスキーマのない関数が含まれます。 null の場合、スキーマ名は検索に使用されません。
functionNamePattern
関数の名前を含む文字列です。
columnNamePattern
パラメーターの名前を含む文字列です。
戻り値
SQLServerResultSet オブジェクトです。
例外
解説
この 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 | この列は、datetime データ型と ISO interval データ型以外は、DATA_TYPE 列と同じです。 注: この情報は SQL Server で利用可能であり、JDBC ドライバー固有です。 |
| SQL_DATETIME_SUB | smallint | SQL_DATA_TYPE の値が SQL_DATETIME または SQL_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 値が許可されるかどうかを決定します。 次のいずれかの値を指定できます。 はい: パラメーターまたは列に null 値を含めることができます。 いいえ: パラメーターまたは列に 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 クラス