Pular para o conteúdo principal

Driver Databricks para SQLTools for Visual Studio Code

info

Visualização

Esse recurso está em Public Preview.

O driverDatabricks para SQLTools permite que o senhor use a extensão SQLTools para Visual Studio Code para navegar pelos objetos SQL e executar consultas SQL no espaço de trabalho remoto Databricks.

Antes de começar​

Antes de poder usar o driver Databricks para SQLTools, o site Databricks workspace e a máquina de desenvolvimento local devem atender aos seguintes requisitos.

requisitos de espaço de trabalho​

O senhor deve ter pelo menos um Databricks workspace disponível, e o workspace deve atender aos seguintes requisitos:

  • O site workspace deve conter pelo menos um Databricks SQL depósito.
nota

nãoDatabricks são compatíveis com o Databricks driver para SQLTools.

Requisitos de máquinas de desenvolvimento local​

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

  • Visual Studio Code versão 1.70 ou superior. Para view sua versão instalada, clique em Code > About Visual Studio Code no menu principal do Linux ou macOS e Help > About em Windows. Para fazer download, instalar e configurar o Visual Studio Code, consulte Configuração do Visual Studio Code.
  • A extensão SQLTools para Visual Studio Code.
  • A extensão Databricks Driver for SQLTools para o Visual Studio Code.

Para instalar a extensão SQLTools, acesse SQLTools e clique em Instalar ou:

  1. No Visual Studio Code, clique em view > Extensions no menu principal.

  2. Na caixa Search Extensions in marketplace , digite SQLTools.

  3. Clique na entrada SQLTools de Matheus Teixeira.

nota

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

  1. Clique em Instalar .

Para instalar a extensão Databricks Driver for SQLTools, acesse Databricks Driver for SQLTools e clique em Install (Instalar ) ou em

  1. No Visual Studio Code, clique em view > Extensions no menu principal.
  2. Na caixa Search Extensions in marketplace , digite Databricks Driver for SQLTools.
  3. Clique na entrada Databricks Driver for SQLTools .
  4. Clique em Instalar .

Autenticação​

O senhor deve configurar a autenticação para o Databricks Driver for SQLTools da seguinte forma.

O Databricks Driver for SQLTools é compatível com os seguintes tipos de autenticação do Databricks:

Databricks autenticação de tokens de acesso pessoal​

Para usar o Databricks driver para SQLTools com Databricks autenticação de tokens de acesso pessoal, o senhor deve ter um Databricks token de acesso pessoal. Para criar tokens de acesso pessoal, siga as etapas em Databricks personal access tokens para usuários workspace.

Autenticação OAuth máquina a máquina (M2M) da Databricks​

O senhor pode usar a autenticação máquina a máquina (M2M) do Databricks OAuth para se autenticar com o Databricks Driver for SQLTools, como segue:

nota

Databricks OAuth A autenticação M2M está disponível em Databricks Driver for SQLTools versões 0.4.2 e acima.

  1. Conclua as etapas de configuração da autenticação OAuth M2M. Consulte a autenticação OAuth máquina a máquina (M2M).
  2. Crie um perfil de configuração do Databricks com suas definições de configuração de autenticação OAuth M2M. Consulte a seção "Config" da autenticação máquina a máquina (M2M) do OAuth.
  3. Instale e abra a extensão Databricks para o Visual Studio Code em seu computador de desenvolvimento local.
  4. Na extensão Databricks para Visual Studio Code, clique no botão Configure (Configurar ) no painel Configuration (Configuração) . Se o botão Configure não for exibido, clique no ícone de engrenagem (Configure workspace ).
  5. Na paleta de comandos, em Host, digite Databricks o Databricks workspace URL da instância, por https://1234567890123456.7.gcp.databricks.com exemplo,, e pressione Enter.
  6. Selecione a entrada do perfil de configuração que corresponda à que você criou na etapa 2.
  7. Complete as instruções na tela do navegador da Web para concluir a autenticação com o seu Databricks account.

Autenticação OAuth de usuário para máquina (U2M) da Databricks​

O senhor pode usar a autenticação Databricks OAuth de usuário para máquina (U2M) para se autenticar com o Databricks Driver for SQLTools, como segue:

nota

Databricks OAuth A autenticação U2M está disponível em Databricks Driver for SQLTools versões 0.4.2 e acima.

  1. Instale e abra a extensão Databricks para o Visual Studio Code em seu computador de desenvolvimento local.
  2. Na extensão Databricks para Visual Studio Code, clique no botão Configure (Configurar ) no painel Configuration (Configuração) . Se o botão Configure não for exibido, clique no ícone de engrenagem (Configure workspace ).
  3. Na paleta de comandos, para Databricks Host, digite o Databricks workspace URL da instância, por https://1234567890123456.7.gcp.databricks.com exemplo,. Em seguida, pressione Enter .
  4. Selecione OAuth (usuário para máquina) .
  5. Complete as instruções na tela do navegador da Web para concluir a autenticação com o seu Databricks account. Se solicitado, permita o acesso ao all-apis.

Conecte-se a um esquema​

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

  2. No SQLTools view, se esta for a primeira vez que o senhor usa a extensão SQLTools, clique em Add New Connection (Adicionar nova conexão ) no painel Connections (Conexões ). Caso contrário, clique no ícone Adicionar nova conexão na barra de título do painel.

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

  4. Para a passo Connection Settings , insira as seguintes informações sobre seu warehouse, catálogo e esquema:

    1. Em Nome da conexão , insira um nome exclusivo para essa conexão.

    2. (Opcional) Em Grupo de conexão , insira o nome de um grupo de conexão existente para adicionar a nova conexão a esse grupo. Ou insira um nome exclusivo para criar um novo grupo de conexão com a nova conexão. Os grupos de conexão facilitam a localização de conexões na extensão.

    3. Para Conectar usando , selecione uma das seguintes opções:

      • Para usar um Databricks tokens de acesso pessoal para autenticação, selecione Hostname e tokens .

      • No caso do Databricks Driver for SQLTools versões 0.4.2 e superiores, para usar a autenticação OAuth U2M ou M2M, selecione a extensão VS Code (beta) .

    4. Se o senhor selecionou Hostname e tokens para Connect using , em Host , digite a configuração do nome do host do servidor do depósito. Para obter a configuração do nome do host do servidor de um depósito, consulte Obter detalhes da conexão para um recurso Databricks compute.

    5. Em Path (Caminho ), insira a configuração do caminho HTTP do depósito ou do clustering. Para obter a configuração do caminho HTTP de um depósito, consulte Obter detalhes da conexão para um recurso Databricks compute.

    6. Se o senhor selecionou Hostname and tokens for Connect using , digite o valor dos tokens de acesso pessoal Databricks em tokens .

    7. Em Catálogo , insira o nome do seu catálogo.

nota

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

  1. Em Esquema , insira o nome do seu esquema.

  2. (Opcional) Para Show records default limit , deixe o default de 50 para mostrar somente até as primeiras 50 linhas de cada consulta ou insira um limite diferente.

  3. Clique em Testar conexão .

  4. Se o teste de conexão for bem-sucedido, clique em Salvar conexão .

Alterar as configurações de uma conexão​

Esse procedimento pressupõe que você tenha se conectado com êxito a pelo menos um depósito.

  1. Se o SQLTools view não estiver visível, no Visual Studio Code, na barra lateral, clique no ícone do SQLTools .
  2. No painel Conexões, expanda o grupo de conexões , se existir um para sua conexão de destino.
  3. Clique com o botão direito na conexão e clique em Editar conexão .
  4. Altere as configurações de destino.
  5. Clique em Testar conexão .
  6. Se o teste de conexão for bem-sucedido, clique em Salvar conexão .
  1. No painel Conexões, expanda o grupo de conexões , se existir um para sua conexão de destino.
  2. Clique duas vezes ou expanda a conexão de destino do seu depósito.
  3. Expanda o banco de dados de destino (esquema), se houver algum para sua conexão.
  4. Expanda Tables or view ( Tabelas ou visualizações), se houver uma ou mais tabelas ou visualizações para seu banco de dados (esquema).
  5. Expanda qualquer tabela de destino ou view para view as colunas da tabela ou view.

visualizar as linhas ou o esquema de uma tabela ou view​

Com as tabelas ou a visualização expandida no painel Conexões , siga um destes procedimentos:

  • Para mostrar as linhas da tabela ou view, clique com o botão direito do mouse na tabela ou view e clique em Show Table Records ou Show view Records .
  • Para mostrar o esquema da tabela ou do site view, clique com o botão direito do mouse na tabela ou no site view e clique em Describe Table ( Descrever tabela ) ou Describe view (Descrever exibição).

Gerar uma consulta de inserção para uma tabela​

  1. Coloque o cursor em um editor existente no local em que você deseja que a consulta de inserção seja adicionada.
  2. Com Tabelas expandidas no painel Conexões , clique com o botão direito do mouse na tabela e clique em Gerar consulta de inserção . A definição da consulta de inserção é adicionada no ponto de inserção do cursor.

Criar e executar uma consulta​

Esse procedimento pressupõe que você tenha se conectado com êxito a pelo menos um depósito.

  1. No painel Conexões, expanda o grupo de conexões , se existir um para sua conexão de destino.
  2. Clique duas vezes ou expanda a conexão de destino do seu depósito.
  3. Com a conexão selecionada, clique em New SQL File (Novo arquivo SQL) na barra de título do painel Connections (Conexões ). É exibido um novo editor tab.
  4. Digite sua consulta SQL no novo editor.
  5. Para executar a consulta SQL, clique em execução na conexão ativa no editor. Os resultados da consulta são exibidos em um novo editor tab.

executar uma consulta existente​

Esse procedimento pressupõe que você tenha se conectado com êxito a pelo menos um depósito.

  1. No painel Conexões, expanda o grupo de conexões , se existir um para sua conexão de destino.
  2. Clique duas vezes ou expanda a conexão de destino do seu depósito.
  3. Com a conexão selecionada, abra qualquer arquivo com a extensão .sql ou selecione qualquer grupo de instruções SQL contínuas em qualquer editor que tenha sido aberto anteriormente.
  4. Para executar a consulta SQL a partir de um arquivo .sql aberto, com o conteúdo do arquivo .sql exibido no editor, clique em executar na conexão ativa no editor. Os resultados da consulta são exibidos em um novo editor tab.
  5. Para executar um grupo selecionado de instruções contínuas SQL em um editor aberto anteriormente, clique com o botão direito do mouse na seleção e, em seguida, clique em Executar consulta selecionada . Os resultados da consulta são exibidos em um novo editor tab.

Enviar o site logs para Databricks​

Se tiver problemas ao usar o Databricks Driver for SQLTools, o senhor pode enviar logs e informações relacionadas ao Databricks Support da seguinte forma:

  1. Instale a extensão Databricks para o Visual Studio Code em seu computador de desenvolvimento local.
  2. Ative o registro em log verificando a configuração logs: Enabled ou definindo databricks.logs.enabled para true, conforme descrito em Configurações para a extensão Databricks para Visual Studio Code Certifique-se de reiniciar o Visual Studio Code depois de ativar o registro.
  3. Tente reproduzir seu problema.
  4. Na paleta de comandos (Exibir > Paleta de comandos no menu principal), execute o Databricks: Abrir o comando logscompleto .
  5. Envie os arquivos Databricks Logs.log, databricks-cli-logs.json e sdk-and-extension-logs.json que aparecem para o suporte da Databricks.
  6. Copie também o conteúdo do Terminal (view > Terminal ) no contexto do problema e envie esse conteúdo para Databricks Support.

A saída view (Exibir > Saída, Databricks logs ) mostra informações truncadas se os logs: Enabled estiver marcado ou databricks.logs.enabled estiver definido como true. Para mostrar mais informações, altere as seguintes configurações, conforme descrito em Configurações da extensão Databricks para o Visual Studio Code:

  • logs: Comprimento máximo da matriz ou databricks.logs.maxArrayLength
  • registros: Comprimento máximo do campo ou databricks.logs.maxFieldLength
  • registros: Profundidade de truncamento ou databricks.logs.truncationDepth

Recurso adicional​

Última atualização em