Como trabalhar com RESULTSETs¶
Este tópico explica como usar um RESULTSET no Script Snowflake.
Introdução¶
No Script Snowflake, um RESULTSET é um tipo de dados SQL que aponta para o conjunto de resultados de uma consulta.
Como um RESULTSET é apenas um ponteiro para os resultados, você deve fazer uma das ações a seguir para acessar os resultados através do RESULTSET:
Use a sintaxe
TABLE(...)para recuperar os resultados como uma tabela.Itere sobre o RESULTSET com um cursor.
Exemplos de ambos estão incluídos abaixo.
Explicação das diferenças entre um cursor e um RESULTSET¶
Tanto o RESULTSET quanto o cursor permitem acesso ao conjunto de resultados de uma consulta. No entanto, esses objetos diferem das seguintes maneiras:
O momento em que a consulta é executada.
Para um cursor, a consulta é executada quando você executa o comando OPEN no cursor.
Para um RESULTSET, a consulta é executada quando você atribui a consulta ao RESULTSET (ou na seção DECLARE ou no bloco BEGIN … END).
Suporte para vinculação no comando OPEN.
Quando você declara um cursor, você pode especificar os parâmetros de vinculação (caracteres
?). Mais tarde, quando você executar o comando OPEN, você poderá vincular variáveis a esses parâmetros na cláusula USING.O RESULTSET não oferece suporte para o comando OPEN. No entanto, você pode vincular variáveis em comandos SQL antes de retornar o conjunto de resultados.
Em geral, é mais simples usar um RESULTSET quando você deseja retornar uma tabela que contém o conjunto de resultados de uma consulta. No entanto, você também pode retornar uma tabela de um bloco de script do Snowflake com um cursor. Para fazer isso, você pode passar o cursor para RESULTSET_FROM_CURSOR(cursor) para retornar um RESULTSET e passar esse RESULTSET para TABLE(...). Consulte Como retornar uma tabela para um cursor.
Como declarar um RESULTSET¶
Você pode declarar um RESULTSET na seção DECLARE de um bloco ou na seção BEGIN … END do bloco.
Dentro da seção DECLARE, use a sintaxe descrita em Sintaxe da instrução RESULTSET. Por exemplo:
Dentro do bloco BEGIN … END, use a sintaxe descrita em Sintaxe de atribuição do RESULTSET. Por exemplo:
Atribuição de uma consulta a um RESULTSET declarado¶
Para atribuir o resultado de uma consulta a um RESULTSET que já tenha sido declarado, use a seguinte sintaxe:
Onde:
resultset_nameO nome do RESULTSET.
O nome deve ser exclusivo no escopo atual.
O nome deve seguir as regras de nomenclatura para Identificadores de objetos.
ASYNCExecuta a consulta como um trabalho filho assíncrono.
queryA consulta a ser atribuída ao RESULTSET.
Para atribuir uma consulta a um RESULTSET:
Para atribuir uma consulta a um RESULTSET e executar a consulta como um trabalho filho assíncrono:
Para criar uma cadeia de caracteres SQL dinamicamente para a consulta, defina query como (EXECUTE IMMEDIATE string_of_sql). Por exemplo:
Embora você possa definir query como uma instrução EXECUTE IMMEDIATE para um RESULTSET, não é possível fazer isso para um cursor.
Como usar um RESULTSET¶
A consulta para um RESULTSET é executada quando o objeto é associado a essa consulta. Por exemplo:
Quando você declara um RESULTSET e define a cláusula DEFAULT para uma consulta, a consulta é executada nesse momento.
Quando você usa o operador
:=para atribuir uma consulta a um RESULTSET, a consulta é executada nesse momento.
Nota
Como um RESULTSET aponta para o conjunto de resultados de uma consulta (e não contém o conjunto de resultados de uma consulta), um RESULTSET é válido somente enquanto os resultados da consulta estiverem em cache (normalmente 24 horas). Para obter mais detalhes sobre o cache de resultados de consultas, consulte Uso de resultados de consultas persistentes.
Após a execução da consulta, você pode acessar os resultados usando um cursor. Você também pode retornar os resultados como uma tabela de um procedimento armazenado.
Como usar um cursor para acessar dados de um RESULTSET¶
Para usar um cursor para acessar os dados de um RESULTSET, declare o cursor no objeto. Por exemplo:
Quando você declara um cursor em um RESULTSET, o cursor tem acesso aos dados que já estão no RESULTSET. A execução do comando OPEN no cursor não executa novamente a consulta para o RESULTSET.
Você pode então abrir o cursor e usar o cursor para obter os dados.
Nota
Se os resultados incluírem valores GEOGRAPHY, você deve converter os valores para o tipo GEOGRAPHY antes de passar os valores para qualquer função que espere valores de entrada GEOGRAPHY. Consulte Como usar um cursor para obter um valor GEOGRAPHY.
Como retornar um RESULTSET como uma tabela¶
Se você quiser retornar os resultados para os quais o RESULTSET aponta, passe o RESULTSET para TABLE(...). Por exemplo:
Isso é semelhante à forma como TABLE(...) é usado com funções de tabela (tais como RESULT_SCAN).
Como mostrado no exemplo, se você escreve um procedimento armazenado que retorna uma tabela, você deve declarar que o procedimento armazenado retorna uma tabela.
Nota
Atualmente, a sintaxe TABLE(resultset_name) é suportada apenas na instrução RETURN.
Mesmo que você tenha usado um cursor para obter linhas do RESULTSET, a tabela retornada por TABLE(resultset_name) ainda conterá todas as linhas (não apenas as linhas que começam no ponteiro de linha interno do cursor).
Limitações do tipo de dados RESULTSET¶
Embora RESULTSET seja um tipo de dados, o Snowflake ainda não oferece suporte para:
A declaração de uma coluna do tipo RESULTSET.
A declaração de um parâmetro do tipo RESULTSET.
A declaração do tipo de retorno de um procedimento armazenado como um RESULTSET.
O Snowflake somente oferece suporte para o RESULTSET dentro do Script Snowflake.
Além disso, você não pode usar o RESULTSET diretamente como uma tabela. Por exemplo, o seguinte é inválido:
Exemplos de uso de um RESULTSET¶
As seções a seguir fornecem exemplos de uso de um RESULTSET:
Exemplo: retorno de uma tabela de um procedimento armazenado
Exemplo: declaração de uma variável RESULTSET sem cláusula DEFAULT
Para ver exemplos que usam a palavra-chave ASYNC para executar consultas especificadas para RESULTSETs como trabalhos filhos assíncronos, consulte Exemplos de uso de trabalhos secundários assíncronos.
Configuração dos dados para os exemplos¶
Muitos dos exemplos abaixo usam a tabela e os dados mostrados abaixo:
Exemplo: retorno de uma tabela de um procedimento armazenado¶
O código a seguir mostra como declarar um RESULTSET e retornar os resultados para os quais o RESULTSET aponta. A cláusula RETURNS no comando CREATE PROCEDURE declara que o procedimento armazenado retorna uma tabela, que contém uma coluna do tipo INTEGER.
A instrução RETURN dentro do bloco usa a sintaxe TABLE(...) para retornar os resultados como uma tabela.
Crie o procedimento armazenado:
Note: If you use Snowflake CLI, SnowSQL, the Classic Console, or the
execute_stream or execute_string method in Python Connector
code, use this example instead (see Using Snowflake Scripting in Snowflake CLI, SnowSQL, and Python Connector):
Chame o procedimento armazenado:
Você pode usar o operador de canal (->>) para processar os resultados da chamada do procedimento armazenado:
Você também pode usar a função RESULT_SCAN para processar os resultados depois de chamar o procedimento armazenado:
Exemplo: construção da instrução SQL¶
Você pode construir o SQL dinamicamente. A seguir, veja um exemplo que executa a mesma consulta que o procedimento armazenado anterior, mas usando uma instrução SQL que é construída dinamicamente:
Note: If you use Snowflake CLI, SnowSQL, the Classic Console, or the
execute_stream or execute_string method in Python Connector
code, use this example instead (see Using Snowflake Scripting in Snowflake CLI, SnowSQL, and Python Connector):
Para executar o exemplo, chame o procedimento armazenado e passe o nome da tabela:
Exemplo: declaração de uma variável RESULTSET sem cláusula DEFAULT¶
O código a seguir mostra como declarar um RESULTSET sem uma cláusula DEFAULT (isso é, sem associar uma consulta com o RESULTSET) e depois associar o RESULTSET a uma consulta mais tarde.
Note: If you use Snowflake CLI, SnowSQL, the Classic Console, or the
execute_stream or execute_string method in Python Connector
code, use this example instead (see Using Snowflake Scripting in Snowflake CLI, SnowSQL, and Python Connector):
Para executar o exemplo, chame o procedimento armazenado:
Exemplo: como usar um CURSOR com um RESULTSET¶
O código a seguir mostra como usar um cursor para iterar sobre as linhas em um RESULTSET:
Crie o procedimento armazenado:
Note: If you use Snowflake CLI, SnowSQL, the Classic Console, or the
execute_stream or execute_string method in Python Connector
code, use this example instead (see Using Snowflake Scripting in Snowflake CLI, SnowSQL, and Python Connector):
Chame o procedimento armazenado e os resultados somam os valores para a na tabela (1 + 2):
Outros exemplos que usam um RESULTSET¶
Veja a seguir outros exemplos que usam o RESULTSET:
Use um loop FOR baseado em RESULTSET
Este exemplo mostra como usar um loop FOR que itera sobre um RESULTSET.
Retorne uma tabela para um cursor
Este exemplo mostra como usar um cursor para retornar uma tabela de dados em um RESULTSET.
Atualização de dados da tabela com entrada do usuário
Este exemplo mostra como usar variáveis de vinculação com base na entrada do usuário para atualizar dados em uma tabela. Ele usa um loop FOR com lógica condicional para iterar sobre as linhas em um RESULTSET.
-
Este exemplo mostra como usar o RESULTSET para coletar dados e inseri-los em uma tabela para rastrear tendências históricas.