getFunctionColumns 方法 (SQLServerDatabaseMetaData)
擷取所指定目錄的系統函數或使用者函數之參數和傳回類型的描述。
語法
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。
傳回值
例外狀況
備註
這個 getFunctionColumns 方法是由 java.sql.DatabaseMetaData 介面中的 getFunctionColumns 方法指定。
這個方法只會傳回符合指定目錄中之指定結構描述、函數名稱和參數名稱的函數和參數。
結果集中的每一個資料列，都會針對參數描述、資料行描述或傳回類型包括下列資料行：
| 名稱 | 類型 | 描述 |
|---|---|---|
| FUNCTION_CAT | String | 函數所在之資料庫的名稱。 |
| FUNCTION_SCHEM | String | 函數的結構描述。 |
| FUNCTION_NAME | String | 函數的名稱。 |
| COLUMN_NAME | String | 參數或資料行的名稱。 |
| COLUMN_TYPE | short | 資料行的類型。 它可能是下列其中一個值： unctionColumnUnknown (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 | datetime ISO interval 子代碼 (如果 SQL_DATA_TYPE 的值是 SQL_DATETIME 或 SQL_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)」。 |