DESCRIBE FUNCTION (Snowpark Container Services)

Décrit la fonction de service spécifiée, y compris la signature (arguments), la valeur de retour, la langue et le corps (chemin vers le service Snowpark Container Services).

Voir aussi :

Fonctions de service, CREATE FUNCTION, ALTER FUNCTION, DROP FUNCTION

Syntaxe

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

Paramètres requis

name

Spécifie l’identificateur de la fonction de service à décrire. Si l’identificateur contient des espaces ou des caractères spéciaux, toute la chaîne doit être délimitée par des guillemets doubles. Les identificateurs entre guillemets doubles sont également sensibles à la casse.

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

Spécifie les arguments/entrées de la fonction de service. Ceux-ci doivent correspondre aux arguments attendus par le service.

S’il n’y a pas d’arguments, incluez les parenthèses sans nom d’argument et type de données.

Exigences en matière de contrôle d’accès

Un rôle utilisé pour exécuter cette opération doit au minimum disposer des privilèges suivants :

Privilège

Objet

Remarques

USAGE

Fonctions de service

Operating on an object in a schema requires at least one privilege on the parent database and at least one privilege on the parent schema.

Pour obtenir des instructions sur la création d’un rôle personnalisé avec un ensemble spécifique de privilèges, voir Création de rôles personnalisés.

Pour des informations générales sur les rôles et les privilèges accordés pour effectuer des actions SQL sur des objets sécurisables, voir Aperçu du contrôle d’accès.

Notes sur l’utilisation

  • Pour post-traiter la sortie de cette commande, vous pouvez utiliser la syntaxe opérateur de canal (->>) ou la fonction RESULT_SCAN. Les deux constructions traitent la sortie comme un jeu de résultats que vous pouvez interroger.

    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.

Exemples

Dans Tutoriel-1, vous créez une fonction de service (my_echo_udf). La commande DESC FUNCTION suivante renvoie la description de la fonction de service :

DESC FUNCTION my_echo_udf(VARCHAR);
Copy

Exemple de sortie :

+--------------------+----------------------+
| 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              |
+--------------------+----------------------+