bcp_setbulkmode

[アーティクル]
01/10/2024

適用対象:SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

bcp_setbulkmodeでは、一括コピー操作で列の形式を指定し、1 つの関数呼び出しですべての列属性を設定できます。

構文

  
RETCODE bcp_setbulkmode (  
   HDBC hdbc,  
   INT property,  
   void * pField,  
   INT cbField,  
   void * pRow,  
   INT cbRow  
);

引数

hdbc
一括コピーが有効な ODBC 接続ハンドルです。

property
BYTE 型の定数です。定数の一覧については、「解説」の表を参照してください。

pField
フィールドターミネータ値を指すポインターです。

cbField
フィールドターミネータ値の長さ (バイト単位)。

pRow
行ターミネータ値を指すポインターです。

cbRow
行ターミネータ値の長さです (バイト単位)。

戻り値

SUCCEED または FAIL を返します。

解説

bcp_setbulkmodeを使用して、クエリまたはテーブルから一括コピーできます。 bcp_setbulkmodeを使用してクエリステートメントを一括コピーする場合は、BCP_HINTでbcp_controlを呼び出す前に呼び出す必要があります。

bcp_setbulkmodeは、 bcp_setcolfmt と bcp_columnsを使用する代わりに、関数呼び出しごとに 1 つの列の形式のみを指定できます。

property パラメーターとして使用できる定数の一覧を次の表に示します。

プロパティ	説明
BCP_OUT_CHARACTER_MODE	文字出力モードを指定します。 BCP.EXEの -c オプションに対応し、BCP_FMT_TYPE プロパティを SQLCHARACTER に設定したbcp_setcolfmtに対応します。
BCP_OUT_WIDE_CHARACTER_MODE	Unicode 出力モードを指定します。プロパティが SQLNCHAR に設定されている BCP.EXE および bcp_setcolfmt の -w オプションBCP_FMT_TYPE対応します。
BCP_OUT_NATIVE_TEXT_MODE	文字型以外にネイティブ型を指定し、文字型に Unicode を指定します。 BCP.EXE の -N オプションに対応し、列の型が文字列の場合 BCP_FMT_TYPEプロパティがSQLNCHAR に設定されたbcp_setcolfmt (文字列でない場合は既定値) に対応します。
BCP_OUT_NATIVE_MODE	ネイティブデータベース型を指定します。プロパティが既定値に設定されている BCP.EXE および bcp_setcolfmt の -n オプション BCP_FMT_TYPE 対応します。

bcp_setbulkmodeは、bcp_setcolfmt、bcp_control、bcp_readfmtを含む一連の関数呼び出しでは使用しないでください。たとえば、bcp_control(BCPTEXTFILE) と bcp_setbulkmodeを呼び出さないでください。

bcp_setbulkmodeと競合しないbcp_controlオプションのbcp_controlとbcp_setbulkmodeを呼び出すことができます。たとえば、bcp_control(BCPFIRST) と bcp_setbulkmodeを呼び出すことができます。

bcp_setcolfmt、bcp_control、bcp_readfmtを含む一連の関数呼び出しでbcp_setbulkmodeを呼び出そうとすると、いずれかの関数呼び出しでシーケンスエラーエラーが返されます。エラーを修正する場合は、bcp_initを呼び出してすべての設定をリセットし、やり直します。

次に、関数のシーケンスエラーが発生する関数呼び出しの例をいくつか示します。

bcp_init("table", DB_IN);  
bcp_setbulkmode();

bcp_init("table", DB_OUT);  
bcp_setbulkmode();  
bcp_readfmt();

bcp_init(NULL, DB_OUT);  
bcp_control(BCPHINTS, "select ...");  
bcp_setbulkmode();

bcp_init("table", DB_OUT);  
bcp_setbulkmode();  
bcp_setcolfmt();

bcp_init("table", DB_OUT);  
bcp_control(BCPDELAYREADFMT, true);  
bcp_readfmt();  
bcp_setcolfmt();

bcp_init(NULL, DB_OUT);  
bcp_control(BCPDELAYREADFMT, true);  
bcp_setbulkmode();  
bcp_control(BCPHINTS, "select ...");  
bcp_readfmt();

bcp_init("table", DB_OUT);  
bcp_control(BCPDELAYREADFMT, true);  
bcp_columns();

bcp_init("table", DB_OUT);  
bcp_control(BCPDELAYREADFMT, true);  
bcp_setcolfmt();

例

次のサンプルでは、bcp_setbulkmode の異なる設定を使用して、4 つのファイルを作成します。

// compile with: sqlncli11.lib odbc32.lib  
  
#include <windows.h>  
#include <stdio.h>  
#include <tchar.h>  
#include <sqlext.h>  
#include "sqlncli.h"  
  
// Global variables  
SQLHENV g_hEnv = NULL;  
SQLHDBC g_hDbc = NULL;  
  
void ODBCCleanUp() {  
   if (g_hDbc) {  
      SQLDisconnect(g_hDbc);  
      SQLFreeHandle(SQL_HANDLE_DBC, g_hDbc);  
      g_hDbc = NULL;  
   }  
   if (g_hEnv) {  
      SQLFreeHandle(SQL_HANDLE_ENV, g_hEnv);  
      g_hEnv = NULL;  
   }  
}  
  
BOOL MakeODBCConnection(TCHAR * pszServer) {  
   TCHAR szConnectionString[500];  
   TCHAR szOutConnectionString[500];  
   SQLSMALLINT iLen;  
   SQLRETURN rc;  
  
   _sntprintf_s(szConnectionString, 500, TEXT("DRIVER={SQL Server Native Client 11.0};Server=%s;Trusted_connection=yes;"), pszServer);  
   rc = SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE,&g_hEnv);  
   if (SQL_SUCCESS != rc && SQL_SUCCESS_WITH_INFO != rc) {  
      printf("SQLAllocHandle(SQL_HANDLE_ENV...) failed\n");  
      return false;  
   }  
   rc = SQLSetEnvAttr(g_hEnv,SQL_ATTR_ODBC_VERSION, (SQLPOINTER)SQL_OV_ODBC3, SQL_IS_UINTEGER);  
   if (SQL_SUCCESS != rc && SQL_SUCCESS_WITH_INFO != rc) {  
      printf("SQLSetEnvAttr failed\n");  
      SQLFreeHandle(SQL_HANDLE_ENV, g_hEnv);  
      return false;  
   }  
   rc = SQLAllocHandle( SQL_HANDLE_DBC, g_hEnv , &g_hDbc);  
   if (SQL_SUCCESS != rc && SQL_SUCCESS_WITH_INFO != rc) {  
      printf("SQLAllocHandle(SQL_HANDLE_DBC...) failed\n");  
      SQLFreeHandle(SQL_HANDLE_ENV, g_hEnv);  
      return false;  
   }  
   // Enable BCP  
   rc = SQLSetConnectAttr(g_hDbc, SQL_COPT_SS_BCP, (SQLPOINTER)SQL_BCP_ON, SQL_IS_INTEGER);  
   if (SQL_SUCCESS != rc && SQL_SUCCESS_WITH_INFO != rc) {  
      printf("SQLSetConnectAttr(.. SQL_COPT_SS_BCP, (SQLPOINTER)SQL_BCP_ON ...) failed\n");  
      ODBCCleanUp();  
      return false;  
   }  
   // connecting ...  
   rc = SQLDriverConnect(g_hDbc,NULL, (SQLTCHAR*)szConnectionString, SQL_NTS, (SQLTCHAR*)szOutConnectionString, 500, &iLen, SQL_DRIVER_NOPROMPT);  
   if (SQL_SUCCESS != rc && SQL_SUCCESS_WITH_INFO != rc) {  
      printf("SQLDriverConnect(SQL_HANDLE_DBC...) failed\n");  
      ODBCCleanUp();  
      return false;  
   }  
   return true;  
}  
  
BOOL BCPSetBulkMode(TCHAR * pszServer, TCHAR * pszQureryOut, char BCPType, TCHAR * pszDataFile) {  
   SQLRETURN rc;  
  
   if (!MakeODBCConnection(pszServer))  
      return false;  
   rc = bcp_init(g_hDbc, NULL, pszDataFile, NULL, DB_OUT);   // bcp init for queryout  
   if (SUCCEED != rc) {  
      printf("bcp_init failed\n");  
      ODBCCleanUp();  
      return false;  
   }  
   // setbulkmode  
   char ColTerm[] = "\t";  
   char RowTerm[] = "\r\n";  
   wchar_t wColTerm[] = L"\t";  
   wchar_t wRowTerm[] = L"\r\n";  
   BYTE * pColTerm = NULL;  
   int cbColTerm = NULL;  
   BYTE * pRowTerm = 0;  
   int cbRowTerm = 0;  
   int bulkmode = -1;  
  
   if (BCPType == 'c') {   // bcp -c  
      pColTerm = (BYTE*)ColTerm;  
      pRowTerm = (BYTE*)RowTerm;  
      cbColTerm = 1;  
      cbRowTerm = 2;  
      bulkmode = BCP_OUT_CHARACTER_MODE;  
   }  
   else  
      if (BCPType == 'w') {   // bcp -w   
         pColTerm = (BYTE*)wColTerm;  
         pRowTerm = (BYTE*)wRowTerm;  
         cbColTerm = 2;  
         cbRowTerm = 4;  
         bulkmode = BCP_OUT_WIDE_CHARACTER_MODE;  
      }  
      else  
         if (BCPType == 'n')   // bcp -n  
            bulkmode = BCP_OUT_NATIVE_MODE;  
         else  
            if (BCPType == 'N')   // bcp -n  
               bulkmode = BCP_OUT_NATIVE_TEXT_MODE;  
            else {  
               printf("unknown bcp mode\n");  
               ODBCCleanUp();  
               return false;  
            }  
            rc = bcp_setbulkmode(g_hDbc, bulkmode, pColTerm, cbColTerm, pRowTerm, cbRowTerm);  
            if (SUCCEED != rc) {  
               printf("bcp_setbulkmode failed\n");  
               ODBCCleanUp();  
               return false;  
            }  
            // set queryout T-SQL statement  
            rc = bcp_control(g_hDbc, BCPHINTS , pszQureryOut);  
            if (SUCCEED != rc) {  
               printf("bcp_control(..BCP_OPTION_HINTS..) failed\n");  
               ODBCCleanUp();  
               return false;  
            }  
            // bcp copy  
            DBINT nRowsInserted = 0;  
            rc = bcp_exec(g_hDbc, &nRowsInserted);  
            if (SUCCEED != rc) {  
               printf("bcp_exec failed\n");  
               ODBCCleanUp();  
               return false;  
            }  
            printf("bcp done\n");  
            ODBCCleanUp();  
            return true;  
}  
  
int main() {  
   BCPSetBulkMode(TEXT("localhost"), TEXT("SELECT 'this is a bcp -c test', 1,2") , 'c', TEXT("bcpc.dat"));  
   BCPSetBulkMode(TEXT("localhost"), TEXT("SELECT 'this is a bcp -w test', 1,2") , 'w', TEXT("bcpw.dat"));  
   BCPSetBulkMode(TEXT("localhost"), TEXT("SELECT 'this is a bcp -c test', 1,2") , 'n', TEXT("bcpn.dat"));  
   BCPSetBulkMode(TEXT("localhost"), TEXT("SELECT 'this is a bcp -w test', 1,2") , 'N', TEXT("bcp_N.dat"));  
}

参照

一括コピー関数

bcp_setbulkmode

構文

引数

戻り値

解説

例

参照

フィードバック

フィードバック

その他のリソース