在目录中，CREATE MACRO 语句可以创建标量宏或表宏（函数）。宏只能是单个 SELECT 语句（类似于 VIEW），但其优点是可以接受参数。
对于标量宏，CREATE MACRO 后面是宏的名称，以及可选的括号中的参数。接下来是关键字 AS，然后是宏的文本。按设计，标量宏只能返回单个值。对于表宏，语法与标量宏类似，但 AS 被替换为 AS TABLE。表宏可以返回任意大小和形状的表。
如果
MACRO是临时的，它只能在同一个数据库连接中使用，并在连接关闭时被删除。
示例
标量宏
创建一个宏，用于添加两个表达式（a 和 b）
CREATE MACRO add(a, b) AS a + b;
创建一个宏，替换可能存在的定义
CREATE OR REPLACE MACRO add(a, b) AS a + b;
如果宏不存在则创建，否则不做任何操作
CREATE MACRO IF NOT EXISTS add(a, b) AS a + b;
为 CASE 表达式创建宏
CREATE MACRO ifelse(a, b, c) AS CASE WHEN a THEN b ELSE c END;
创建一个执行子查询的宏
CREATE MACRO one() AS (SELECT 1);
宏是依赖于模式的，并且有一个别名 FUNCTION
CREATE FUNCTION main.my_avg(x) AS sum(x) / count(x);
创建带有默认常量参数的宏
CREATE MACRO add_default(a, b := 5) AS a + b;
创建一个宏 arr_append （功能等同于 array_append）
CREATE MACRO arr_append(l, e) AS list_concat(l, list_value(e));
表宏
创建不带参数的表宏
CREATE MACRO static_table() AS TABLE
SELECT 'Hello' AS column1, 'World' AS column2;
创建带参数的表宏（参数可以是任何类型）
CREATE MACRO dynamic_table(col1_value, col2_value) AS TABLE
SELECT col1_value AS column1, col2_value AS column2;
创建一个返回多行的表宏。如果它已经存在，则会被替换，并且它是临时的（连接结束时会自动删除）
CREATE OR REPLACE TEMP MACRO dynamic_table(col1_value, col2_value) AS TABLE
SELECT col1_value AS column1, col2_value AS column2
UNION ALL
SELECT 'Hello' AS col1_value, 456 AS col2_value;
将参数作为列表传递
CREATE MACRO get_users(i) AS TABLE
SELECT * FROM users WHERE uid IN (SELECT unnest(i));
以下是使用 get_users 表宏的示例
CREATE TABLE users AS
SELECT *
FROM (VALUES (1, 'Ada'), (2, 'Bob'), (3, 'Carl'), (4, 'Dan'), (5, 'Eve')) t(uid, name);
SELECT * FROM get_users([1, 5]);
要在任意表上定义宏，请使用 query_table 函数。例如，以下宏计算表的列式校验和
CREATE MACRO checksum(table_name) AS TABLE
SELECT bit_xor(md5_number(COLUMNS(*)::VARCHAR))
FROM query_table(table_name);
CREATE TABLE tbl AS SELECT unnest([42, 43]) AS x, 100 AS y;
SELECT * FROM checksum('tbl');
重载
可以根据宏接受的参数数量来重载宏，这适用于标量宏和表宏。
通过提供重载，我们可以同时拥有具有不同函数体的 add_x(a, b) 和 add_x(a, b, c)。
CREATE MACRO add_x
(a, b) AS a + b,
(a, b, c) AS a + b + c;
SELECT
add_x(21, 42) AS two_args,
add_x(21, 42, 21) AS three_args;
| 两个参数 | 三个参数 |
|---|---|
| 63 | 84 |
语法
宏允许您为表达式组合创建快捷方式。
CREATE MACRO add(a) AS a + b;
Binder Error:
Referenced column "b" not found in FROM clause!
这样可行
CREATE MACRO add(a, b) AS a + b;
使用示例
SELECT add(1, 2) AS x;
| x |
|---|
| 3 |
然而，这会失败
SELECT add('hello', 3);
Binder Error:
Could not choose a best candidate function for the function call "add(STRING_LITERAL, INTEGER_LITERAL)". In order to select one, please add explicit type casts.
Candidate functions:
add(DATE, INTEGER) -> DATE
add(INTEGER, INTEGER) -> INTEGER
宏可以有默认参数。与某些语言不同，默认参数在调用宏时必须指定名称。
b 是一个默认参数
CREATE MACRO add_default(a, b := 5) AS a + b;
以下结果将是 42
SELECT add_default(37);
以下将抛出错误
SELECT add_default(40, 2);
Binder Error:
Macro function 'add_default(a)' requires a single positional argument, but 2 positional arguments were provided.
默认参数必须通过以下方式赋值使用
SELECT add_default(40, b := 2) AS x;
| x |
|---|
| 42 |
然而，以下操作会失败
SELECT add_default(b := 2, 40);
Binder Error:
Positional parameters cannot come after parameters with a default value!
默认参数的顺序无关紧要
CREATE MACRO triple_add(a, b := 5, c := 10) AS a + b + c;
SELECT triple_add(40, c := 1, b := 1) AS x;
| x |
|---|
| 42 |
当使用宏时，它们会被展开（即，替换为原始表达式），并且展开表达式中的参数会被替换为提供的实参。一步一步来
我们上面定义的 add 宏在查询中使用
SELECT add(40, 2) AS x;
在内部，add 被替换为其定义 a + b
SELECT a + b; AS x
然后，参数被提供的实参替换
SELECT 40 + 2 AS x;
限制
使用命名参数
目前，位置宏参数只能按位置使用，而命名参数只能通过提供其名称来使用。因此，以下方法将不起作用
CREATE MACRO my_macro(a, b := 42) AS (a + b);
SELECT my_macro(32, 52);
Binder Error:
Macro function 'my_macro(a)' requires a single positional argument, but 2 positional arguments were provided.
使用子查询宏
如果 MACRO 定义为子查询，则无法在表函数中调用。DuckDB 将返回以下错误
Binder Error:
Table function cannot contain subqueries
重载
宏函数的重载必须在创建时设置，不能在不先删除第一个定义的情况下两次定义同名宏。
递归函数
不支持定义递归函数。例如，以下宏（旨在计算斐波那契数列的第 n 个数）会失败
CREATE OR REPLACE FUNCTION fibo(n) AS (SELECT 1);
CREATE OR REPLACE FUNCTION fibo(n) AS (
CASE
WHEN n <= 1 THEN 1
ELSE fibo(n - 1)
END
);
SELECT fibo(3);
Binder Error:
Max expression depth limit of 1000 exceeded. Use "SET max_expression_depth TO x" to increase the maximum expression depth.