getColumns 方法 (SQLServerDatabaseMetaData)
擷取可透過指定目錄提供之資料表資料行的描述。
語法
public java.sql.ResultSet getColumns(java.lang.String catalog,
java.lang.String schema,
java.lang.String table,
java.lang.String col)
參數
catalog
包含目錄名稱的 String。
schema
包含結構描述名稱模式的 String。
table
包含資料表名稱模式的 String。
col
包含資料表名稱模式的 String。
傳回值
例外狀況
備註
這個 getColumns 方法是由 java.sql.DatabaseMetaData 介面中的 getColumns 方法指定。
透過 getColumns 方法所傳回的結果將包含下列資訊：
| 名稱 | 類型 | 描述 |
|---|---|---|
| TABLE_CAT | String | 目錄的名稱。 |
| TABLE_SCHEM | String | 資料表結構描述名稱。 |
| TABLE_NAME | String | 資料表名稱。 |
| COLUMN_NAME | String | 資料行名稱。 |
| DATA_TYPE | smallint | 來自 java.sql.Types 的 SQL 資料型別。 |
| TYPE_NAME | String | 資料類型的名稱。 |
| COLUMN_SIZE | int | 資料行的有效位數。 |
| BUFFER_LENGTH | smallint | 資料的傳送大小。 |
| DECIMAL_DIGITS | smallint | 資料行的小數位數。 |
| NUM_PREC_RADIX | smallint | 資料行的基數。 |
| NULLABLE | smallint | 指出資料行是否可為 Null。 它可能是下列其中一個值： columnNoNulls (0) columnNullable (1) |
| REMARKS | String | 與資料行相關聯的註解。 注意：SQL Server 一律會針對這個資料行傳回 Null。 |
| COLUMN_DEF | String | 資料行的預設值。 |
| SQL_DATA_TYPE | smallint | SQL 資料類型出現在描述子之 TYPE 欄位時的值。 除了 datetime 和 SQL-92 interval 資料類型，這個資料行與 DATA_TYPE 資料行相同。 這個資料行一律會傳回值。 |
| SQL_DATETIME_SUB | smallint | datetime 和 SQL-92 interval 資料類型的子類型代碼。 其他資料類型的這個資料行都會傳回 NULL。 |
| CHAR_OCTET_LENGTH | int | 資料行中的最大位元組數。 |
| ORDINAL_POSITION | int | 資料表內資料行的索引。 |
| IS_NULLABLE | String | 指出資料行是否允許為 Null 值。 |
| SS_IS_SPARSE | smallint | 如果資料行為疏鬆資料行，則這個值為 1，否則為 0。1 |
| SS_IS_COLUMN_SET | smallint | 如果資料行為疏鬆資料行 column_set，這個值為 1，否則為 0。 1 |
| SS_IS_COMPUTED | smallint | 指出 TABLE_TYPE 中的資料行是否為計算資料行。 1 |
| IS_AUTOINCREMENT | String | 如果資料行會自動累加則為 "YES"， 如果資料行不會自動累加則為 "NO"。 如果驅動程式無法判斷資料行是否會自動累加，則為 "" (空字串)。 1 |
| SS_UDT_CATALOG_NAME | String | 包含使用者定義型別 (UDT) 的目錄名稱。 1 |
| SS_UDT_SCHEMA_NAME | String | 包含使用者定義型別 (UDT) 的結構描述名稱。 1 |
| SS_UDT_ASSEMBLY_TYPE_NAME | String | 完整名稱的使用者定義型別 (UDT)。 1 |
| SS_XML_SCHEMACOLLECTION_CATALOG_NAME | String | 定義 XML 結構描述集合名稱所在目錄的名稱。 如果找不到目錄名稱，則此變數包含空字串。 1 |
| SS_XML_SCHEMACOLLECTION_SCHEMA_NAME | String | 定義 XML 結構描述集合名稱所在結構描述的名稱。 如果找不到結構描述名稱，這就是空字串。 1 |
| SS_XML_SCHEMACOLLECTION_NAME | String | XML 結構描述集合的名稱。 如果找不到該名稱，這就是空字串。 1 |
| SS_DATA_TYPE | tinyint | 擴充預存程序所使用的 SQL Server 資料類型。 注意：如需 SQL Server 傳回之資料類型的詳細資訊，請參閱《SQL Server 線上叢書》中的「資料類型 (Transact-SQL)」。 |
(1) 如果您連線至 SQL Server 2005 (9.x)，這個資料行不會存在。
注意
如需 getColumns 方法所傳回資料的詳細資訊，請參閱《SQL Server 線上叢書》中的＜sp_columns (Transact-SQL)＞。
在 Microsoft SQL Server JDBC Driver 3.0 中，您會看到與舊版 JDBC 驅動程式不同的下列行為變更：
DATA_TYPE 資料行有下列變更：
| SQL Server 資料類型 | JDBC Driver 2.0 中傳回類型及關聯的數值常數 (若連線至 SQL Server 2005 (9.x)) | 連線至 SQL Server 2008 (10.0.x) 和更新版本時，傳回 JDBC Driver 3.0 中的類型 |
|---|---|---|
| 大於 8 kB 的使用者定義型別 | LONGVARBINARY (-4) | VARBINARY (-3) |
| geography | LONGVARBINARY (-4) | VARBINARY (-3) |
| 幾何 | LONGVARBINARY (-4) | VARBINARY (-3) |
| varbinary(max) | LONGVARBINARY (-4) | VARBINARY (-3) |
| nvarchar(max) | LONGVARCHAR (-1) 或 LONGNVARCHAR (JDBC 4) (-16) | VARCHAR (12) 或 NVARCHAR (JDBC 4) (-9) |
| varchar(max) | LONGVARCHAR (-1) | VARCHAR (12) |
| time | VARCHAR (12) 或 NVARCHAR (JDBC 4) (-9) | TIME (-154) |
| date | VARCHAR (12) 或 NVARCHAR (JDBC 4) (-9) | DATE (91) |
| datetime2 | VARCHAR (12) 或 NVARCHAR (JDBC 4) (-9) | TIMESTAMP (93) |
| datetimeoffset | VARCHAR (12) 或 NVARCHAR (JDBC 4) (-9) | microsoft.sql.Types.DATETIMEOFFSET (-155) |
COLUMN_SIZE 資料行有下列變更：
| SQL Server 資料類型 | JDBC Driver 2.0 中的傳回類型 | JDBC Driver 3.0 中的傳回類型 |
|---|---|---|
| nvarchar(max) | 1073741823 | 2147483647 (資料庫中繼資料) |
| Xml | 1073741823 | 2147483647 (資料庫中繼資料) |
| 小於或等於 8 kB 的使用者定義型別 | 8 kB (結果集和參數中繼資料) | 預存程序傳回的實際大小。 |
| time | 該類型的字串表示法長度 (以字元為單位)，假設最大值可以容納分數秒元件的有效位數。 | |
| date | 與 time 相同 | |
| datetime2 | 與 time 相同 | |
| datetimeoffset | 與 time 相同 |
BUFFER_LENGTH 資料行有下列變更：
| SQL Server 資料類型 | JDBC Driver 2.0 中的傳回類型 | JDBC Driver 3.0 中的傳回類型 |
|---|---|---|
| 大於 8 kB 的使用者定義型別 | 2147483647 |
TYPE_NAME 資料行有下列變更：
| SQL Server 資料類型 | JDBC Driver 2.0 中的傳回類型 | JDBC Driver 3.0 中的傳回類型 |
|---|---|---|
| varchar(max) | 文字 | varchar |
| varbinary(max) | image | varbinary |
DECIMAL_DIGITS 資料行有下列變更：
| SQL Server 類型 | JDBC Driver 2.0 | JDBC Driver 3.0 |
|---|---|---|
| time | null | 7 (如果有指定的話，則為更小的值) |
| date | null | null |
| datetime2 | null | 7 (如果有指定的話，則為更小的值) |
| datetimeoffset | null | 7 (如果有指定的話，則為更小的值) |
SQL_DATA_TYPE 資料行有下列變更：
| SQL Server 資料類型 | JDBC Driver 2.0 中的 SQL Server 2008 資料值 | JDBC Driver 3.0 中的 SQL Server 2008 資料值 |
|---|---|---|
| varchar(max) | -10 | -9 |
| nvarchar(max) | -1 | -9 |
| Xml | -10 | -152 |
| 小於或等於 8 kB 的使用者定義型別 | -3 | -151 |
| 大於 8 kB 的使用者定義型別 | 不適用於 JDBC Driver 2.0 | -151 |
| geography | -4 | -151 |
| 幾何 | -4 | -151 |
| hierarchyid | -4 | -151 |
| time | -9 | 92 |
| date | -9 | 91 |
| datetime2 | -9 | 93 |
| datetimeoffset | -9 | -155 |
範例
下列範例示範如何使用 getColumns 方法來傳回 AdventureWorks2022 範例資料庫中 Person.Contact 資料表的資訊。
import java.sql.*;
public class c1 {
public static void main(String[] args) {
String connectionUrl = "jdbc:sqlserver://localhost:1433;encrypt=true;databaseName=AdventureWorks;integratedsecurity=true";
Connection con = null;
Statement stmt = null;
ResultSet rs = null;
try {
Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
con = DriverManager.getConnection(connectionUrl);
DatabaseMetaData dbmd = con.getMetaData();
rs = dbmd.getColumns("AdventureWorks", "Person", "Contact", "FirstName");
ResultSet r = dbmd.getColumns(null, null, "Contact", null);
ResultSetMetaData rm = r.getMetaData();
int noofcols = rm.getColumnCount();
if (r.next())
for (int i = 0 ; i < noofcols ; i++ )
System.out.println(rm.getColumnName( i + 1 ) + ": \t\t" + r.getString( i + 1 ));
}
catch (Exception e) {}
finally {}
}
}
另請參閱
SQLServerDatabaseMetaData 方法
SQLServerDatabaseMetaData 成員
SQLServerDatabaseMetaData 類別