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> ] [ , ... ] )
Paramètres requis¶
nameSpé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 |
Pour effectuer une opération sur un objet dans un schéma, il est nécessaire de disposer d’au moins un privilège sur la base de données parente et d’au moins un privilège sur le schéma parent.
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.Par exemple, vous pouvez utiliser l’opérateur de canal ou la fonction RESULT_SCAN pour sélectionner des colonnes spécifiques à partir de la sortie de la commande SHOW ou pour filtrer les lignes.
Lorsque vous faites référence aux colonnes de sortie, utilisez des identificateurs entre guillemets doubles pour les noms des colonnes. Par exemple, pour sélectionner la colonne de sortie
type, spécifiezSELECT "type".Vous devez utiliser des identificateurs entre guillemets doubles, car les noms des colonnes de sortie pour les commandes SHOW sont en minuscules. Les guillemets doubles garantissent que les noms des colonnes dans la liste SELECT ou dans la clause WHERE correspondent aux noms des colonnes dans la sortie de la commande SHOW qui a été analysée.
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);
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 |
+--------------------+----------------------+