Databricks Driver para SQLTools para Visual Studio Code

Importante

Esta funcionalidade está em Pré-visualização Pública.

O Databricks Driver for SQLTools permite-lhe usar a extensão SQLTools para Visual Studio Code para procurar objetos SQL e executar consultas SQL em espaços de trabalho remotos do Azure Databricks.

Requirements

Antes de poder usar o Databricks Driver for SQLTools, o seu espaço de trabalho do Azure Databricks e a sua máquina de desenvolvimento local devem cumprir os seguintes requisitos.

Requisitos do espaço de trabalho

Você deve ter pelo menos um espaço de trabalho do Azure Databricks disponível e o espaço de trabalho deve atender aos seguintes requisitos:

Requisitos da máquina de desenvolvimento local

Você deve ter o seguinte em sua máquina de desenvolvimento local:

Para instalar a extensão SQLTools, vá para SQLTools e clique em Instalar ou:

  1. No Visual Studio Code, clique em Ver > Extensões no menu principal.

  2. Na caixa Extensões de pesquisa no Marketplace, introduza SQLTools.

  3. Clique no item SQLTools de Matheus Teixeira.

    Nota

    Pode haver várias entradas SQLTools listadas. Não deixe de clicar na entrada de Matheus Teixeira.

  4. Clique em Install.

Para instalar a extensão Databricks Driver for SQLTools, vá para Databricks Driver for SQLTools e clique em Instalar ou:

  1. No Visual Studio Code, clique em Ver > Extensões no menu principal.
  2. Na caixa Pesquisar extensões no Marketplace, introduza Databricks Driver for SQLTools.
  3. Clique na opção Databricks Driver for SQLTools.
  4. Clique em Install.

Autenticação

Deve configurar a autenticação para o controlador Databricks para SQLTools da seguinte forma.

O Driver Databricks para SQLTools dá suporte aos seguintes tipos de autenticação do Azure Databricks:

Nota

O driver Databricks para SQLTools não suporta tokens de ID do Microsoft Entra.

Autenticação de token de acesso pessoal do Azure Databricks

Para usar o Driver Databricks para SQLTools com a autenticação de token de acesso pessoal do Azure Databricks, tem de ter um token de acesso pessoal do Azure Databricks. Para criar um token de acesso pessoal, siga as etapas em Criar tokens de acesso pessoal para usuários do espaço de trabalho.

Autenticação de máquina a máquina (M2M) OAuth do Azure Databricks

Você pode usar a autenticação de máquina a máquina (M2M) OAuth do Azure Databricks para autenticar com o Driver Databricks para SQLTools, da seguinte maneira:

Nota

A autenticação Azure Databricks OAuth M2M está disponível no Databricks Driver para SQLTools versões 0.4.2 e superiores.

  1. Conclua as etapas de configuração para autenticação OAuth M2M. Consulte Autenticação OAuth máquina-a-máquina (M2M).
  2. Crie um perfil de configuração do Azure Databricks com suas definições de configuração de autenticação OAuth M2M. Consulte a secção "Config" da autenticação OAuth machine-to-machine (M2M).
  3. Instale e abra a extensão Databricks para Visual Studio Code em sua máquina de desenvolvimento local.
  4. Na extensão IDE Databricks, clique no botão Configurar no painel de Configuração . Se o botão Configurar não for exibido, clique no ícone de engrenagem (Configurar espaço de trabalho).
  5. Na Paleta de Comandos, para Databricks Host, introduza o URL por área de trabalho do Azure Databricks, por exemplo https://adb-1234567890123456.7.azuredatabricks.net, e, em seguida, prima Enter.
  6. Selecione a entrada do perfil de configuração que corresponde àquela que criou no passo 2.
  7. Siga as instruções apresentadas no ecrã no seu navegador web para concluir a autenticação com a sua conta do Azure Databricks.

Autenticação OAuth do Azure Databricks de utilizador para máquina (U2M)

Você pode usar a autenticação OAuth de utilizador para máquina (U2M) do Azure Databricks para autenticar com o driver Databricks para SQLTools, da seguinte maneira:

Nota

A autenticação U2M do Azure Databricks OAuth está disponível no Databricks Driver para SQLTools versões 0.4.2 e superiores.

  1. Instale e abra a extensão Databricks para Visual Studio Code em sua máquina de desenvolvimento local.
  2. Na extensão IDE Databricks, clique no botão Configurar no painel de Configuração. Se o botão Configurar não for exibido, clique no ícone de engrenagem (Configurar espaço de trabalho).
  3. Na Paleta de comandos, para Databricks Host, insira a sua URL por espaço de trabalho do Azure Databricks, por exemplohttps://adb-1234567890123456.7.azuredatabricks.net. Em seguida, prima Enter.
  4. Selecione OAuth (utilizador para máquina).
  5. Siga as instruções apresentadas no ecrã no seu navegador para concluir a autenticação com a sua conta do Azure Databricks. Se lhe for solicitado, permita o acesso a all-apis.

Autenticação da CLI do Azure

Você pode usar a CLI do Azure para autenticar com o Databricks Driver for SQLTools, da seguinte maneira:

Nota

A autenticação com a CLI do Azure está num estado experimental. Este recurso está disponível no Databricks Driver para SQLTools versões 0.4.2 e superiores.

  1. Instale a CLI do Azure na sua máquina de desenvolvimento local, se ainda não o tiver feito.
  2. Instale e abra a extensão Databricks para Visual Studio Code em sua máquina de desenvolvimento local.
  3. Na extensão IDE Databricks, clique no botão Configurar no painel de Configuração. Se o botão Configurar não for exibido, clique no ícone de engrenagem (Configurar espaço de trabalho).
  4. Na Paleta de comandos, para Databricks Host, insira a sua URL por espaço de trabalho do Azure Databricks, por exemplo https://adb-1234567890123456.7.azuredatabricks.net. Em seguida, prima Enter.
  5. Selecione CLI do Azure.
  6. Siga as instruções na tela para concluir a autenticação com a CLI do Azure.

Conectar-se a um schema

  1. No Visual Studio Code, na barra lateral, clique no ícone SQLTools .

  2. Na visualização SQLTools, se esta for a primeira vez que utiliza a extensão SQLTools, clique em Adicionar Nova Conexão no painel Conexões. Caso contrário, clique no ícone Adicionar Nova Conexão na barra de título do painel.

  3. Na guia Configurações SQLTools, para a etapa Selecionar um driver de base de dados, clique no ícone Databricks.

  4. Para a etapa Configurações de conexão , insira as seguintes informações sobre seu depósito, catálogo e esquema:

    1. Em Nome da conexão, insira algum nome exclusivo para essa conexão.
    2. (Opcional) Em Grupo de conexões , insira o nome de um grupo de conexões existente para adicionar a nova conexão a esse grupo. Ou insira um nome exclusivo para criar um novo grupo de conexões com a nova conexão. Os grupos de conexão facilitam a localização de conexões na extensão.
    1. Para Conectar usando, selecione uma das seguintes opções:
      • Para usar um token de acesso pessoal do Azure Databricks para autenticação, selecione Nome do host e Token.
      • Para Databricks Driver for SQLTools versões 0.4.2 e superiores, para usar OAuth U2M ou M2M ou autenticação CLI do Azure, selecione VS Code extension (beta).

    1. Se tiver selecionado Nome do host e Token para Conectar usando, então, para Host, insira a configuração de Nome do host do servidor do armazém. Para obter a configuração do hostname do servidor de um depósito, consulte Obter detalhes de conexão para um recurso de computação do Azure Databricks.

    2. Para Caminho, insira a definição do caminho HTTP do armazém ou cluster. Para obter a definição de caminho HTTP de um armazém, consulte Obter detalhes de conexão para um recurso de computação do Azure Databricks.

    3. Se você selecionou Nome do host e Token para Ligar utilizando, insira o valor do token de acesso pessoal do Azure Databricks em Token.

    4. Para Catálogo, insira o nome do catálogo.

      Nota

      Para espaços de trabalho que não estão habilitados para o Unity Catalog, pode deixar Catalog em branco para usar o valor padrão de hive_metastore.

    5. Em Schema, insira o nome do esquema.

    6. (Opcional) Para Limite predefinido de registos a mostrar, deixe o padrão de 50 para mostrar apenas até as primeiras 50 linhas para cada consulta ou insira um limite diferente.

  5. Clique em Testar Ligação.

  6. Se o teste de ligação for bem-sucedido, clique em Guardar ligação.

Alterar as configurações de uma conexão

Este procedimento pressupõe que tenha estabelecido ligação com êxito a pelo menos um depósito.

  1. Se a vista SQLTools não estiver visível, em Visual Studio Code, na barra lateral, clique no ícone SQLTools.
  2. No painel Conexões, expanda o grupo de conexões, se existir um para a conexão de destino.
  3. Clique com o botão direito do rato na conexão e selecione Editar Conexão.
  4. Altere as configurações de destino.
  5. Clique em Testar Ligação.
  6. Se o teste de ligação for bem-sucedido, clique em Guardar ligação.

Procurar objetos de um esquema

  1. No painel Conexões, expanda o grupo de conexões, se existir um para a conexão de destino.
  2. Clique duas vezes ou expanda a conexão de destino para seu depósito.
  3. Expandir a base de dados de destino (esquema), se existir uma para a sua ligação.
  4. Expanda Tabelas ou Vistas, se existir uma ou mais tabelas ou vistas para a sua base de dados (esquema).
  5. Expanda qualquer tabela ou visualização de destino para ver as colunas da tabela ou visualização.

Exibir as linhas ou o esquema de uma tabela ou vista

Com Tabelas ou Vistas expandidas no painel Conexões, siga um destes procedimentos:

  • Para mostrar as linhas da tabela ou vista, clique com o botão direito do rato na tabela ou vista e clique em Mostrar Registos de Tabela ou Mostrar Registos de Vista.
  • Para mostrar o esquema da tabela ou vista, clique com o botão direito do rato na tabela ou vista e clique em Descrever Tabela ou Descrever Vista.

Gerar uma consulta de inserção para uma tabela

  1. Coloque o cursor num editor existente no local onde deseja que a consulta de inserção seja adicionada.
  2. Com Tabelas expandido no painel Conexões, clique com o botão direito do rato na tabela e clique em Gerar consulta INSERT. A definição da consulta insert é adicionada no ponto de inserção do cursor.

Criar e executar uma consulta

Este procedimento pressupõe que se tenha ligado com êxito a pelo menos um depósito.

  1. No painel Conexões, expanda o grupo de conexões, se existir um para a conexão de destino.
  2. Clique duas vezes ou expanda a conexão de destino para seu armazém.
  3. Com a conexão selecionada, clique em Novo Arquivo SQL na barra de título do painel Conexões . Um novo separador do editor aparece.
  4. Insira a sua consulta SQL no novo editor.
  5. Para executar a consulta SQL, clique em Executar na ligação ativa no editor. Os resultados da consulta são exibidos em uma nova guia do editor.

Executar uma consulta existente

Este procedimento pressupõe que se tenha ligado com êxito a pelo menos um depósito.

  1. No painel Conexões, expanda o grupo de conexões, se existir um para a conexão de destino.
  2. Clique duas vezes ou expanda a conexão de destino para seu armazém.
  3. Com a conexão selecionada, abra qualquer ficheiro com a extensão de ficheiro de .sql, ou selecione qualquer grupo de instruções SQL consecutivas em qualquer editor que tenha sido aberto anteriormente.
  4. Para executar a consulta SQL a partir de um ficheiro aberto .sql, com o conteúdo do seu ficheiro .sql visível no editor, clique em Executar na conexão ativa no editor. Os resultados da consulta são exibidos em uma nova guia do editor.
  5. Para executar um grupo selecionado de instruções SQL contínuas num editor que foi aberto anteriormente, clique com o botão direito do rato na sua seleção e clique em Executar Consulta Selecionada. Os resultados da consulta são exibidos em uma nova guia do editor.

Enviar registos de utilização para a Databricks

Se você encontrar problemas ao usar o driver Databricks para SQLTools, você pode enviar logs de uso e informações relacionadas para o Suporte do Databricks fazendo o seguinte:

  1. Instale a extensão Databricks para Visual Studio Code em sua máquina de desenvolvimento local.
  2. Ative o registo verificando a definição Logs: Ativado, ou definindo databricks.logs.enabled para true, conforme descrito nas Definições para a extensão do IDE Databricks. Certifique-se de reiniciar o Visual Studio Code depois de ativar o registo.
  3. Tente reproduzir o problema que reportou.
  4. Na Paleta de Comandos (Ver > Paleta de Comandos no menu principal), execute o comando Databricks: Abrir registos completos.
  5. Envie os ficheiros Databricks Logs.log, databricks-cli-logs.json e sdk-and-extension-logs.json que aparecem para o Suporte do Databricks.
  6. Copie também o conteúdo do Terminal (View > Terminal) no contexto do problema e envie esse conteúdo para o Suporte da Databricks.

O modo de exibição Saída (Exibir > Saída, Logs do Databricks) mostra informações truncadas se Logs: Enabled estiver marcado ou databricks.logs.enabled definido como true. Para mostrar mais informações, altere as seguintes definições, conforme descrito em Definições para a extensão do IDE Databricks:

  • Logs: Comprimento máximo do array ou databricks.logs.maxArrayLength
  • Logs: Comprimento máximo do campo ou databricks.logs.maxFieldLength
  • Logs: Profundidade de truncamento ou databricks.logs.truncationDepth

Recursos adicionais

  • Última atualização a