Snowflake Extension for Visual Studio Code¶

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. Selecione Snowflake: Execute All Statements () para executar um comando.

Executar comandos ou consultas¶

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

• Para executar todas as instruções SQL em um arquivo, selecione Snowflake: Execute All Statements ().

• Para executar um comando específico, coloque o cursor sobre a instrução que deseja executar e selecione Execute.

• Para executar vários comandos, selecione as instruções que deseja executar e, em seguida, selecione 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 + [enter] em um teclado Mac ou + [enter] em um teclado Windows.

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

Para cancelar as consultas em andamento, selecione uma consulta na lista QUERY HISTORY e selecione Cancel query ().

Visualização do histórico de consultas¶

1. No VS Code, expanda Query History.

2. Selecione uma instrução.

3. Analise os resultados no painel SNOWFLAKE.

4. Opcional. Selecione um dos seguintes:

   • Selecione Snowflake: Copy to Clipboard () para copiar o texto da consulta para a área de transferência.

   • Selecione Snowflake: Remove Query () 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 um dos seguintes:

   • Selecione Cloud () para salvar os resultados como um arquivo gzip compactado.

   • Selecione Save () para salvar os resultados como um arquivo separado por vírgulas (CSV).

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.

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.

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.

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.

Visualize a paleta de comandos do Snowflake Native App da extensão VS Code¶

A paleta de comandos do Snowflake Native App da extensão VS Code fornece acesso aos seguintes comandos do Snowflake Native App:

• Criação de um Native App

• Implementação de um Native App

• Foco em uma exibição de Native App

• Abertura de um Native App

• Execução (implementação e reinstalação) de um Native App

• Desinstalação de um Native App

Para acessar esses comandos, digite >Snowflake Native no campo de pesquisa na parte superior da janela do VS Code.

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 selecione Create new from template.

3. Selecione um dos seguintes:

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

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

4. Selecione um dos seguintes:

   • Digite o URL para o repositório GitHub onde os modelos do Snowflake Native App são armazenados e, em seguida, selecione Enter.

   • Digite o caminho para uma pasta de modelos local.

   • Para aceitar o URL do repositório de modelos padrão do Snowflake Native App no GitHub, selecione Enter.

5. Selecione um dos seguintes modelos:

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

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

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

   • 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 utilizar as opções Run (deploy and re-install) ou Deploy, é usado o aplicativo selecionado no painel NATIVE APP. Quando vários aplicativos Snowflake Native App estão disponíveis, é exibido um prompt e é possível selecionar qual arquivo snowflake.yml deve ser usado para a implementaçã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:

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

   • No painel NATIVE APP da extensão VS Code, selecione 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. Selecione a guia OUTPUT no painel de resultados de consulta para visualizar o progresso da implementação.

3. No painel NATIVE APP, selecione Open.

Exibir status do objeto do aplicativo Snowflake Native App¶

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

  Uma fonte azul e um círculo azul indicam que o objeto do aplicativo não foi instalado ou implementado.

Exibição do gerenciador de variáveis de ambiente Snowflake¶

Use o gerenciador de variáveis de ambiente Snowflake para criar e gerenciar variáveis de ambiente em perfis de variáveis de ambiente. É possível usar um perfil de variável de ambiente para personalizar o comportamento do objeto nos arquivos de definição de projeto do Snowflake Native App. Por exemplo, é possível criar perfis de variáveis de ambiente que alteram o comportamento do objeto em ambientes de desenvolvimento, estágio e produção. Para obter mais informações sobre variáveis de ambiente e conexões do Snowflake, consulte Arquivos de definição de projeto.

Use um dos métodos a seguir para visualizar o gerenciador de variáveis de ambiente Snowflake:

• No painel NATIVE APP da extensão VS Code, selecione Environment Variables.

• Na paleta de comandos, selecione Open Environment Variables Manager.

Como adicionar uma variável de ambiente a um perfil de variável de ambiente¶

Um perfil de variável de ambiente armazena variáveis de ambiente.

1. No painel NATIVE APP da extensão VS Code, selecione Environment Variables.

2. Na lista Selected Profile, selecione um perfil.

3. Na coluna Environment Variable, insira uma variável de ambiente.

4. Na coluna Value, digite um valor para a variável de ambiente.

5. Opcional: para adicionar outras variáveis de ambiente ao perfil de variável de ambiente, repita as etapas 3 e 4.

6. Opcional: para adicionar outras linhas ao perfil de variável de ambiente, selecione + (Add Row).

Como adicionar um perfil de variável de ambiente¶

Um perfil de variável de ambiente armazena variáveis de ambiente. Para personalizar o comportamento do objeto nos arquivos de definição de projeto do Snowflake Native App, crie um novo perfil.

1. No painel NATIVE APP da extensão VS Code, selecione Environment Variables.

2. Selecione Add Profile.

3. Digite um nome para o perfil e pressione Enter.

Como adicionar uma linha a um perfil de variável de ambiente¶

Para adicionar uma variável de ambiente, adicione uma linha ao perfil da variável de ambiente.

1. No painel NATIVE APP da extensão VS Code, selecione Environment Variables.

2. Selecione um perfil na lista Selected Profile.

3. Selecione + (Add Row).

Como renomear um perfil de variável de ambiente¶

1. No painel NATIVE APP da extensão VS Code, selecione Environment Variables.

2. Selecione um perfil na lista Selected Profile.

3. Selecione Rename Profile.

4. Digite um nome para o perfil e pressione Enter.

Exclusão de um perfil de variável de ambiente¶

1. No painel NATIVE APP da extensão VS Code, selecione Environment Variables.

2. Selecione um perfil na lista Selected Profile.

3. Selecione Delete Profile.

Ativação do modo de depuração do Snowflake Native App¶

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

• No painel NATIVE APP da extensão VS Code, selecione App Debug Mode: OFF.

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, selecione Teardown. Uma mensagem de confirmação aparece quando a desmontagem é concluída.

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 OBJECT EXPLORER do VS Code, navegue até um estágio e selecione Upload ().

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. Selecione Download () para fazer o download de todos os arquivos ou expanda 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. Selecione Remove ().

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

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

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

1. Selecione um dos seguintes:

   • No Windows/Linux, selecione File > Preferences > Settings.

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