2024 年 9 月 26 日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不受支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0

44.9. 实用函数 #

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.errorplpy.fatal 实际上会引发 Python 异常,如果未捕获,则会传播到调用查询,导致当前事务或子事务中止。 raise plpy.Error(msg)raise plpy.Fatal(msg) 等效于分别调用 plpy.error(msg)plpy.fatal(msg),但 raise 形式不允许传递关键字参数。其他函数只生成不同优先级的消息。是否将特定优先级的消息报告给客户端、写入服务器日志或同时进行,由 log_min_messagesclient_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 plpython3u;

=# 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 节 中描述的内置引用函数。它们在构造临时查询时很有用。PL/Python 等效于来自 示例 41.1 的动态 SQL 将是

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

提交更正

如果您在文档中看到任何不正确的内容,与您对特定功能的体验不符,或者需要进一步说明,请使用 此表格 报告文档问题。