Alteração de comportamento do driver ODBC ao lidar com conversões de caracteres

Artigo
07/04/2024

Aplica-se a: SQL Server Banco de Dados SQL do Azure Instância Gerenciada de SQL do Azure PDW (Sistema de Plataforma de Análise) do Azure Synapse Analytics

Importante

O SQL Server Native Client (SNAC) não é fornecido com:

SQL Server 2022 (16.x) e posterior
SQL Server Management Studio 19 e posterior

O SQL Server Native Client (SQLNCLI ou SQLNCLI11) e o Provedor OLE DB herdado da Microsoft para o SQL Server (SQLOLEDB) não são recomendados para um novo desenvolvimento de aplicativo.

Para novos projetos, use um dos seguintes drivers:

Para SQLNCLI que é fornecido como um componente do Mecanismo de Banco de Dados do SQL Server (versões 2012 a 2019), confira esta exceção de Ciclo de Vida de Suporte.

O Driver ODBC do Cliente Nativo do SQL Server 2012 (11.x) (SQLNCLI11.dll) alterou a forma como ele faz as conversões SQL_WCHAR* (NCHAR/NVARCHAR/NVARCHAR(MAX)) e SQL_CHAR* (CHAR/VARCHAR/NARCHAR(MAX)). Funções ODBC, como SQLGetData, SQLBindCol, SQLBindParameter, retornam (-4) SQL_NO_TOTAL como o parâmetro length/indicator ao usar o driver ODBC do SQL Server 2012 Native Client. As versões anteriores do driver ODBC do SQL Server Native Client retornavam um valor de comprimento, que pode estar incorreto.

Comportamento de SQLGetData

Muitas funções do Windows permitem especificar um tamanho do buffer de 0 e o comprimento retornado é o tamanho dos dados retornados. O seguinte padrão é comum para programadores do Windows:

int iSize = 0;  
BYTE * pBuffer = NULL;  
GetMyFavoriteAPI(pBuffer, &iSize);   // Returns needed size in iSize  
pBuffer = new BYTE[iSize];   // Allocate buffer   
GetMyFavoriteAPI(pBuffer, &iSize);   // Retrieve actual data

No entanto, SQLGetData não deve ser usado nesse cenário. Os padrões a seguir não devem ser usados:

// bad  
int iSize = 0;  
WCHAR * pBuffer = NULL;  
SQLGetData(hstmt, SQL_W_CHAR, ...., (SQLPOINTER*)0x1, 0, &iSize);   // Get storage size needed  
pBuffer = new WCHAR[(iSize/sizeof(WCHAR)) + 1];   // Allocate buffer  
SQLGetData(hstmt, SQL_W_CHAR, ...., (SQLPOINTER*)pBuffer, iSize, &iSize);   // Retrieve data

SQLGetData só pode ser chamado para recuperar partes de dados reais. Não há suporte para o uso de SQLGetData para obter o tamanho dos dados.

O exemplo a seguir mostra o impacto da alteração do driver quando você usa o padrão incorreto. Esse aplicativo consulta uma coluna varchar e uma associação como Unicode (SQL_UNICODE/SQL_WCHAR):

Consulta: select convert(varchar(36), '123')

SQLGetData(hstmt, SQL_WCHAR, ....., (SQLPOINTER*) 0x1, 0 , &iSize);   // Attempting to determine storage size needed

Versão do driver ODBC do SQL Server Native Client	Comprimento ou resultado do indicador	Descrição
SQL Server 2008 R2 (10.50.x) Native Client ou anterior	6	O driver presumiu incorretamente que a conversão de CHAR para WCHAR poderia ser realizada como o comprimento * 2.
SQL Server 2012 (11.x) Native Client (versão 11.0.2100.60) ou posterior	-4 (SQL_NO_TOTAL)	O driver não pressupõe mais que a conversão de CHAR para WCHAR ou WCHAR para CHAR é uma ação (multiplicar) 2 ou (dividir)/2. Chamar SQLGetData* não retorna mais a duração da conversão esperada. O driver detecta a conversão para ou de CHAR e WCHAR e retorna (- 4) SQL_NO_TOTAL em vez do comportamento de *2 ou /2 que poderia estar incorreto.

Use SQLGetData para recuperar as partes dos dados. (Pseudocódigo mostrado:)

while( (SQL_SUCCESS or SQL_SUCCESS_WITH_INFO) == SQLFetch(...) ) {  
   SQLNumCols(...iTotalCols...)  
   for(int iCol = 1; iCol < iTotalCols; iCol++) {  
      WCHAR* pBufOrig, pBuffer = new WCHAR[100];  
      SQLGetData(.... iCol ... pBuffer, 100, &iSize);   // Get original chunk  
      while(NOT ALL DATA RETREIVED (SQL_NO_TOTAL, ...) ) {  
         pBuffer += 50;   // Advance buffer for data retrieved  
         // May need to realloc the buffer when you reach current size  
         SQLGetData(.... iCol ... pBuffer, 100, &iSize);   // Get next chunk  
      }  
   }  
}

Comportamento de SQLBindCol

Consulta: select convert(varchar(36), '1234567890')

SQLBindCol(... SQL_W_CHAR, ...)   // Only bound a buffer of WCHAR[4] - Expecting String Data Right Truncation behavior

Versão do driver ODBC do SQL Server Native Client	Comprimento ou resultado do indicador	Descrição
SQL Server 2008 R2 (10.50.x) Native Client ou anterior	20	O SQLFetch relata que há um truncamento no lado direito dos dados. O comprimento é o comprimento dos dados retornados, não o que foi armazenado (presume a conversão *2 CHAR para WCHAR, que pode ter as marcas incorretas). Os dados armazenados em buffer são 123\0. O buffer é garantido para ser terminado em NULL.
SQL Server 2012 (11.x) Native Client (versão 11.0.2100.60) ou posterior	-4 (SQL_NO_TOTAL)	O SQLFetch relata que há um truncamento no lado direito dos dados. O comprimento indica -4 (SQL_NO_TOTAL) porque o restante dos dados não foi convertido. Os dados armazenados no buffer são 123\0. - O buffer é garantido para ser terminado em NULL.

SQLBindParameter (comportamento de parâmetro OUTPUT)

Consulta: create procedure spTest @p1 varchar(max) OUTPUT

select @p1 = replicate('B', 1234)

SQLBindParameter(... SQL_W_CHAR, ...)   // Only bind up to first 64 characters

Versão do driver ODBC do SQL Server Native Client	Comprimento ou resultado do indicador	Descrição
SQL Server 2008 R2 (10.50.x) Native Client ou anterior	2468	O SQLFetch não retorna mais dados disponíveis. SQLMoreResults não retorna mais dados disponíveis. O comprimento indica o tamanho dos dados retornados do servidor, não armazenados em buffer. O buffer original contém 63 bytes e um terminador em NULL. O buffer é garantido para ser terminado em NULL.
SQL Server 2012 (11.x) Native Client (versão 11.0.2100.60) ou posterior	-4 (SQL_NO_TOTAL)	O SQLFetch não retorna mais dados disponíveis. SQLMoreResults não retorna mais dados disponíveis. O comprimento indica (-4) SQL_NO_TOTAL porque o restante dos dados não foi convertido. O buffer original contém 63 bytes e um terminador em NULL. O buffer é garantido para ser terminado em NULL.

Execução de conversões CHAR e WCHAR

O driver ODBC do SQL Server 2012 (11.x) Native Client oferece várias maneiras de executar conversões CHAR e WCHAR. A lógica é semelhante à manipulação de blobs (varchar(max), nvarchar(max), ...):

Os dados são salvos ou truncados no buffer especificado ao associar com SQLBindCol ou SQLBindParameter.
Se você não associar, poderá recuperar os dados em partes usando SQLGetData e SQLParamData.

Confira também

Recursos do SQL Server Native Client

Partilhar via