Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16

46.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 配置变量控制。有关更多信息,请参见第 20 章

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 节 中描述的内置引用函数。在构建临时查询时它们很有用。来自 示例 43.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)))