Delen via

DESCRIBE FUNCTION

  • Artikel

Van toepassing op:vinkje als ja aan Databricks SQL vinkje als ja aan Databricks Runtime

Retourneert de basismetagegevens van een bestaande functie. De metagegevensinformatie bevat de functienaam, de implementatieklasse en de gebruiksgegevens. Als de optionele EXTENDED optie is opgegeven, worden de basisgegevens van metagegevens samen met de uitgebreide gebruiksgegevens geretourneerd.

Syntaxis

{ DESC | DESCRIBE } FUNCTION [ EXTENDED ] function_name

Parameters

  • function_name

    De naam van een bestaande functie in de metastore. De functienaam kan optioneel worden gespecificeerd met een schema-naam. Als function_name is gekwalificeerd met een schema, wordt de functie afgeleid van de door de gebruiker gespecificeerde schema, anders wordt deze afgeleid van de huidige schema.

Voorbeelden

-- Describe a builtin scalar function.
-- Returns function name, implementing class and usage
> DESCRIBE FUNCTION abs;
 Function: abs
 Class: org.apache.spark.sql.catalyst.expressions.Abs
 Usage: abs(expr) - Returns the absolute value of the numeric value.

-- Describe a builtin scalar function.
-- Returns function name, implementing class and usage and examples.
> DESCRIBE FUNCTION EXTENDED abs;
 Function: abs
 Class: org.apache.spark.sql.catalyst.expressions.Abs
 Usage: abs(expr) - Returns the absolute value of the numeric value.
 Extended Usage:
     Examples:
       > SELECT abs(-1);
        1

-- Describe a builtin aggregate function
> DESCRIBE FUNCTION max;
 Function: max
 Class: org.apache.spark.sql.catalyst.expressions.aggregate.Max
 Usage: max(expr) - Returns the maximum value of `expr`.

-- Describe a builtin user defined aggregate function
-- Returns function name, implementing class and usage and examples.
> DESCRIBE FUNCTION EXTENDED explode;
 Function: explode
 Class: org.apache.spark.sql.catalyst.expressions.Explode
 Usage: explode(expr) - Separates the elements of array `expr`
  into multiple rows, or the elements of map `expr` into
  multiple rows and columns. Unless specified otherwise, use
  the default column name `col` for elements of the array or
  `key` and `value` for the elements of the map.
 Extended Usage:
     Examples:
       > SELECT explode(array(10, 20));
        10
        20

-- Describe a user defined scalar function
> CREATE FUNCTION dice(n INT) RETURNS INT
    NOT DETERMINISTIC
    COMMENT 'An n-sided dice'
    RETURN floor((rand() * n) + 1);

> DESCRIBE FUNCTION EXTENDED dice;
 Function:      default.dice
 Type:          SCALAR
 Input:         n INT
 Returns:       INT
 Comment:       An n-sided dice
 Deterministic: false
 Owner:         user
 Create Time:   Fri Apr 16 10:00:00 PDT 2021
 Body:          floor((rand() * n) + 1)