Alias Function
Introductionβ
An alias function refers to assigning an alias name to a function. By registering a new signature for a function or expression fragment in the system, it aims to enhance compatibility or increase convenience.
Alias functions, like other custom functions, support two scopes: LOCAL
and GLOBAL
.
-
LOCAL
: Alias functions are registered under the current database scope. If the alias function needs to be used under other databases, its fully qualified name should be used, i.e.,<Database Name>.<Function Name>
. -
GLOBAL
: Alias functions are registered under the global scope. They can be directly accessed by their function names under any database.
Use Caseβ
Assigning Aliases to Functionsβ
This scenario is common in system migration. When users have existing queries targeting other database systems, there may be functions in these queries that have the same functionality as a function in Doris but different names. In this case, by defining a new alias function for this function, migration can be completed without users noticing any changes.
Simplifying Query Statementsβ
This scenario is often seen in complex analyses. When writing complex query statements, there may be a large number of repetitive expression fragments within a statement or across different statements. By creating an alias function for this complex expression fragment, the query statement can be simplified, enhancing writing convenience and maintainability.
Supported Scopeβ
Expression Requirementsβ
Currently, alias functions require that the root node of the actual expression they point to must be a function expression.
Legal Examples:
-- Create an alias function named func with parameters INT, INT, actually pointing to the expression abs(foo + bar);
CREATE ALIAS FUNCTION func(INT, INT) WITH PARAMETER(foo, bar) AS abs(foo + bar);
-- Create an alias function named func with parameters DATETIMEV2(3), INT, actually pointing to the expression date_trunc(days_sub(foo, bar), 'day')
CREATE ALIAS FUNCTION func(DATETIMEV2(3), INT) WITH PARAMETER (foo, bar) AS date_trunc(days_sub(foo, bar), 'day')
Illegal Example:
-- The root expression is not a function
CREATE ALIAS FUNCTION func(INT, INT) WITH PARAMETER(foo, bar) AS foo + bar;
Parameter Requirementsβ
Currently, alias functions do not support variable-length parameters and must have at least one parameter.
More Contentβ
Apart from alias functions, Doris supports Java UDF and UDTF functionalities. For detailed information, please refer to the documentation Java UDF.