↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发中的版本: 19 / 20devel
已结束支持的版本: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0
历史版本。 PostgreSQL 12 已结束支持。 2024-11-21. 请参阅 当前版本手册.

45.10. 辅助函数 #

plpy 模块还提供以下函数:

plpy.debug(msg, **kwargs)
plpy.log(msg, **kwargs)
plpy.info(msg, **kwargs)
plpy.notice(msg, **kwargs)
plpy.warning(msg, **kwargs)
plpy.error(msg, **kwargs)
plpy.fatal(msg, **kwargs)

plpy.error 和 plpy.fatal 实际上会引发 Python 异常;如果这些异常未被捕获,就会传播到调用查询,导致当前事务或子事务中止。raise plpy.Error(msg) 和 raise plpy.Fatal(msg) 分别等价于调用 plpy.error(msg) 和 plpy.fatal(msg),不过 raise 形式不允许传递关键字参数。其他函数只会生成不同优先级的消息。某一优先级的消息是报告给客户端、写入服务器日志还是两者兼有,由配置变量 log_min_messages 和 client_min_messages 控制。更多信息见第 19 章。

msg 参数作为位置参数给出。为了向后兼容,也可以给出多个位置参数。在这种情况下,这些位置参数所构成元组的字符串表示会成为报告给客户端的消息。

可接受以下仅限关键字的参数:

detail
hint
sqlstate
schema_name
table_name
column_name
datatype_name
constraint_name

作为仅限关键字参数传入的对象,其字符串表示会被用来丰富报告给客户端的消息。例如:

CREATE FUNCTION raise_custom_exception() RETURNS void AS $$
plpy.error("custom exception message",
           detail="some info about exception",
           hint="hint for users")
$$ LANGUAGE plpythonu;

=# SELECT raise_custom_exception();
ERROR:  plpy.Error: custom exception message
DETAIL:  some info about exception
HINT:  hint for users
CONTEXT:  Traceback (most recent call last):
  PL/Python function "raise_custom_exception", line 4, in <module>
    hint="hint for users")
PL/Python function "raise_custom_exception"

另一组辅助函数是 plpy.quote_literal(string)、plpy.quote_nullable(string) 以及 plpy.quote_ident(string)。它们等价于第 9.4 节中描述的内置加引号函数。在构造临时查询时,这些函数很有用。例 42.1 中动态 SQL 的一个 PL/Python 等价写法如下:

plpy.execute("UPDATE tbl SET %s = %s WHERE key = %s" % (
    plpy.quote_ident(colname),
    plpy.quote_nullable(newvalue),
    plpy.quote_literal(keyvalue)))

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.