Поддержка FILESTREAM (ODBC)
Область применения: 
SQL Server
Внимание
SQL Server Native Client (SNAC) не поставляется с:
- SQL Server 2022 (16.x) и более поздних версий
- SQL Server Management Studio 19 и более поздних версий
Собственный клиент SQL Server (SQLNCLI или SQLNCLI11) и устаревший поставщик Microsoft OLE DB для SQL Server (SQLOLEDB) не рекомендуется для разработки новых приложений.
Для новых проектов используйте один из следующих драйверов:
Сведения о SQLNCLI, которые поставляется в качестве компонента SQL Server ядро СУБД (версии 2012–2019), см. в этом исключении жизненного цикла поддержки.
ODBC в собственном клиенте SQL Server поддерживает расширенную функцию FILESTREAM. Дополнительные сведения об этой функции см. в разделе "Поддержка FILESTREAM". Пример, демонстрирующий поддержку ODB для FILESTREAM, см. в разделе "Отправка и получение данных" постепенно с помощью FILESTREAM (ODBC).
Для отправки и получения значений varbinary(max) больше 2 ГБ приложение должно привязать параметры с помощью SQLBindParameter с параметром ColumnSize для SQL_SS_LENGTH_UNLIMITED и задать для содержимого StrLen_or_IndPtr значение SQL_DATA_AT_EXEC до SQLExecDirect или SQLExecute.
Как и в случае с любым параметром выполнения данных, данные будут предоставлены с ПОМОЩЬЮ SQLParamData и SQLPutData.
Вы можете вызвать SQLGetData, чтобы получить данные в блоках для столбца FILESTREAM, если столбец не привязан к SQLBindCol.
Данные FILESTREAM можно обновить, если он привязан к SQLBindCol.
При вызове SQLFetch в привязанном столбце вы получите предупреждение "усечение данных", если буфер недостаточно велик, чтобы сохранить все значение. Игнорировать это предупреждение и обновлять данные в этом связанном столбце с помощью вызовов SQLParamData и SQLPutData. Данные FILESTREAM можно обновить с помощью SQLSetPos, если он привязан к SQLBindCol.
Пример
Столбцы FILESTREAM ведут себя точно так же, как столбцы varbinary(max), но без ограничения размера. Они связываются как SQL_VARBINARY. (SQL_LONGVARBINARY используется с столбцами изображений, и существуют ограничения на этот тип. Например, SQL_LONGVARBINARY connot следует использовать в качестве выходного параметра.) В следующих примерах показан прямой доступ NTFS для столбцов FILESTREAM. В этих примерах предполагается, что в базе данных выполнен следующий код Transact-SQL:
CREATE TABLE fileStreamDocs(
id uniqueidentifier ROWGUIDCOL NOT NULL UNIQUE,
author varchar(64),
document VARBINARY(MAX) FILESTREAM NULL)
Читать
void selectFilestream (LPCWSTR dstFilePath) {
SQLRETURN r;
SQLCHAR transactionToken[1024];
SQLWCHAR srcFilePath[1024];
SQLINTEGER cbTransactionToken, cbsrcFilePath;
// The GUID columns must be visible to the query,
// even if it is not used
r = SQLExecDirect(hstmt, (SQLTCHAR *)
_T("select GET_FILESTREAM_TRANSACTION_CONTEXT(); \
select TOP(1) id, document.PathName() \
from fileStreamDocs WHERE author = 'Chris Lee'"),
SQL_NTS);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
r = SQLFetch(hstmt);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
r = SQLGetData(hstmt, 1, SQL_C_BINARY,
transactionToken, sizeof(transactionToken), &cbTransactionToken);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
r = SQLMoreResults(hstmt);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
r = SQLFetch(hstmt);
r = SQLGetData(hstmt, 2, SQL_C_TCHAR,
srcFilePath, sizeof(srcFilePath), &cbsrcFilePath);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
if (!copyFileFromSql(srcFilePath, dstFilePath, transactionToken, cbTransactionToken)) {
DeleteFile(dstFilePath);
}
r = SQLTransact(henv, hdbc, SQL_ROLLBACK);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
}
Insert
void insertFilestream(LPCWSTR srcFilePath) {
SQLRETURN r;
SQLCHAR transactionToken[64];
SQLWCHAR dstFilePath[1024];
SQLINTEGER cbTransactionToken, cbDstFilePath;
SQLUSMALLINT mode;
r = SQLExecDirect(hstmt, (SQLTCHAR *)
_T("insert into fileStreamDocs (id, author, document)\
output Get_Filestream_Transaction_Context(), inserted.document.PathName() \
values (newid(), 'Chris Lee', convert(varbinary, '**Temp**')) "), SQL_NTS);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
r = SQLFetch(hstmt);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
r = SQLGetData(hstmt, 1, SQL_C_BINARY,
transactionToken, sizeof(transactionToken), &cbTransactionToken);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
r = SQLGetData(hstmt, 2, SQL_C_TCHAR,
dstFilePath, sizeof(dstFilePath), &cbDstFilePath);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
r = SQLCloseCursor(hstmt);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
if (copyFileToSql(
srcFilePath, dstFilePath,
transactionToken, cbTransactionToken)) {
mode = SQL_COMMIT;
}
else {
mode = SQL_ROLLBACK;
}
r = SQLTransact(henv, hdbc, mode);
if (r != SQL_SUCCESS && r!=SQL_SUCCESS_WITH_INFO) {
ODBCError(henv, hdbc, hstmt, NULL, true); exit(-1);
}
}
Вспомогательные подпрограммы
#define COPYBUFFERSIZE 4096
BOOL copyFileContents (HANDLE srcHandle, HANDLE dstHandle) {
BYTE buffer[COPYBUFFERSIZE];
DWORD bytesRead, bytesWritten;
BOOL r;
do {
r = ReadFile(srcHandle, buffer, COPYBUFFERSIZE, &bytesRead,NULL);
if (bytesRead == 0) {
return r;
}
r = WriteFile(dstHandle, buffer, bytesRead, &bytesWritten, NULL);
if (bytesWritten == 0) {
return r;
}
} while (TRUE);
}
BOOL copyFileToSql(LPCWSTR srcFilePath, LPCWSTR dstFilePath, LPBYTE transactionToken, SQLINTEGER cbTransactionToken) {
BOOL r;
HANDLE srcHandle, dstHandle;
unsigned int NtStatus;
srcHandle = CreateFile(
srcFilePath,
GENERIC_READ,
FILE_SHARE_READ,
NULL,
OPEN_EXISTING,
FILE_FLAG_SEQUENTIAL_SCAN,
NULL);
if (srcHandle == INVALID_HANDLE_VALUE) {
return FALSE;
}
dstHandle = OpenSqlFilestream(
dstFilePath,
Write,
0,
transactionToken,
cbTransactionToken,
0);
if (dstHandle == INVALID_HANDLE_VALUE) {
NtStatus = GetLastError();
r = CloseHandle(srcHandle);
return FALSE;
}
//copy file
r = copyFileContents(srcHandle, dstHandle);
CloseHandle(srcHandle);
CloseHandle(dstHandle);
return r;
}
BOOL copyFileFromSql(LPCWSTR srcFilePath, LPCWSTR dstFilePath, LPBYTE transactionToken, SQLINTEGER cbTransactionToken) {
BOOL r;
HANDLE srcHandle, dstHandle;
unsigned int NtStatus;
srcHandle = OpenSqlFilestream(
srcFilePath,
Read,
0,
transactionToken,
cbTransactionToken,
0);
if (srcHandle == INVALID_HANDLE_VALUE) {
return FALSE;
}
dstHandle = CreateFile(
dstFilePath,
GENERIC_WRITE,
0,
NULL,
OPEN_ALWAYS,
FILE_ATTRIBUTE_NORMAL,
NULL);
if (dstHandle == INVALID_HANDLE_VALUE) {
CloseHandle(srcHandle);
return FALSE;
}
r = copyFileContents(srcHandle, dstHandle);
CloseHandle(srcHandle);
CloseHandle(dstHandle);
return r;
}