DESCRIBE FUNCTION¶
Descreve a função definida pelo usuário (UDF) ou função externa especificada, incluindo a assinatura (isto é, argumentos), valor de retorno, linguagem e corpo (isto é, definição).
DESCRIBE pode ser abreviado como DESC.
- Consulte também:
DROP FUNCTION , ALTER FUNCTION , CREATE FUNCTION , SHOW USER FUNCTIONS , SHOW EXTERNAL FUNCTIONS
Sintaxe¶
DESC[RIBE] FUNCTION <name> ( [ <arg_data_type> ] [ , ... ] )
Parâmetros¶
nameEspecifica o identificador da função a ser descrita. Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.
arg_data_type [ , ... ]Especifica o tipo de dados do(s) argumento(s), se houver, para a função. Os tipos de dados do argumento são necessários porque as funções oferecem suporte à sobrecarga de nomes (ou seja, duas funções no mesmo esquema podem ter o mesmo nome) e os tipos de dados de argumento são usados para identificar a função.
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.Por exemplo, você pode usar o operador de canal ou a função RESULT_SCAN para selecionar colunas específicas da saída do comando SHOW ou filtrar as linhas.
Quando você fizer referência a colunas de saída, use identificadores entre aspas duplas para os nomes das colunas. Por exemplo, para selecionar a coluna de saída
type, especifiqueSELECT "type".Você deve usar identificadores entre aspas duplas porque os nomes das colunas de saída para os comandos SHOW estão em minúsculas. As aspas duplas garantem que os nomes das colunas na lista SELECT ou na cláusula WHERE correspondam aos nomes das colunas na saída do comando SHOW que foi verificada.
Exemplos¶
Isso demonstra o comando 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 | -----------+----------------------------------+