SHOW USER FUNCTIONS

Lista todas as funções definidas pelo usuário (UDFs) para as quais você tem privilégios de acesso. Use esse comando para listar as UDFs para um banco de dados ou esquema especificado (ou o banco de dados/esquema atual da sessão) ou em toda a sua conta.

Para obter um comando que lista todas as funções, inclusive as funções internas, consulte SHOW FUNCTIONS.

Consulte também:

SHOW FUNCTIONS, SHOW EXTERNAL FUNCTIONS, Exibição FUNCTIONS (Information Schema), Exibição FUNCTIONS (Account Usage)

Sintaxe

SHOW USER FUNCTIONS [ LIKE '<pattern>' ]
  [ IN
    {
      ACCOUNT                                         |

      DATABASE                                        |
      DATABASE <database_name>                        |

      SCHEMA                                          |
      SCHEMA <schema_name>                            |
      <schema_name>

      APPLICATION <application_name>                  |
      APPLICATION PACKAGE <application_package_name>  |
    }
  ]
Copy

Parâmetros

LIKE 'pattern'

Opcionalmente, filtra a saída do comando pelo nome do objeto. O filtro utiliza correspondência de padrão que não diferencia maiúsculas e minúsculas, com suporte para caracteres curinga SQL (% e _).

Por exemplo, os seguintes padrões retornam os mesmos resultados:

... LIKE '%testing%' ...
... LIKE '%TESTING%' ...

. padrão: sem valor (nenhuma filtragem é aplicada à saída).

[ IN ... ]

Opcionalmente, especifica o escopo do comando. Especifique um dos seguintes:

ACCOUNT

Retorna registros para toda a conta.

DATABASE, . DATABASE db_name

Retorna registros do banco de dados atual em uso ou de um banco de dados especificado (db_name).

Se você especificar DATABASE sem db_name e nenhum banco de dados estiver em uso, a palavra-chave não terá efeito sobre a saída.

Nota

Usar comandos SHOW sem uma cláusula IN em um contexto de banco de dados pode resultar em menos resultados do que o esperado.

Os objetos com o mesmo nome são exibidos apenas uma vez se não for usada a cláusula IN. Por exemplo, se a tabela t1 estiver em schema1 e a tabela t1 estiver em schema2 e ambas estiverem no escopo do contexto do banco de dados especificado (ou seja, o banco de dados selecionado é o pai de schema1 e schema2), então SHOW TABLES exibirá apenas uma das tabelas t1.

SCHEMA, . SCHEMA schema_name

Retorna registros do esquema atual em uso ou de um esquema especificado (schema_name).

SCHEMA é opcional se um banco de dados estiver em uso ou se você especificar o schema_name totalmente qualificado (por exemplo, db.schema).

Se nenhum banco de dados estiver em uso, a especificação SCHEMA não terá efeito sobre a saída.

APPLICATION application_name, . APPLICATION PACKAGE application_package_name

Retorna registros para o Snowflake Native App ou pacote de aplicativo nomeado.

Padrão: depende se a sessão tem ou não um banco de dados em uso no momento:

  • Banco de dados: DATABASE é o padrão (ou seja, o comando retorna os objetos nos quais você tem privilégios para visualizar no banco de dados).

  • Sem banco de dados: ACCOUNT é o padrão (ou seja, o comando retorna os objetos que você tem privilégios de visualização em sua conta).

Saída

A saída do comando fornece propriedades de função do usuário e metadados nas seguintes colunas:

Coluna

Descrição

created_on

Carimbo de data/hora em que a função definida pelo usuário (UDF) foi criada.

name

Nome do UDF.

schema_name

Nome do esquema no qual a UDF existe.

is_builtin

Sempre N para funções definidas pelo usuário. Consulte SHOW FUNCTIONS para obter um comando para listar todas as funções, inclusive as funções internas.

is_aggregate

Y se a função for uma função de agregação; caso contrário, N.

is_ansi

Não aplicável atualmente.

min_num_arguments

Número mínimo de argumentos para a UDF.

max_num_arguments

Número máximo de argumentos para a UDF.

arguments

Tipos de dados dos argumentos e do valor de retorno.

description

Descrição do UDF.

catalog_name

Nome do banco de dados no qual a UDF existe.

is_table_function

Y se a UDF for uma função de tabela; caso contrário, N.

valid_for_clustering

Y se a UDF puder ser usada em uma expressão CLUSTER BY; caso contrário, N.

is_secure

Y se a UDF for uma UDF segura; caso contrário, N.

secrets

Mapa dos valores de segredo especificados pelo parâmetro SECRETS da função, em que as chaves do mapa são nomes de variáveis secretas e os valores do mapa são nomes de objetos secretos.

external_access_integrations

Nomes de integrações de acesso externo especificados pelo parâmetro EXTERNAL_ACCESS_INTEGRATION da função.

is_external_function

Y se a função for uma função externa; caso contrário, N. Consulte SHOW EXTERNAL FUNCTIONS para obter um comando para listar funções externas.

language

Linguagem de programação da UDF (por exemplo, PYTHON ou SQL).

is_memoizable

Y se a função for memoizável; caso contrário, N.

is_data_metric

Y se a função for uma função métrica de dados; caso contrário, N.

Notas de uso

  • O comando não precisa de um warehouse em funcionamento para ser executado.

  • O comando retorna apenas objetos para os quais a função atual do usuário atual recebeu pelo menos um privilégio de acesso.

  • O privilégio de acesso MANAGE GRANTS permite implicitamente que seu titular consulte todos os objetos da conta. Por padrão, somente o administrador de conta (usuários com a função ACCOUNTADMIN) e o administrador de segurança (usuários com a função SECURITYADMIN) têm o privilégio MANAGE GRANTS.

  • Para pós-processar a saída deste comando, você pode usar a função RESULT_SCAN, que trata a saída como uma tabela que pode ser consultada. Você também pode usar o operador de canal para consultar a saída desse comando.

  • O comando retorna um máximo de dez mil registros para o tipo de objeto especificado, conforme ditado pelos privilégios de acesso da função usada para executar o comando. Todos os registros acima do limite de dez mil registros não são retornados, mesmo com um filtro aplicado.

    Para visualizar os resultados para os quais existem mais de dez mil registros, consulte a exibição correspondente (se houver) em Snowflake Information Schema.

Exemplos

Mostrar todos os UDFs que você tem privilégios para visualizar no banco de dados atual:

SHOW USER FUNCTIONS LIKE 'ALLOWED_REGIONS%' IN SCHEMA;
Copy
---------------------------------+--------------------------+-------------+------------+--------------+---------+-------------------+-------------------+-----------------------------------------+-----------------------+----------------+-------------------+----------------------+-----------+---------+-----------------------------+----------------------+----------+---------------+----------------+
          created_on             |           name           | schema_name | is_builtin | is_aggregate | is_ansi | min_num_arguments | max_num_arguments |                arguments                |      description      |  catalog_name  | is_table_function | valid_for_clustering | is_secure | secrets | external_access_integration | is_external_function | language | is_memoizable | is_data_metric |
---------------------------------+--------------------------+-------------+------------+--------------+---------+-------------------+-------------------+-----------------------------------------+-----------------------+----------------+-------------------+----------------------+-----------+---------+-----------------------------+----------------------+----------+---------------+----------------+
 Fri, 23 Jun 1967 00:00:00 -0700 | ALLOWED_REGIONS          | PUBLIC      | N          | N            | N       | 0                 | 0                 | ALLOWED_REGIONS() RETURN ARRAY          | user-defined function | MEMO_FUNC_TEST | N                 | N                    | N         |         |                             | N                    | SQL      | Y             | N              |
 Fri, 23 Jun 1967 00:00:00 -0700 | ALLOWED_REGIONS_NON_MEMO | PUBLIC      | N          | N            | N       | 0                 | 0                 | ALLOWED_REGIONS_NON_MEMO() RETURN ARRAY | user-defined function | MEMO_FUNC_TEST | N                 | N                    | N         |         |                             | N                    | SQL      | N             | N              |
---------------------------------+--------------------------+-------------+------------+--------------+---------+-------------------+-------------------+-----------------------------------------+-----------------------+----------------+-------------------+----------------------+-----------+---------+-----------------------------+----------------------+----------+---------------+----------------+