وصف الدالة (SQL ستريك البيانات)

إرجاع معلومات بيانات التعريف الأساسية لدالة موجودة. تتضمن معلومات بيانات التعريف اسم الدالة وفئة التنفيذ وتفاصيل الاستخدام. إذا EXTENDED تم تحديد الخيار الاختياري، يتم إرجاع معلومات بيانات التعريف الأساسية مع معلومات الاستخدام الموسعة.

بناء الجملة

{ DESC | DESCRIBE } FUNCTION [ EXTENDED ] function_name

المعلمات

  • function_name

    اسم دالة موجودة في النظام. قد يكون اسم الدالة مؤهلا بشكل اختياري باستخدام اسم قاعدة بيانات. إذا function_name كان مؤهلا مع قاعدة بيانات ثم يتم حل الدالة من قاعدة بيانات المستخدم المحدد، وإلا فإنه يتم حلها من قاعدة البيانات الحالية.

أمثلة

-- Describe a builtin scalar function.
-- Returns function name, implementing class and usage
> DESC 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.
> DESC 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
> DESC 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.
> DESC 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)