DESCRIBE FUNCTION (Snowpark Container Services)¶

Sintaxe¶

{ DESC | DESCRIBE } FUNCTION [ IF EXISTS ] <name> ( [ <arg_data_type> ] [ , ... ] )

Parâmetros obrigatórios¶

name

Especifica o identificador para a função de serviço a ser descrita. Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Identificadores entre aspas duplas também diferenciam maiúsculas de minúsculas.

( [ arg_name arg_data_type ] [ , ... ] )

Especifica os argumentos/entradas para a função de serviço. Eles devem corresponder aos argumentos que o serviço espera.

Se não houver argumentos, incluir os parênteses sem nome(s) de argumento(s) e tipo(s) de dados.

Requisitos de controle de acesso¶

A função usada para executar essa operação deve ter, no mínimo, os seguintes privilégios:

O privilégio USAGE no banco de dados e no esquema pai é necessário para executar operações em qualquer objeto de um esquema. Observe que uma função com privilégio concedido em um esquema permite que essa função resolva o esquema. Por exemplo, uma função com privilégio CREATE concedido em um esquema pode criar objetos nesse esquema sem também ter USAGE concedido nesse esquema.

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso¶

• Para pós-processar a saída deste comando, você pode usar o operador de canal (->>) ou a função RESULT_SCAN. Ambos os constructos tratam a saída como um conjunto de resultados que você pode consultar.

  For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

  When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

  You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

Exemplos¶

No Tutorial-1, você cria uma função de serviço (my_echo_udf). O comando DESC FUNCTION a seguir retorna a descrição da função de serviço:

DESC FUNCTION my_echo_udf(VARCHAR);

Exemplo de saída:

+--------------------+----------------------+
| property           | value                |
|--------------------+----------------------|
| signature          | (INPUTTEXT VARCHAR)  |
| returns            | VARCHAR              |
| language           | NULL                 |
| null handling      | CALLED ON NULL INPUT |
| volatility         | VOLATILE             |
| body               | /echo                |
| headers            | null                 |
| context_headers    | null                 |
| max_batch_rows     | not set              |
| service            | ECHO_SERVICE         |
| service_endpoint   | echoendpoint         |
| max_batch_retries  | 3                    |
| on_batch_failure   | ABORT                |
| batch_timeout_secs | not set              |
+--------------------+----------------------+