使用 ODBC 資料表值參數

本主題將討論搭配 ODBC 使用資料表值參數的主要使用者案例:

  • 完整繫結多資料列緩衝區之下的資料表值參數 (使用記憶體中的所有值,將資料當做 TVP 傳送)

  • 以資料流方式傳送資料列的資料表值參數 (使用資料執行中,將資料當做 TVP 傳送)

  • 從系統目錄擷取資料表值參數中繼資料

  • 針對準備好的陳述式擷取資料表值參數中繼資料

完整繫結多資料列緩衝區之下的資料表值參數 (使用記憶體中的所有值,將資料當做 TVP 傳送)

當搭配完整繫結的多資料列緩衝區使用時,記憶體中將提供所有參數值。 例如,這對於 OLTP 交易而言就是典型的情況,在這類交易中,資料表值參數可以封裝到單一預存程序中。 如果沒有資料表值參數,這會牽涉到動態產生複雜的多重陳述式批次,或是對伺服器進行多次呼叫。

資料表值參數本身的繫結是利用 SQLBindParameter,連同其他參數。 在已經繫結所有參數以後,應用程式會在每一個資料表值參數上設定參數焦點屬性 SQL_SOPT_SS_PARAM_FOCUS,並針對資料表值參數的資料行呼叫 SQLBindParameter

資料表值參數的伺服器類型是 SQL Server 所特有的新類型 SQL_SS_TABLE。 SQL_SS_TABLE 的繫結 C 類型一定必須是 SQL_C_DEFAULT。 資料表值參數繫結的參數不會傳送任何資料;它是用來傳遞資料表中繼資料,以及控制要如何傳遞資料表值參數之組成資料行中的資料。

資料表值參數的長度會設定為傳送給伺服器的資料列數。 資料表值參數之 SQLBindParameter 的 ColumnSize 參數會指定可以傳送的最大資料列數;這是資料行緩衝區的陣列大小。 ParameterValuePtr 是 SQLBindParameter 中資料表值參數的參數緩衝區。 ParameterValuePtr 和它的關聯 BufferLength 會在需要時用來傳遞資料表值參數的類型名稱。 此類型名稱不是預存程序呼叫所需,但為 SQL 陳述式所需。

當資料表值參數類型名稱是在 SQLBindParameter 的呼叫上指定時,一定要將該名稱指定為 Unicode 值,即使在建置為 ANSI 應用程式的應用程式中也是如此。 當您使用 SQLSetDescField 來指定資料表值參數類型名稱時,您可以使用符合應用程式建置方式的常值。 ODBC 驅動程式管理員將會執行所有必要的 Unicode 轉換。

可以使用 SQLGetDescRecSQLSetDescRecSQLGetDescFieldSQLSetDescField 來明確及個別操作資料表值參數和資料表值參數資料行的中繼資料。 但是,多載 SQLBindParameter 通常會比較方便,而且在大多數情況下不需要明確描述項存取。 對於其他資料類型而言,這個方法與 SQLBindParameter 定義一致,例外之處是對於資料表值參數而言,受影響的描述項欄位會有些不同。

有時應用程式會搭配動態 SQL 使用資料表值參數,而且必須提供此資料表值參數的類型名稱。 如果是這種情況,而且連接的目前預設結構描述中未定義此資料表值參數,則必須使用 SQLSetDescField 來設定 SQL_CA_SS_TYPE_CATALOG_NAME 和 SQL_CA_SS_TYPE_SCHEMA_NAME。 因為資料表類型定義和資料表值參數必須在相同的資料庫中,所以如果應用程式使用資料表值參數,就不能設定 SQL_CA_SS_TYPE_CATALOG_NAME。 否則,SQLSetDescField 將會報告錯誤。

此案例的範例程式碼位於<使用資料表值參數 (ODBC)>中的 demo_fixed_TVP_binding 程序內。

以資料流方式傳送資料列的資料表值參數 (使用資料執行中,將資料當做 TVP 傳送)

在此案例中,應用程式會在要求時提供資料列給驅動程式,然後以資料流方式將資料列傳送給伺服器。 如此就不需要在記憶體中緩衝處理所有資料列。 這是大量插入/更新案例的代表。 資料表值參數會提供參數陣列與大量複製之間某一處的效能點。 也就是說,編寫資料表值參數就跟參數陣列一樣輕鬆,但是資料表值參數在伺服器上提供更大的彈性。

如同上一節「完整繫結多資料列緩衝區之下的資料表值參數」所討論,資料表值參數和它的資料行會繫結在一起,但是資料表值參數本身的長度指標會設定為 SQL_DATA_AT_EXEC。 此驅動程式會依照資料執行中參數所適用的一般方式對應到 SQLExecuteSQLExecuteDirect,也就是藉由傳回 SQL_NEED_DATA。 當驅動程式準備好要接受資料表值參數的資料時,SQLParamData 會在 SQLBindParameter 中傳回 ParameterValuePtr 的值。

應用程式會針對資料表值參數使用 SQLPutData,表示資料表值參數組成資料行的資料可用性。 當針對資料表值參數呼叫 SQLPutData 時,DataPtr 永遠必須為 null,而且 StrLen_or_Ind 必須為 0 或是小於或等於為資料表值參數緩衝區指定之陣列大小的數字 (SQLBindParameter 的 ColumnSize 參數)。 0 表示資料表值參數沒有其他資料列,而且此驅動程式將會繼續處理下一個實際程序參數。 當 StrLen_or_Ind 不是 0 時,此驅動程式將會依照非資料表值參數繫結之參數的相同方式來處理資料表值參數組成資料行:每一個資料表值參數資料行都可以指定它的實際資料長度 SQL_NULL_DATA,或是可以透過它的長度/指標緩衝區來指定資料執行中。 當字元或二進位值要以片段方式傳遞時,可以與往常一樣重複呼叫 SQLPutData 來傳遞資料表值參數資料行值。

當所有資料表值參數資料行都已經處理過之後,此驅動程式會回到資料表值參數來進一步處理資料表值參數資料的資料列。 因此,如果是資料執行中的資料表值參數,此驅動程式不會遵循一般的繫結參數循序掃描。 在使用等於 0 的 StrLen_Or_IndPtr 呼叫 SQLPutData 之前,將會輪詢繫結資料表值參數,而在呼叫它時,此驅動程式會略過資料表值參數資料行,並移到下一個實際預存程序參數。 當 SQLPutData 傳遞大於或等於 1 的指標值時,此驅動程式會循序處理資料表值參數資料行和資料列,直到它擁有所有繫結資料列和資料行的值為止。 然後此驅動程式會回到資料表值參數。 在從 SQLParamData 接收資料表值參數的 Token 與呼叫資料表值參數的 SQLPutData(hstmt, NULL, n) 期間中,應用程式必須設定資料表值參數組成資料行資料和指標緩衝區內容,接下來的資料列才能傳遞給伺服器。

此案例的範例程式碼位於<使用資料表值參數 (ODBC)>中的 demo_variable_TVP_binding 常式內。

從系統目錄擷取資料表值參數中繼資料

當應用程式針對具有資料表值參數的程序呼叫 SQLProcedureColumns 時,DATA_TYPE 會以 SQL_SS_TABLE 的形式傳回,而且 TYPE_NAME 是資料表值參數之資料表類型的名稱。 有兩個其他資料行會加入到 SQLProcedureColumns 所傳回的結果集:SS_TYPE_CATALOG_NAME 會傳回定義資料表值參數之資料表類型的目錄名稱,而 SS_TYPE_SCHEMA_NAME 會傳回定義資料表值參數之資料表類型的結構描述名稱。 依照 ODBC 規格規定,SS_TYPE_CATALOG_NAME 和 SS_TYPE_SCHEMA_NAME 會出現在舊版 SQL Server 中所加入的所有驅動程式特有資料行之前,以及 ODBC 本身所託管的所有資料行之後。

新的資料行不但會針對資料表值參數擴展,也會針對 CLR 使用者定義型別參數擴展。 仍然會擴展 UDT 參數現有的結構描述和目錄資料行,但是讓需要的資料類型擁有共同的結構描述和目錄資料行將會簡化未來的應用程式開發過程 (請注意,XML 結構描述集合會有些不同,而且未包含在這項變更中)。

應用程式會使用 SQLTables 來決定資料表類型的名稱,與處理保存的資料表、系統資料表和檢視表的方法一樣。 新的資料表類型 TABLE TYPE 已經導入,可讓應用程式識別與資料表值參數相關聯的資料表類型。 資料表類型和一般表格會使用不同的命名空間。 這表示,您可以將相同的名稱用於資料表類型和實際資料表。 為了處理這個情況,已經導入了新的陳述式屬性 SQL_SOPT_SS_NAME_SCOPE。 這個屬性會指定 SQLTables 和其他採用資料表名稱當做參數的目錄函數是否應該將資料表名稱解譯為實際資料表的名稱,或是資料表類型的名稱。

應用程式會使用 SQLColumns 來決定資料表類型的資料行,就像是處理保存的資料表一樣,但是必須先設定 SQL_SOPT_SS_NAME_SCOPE 來指示它正在處理資料表類型,而不是實際資料表。 SQLPrimaryKeys 也可以搭配資料表類型使用,這同樣是利用 SQL_SOPT_SS_NAME_SCOPE。

此案例的範例程式碼位於<使用資料表值參數 (ODBC)>中的 demo_metadata_from_catalog_APIs 常式內。

針對準備好的陳述式擷取資料表值參數中繼資料

在此案例中,應用程式會使用 SQLNumParametersSQLDescribeParam 來擷取資料表值參數的中繼資料。

IPD 欄位 SQL_CA_SS_TYPE_NAME 是用來擷取資料表值參數的類型名稱。 IPD 欄位 SQL_CA_SS_TYPE_SCHEMA_NAME 和 SQL_CA_SS_TYPE_CATALOG_NAME 是分別用來擷取它的目錄和結構描述。

資料表類型定義和資料表值參數必須在相同的資料庫中。 如果應用程式在使用資料表值參數時設定 SQL_CA_SS_TYPE_CATALOG_NAME,SQLSetDescField 將會報告錯誤。

SQL_CA_SS_TYPE_CATALOG_NAME 和 SQL_CA_SS_TYPE_SCHEMA_NAME 也可以用來擷取與 CLR 使用者定義型別參數相關聯的目錄和結構描述。 SQL_CA_SS_TYPE_CATALOG_NAME 和 SQL_CA_SS_TYPE_SCHEMA_NAME 是 CLR UDT 類型的現有類型特有之目錄結構描述屬性的替代方式。

在此案例中,應用程式也會使用 SQLColumns 來擷取資料表值參數的資料行中繼資料,因為 SQLDescribeParam 不會針對資料表值參數資料行的資料行傳回中繼資料。

此使用案例的範例程式碼位於<使用資料表值參數 (ODBC)>中的 demo_metadata_from_prepared_statement 常式內。

請參閱

概念

資料表值參數 (ODBC)