Snowflake Extension for Visual Studio Code¶

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 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 na barra de atividades.

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

1. 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.

Uso de Snowflake Extension for Visual Studio Code com arquivos de configuração SnowSQL¶

O Snowflake Extension for Visual Studio Code pode usar arquivos de configuração Snow SQL para carregar configurações de conexão.

Para configurar Snowflake Extension for Visual Studio Code para usar um arquivo de configuração Snow SQL, faça o seguinte:

1. Em Activity Bar, selecione o ícone Snowflake.

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

2. Selecione o menu suspenso Username e, em seguida, Sign in to another account.

3. Selecione Use SnowSQL Config. A página de configurações de código do Visual Studio para Snowflake Extension for Visual Studio Code é aberta com SnowSQL Config Path selecionado.

4. Digite um caminho para um arquivo de configuração SnowSQL válido.

A lista suspensa da conta é atualizada para incluir todas as conexões definidas no arquivo de configuração especificado.

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. Como alternativa, clique em () no painel explorador de banco de dados para criar um novo arquivo SQL.

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 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 + [enter] em um teclado Mac, ou + [enter] em um teclado Windows.

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

Como usar o histórico de consultas¶

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

Para examinar os resultados de consultas executadas anteriormente, 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.

Como trabalhar com resultados de consultas¶

Você pode classificar, reordenar, ocultar, congelar ou salvar os resultados da consulta no disco.

Para modificar a exibição de uma determinada consulta, faça o seguinte:

1. Em QUERY HISTORY, selecione uma consulta.

2. Em QUERY RESULTS, escolha uma coluna.

3. Selecione a seta para baixo (↓) e, em seguida, uma das opções: SORT A-Z (descendente), Sort Z-A (ascendente), Hide column «column name» ou Freeze columns up to «column name».

A exibição do conteúdo será alterada adequadamente.

Para salvar os resultados de uma consulta no disco, selecione o disco () ou o download () associado à consulta. O conteúdo será salvo em um arquivo, seja como um gzip compactado ou como um arquivo separado por vírgula.

Depuração de funções do Snowpark Python¶

Para depurar uma função Snowpark Python:

1. Escreva um procedimento armazenado Snowflake em uma função Python onde o primeiro parâmetro é um objeto Snowpark Session.

2. Você deverá ver uma opção Snowflake: Debug embutida acima do nome da função. Escolha esta opção para executar o procedimento armazenado na função, usando sua sessão ativa atual por meio da extensão. Você também pode definir pontos de interrupção de depuração.

Destaque de sintaxe e preenchimento automático para SQL em Python¶

Você pode adicionar destaque de sintaxe de SQL no código Python ativando a detecção automática ou usando comentários para denotar manualmente cadeias de caracteres SQL.

Detecção de instruções SQL automaticamente¶

Para configurar o realce de sintaxe SQL automático, ative a configuração de extensão Auto Detect Sql in Python. A extensão detecta automaticamente instruções SQL procurando uma palavra-chave SQL em letras maiúsculas como a primeira palavra em uma cadeia de caracteres Python, conforme mostrado na captura de tela a seguir.

Denotação de instruções SQL manualmente¶

Para denotar manualmente uma instrução SQL em uma cadeia de caracteres Python:

1. (Opcional) Desative a configuração de extensão Auto Detect Sql in Python.

2. Use comentários para indicar o início e o fim de uma instrução SQL. Você pode usar qualquer combinação dos seguintes marcadores:

   • Marcadores iniciais: -–startsql, -–beginsql, -–start-sql, -–begin-sql

   • Marcadores finais: –-endsql, –-end-sql

Por exemplo, a captura de tela a seguir mostra o código que usa --begin-sql e --end-sql para denotar manualmente uma instrução SQL.

Uso do preenchimento automático SQL em cadeias de caracteres Python¶

Para usar o preenchimento automático para instruções SQL em cadeias de caracteres Python:

1. Em um arquivo Python, crie uma cadeia de caracteres Python enquanto estiver conectado a uma sessão ativa do Snowflake por meio da extensão.

2. Comece a escrever uma declaração SQL e veja as sugestões de preenchimento automático que aparecem.

Por exemplo, quando você começa a escrever uma instrução como SELECT * FROM db1.public, a extensão sugere automaticamente nomes de tabelas.

Da mesma forma, quando você começa a preencher colunas dentro de uma instrução SELECT que faz referência a uma tabela, a extensão sugere automaticamente nomes de colunas, conforme mostrado na captura de tela a seguir.

Destaque de sintaxe do modelo Jinja¶

Por padrão, a extensão adiciona realce de sintaxe básico e preenchimento automático de colchetes para escrever modelos Jinja no Snowflake SQL, conforme mostrado na captura de tela a seguir.

Como trabalhar com estágios¶

O Snowflake Extension for Visual Studio Code oferece suporte ao gerenciamento do conteúdo do estágio diretamente no Database Explorer. Você pode:

• Listar todos os arquivos em um estágio:

  1. Navegue até um estágio específico.

  2. Expanda o estágio para ver todos os arquivos preparados.

• Carregar os arquivos do sistema de arquivos local para um estágio, semelhante a PUT:

  1. Navegue até o estágio e selecione carregar ().

  2. Digite qualquer parâmetro opcional para a operação de carregamento. Consulte PUT para obter uma lista de parâmetros opcionais.

  3. Navegue até a pasta que contém os arquivos para carregamento, selecione um ou mais arquivos e faça o carregamento.

• Baixar arquivos de um estágio para um sistema de arquivos local, semelhante a GET:

  1. Navegue até o estágio.

  2. Selecione baixar () no estágio para baixar todos os arquivos ou expanda o estágio.

  3. Selecione um arquivo e faça o download desse arquivo.

  4. Selecione um diretório para concluir o download.

• Remover arquivos de um estágio, semelhante a REMOVE:

  1. Selecione um arquivo.

  2. Selecione o botão de remoção associado ().

Mostrar log de alterações¶

Para visualizar o log de alterações da extensão, você também pode usar o comando Show Change Log:

1. Abra o Command Palette pressionando CMD+Shift+P em um teclado Mac ou CTRL+Shift+P em um teclado Windows.

2. Insira o seguinte comando:

   Show Change Log
   

   Copy

Configurações de extensão na visualização¶

As seguintes configurações de extensão estão atualmente disponíveis para visualização:

Alterar configurações de extensão¶

Para alterar as configurações de extensão:

1. No Windows/Linux, selecione File » Preferences » Settings. . Em macOS, selecione Code » Preferences » Settings.

2. Na caixa de texto Search settings, digite Snowflake.

3. Selecione as guias User ou Workspace para visualizar ou modificar configurações específicas do usuário ou do espaço de trabalho.

4. Feche a guia Settings.