IBCPSession::BCPInit (Native Client OLE DB Provider)

適用於:SQL ServerAzure SQL DatabaseAzure SQL 受控執行個體Azure Synapse AnalyticsAnalytics Platform System (PDW)

重要

SQL Server Native Client (通常縮寫為 SNAC) 已從 SQL Server 2022 (16.x) 和 SQL Server Management Studio 19 (SSMS) 中移除。 不建議使用 SQL Server Native Client OLE DB 提供者 (SQLNCLI 或 SQLNCLI11) 和舊版 Microsoft OLE DB Provider for SQL Server (SQLOLEDB) 進行新的開發。 請切換至新的 Microsoft OLE DB Driver (MSOLEDBSQL) for SQL Server 以繼續使用。

初始化大量複製結構、執行一些錯誤檢查、確認資料和格式檔案名稱正確無誤,然後開啟這些項目。

語法

  
HRESULT BCPInit(   
      const wchar_t *pwszTable,  
      const wchar_t *pwszDataFile,  
      const wchar_t *pwszErrorFile,  
      int eDirection);  

備註

BCPInit 方法應該在任何其他的大量複製方法之前呼叫。 BCPInit 方法會針對工作站和 SQL Server 之間的資料大量複製,執行必要的初始化。

BCPInit 方法會檢查資料庫來源或目標資料表的結構,而不會檢查資料檔案的結構。 此方法會根據資料庫資料表、檢視或 SELECT 結果集中的每個資料行,指定資料檔的資料格式值。 這個指定包括每個資料行的資料類型、資料中是否有長度或 null 指標和結束字元位元組字串,以及固定長度資料類型的寬度。 BCPInit 方法會設定這些值,如下所示:

  • 指定的資料類型為資料行在資料庫資料表、檢視或 SELECT 結果集中的資料類型。 資料類型是由 SQL Server Native Client 標頭檔 (sqlncli.h) 中指定的 SQL Server 原生資料類型所列舉。 其值會採用 BCP_TYPE_XXX 的模式。 資料會以其電腦格式表示。 也就是說,來自 integer 資料類型之資料行的資料會根據建立資料檔案之電腦,以四個位元組由大到小或由小到大的順序表示。

  • 如果資料庫資料類型的長度是固定的,資料檔案資料的長度也是固定的。 處理資料的大量複製方法 (例如 IBCPSession::BCPExec) 會剖析資料列,期望資料在資料檔案中的長度與資料在資料庫資料表、檢視或 SELECT 資料行清單中指定的長度相同。 例如,定義為 char(13) 之資料庫資料行的資料,對於檔案中資料的每個資料列,必須以 13 個字元表示。 如果資料庫資料行允許使用 Null 值,固定長度的資料前置詞可以是 Null 指標。

  • 將資料複製到 SQL Server 時,資料檔案在資料庫資料表的每個資料行中都必須有資料。 從 SQL Server 複製資料時,資料庫資料表、檢視或 SELECT 結果集中所有資料行的資料都會複製到資料檔案。

  • 將資料複製到 SQL Server 時,資料檔案的資料行序數位置必須與資料庫資料表的資料行序數位置相同。 從 SQL Server 複製資料時,BCPExec 方法會根據資料庫資料表的資料行序數位置來放置資料。

  • 如果資料庫資料類型的長度是變數 (例如,varbinary(22)),或者如果資料庫資料行可以包含 Null 值,資料檔案中資料的前置詞為長度/Null 指標。 指標的寬度會根據資料類型和大量複製的版本而改變。 IBCPSession::BCPControl 方法選項 BCP_OPTION_FILEFMT 會藉由指出資料的指標寬度比預期窄,提供舊版大量複製資料檔案與執行新版 SQL Server 之伺服器之間的相容性。

注意

若要變更針對資料檔案而指定的資料格式值,請使用 IBCPSession::BCPColumnsIBCPSession::BCPColFmt 方法。

SQL Server 大量複製可以針對不包含索引的資料表進行最佳化,方法是設定資料庫選項 [select into/bulkcopy]。

引數

pwszTable[in]
這是要來回複製之資料庫資料表的名稱。 此名稱也可以包含資料庫名稱或擁有者名稱。 例如,"pubs.username.titles"、"pubs..titles" 和 "username.titles" 等。

如果 eDirection 引數設定為 BCP_DIRECTION_OUT,則 pwszTable 引數也可以做為資料庫檢視的名稱。

如果 eDirection 引數設定為 BCP_DIRECTION_OUT,而且會在呼叫 BCPExec 方法之前,使用 BCPControl 方法來指定 SELECT 陳述式,則 pwszTable 引數必須設定為 NULL。

pwszDataFile[in]
這是要來回複製之使用者檔案的名稱。

pwszErrorFile[in]
這是錯誤檔案的名稱,該檔案會以進度訊息、錯誤訊息,以及因為任何原因而無法從使用者檔案複製到資料表之任何資料列的複本。 如果 pwszErrorFile 引數設定為 NULL,則不會使用任何錯誤檔案。

eDirection[in]
這是複製的方向,BCP_DIRECTION_IN 或 BCP_DIRECTION _OUT。 BCP_DIRECTION _IN 代表從使用者檔案複製到資料庫資料表;BCP_DIRECTION _OUT 則代表從資料庫資料表複製到使用者檔案。

傳回碼值

S_OK
此方法已成功。

E_FAIL
發生提供者特有的錯誤,如需詳細資訊,請使用 ISQLServerErrorInfo 介面。

E_OUTOFMEMORY
記憶體不足錯誤

E_INVALIDARG
未正確指定一個或多個引數。 例如,指定了無效的檔案名稱。

另請參閱

IBCPSession (OLE DB)
執行大量複製作業