Snowflake Extension for Visual Studio Code

O Snowflake fornece uma extensão para o Visual Studio Code (VS Code) para permitir que os usuários do Snowflake escrevam e executem instruções SQL do Snowflake diretamente no VS Code. As extensões são funcionalidades colocadas em pacote, frequentemente fornecidas por terceiros, que acrescentam novas características e funcionalidades ao VS Code.

Neste tópico:

Instalação do Snowflake Extension for Visual Studio Code

Os usuários do Snowflake podem instalar a extensão do VS Code diretamente do Visual Studio marketplace, ou baixar a extensão, como um arquivo .xsix, e depois instalar.

Instalação a partir do Visual Studio Marketplace

Para instalar diretamente do Visual Studio Marketplace, faça o seguinte:

  1. Abra o Visual Studio Code.

  2. Selecione Code » Preferences » Extensions.

    Você também pode selecionar View » Extensions ou clicar no botão de extensões vsc-extensions-button na barra de atividades do VS Code.

  3. Na caixa de texto Search Extensions, digite o texto Snowflake para procurar a Extensão do Snowflake do Visual Studio.

  4. A partir do conjunto de extensões, selecione a extensão de autoria de Snowflake e clique em Install.

Instalação a partir de um arquivo .vsix

Para baixar e instalar de um arquivo .vsix, faça o seguinte:

  1. Baixe a extensão.

    1. Abra a página Extensão Snowflake do Visual Studio Code.

    2. Selecione a guia Version History.

    3. Selecione uma versão para baixar e clique em Download. Observe onde o arquivo é baixado.

  2. Abra o Visual Studio Code.

  3. Selecione Code » Preferences » Extensions.

    Você também pode selecionar View » Extensions ou clicar no botão de extensões vsc-extensions-button na barra de atividades.

  4. Selecione Install from VSIX no menu mais(…).

    In the Extensions page, select more and then Install from VSIX file.
  5. Localize o arquivo snowflake-x.y.z.vsix em seu computador, selecione o arquivo, e então selecione Install.

Após a conclusão da instalação, o Snowflake Extension for Visual Studio Code aparece na seção INSTALLED do menu Extensions no VS Code.

The Snowflake SQL extension, after being installed in Visual Studio Code.

Como entrar

Antes de poder executar instruções SQL, você deve assinar uma conta Snowflake.

Você pode entrar no Snowflake usando seu identificador de conta Snowflake, nome de usuário e senha, ou usando autenticação federada ao Snowflake com SAML SSO.

A primeira vez que você entra no Snowflake a partir da extensão do VS Code, você precisa adicionar sua conta inserindo o identificador de conta para sua conta Snowflake ou o URL que você usa para se conectar ao Snowflake.

Consulte Identificadores de conta para obter detalhes sobre como determinar o identificador de sua conta.

Para entrar no Snowflake a partir da extensão do VS Code, faça o seguinte:

  1. Em Activity Bar, clique no ícone do Snowflake.

    O painel da barra lateral muda para navegação Snowflake, e exibe as caixas de diálogo Add Account ou Sign in.

  2. Em Add Account, digite o identificador da conta e selecione Continue.

    Add Account só é exibido se nenhuma conta tiver sido previamente especificada.

    The Snowflake select account dialog.
  3. Digite um nome de usuário e senha para a conta selecionada e selecione Sign in.

Ao entrar com sucesso, a barra lateral muda para exibir o contexto da sessão (ACCOUNT), DATABASE EXPLORER para o usuário em sua função padrão, e QUERY HISTORY.

Como trabalhar com arquivos SQL

Você pode usar o Snowflake Extension for Visual Studio Code para criar e carregar arquivos SQL. Arquivos SQL são arquivos de texto simples que contêm uma ou mais instruções SQL.

Abertura de arquivos SQL

Para criar ou abrir arquivos SQL do Snowflake, faça o seguinte:

  1. Selecione File » Open, navegue e abra um arquivo de texto contendo SQL.

    Se você não tiver um arquivo SQL existente, você poderá criar um novo arquivo. Selecione File » New File e crie um arquivo do tipo Snowflake SQL File.

    Alternatively, click the (vsc-new-sql-file-button) button in the Database explorer panel to create a new SQL file.

    The Snowflake SQL extension database explorer panel with new SQL file button highlighted.
  2. Adicione uma ou mais instruções SQL Snowflake ao arquivo.

  3. Selecione uma linha e pressione [Executar], acima da linha, para executar o comando.

Execução de comandos ou consultas

Para executar um ou mais comandos ou consultas, faça o seguinte:

  1. Selecione o arquivo vsc-execute-all-button para o arquivo SQL selecionado para executar todas as instruções contidas nesse arquivo.

  2. Selecione uma linha a ser executada colocando seu cursor sobre a instrução a ser executada.

    Selecione dois ou mais comandos - Todos os comandos selecionados serão executados.

  3. Pressione o botão [Executar] acima do primeiro comando selecionado.

Se você selecionar comandos múltiplos, os comandos são executados por ordem de cima para baixo.

Você também pode executar instruções usando atalhos de teclado. Após selecionar as instruções SQL que você deseja executar, pressione Apple OSX Command key. + [enter] em um teclado Mac, ou Generic control key. + [enter] em um teclado Windows.

Você pode ver os resultados da instrução SQL na tabela SNOWFLAKE:QUERY RESULTS da seção Output.

Dica

Consultas em andamento podem ser canceladas. Para cancelar uma consulta em andamento, encontre a consulta em QUERY HISTORY e pressione a tecla cancelar consulta (vsc-cancel-query-button).

Como usar o histórico de consultas

Os resultados das consultas são gravados em QUERY HISTORY.

Para exibir os resultados das consultas, faça o seguinte:

  1. Expanda o Query History.

  2. Selecione uma instrução.

  3. Examine o resultado na guia SNOWFLAKE:QUERY RESULTS do painel Output.

Example of executing a statement with result highlighted.

Dica

Você pode usar o Query History para reexecutar uma consulta (vsc-query-rerun-button), copiar o texto da consulta na área de transferência (vsc-query-copy-button) ou excluir uma consulta (vsc-query-delete-button).

Mudança do contexto da sessão

Você pode usar a seção Account do painel Side Bar para selecionar funções, bancos de dados, esquemas e warehouses. Use o menu suspenso associado para selecionar cada um deles conforme apropriado.

The Snowflake sign in dialog.

Dica

Use o menu suspenso da conta para entrar ou alternar entre diferentes contas.

Sign in to, or switch between accounts.

Exibição dos detalhes da extensão

Você pode ver as informações da extensão do Snowflake SQL do Visual Studio Code a qualquer momento.

Você pode ver os seguintes detalhes sobre a extensão, inclusive:

  • Informações sobre a versão: qual versão da extensão está atualmente instalada.

  • Log de alterações: informações por versão sobre recursos adicionados, alterados ou atualizados.

  • Apresentações de recursos.

Além disso, você pode desativar ou ativar a extensão usando o menu suspenso ativar/desativar.

Para ver as informações de extensão, faça o seguinte:

  1. Selecione Code » Preferences » Extensions.

  2. Selecione a extensão Snowflake SQL VS Code.

    Você também pode selecionar View » Extensions ou clicar no botão de extensões vsc-extensions-button na barra Activities.

Desinstalação da extensão

Para desativar ou desinstalar a extensão, faça o seguinte:

  1. Selecione Code » Preferences » Extensions

  2. Selecione a extensão.

  3. Clique com o botão direito do mouse e escolha Disable ou Uninstall.