bcp_setbulkmode

Статья
05/07/2013

Функция bcp_setbulkmode позволяет указывать формат столбца в рамках операции массового копирования, задавая все атрибуты столбца в одном вызове функции.

Синтаксис

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_control с подсказкой BCP_HINT.

Функция bcp_setbulkmode является альтернативой использованию функций bcp_setcolfmt и bcp_columns, позволяя задавать формат одного столбца в рамках одного вызова функции.

В следующей таблице перечислены константы для параметра property.

Свойство	Описание
BCP_OUT_CHARACTER_MODE	Указывает символьный режим вывода. Соответствует параметру -c в программе BCP.EXE и вызову bcp_setcolfmt с установкой свойства BCP_FMT_TYPE в значение SQLCHARACTER.
BCP_OUT_WIDE_CHARACTER_MODE	Указывает режим вывода в Юникоде. Соответствует параметру -w в программе BCP.EXE и вызову bcp_setcolfmt с установкой свойства BCP_FMT_TYPE в значение SQLNCHAR.
BCP_OUT_NATIVE_TEXT_MODE	Указывает собственные типы для несимвольных типов и Юникод для символьных типов. Соответствует параметру –N в программе BCP.EXE и вызову функции bcp_setcolfmt, свойству BCP_FMT_TYPE которой задано значение SQLNCHAR, если типом столбца является строка (по умолчанию это не строка).
BCP_OUT_NATIVE_MODE	Указывает типы данных базы данных. Соответствует параметру -n в программе BCP.EXE и вызову функции bcp_setcolfmt с установкой свойства BCP_FMT_TYPE в значение по умолчанию.

Не следует использовать функцию bcp_setbulkmode в последовательности вызовов функций, включающих функции bcp_setcolfmt, bcp_control и bcp_readfmt. Например, не следует вызывать функции bcp_control(BCPTEXTFILE) и bcp_setbulkmode.

Можно вызвать bcp_control и bcp_setbulkmode для параметров bcp_control, которые не конфликтуют с bcp_setbulkmode. Например, можно вызвать функции bcp_control(BCPFIRST) и bcp_setbulkmode.

При попытке вызвать bcp_setbulkmode с последовательностью вызовов функций, который включает bcp_setcolfmt, bcp_control и bcp_readfmt, один из вызовов функций вернет ошибку последовательности. Чтобы исправить ошибку, вызовите функцию 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.

// 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 TSQL 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"));
}

См. также

Справочник

Функции массового копирования

Поделиться через