DESCRIBE FUNCTION

Décrit la fonction définie par l’utilisateur (UDF) spécifiée ou une fonction externe, y compris la signature (c’est-à-dire les arguments), la valeur de retour, la langue et le corps (c’est-à-dire la définition).

DESCRIBE peut être abrégé en DESC.

Voir aussi :

DROP FUNCTION , ALTER FUNCTION , CREATE FUNCTION , SHOW USER FUNCTIONS , SHOW EXTERNAL FUNCTIONS

Syntaxe

DESC[RIBE] FUNCTION <name> ( [ <arg_data_type> ] [ , ... ] )
Copy

Paramètres

name

Spécifie l’identificateur pour la fonction à 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_data_type [ , ... ]

Spécifie le type de données de(s) l’argument(s), le cas échéant, pour la fonction. Les types de données d’arguments sont nécessaires parce que les fonctions prennent en charge le surchargement de nom (plus précisément, deux fonctions dans le même schéma peuvent avoir le même nom) et les types de données d’arguments sont utilisés pour identifier la fonction.

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 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écifiez SELECT "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 commande SHOW qui a été analysée.

Exemples

Ceci démontre la commande DESCRIBE FUNCTION :

DESC FUNCTION multiply(number, number);

-----------+----------------------------------+
 property  |              value               |
-----------+----------------------------------+
 signature | (a NUMBER(38,0), b NUMBER(38,0)) |
 returns   | NUMBER(38,0)                     |
 language  | SQL                              |
 body      | a * b                            |
-----------+----------------------------------+
Copy