Snowflake Extension for Visual Studio Code

A extensão Snowflake Visual Studio Code (VS Code) permite que você grave e execute instruções SQL Snowflake diretamente no VS Code. A extensão também se integra ao Snowpark Python para fornecer recursos de depuração, realce de sintaxe e preenchimento automático para SQL no código Python.

Você pode instalar a extensão VS Code do Visual Studio Marketplace ou baixar e instalar o arquivo .vsix.

Neste tópico:

Instale a extensão VS Code do Visual Studio Marketplace

  1. No VS Code, selecione Code » Settings » Extensions.

  2. No campo Search Extensions in Marketplace, digite Snowflake e selecione a extensão do Snowflake.

    Para confirmar que você selecionou a extensão correta, procure o selo Snowflake, conforme mostrado na imagem a seguir:

    O local de certificação Snowflake. A certificação Snowflake é uma marca de confirmação dentro de um círculo azul.

  3. Clique em Install.

Instalar a extensão VS Code a partir de um arquivo .vsix

  1. Baixe a extensão:

    1. Acesse https://marketplace.visualstudio.com/items?itemName=snowflake.snowflake-vsc.

    2. Clique na guia Version History.

    3. Clique em Download para versão do VS Code que você deseja instalar. Observe onde o arquivo é baixado.

  2. No VS Code, selecione Code » Settings » Extensions.

  3. Clique em More (…) » Install from VSIX.

  4. Procure o local do arquivo snowflake-x.y.z.vsix no seu computador, selecione o arquivo e depois 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.

Entrar no Snowflake com a extensão VS Code

Antes de poder executar instruções SQL ou usar os recursos do Snowpark Python, você deve entrar em uma conta Snowflake.

Para fazer login no Snowflake com a extensão VS Code, você pode:

  • Usar seu identificador de conta Snowflake, nome de usuário e senha.

  • Usar autenticação federada, como Security Assertion Markup Language (SAML) ou Single Sign-on (SSO).

  • Usar autenticação de par de chaves.

Na primeira vez que você usar a extensão VS Code para fazer login no Snowflake, será necessário inserir o identificador de conta da sua conta Snowflake ou o URL que você usa para se conectar ao Snowflake. Para determinar o identificador de conta, consulte Identificadores de conta.

  1. Clique no ícone do Snowflake na Barra de atividade do VS Code.

  2. No campo Account Identifier/URL, insira o identificador de conta da sua conta Snowflake ou o URL que você usa para se conectar ao Snowflake e clique em Continue.

    O campo Account Identifier/URL não estará disponível se você tiver fornecido anteriormente as credenciais da sua conta Snowflake.

  3. Selecione uma das seguintes opções na lista Auth Method:

    1. Selecione Single sign-on para usar suas credenciais SSO para fazer login no Snowflake.

    2. Selecione Username/password para usar seu nome de usuário e senha do Snowflake para fazer login no Snowflake.

    3. Selecione Key Pair para usar seu nome de usuário e senha do Snowflake para fazer login no Snowflake. Para saber mais sobre autenticação de par de chaves, consulte Autenticação de pares de chaves e rotação de pares de chaves.

  4. Insira suas credenciais e clique em Sign in.

    Quando você seleciona SSO, uma página de autenticação separada é aberta depois que você insere seu nome de usuário e seleciona Sign in with single sign-on. Insira suas credenciais SSO e depois retorne para o VS Code para concluir o login no Snowflake.

    Após efetuar o login com sucesso, a barra lateral exibe as informações da sua conta, sua função padrão, o OBJECT EXPLORER com uma lista de Bancos de dados e seu QUERY HISTORY.

Editar o arquivo do Snowflake connections.toml

Você pode adicionar e modificar definições de conexão no arquivo de configuração do Snowflake connections.toml. Uma definição de conexão é uma coleção de parâmetros relacionados à conexão. Para obter mais informações sobre como conectar-se ao Snowflake com um arquivo TOML, consulte Conexão usando o arquivo connections.toml.

  1. No VS Code, abra a extensão Snowflake VS Code e entre no Snowflake.

  2. Clique em Snowflake:Edit Connections File no painel ACCOUNT.

    A localização do Snowflake:Edit Connections File.

  3. Edite o arquivo TOML.

  4. Feche o arquivo TOML e selecione Save.

A interface de extensão do VS Code

Uma visão geral da extensão Snowflake VS Code mostrando suas principais áreas: o painel da barra lateral, o painel SQL e o painel de resultados de consulta.

A tabela a seguir fornece descrições das áreas funcionais de interface da extensão VS Code.

Item

Descrição

1

Painel da barra lateral. Contém os painéis Conta, Explorador de objetos e Histórico de consultas. Use este painel para especificar detalhes da conta, examinar objetos de banco de dados e examinar os resultados das consultas.

2

Painel Snowflake SQL. Exibe arquivos Snowflake SQL.

3

Painel Histórico de consultas. Mostra consultas recentes.

4

Painel Resultados de consultas. Mostra os resultados das consultas. Selecione uma consulta para exibir o resultado da execução.

5

Sessão atual. Mostra informações da sessão atual, incluindo função atual, banco de dados, esquema e warehouse ativo.

Use a extensão VS 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.

Nota

Somente os valores de configuração de conexão são usados. Outros valores de configuração SnowSQL são ignorados.

  1. No campo de pesquisa do VS Code, digite >user settings e selecione Preferences: Open User Settings.

  2. Na guia User, expanda Extensions.

  3. Role para baixo e selecione Snowflake.

  4. No painel direito, role para baixo até Snowsql Config Path.

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

    Todas as conexões definidas na configuração são exibidas no painel Conta.

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 que contêm uma ou mais instruções SQL.

Abrir ou criar arquivos SQL

  1. No VS Code, selecione File » Open, navegue até o local de um arquivo SQL e abra-o.

    Para criar um novo arquivo SQL, selecione File » New File e crie um arquivo do tipo Snowflake SQL File.

  2. Adicione uma ou mais instruções SQL Snowflake ao arquivo.

  3. (Opcional) Clique em Snowflake: Execute All Statements (Botão Executar todas as instruções) para executar um comando.

Executar comandos ou consultas

Importante

Para exibir os resultados da consulta do Snowflake, a extensão VS Code executa automaticamente DESC RESULT '<query_id>' em segundo plano após cada consulta. Este processo torna LAST_QUERY_ID() impreciso. Para obter mais informações sobre o comando DESCRIBE RESULT e seus parâmetros, consulte DESCRIBE RESULT.

No VS Code, selecione uma das seguintes opções:

  • Para executar todas as instruções SQL em um arquivo, clique em Snowflake: Execute All Statements (Botão Executar todas as instruções).

  • Para executar um comando específico, coloque o cursor na instrução que deseja executar e clique em Execute.

  • Para executar vários comandos, selecione as instruções que deseja executar e clique em Execute. Os comandos são executados em ordem de cima para baixo.

Para usar atalhos de teclado para executar instruções, selecione as instruções SQL que deseja executar, pressione Tecla de comando OSX da Apple. + [enter] em um teclado Mac ou Chave de controle genérica. + [enter] em um teclado Windows.

Os resultados da instrução SQL executada são exibidos no painel SNOWFLAKE.

Para cancelar consultas em andamento, selecione uma consulta na lista QUERY HISTORY e clique em Cancel query (Botão Cancelar consulta).

Visualização do histórico de consultas

  1. No VS Code, expanda Query History.

  2. Selecione uma instrução.

  3. Reveja os resultados no painel SNOWFLAKE.

  4. (Opcional) Selecione uma das seguintes opções:

    1. Clique em Snowflake: Copy to Clipboard (Botão Copiar o texto da consulta para a área de transferência) para copiar o texto da consulta para a área de transferência.

    2. Clique em Snowflake: Remove Query (Botão Excluir consulta) para excluir uma consulta.

Trabalhar com resultados de consulta

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

  1. Em QUERY HISTORY, selecione uma consulta.

  2. No painel SNOWFLAKE, escolha uma coluna.

  3. Selecione a seta de expansão (↓) e depois um dos seguintes: Sort Ascending, Sort Descending, Hide column «column name» ou Freeze columns up to «column name».

    Se uma coluna estava oculta anteriormente, escolha qualquer outra coluna e selecione Unhide N columns.

  4. (Opcional) Selecione uma das seguintes opções:

    1. Clique em Cloud (Botão Baixar resultados) para salvar os resultados como um arquivo gzip compactado.

    2. Clique em Save (Botão Salvar resultados) para salvar os resultados como um arquivo separado por vírgulas (CSV).

Trabalhar com código Snowpark Python

Logotipo do Snowflake em preto (sem texto) Recurso em versão preliminar — Aberto

Disponível para todas as contas. Para usar os recursos do Snowpark Python da extensão VS Code, você deve ativar a configuração de extensão Enable Public Preview Features. Para obter mais informações, consulte Configurações de visualização da extensão VS Code.

Você pode usar Snowflake Extension for Visual Studio Code para escrever e depurar instruções SQL do Snowflake no código Snowpark Python.

Depurar funções do Snowpark Python

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

  2. Uma opção Snowflake: Debug embutida aparece 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.

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 por uma palavra-chave SQL com todas as letras maiúsculas como a primeira palavra em uma cadeia de caracteres Python, conforme mostrado na imagem a seguir.

Um trecho de código de uma instrução Snowflake SQL em uma cadeia de caracteres Python mostrando realce automático de sintaxe SQL.

Denotação de instruções SQL manualmente

  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

    A imagem a seguir mostra como os marcadores --begin-sql e --end-sql denotam manualmente uma instrução SQL.

Um trecho de código de uma instrução SQL do Snowflake em uma cadeia de caracteres Python usando comentários para ativar manualmente o realce de sintaxe SQL.

Uso do preenchimento automático 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 com a extensão VS Code.

  2. Escreva uma instrução SQL. As sugestões de preenchimento automático 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 imagem a seguir.

Um trecho de código de uma instrução Snowflake SQL em uma cadeia de caracteres Python mostrando sugestões de preenchimento automático para nomes de colunas.

Destaque de sintaxe do modelo Jinja

Por padrão, a extensão VS Code adiciona destaque de sintaxe básica e preenchimento automático de colchetes para escrever modelos Jinja no Snowflake SQL, conforme mostrado na imagem a seguir.

Um trecho de código de uma instrução Snowflake SQL com um modelo Jinja mostrando realce de sintaxe e preenchimento automático de colchetes.

Como trabalhar com o Snowflake Native App Framework

Logotipo do Snowflake em preto (sem texto) Recurso em versão preliminar — Aberto

Disponível para todas as contas. Para usar os recursos do Snowpark Python da extensão VS Code, você deve ativar a configuração de extensão Enable Public Preview Features. Para obter mais informações, consulte Configurações de visualização da extensão VS Code.

Você pode usar a extensão VS Code para criar e gerenciar um Snowflake Native App. Para obter mais informações sobre o Snowflake Native App Framework, consulte Sobre o Snowflake Native App Framework.

Criar uma Snowflake Native App

  1. No VS Code, abra a extensão Snowflake VS Code e entre no Snowflake.

  2. Expanda o painel NATIVE APP e clique em Create new from template.

  3. Selecione um dos seguintes:

    1. Digite o nome da pasta onde você deseja criar o Snowflake Native App e pressione Enter.

    2. Pressione Enter para aceitar o diretório padrão como o local para o Snowflake Native App.

  4. Selecione um dos seguintes:

    1. Digite o URL para o repositório GitHub onde seus modelos do Snowflake Native App estão armazenados e pressione Enter.

    2. Pressione Enter para aceitar o URL do repositório de modelos padrão do GitHub Snowflake Native App.

  5. Selecione um dos seguintes modelos:

    1. Selecione basic para criar um Snowflake Native App com o mínimo de exemplos de código e orientação.

    2. Selecione streamlit-python para criar um Snowflake Native App com código de extensão Python e exemplos de código Streamlit.

    3. Selecione streamlit-java para criar um Snowflake Native App com código de extensão Java e exemplos de código Streamlit.

    4. Selecione spcs-basic para criar um Snowflake Native App com código de extensão SPCS e exemplos de código Streamlit.

Implantar e abrir um Snowflake Native App

Ao usar as opções Run (deploy and re-install) ou Deploy, o primeiro arquivo snowflake.yml listado no painel NATIVE APP é usado. Quando vários arquivos snowflake.yml estiverem disponíveis, um prompt será exibido e você poderá selecionar o arquivo snowflake.yml que deseja usar para a implantação.

Depois de implantar seu Snowflake Native App, você pode abri-lo no Snowflake para gerenciar o acesso, visualizar, adicionar e validar pacotes de aplicativos, exibir logs e eventos e modificar privilégios.

  1. Selecione um dos seguintes:

    1. No painel NATIVE APP da extensão VS Code, clique em Run (deploy and re-install). Essa é a opção recomendada quando você faz alterações significativas e um objeto de aplicativo é necessário.

    2. No painel NATIVE APP da extensão VS Code, clique em Deploy. Essa é a opção recomendada quando você está implantando pacotes de aplicativo e arquivos de estágio, e um objeto de aplicativo não é necessário.

  2. (Opcional) Clique na guia OUTPUT no painel de resultados de consulta para exibir o progresso da implantação.

  3. No painel NATIVE APP, clique em Open.

Exibir status do objeto do aplicativo Snowflake Native App

  • No painel NATIVE APP da extensão VS Code, expanda seu aplicativo.

    Objetos de aplicativo desinstalados são azuis.

Ativação do modo de depuração

Use o modo de depuração para mostrar objetos de aplicativo que não são visíveis aos consumidores. Por exemplo, objetos de conteúdo compartilhado ou objetos não concedidos a uma função de banco de dados específica. Para obter mais informações sobre o modo de depuração e como ativá-lo programaticamente, consulte Ativação do modo de depuração.

  1. No painel NATIVE APP da extensão VS Code, clique em Debug Mode.

  2. Clique em Enable Debug Mode.

  3. Selecione Enable debug mode for all Native Apps operations.

Descartar pacotes e objetos de aplicativo do Snowflake Native App

Use a opção Teardown para descartar o pacote e o objeto de aplicativo configurados na definição do projeto resolvido.

  • No painel NATIVE APP da extensão VS Code, clique em Teardown. Uma mensagem de confirmação aparece quando a desmontagem é concluída.

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

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

Faça login ou alterne entre contas.

Gerenciar conteúdo de estágio

O Snowflake Extension for Visual Studio Code é compatível com o gerenciamento de conteúdo de estágio diretamente no Object Explorer.

Listar todos os arquivos em um estágio

  1. No VS Code OBJECT EXPLORER, navegue até um estágio.

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

Carregar arquivos do sistema de arquivos local para um estágio

O Snowflake Extension for Visual Studio Code é compatível somente com o carregamento de estágios internos, todas as outras operações funcionam para estágios internos e externos.

  1. No VS Code OBJECT EXPLORER, navegue até um estágio e clique em Upload (Botão Enviar arquivo).

  2. Insira parâmetros opcionais 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 de upload, selecione e carregue um ou mais arquivos.

Baixar arquivos de um estágio para um sistema de arquivos local

  1. No VS Code OBJECT EXPLORER, navegue até um estágio.

  2. Clique em Download (Botão Baixar resultados) para baixar todos os arquivos ou expandir o estágio.

  3. Selecione e baixe um arquivo.

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

Remover arquivos de um estágio

Consulte também REMOVE.

  1. No VS Code OBJECT EXPLORER, navegue até um estágio.

  2. Selecione um arquivo.

  3. Clique em Remove (Botão Remover).

Configurações da extensão VS Code

A tabela a seguir lista as configurações Snowflake Extension for Visual Studio Code.

Configuração

Descrição

Padrão

Exportar delimitador CSV »

Especifica o delimitador das colunas

Vírgula

Exportar cabeçalho CSV »

Permitir a inclusão da linha de cabeçalho no arquivo CSV exportado

Habilitado

Exportar incluindo linhas vazias CSV »

Permitir a inclusão de linhas vazias no arquivo CSV exportado

Excluir

Exportar aspas CSV »

Ativar aspas duplas em torno de todos os valores no arquivo CSV exportado

Habilitado

Consulta de destaque

Ativar o destaque em segundo plano na instrução SQL atual

Habilitado

Mostrar a instrução Executar acima

Ativar uma ação de execução clicável acima de cada instrução

Habilitado

Caminho de configuração do Snowsql

Se definido, a configuração da conexão será carregada a partir desse arquivo.

Não definido

Preencher detalhes do objeto automaticamente

Exibir detalhes de um objeto Snowflake depois de selecionar sua entrada de preenchimento automático

Desabilitado

Definir sessão do cliente Keep Alive

Especifica se a sessão deve ser mantida ativa indefinidamente enquanto a conexão estiver ativa, independentemente da atividade. Se não estiver ativado, você deverá fazer login novamente após quatro horas de inatividade.

Habilitado

Preencher chaves de variante automaticamente

Mostrar sugestões de preenchimento automático de OBJECT/VARIANT principais

Desabilitado

Explorador de objetos: pesquisa

Habilitar pesquisa no explorador de objetos

Habilitado

Histórico de consultas: limite de itens

Especifica o número máximo de consultas mostradas no histórico. Mostrar mais consultas pode afetar o desempenho.

1000

Configurações de visualização da extensão VS Code

Logotipo do Snowflake em preto (sem texto) Recurso em versão preliminar — Aberto

Disponível para todas as contas.

A tabela a seguir lista as configurações de visualização da extensão VS Code.

Configuração

Descrição

Padrão

Destaque de sintaxe: detecção automática de SQL em Python

Ativar o realce automático de sintaxe de instruções SQL em cadeias de caracteres Python

Habilitado

Habilitar recursos de versão preliminar pública

Habilite recursos de versão preliminar pública para a extensão

Desabilitado

Alterar as configurações da extensão VS Code

  1. Selecione um dos seguintes:

    1. No Windows/ Linux selecione File » Preferences » Settings.

    2. No macOS selecione Code » Settings » Settings.

  2. No campo 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.

Mostrar o registro de alterações da extensão VS Code

  1. Pressione CMD+Shift+P (Mac), ou CTRL+Shift+P (Windows).

  2. Insira o seguinte comando:

    Show Change Log
    Copy

Desinstalar a extensão VS Code

  1. Selecione Code » Settings » Extensions

  2. Selecione a extensão.

  3. Clique com o botão direito e selecione Disable ou Uninstall.

Linguagem: Português