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:

Abra o Visual Studio Code.
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.
Na caixa de texto Search Extensions, digite o texto Snowflake para procurar a Extensão do Snowflake do Visual Studio.
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:

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.
Abra o Visual Studio Code.
Selecione Code » Preferences » Extensions.

Você também pode selecionar View » Extensions ou clicar no botão de extensões na barra de atividades.
Selecione Install from VSIX no menu mais(…).

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.

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:

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.
Em Add Account, digite o identificador da conta e selecione Continue.

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

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.

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.

Nota

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

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

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.
Selecione o menu suspenso Username e, em seguida, Sign in to another account.
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.
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.

Navegação na interface Snowflake Extension for Visual Studio Code¶

O Snowflake Extension for Visual Studio Code tem as seguintes seções principais:

Painel lateral (1): o painel mais à esquerda é o painel de Conta, Exploração de banco de dados 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.
O painel Snowflake SQL (2): o painel Snowflake SQL exibe arquivos do Snowflake SQL.
Painel de resultados da consulta (3): o painel de resultados da consulta mostra os resultados das consultas.

Selecione uma consulta no Side Bar » Query History para exibir seu resultado de execução (painel 4).
Seção Histórico de consultas de Side Bar (4): o histórico das consultas mostra as consultas recentes.
Sessão atual (5): informações da sessão atual, incluindo função atual, banco de dados, esquema e warehouse ativo.
Ícone Snowflake (não numerado) - Selecione o ícone Snowflake para exibir ou ocultar o painel Side Bar.

The Snowflake SQL extension in use showing its main areas: the sidebar panel, the sql panel and the query results panel.

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:

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.
Adicione uma ou mais instruções SQL Snowflake ao arquivo.
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:

Selecione o arquivo para o arquivo SQL selecionado para executar todas as instruções contidas nesse arquivo.
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.
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.

Dica

Consultas em andamento podem ser canceladas. Para cancelar uma consulta em andamento, encontre a consulta em QUERY HISTORY e selecione cancelar consulta ().

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:

Expanda o Query History.
Selecione uma instrução.
Examine o resultado na guia SNOWFLAKE:QUERY RESULTS do painel Output.

Dica

Você pode usar o Query History para reexecutar uma consulta (), copiar o texto da consulta na área de transferência () ou excluir uma consulta ().

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:

Em QUERY HISTORY, selecione uma consulta.
Em QUERY RESULTS, escolha uma coluna.
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.

Dica

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

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.

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.

Dica

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

Navegação com o Navegador de Banco de Dados¶

Use a seção DATABASE EXPLORER do painel Side Bar para examinar e exibir as características dos objetos de banco de dados.

Para examinar um objeto de banco de dados, faça o seguinte:

Entre em uma conta.
Expanda a seção DATABASE EXPLORER do painel Sidebar.
Selecione um banco de dados e expanda-o.
Selecione um esquema e expanda-o.
Navegue até um componente filho.
Selecione qualquer elemento para ver suas características na guia SNOWFLAKE:OBJECT DETAILS do painel Output.

Dica

Use o botão para exibir detalhes do objeto () para exibir os detalhes do objeto associado. . Use o botão Exibir objeto DML () para exibir o DML usado para criar o objeto.

Ao examinar os detalhes associados a uma tabela, exibição, exibição materializada ou objeto semelhante, selecione a pré-visualização () para exibir uma pré-visualização de até 100 linhas de conteúdo.

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:

Navegue até um estágio específico.

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:

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

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

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:

Navegue até o estágio.

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

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

Selecione um diretório para concluir o download.

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

Selecione um arquivo.

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

Nota

O Snowflake Extension for Visual Studio Code oferece suporte somente ao carregamento para estágios internos, todas as outras operações funcionam para estágios internos e externos.

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:

Selecione Code » Preferences » Extensions.
Selecione a extensão Snowflake SQL VS Code.

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

Configurações de extensão¶

O Snowflake Extension for Visual Studio Code oferece suporte às seguintes configurações:

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

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

No Windows/Linux, selecione File » Preferences » Settings. . Em macOS, selecione Code » Preferences » Settings.
Na caixa de texto Search settings, digite Snowflake.
Selecione as guias User ou Workspace para visualizar ou modificar configurações específicas do usuário ou do espaço de trabalho.
Feche a guia Settings.

Desinstalação da extensão¶

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

Selecione Code » Preferences » Extensions
Selecione a extensão.
Clique com o botão direito do mouse e escolha Disable ou Uninstall.