Cabeçalho e informações de versão de LocalDB do SQL Server Express

Aplica-se a: SQL Server

Não há nenhum arquivo de cabeçalho separado para a API da instância do LocalDB do SQL Server Express; as assinaturas de função LocalDB e os códigos de erro são definidos no arquivo de cabeçalho do Microsoft OLE DB Driver for SQL Server (msoledbsql.h). Para usar a API de instância do LocalDB, você deve incluir o arquivo de cabeçalho msoledbsql.h em seu projeto. Este documento foi atualizado recentemente e não faz mais referência ao arquivo de cabeçalho do SQL Server Native Client (sqlncli.h).

Controle de versão de LocalDB

A instalação de LocalDB usa um único conjunto de binários por versão principal do SQL Server. Estas versões LocalDB são mantidas e corrigidas de maneira independente. Isto significa que o usuário tem que especificar qual versão de linha de base do LocalDB (quer dizer, a versão principal do SQL Server) ele ou ela estará usando. A versão é especificada no formato de versão padrão definido pela classe System.Version do .NET Framework:

major.minor[.build[.revision]]

Os dois primeiros números na cadeia de caracteres da versão (principal e secundária) são obrigatórios. Os dois últimos números na cadeia de caracteres de versão (build e revisão) são opcionais e o padrão é zero se o usuário os deixar de fora. Isso significa que, se o usuário especificar apenas "12.2" como o número da versão do LocalDB, ele será tratado como se o usuário tivesse especificado "12.2.0.0".

A versão da instalação do LocalDB é definida na MSSQLServer\CurrentVersion chave do Registro na chave do Registro da instância do SQL Server, por exemplo:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\MSSQL13E.LOCALDB\ MSSQLServer\CurrentVersion: "CurrentVersion"="12.0.2531.0"  

Diversas versões do LocalDB na mesma estação de trabalho têm suporte lado a lado. No entanto, o código do usuário sempre usa a DLL SQLUserInstance mais recente disponível no computador local para se conectar a instâncias LocalDB.

Localizando a DLL SQLUserInstance

Para localizar a DLL SQLUserInstance , o provedor de cliente usa a seguinte chave do Registro:

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server Local DB\Installed Versions]  

Nesta chave, há uma lista de chaves, uma para cada versão do LocalDB instalada no computador. Cada uma dessas chaves é nomeada com o número de versão do LocalDB no formato <major-version.<>versão> secundária (por exemplo, a chave para SQL Server 2014 (12.x) é chamada de 13.0). Em cada chave de versão há um par de nome-valor InstanceAPIPath que define o caminho completo para o arquivo SQLUserInstance.dll instalado com essa versão. O exemplo a seguir mostra as entradas do Registro para um computador que tem as versões 11.0 e 13.0 do LocalDB instaladas:

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server Local DB\Installed Versions\13.0]  
"InstanceAPIPath"="C:\\Program Files\\Microsoft SQL Server\\130\\LocalDB\\Binn\\SqlUserInstance.dll"  
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server Local DB\Installed Versions\13.0]  
"InstanceAPIPath"="C:\\Program Files\\Microsoft SQL Server\\130\\LocalDB\\Binn\\SqlUserInstance.dll"   

O provedor de cliente deve encontrar a versão mais recente entre todas as versões instaladas e carregar o arquivo DLL SQLUserInstance do valor associado InstanceAPIPath .

Modo de WOW64 no Windows de 64 bits

As instalações de 64 bits do LocalDB terão um conjunto adicional de chave do Registro para permitir que aplicativos de 32 bits executados em modo WOW64 (Windows-32-on-Windows-64) usem LocalDB. Especificamente, no Windows de 64 bits, o LocalDB MSI criará as chave do Registro a seguir:

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Wow6432Node\Microsoft SQL Server Local DB\Installed Versions\13.0]  
"InstanceAPIPath"="C:\\Program Files (x86)\\Microsoft SQL Server\\130\\LocalDB\\Binn\\SqlUserInstance.dll"  
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Wow6432Node\Microsoft SQL Server Local DB\Installed Versions\13.0]  
"InstanceAPIPath"="C:\\Program Files (x86)\\Microsoft SQL Server\\130\\LocalDB\\Binn\\SqlUserInstance.dll"   
  

Os programas de 64 bits que lerem a Installed Versions chave verão valores apontando para versões de 64 bits da DLL SQLUserInstance, enquanto os programas de 32 bits (em execução no Windows de 64 bits no modo WOW64) serão redirecionados automaticamente para uma Installed Versions chave localizada sob o Wow6432Node hive. Essa chave contém valores que apontam para versões de 32 bits da DLL SQLUserInstance .

Usando LOCALDB_DEFINE_PROXY_FUNCTIONS

A API da instância LocalDB define uma constante chamada LOCALDB_DEFINE_PROXY_FUNCTIONS que automatiza a descoberta e o carregamento da DLL SqlUserInstance .

A seção de código habilitada por esta constante fornece uma implementação de proxies para cada API do LocalDB. As implementações de proxy usam uma função comum para associar a pontos de entrada na DLL SqlUserInstance instalada mais recente e, em seguida, encaminhar as solicitações.

As funções de proxy serão habilitadas somente se a LOCALDB_DEFINE_PROXY_FUNCTIONS constante for definida no código do usuário antes de incluir o arquivo msoledbsql.h. A constante deve ser definida em somente um módulo de origem (arquivo .cpp) porque define nomes de função externos para todos os pontos de entrada da API. Fornece uma implementação de proxies para cada API de LocalDB.

O exemplo de código a seguir mostra como usar a macro do código de C++ nativo:

// Define the LOCALDB_DEFINE_PROXY_FUNCTIONS constant to enable the LocalDB proxy functions   
// The #define has to take place BEFORE the API header file (msoledbsql.h) is included  
#define LOCALDB_DEFINE_PROXY_FUNCTIONS  
#include <msoledbsql.h>  
...  
HRESULT hr = S_OK;  
  
// Create LocalDB instance by calling the create API proxy function included by macro  
if (FAILED(hr = LocalDBCreateInstance( L"12.0", L"name", 0)))  
{  
...  
}  
...