Conectar-se a um banco de dados com a extensão MSSQL para Visual Studio Code

A extensão MSSQL para Visual Studio Code gira em torno de suas conexões com SQL Server, SQL do Azure e banco de dados SQL em Microsoft Fabric. Este artigo mostra como criar conexões com a caixa de diálogo Conexão e quais tipos de autenticação a extensão suporta. Ele também explica como organizar conexões salvas no Pesquisador de Objetos e como escolher a conexão que a extensão usa quando você abre um novo arquivo SQL.

Depois de se conectar, consulte Início Rápido: execute sua primeira consulta com a extensão MSSQL para Visual Studio Code criar um banco de dados, adicionar dados e executar instruções Transact-SQL.

Caixa de diálogo de conexão

A caixa de diálogo Conexão é a principal maneira de criar ou editar uma conexão. Abra-o selecionando Adicionar Conexão no Pesquisador de Objetos ou executando o comando MS SQL: Adicionar Conexão na Paleta de Comandos.

A caixa de diálogo tem três áreas principais:

  • Uma área de formulário no meio, em que você preenche os detalhes da conexão.
  • Um painel à direita com Conexões Salvas e Conexões Recentes, que lista conexões que você pode reabrir ou editar rapidamente.
  • Um rodapé com as ações Avançado, Testar conexão, Salvar sem conexão e Conectar .

Captura de tela da caixa de diálogo Conexão para a extensão MSSQL, mostrando vários modos e parâmetros de entrada e uma barra lateral com conexões usadas e salvas recentemente.

Tipos de entrada

Na parte superior do formulário, o seletor de tipo de entrada controla como você insere detalhes da conexão. Use o tipo de entrada que melhor corresponda ao que você já sabe sobre o servidor de destino.

  • Parâmetros: preencha campos individuais, como nome do servidor, nome do banco de dados, tipo de autenticação, nome de usuário e senha. Esse tipo de entrada é o padrão e é a opção mais fácil para a maioria dos cenários.

  • Connection String: cole um cadeia de conexão completo no estilo ADO.NET. Esse tipo de entrada é útil quando um cadeia de conexão já foi fornecido a você (por exemplo, no portal Azure ou por um administrador) ou quando você precisa configurar opções não expostas no modo de exibição Parâmetros.

  • Navegue Azure: entre no Azure e escolha um servidor e um banco de dados de suas assinaturas. Você pode filtrar por assinatura e grupo de recursos para localizar o banco de dados desejado. Essa opção se aplica ao Banco de Dados SQL do Azure e ao Instância Gerenciada de SQL do Azure (tanto os pontos de extremidade privados quanto os públicos são listados). Você pode fazer as assinaturas favoritas para que elas apareçam na parte superior da lista e carreguem automaticamente.

  • Navegue Fabric: entre no Microsoft Fabric e escolha um banco de dados SQL em um de seus workspaces. A caixa de diálogo lista os workspaces aos quais você tem acesso e os bancos de dados SQL dentro deles. Assim como ao navegar no Azure, você pode favoritar workspaces para que eles apareçam na parte superior da lista e sejam carregados automaticamente.

Tanto Explorar o Azure quanto Explorar o Fabric usam as contas da Microsoft que você usa para entrar no Visual Studio Code. Você pode fazer login com quantas contas da Microsoft quiser e alternar entre as contas e seus locatários usando os menus suspensos na parte superior do painel de exploração. GitHub contas não podem ser usadas para procurar bancos de dados Azure e Fabric.

Captura de tela do seletor de tipo de entrada na parte superior da caixa de diálogo Conexão, mostrando Parâmetros, Cadeia de Conexão, Procurar Azure e Procurar Fabric.

Escolher um banco de dados

O campo Banco de Dados permite que você se conecte ao banco de dados padrão do servidor ou a um banco de dados específico.

  • Deixe o campo em <Padrão> para se conectar ao banco de dados padrão que o servidor atribuir ao seu login. Essa é a opção mais simples, e você ainda pode alternar entre bancos de dados mais tarde no editor.

  • Selecione um banco de dados específico na lista suspensa. Depois de preencher detalhes suficientes para autenticar, a extensão tenta buscar a lista de bancos de dados no servidor em segundo plano. Se a lista carregar corretamente, você poderá escolher um item nela.

  • Se a lista de banco de dados não puder ser carregada , por exemplo, quando o logon não tiver permissão para enumerar bancos de dados no servidor, você ainda poderá digitar o nome do banco de dados diretamente no campo.

Captura de tela do menu suspenso Banco de Dados na caixa de diálogo Conexão, com uma lista de bancos de dados preenchida.

Configurações avançadas

Selecione Avançado no rodapé para abrir um painel lateral com o conjunto completo de mais opções de conexão, como Always Encrypted, Tempo Limite de Comando e Intenção de Aplicativo (somente leitura ou leitura/gravação). Essas são as mesmas opções que você encontraria em uma cadeia de conexão, agrupada em categorias como Segurança, Resiliência de Conexão e Pooling. Use a caixa de pesquisa na parte superior do painel para localizar rapidamente uma configuração específica.

Captura de tela do painel de Configurações avançadas de conexão com a caixa de pesquisa e as categorias de configuração.

Os botões no rodapé controlam o que acontece quando você termina de preencher o formulário.

  • Conectar-se: conecta-se ao banco de dados e adiciona a conexão à sua lista de conexões salvas.

  • Testar a conexão: tenta se conectar usando os valores de formulário atuais sem salvar nada. Use isso para verificar se o servidor, as credenciais e outras configurações estão corretas antes de se comprometer com uma conexão.

  • Salve sem se conectar: salva o perfil de conexão em sua lista de conexões salvas, mas não abre uma sessão. Isso é útil quando você está configurando conexões com antecedência ou quando deseja renomear uma conexão existente sem se conectar.

Trabalhar com conexões existentes

As listas Conexões salvas e Conexões recentes, à direita da caixa de diálogo, facilitam começar a partir de uma conexão que você já possui.

  • Passe o cursor sobre uma conexão salva para exibir um menu de ações. A partir daí, você pode editar os detalhes da conexão, criar uma nova conexão com base em uma existente (um atalho útil quando várias conexões compartilham o mesmo servidor, mas bancos de dados ou credenciais diferentes) ou remover a conexão da lista.

  • As conexões recentes funcionam da mesma maneira, mas estão limitadas às conexões usadas recentemente, mesmo que elas não sejam salvas.

Captura de tela do painel Conexões Salvas e Recentes na caixa de diálogo de Conexão com o menu de ações ao passar o mouse.

Tipos de autenticação com suporte

A extensão MSSQL dá suporte a vários tipos de autenticação. Escolha aquele que corresponda à forma como o servidor está configurado.

Logon do SQL

Insira um nome de usuário e uma senha definidos no próprio SQL Server. O Logon do SQL funciona para SQL Server, Banco de Dados SQL do Azure e Instância Gerenciada de SQL do Azure.

Opcionalmente, você pode salvar a senha para não precisar reentrada sempre que se conectar.

Autenticação do Windows

Use sua conta de Windows atual para entrar no servidor, sem necessidade de nome de usuário ou senha. A Autenticação do Windows só funciona quando você está se conectando a uma instância do SQL Server configurada para aceitá-la, normalmente em uma rede associada a um domínio ou na mesma máquina que o servidor.

Às vezes, essa opção é chamada de Autenticação Integrada. Ele não está disponível para Banco de Dados SQL do Azure, Instância Gerenciada de SQL do Azure ou banco de dados SQL no Fabric.

Microsoft Entra ID – Universal com MFA

Entre com uma conta Microsoft Entra ID. Essa opção dá suporte à autenticação multifator (MFA), às políticas de acesso condicional e às contas pessoais da Microsoft que são convidadas em um locatário do Microsoft Entra.

Quando você seleciona essa opção, a caixa de diálogo solicita que você escolha ou adicione uma conta Microsoft Entra ID e escolha um locatário se a conta tiver acesso a mais de uma.

A extensão usa as contas Microsoft com as quais você entrou Visual Studio Code (as mesmas contas mostradas no menu Contas no canto inferior esquerdo da janela). Se você ainda não fez login no Visual Studio Code ou ainda não concedeu à extensão MSSQL permissão para usar contas, será solicitado que você faça login ao se conectar.

Note

Se você entrou anteriormente na extensão MSSQL usando o próprio sistema de conta da extensão (usado no MSSQL 1.42.2 e anterior), será solicitado que você entre no Visual Studio Code (se ainda não estiver) na próxima vez que se conectar usando uma de suas conexões salvas.

Se usar Visual Studio Code sistema de contas não estiver funcionando para você, informe-nos. Você pode voltar ao mecanismo de login anterior definindo mssql.preview.useVscodeAccountsForEntraMFA como false.

Captura de tela do seletor de conta Microsoft Entra ID na caixa de diálogo Conexão, incluindo a opção Adicionar uma conta.

Microsoft Entra ID – Padrão

Essa opção usa Microsoft Entra ID autenticação padrão. O driver Microsoft Data SQL (MDS) seleciona automaticamente uma identidade disponível do Microsoft Entra ID entre os provedores de credenciais instalados no seu sistema. Esse tipo de autenticação é útil quando você tem requisitos de autenticação específicos que não têm suporte direto pela extensão MSSQL.

As identidades podem vir de várias fontes diferentes, como uma sessão conectada do CLI do Azure (az login) ou variáveis de ambiente, e você pode especificar qual identidade deve ser usada definindo o campo User name. Para obter mais informações sobre como a autenticação padrão seleciona uma identidade, consulte DefaultAzureCredential na biblioteca de clientes do Azure Identity

Microsoft Entra ID - Service Principal

Autentique-se como uma entidade de serviço do Microsoft Entra ID (uma identidade de aplicativo em vez de um usuário). Use essa opção para cenários de automação, estações de trabalho compartilhadas ou qualquer caso em que seja preferível conceder acesso de banco de dados a uma identidade de aplicativo em vez de uma pessoa.

Quando você seleciona essa opção, os campos Nome de usuário e senha são reaproveitados:

  • Insira o ID do aplicativo (cliente) da entidade de serviço como nome de usuário.
  • Insira o segredo do cliente do principal de serviço como senha.

Para obter mais informações sobre como usar uma entidade de serviço com SQL, consulte a Entidade de Serviço na biblioteca de clientes do Azure Identity

Conexões no Pesquisador de Objetos

Cada conexão criada na caixa de diálogo Conexão (se você se conectar imediatamente ou salvar sem se conectar) aparece no Pesquisador de Objetos no modo de exibição MSSQL. O Pesquisador de Objetos é onde você vai procurar conteúdo do servidor, executar ações como backups e reconectar-se aos bancos de dados usados antes.

Grupos de conexões

As conexões podem ser organizadas em grupos de conexões. Os grupos agem como pastas: você pode nomeá-las, atribuir uma cor e colocar conexões dentro delas para manter os ambientes visualmente separados (por exemplo, Produção, Preparo e Local).

  • Criar um grupo: use o comando Novo Grupo de Conexões ou atribua um novo grupo ao criar ou editar uma conexão.

  • Arraste e solte para organizar: arraste uma conexão para um grupo para movê-la para esse grupo. Arraste um grupo para outro grupo para aninhar. Você pode criar grupos aninhados com vários níveis de profundidade.

  • Expandir e recolher: use as setas ao lado de cada grupo para expandi-lo e recolhê-lo, de modo que você veja apenas as conexões com que está trabalhando no momento. Para iniciar sempre com os grupos recolhidos ao iniciar o Visual Studio Code, habilite a configuração mssql.collapseConnectionGroupsOnStartup.

Captura de tela do Pesquisador de Objetos mostrando grupos de conexões, incluindo grupos aninhados e conexões contidas.

Menu de contexto de conexão

Clique com o botão direito do mouse em uma conexão de servidor no Pesquisador de Objetos para ver ações que se aplicam à própria conexão. As opções mais usadas relacionadas à conexão incluem:

  • Conectar / Desconectar: inicie ou encerre uma sessão no servidor.
  • Editar Conexão: abra a caixa de diálogo Conexão com o perfil de conexão carregado para editar seus parâmetros.
  • Copiar Connection String: copie um cadeia de conexão para a conexão salva para sua área de transferência. Isso é útil quando você precisa compartilhar a conexão com outra ferramenta ou colá-la no código do aplicativo. Senhas e segredos não estão incluídos.
  • Remover Conexão: exclua a conexão da sua lista salva.

Captura de tela do menu Pesquisador de Objetos clique com o botão direito do mouse para uma conexão de servidor, com Copiar Cadeia de Conexão realçada.

Regras de firewall para SQL do Azure

Ao se conectar a um Banco de Dados SQL do Azure ou Instância Gerenciada de SQL do Azure de um endereço IP do cliente que não é permitido pelo firewall do servidor, você pode usar a extensão MSSQL para adicionar uma regra de firewall por meio da caixa de diálogo Adicionar Regra de Firewall.

Na caixa de diálogo Adicionar Regra de Firewall, entre com um conta Microsoft que tenha permissão para gerenciar o servidor, dê um nome à regra e escolha se deseja permitir apenas o endereço IP atual ou um intervalo. Depois de salvar a regra, sua conexão será repetida automaticamente.

Captura de tela da caixa de diálogo Adicionar Regra de Firewall com campos para o nome da regra e o intervalo de IP.

Conexões de espaço de trabalho

Conexões salvas e grupos de conexões são armazenados em seu Visual Studio Code settings.json. A extensão lê conexões de dois escopos:

  • Configurações do usuário (global): novas conexões são salvas aqui. Eles estão disponíveis em todas as suas sessões de Visual Studio Code, independentemente de qual pasta esteja aberta.

  • Configurações do workspace: as conexões salvas no nível do workspace só estão disponíveis quando esse workspace está aberto. Esse escopo é útil para conexões específicas do projeto que você deseja compartilhar com colaboradores verificando o arquivo de workspace .code-workspace no controle do código-fonte.

Para mover uma conexão das configurações do usuário para as configurações do workspace, copie a entrada JSON da conexão do usuário settings.json para o workspace settings.jsone exclua-a da configuração do usuário.

Note

A extensão não lê conexões das configurações de workspace folder individuais (o .vscode/settings.json por pasta dentro de um workspace com várias raízes). Se você quiser que uma conexão se aplique a um projeto específico, salve-a no nível do workspace.

Quando você salva uma conexão com uma senha ou segredo, sua senha não é armazenada em settings.json. As senhas são mantidas separadamente no repositório de credenciais seguro do Visual Studio Code.

Seleção de conexão ao abrir um novo arquivo SQL ou editor

Quando você abre um .sql arquivo ou cria um novo editor de SQL, a extensão pode deixar o editor desconectado ou conectá-lo automaticamente.

Esse comportamento é controlado pela configuração mssql.newEditorConnectionBehavior, que oferece suporte a três modos:

Mode Description
none Novos editores SQL são abertos sem uma conexão. Você será solicitado a escolher uma conexão na primeira vez que executar uma consulta ou usar o comando SQL: Conectar para anexar uma conexão manualmente.
transferActive (padrão) Novos editores de SQL são automaticamente conectados ao mesmo banco de dados que seu editor de SQL ativo no momento. Isso é conveniente quando você está trabalhando em vários arquivos no mesmo banco de dados e não deseja reconectar cada um deles. Se nenhum editor do SQL estiver ativo no momento, o novo editor será aberto sem uma conexão.
defaultConnection Novos editores sql são conectados automaticamente a uma conexão específica que você designou como padrão. A conexão padrão é identificada pela configuração mssql.defaultConnectionId .

Para usar esse modo, você também precisa definir mssql.defaultConnectionId para a ID de uma de suas conexões salvas. Você pode encontrar a ID examinando suas conexões salvas em settings.json. Se mssql.defaultConnectionId não estiver definido ou não corresponder mais a uma conexão salva, a extensão solicitará que você escolha uma conexão padrão na próxima vez que abrir um novo editor de SQL.

Você pode alterar essas configurações na interface de usuário de configurações do Visual Studio Code pesquisando por mssql.newEditorConnectionBehavior ou mssql.defaultConnectionId.

Conteúdo relacionado

  • Last updated on