26.3. 使用 PL/Python #
plpython_function.sql 中有示例函数。你编写的 Python
代码会被转换成一个函数。例如,
CREATE FUNCTION myfunc(text) RETURNS text AS 'return args[0]' LANGUAGE 'plpython';
会被转换成
def __plpython_procedure_myfunc_23456(): return args[0]
其中 23456 是该函数的 Oid。
如果你不提供返回值,Python 返回默认的
None,这可能符合也可能不符合你的需要。语言模块把 Python 的 None 转换成 SQL NULL。
PostgreSQL 的函数变量可以在全局
args 列表中得到。在 myfunc
的例子中,args[0] 包含作为 text
参数传进来的任何内容。对于
myfunc2(text, integer),args[0]
将包含 text 变量,args[1] 包含 integer 变量。
全局字典 SD 可用于在函数调用之间存储数据。这个变量是私有静态数据。全局字典 GD 是公共数据,对一个后端中的所有 python 函数可用。请小心使用。
每个函数在 Python 解释器中得到自己的受限执行对象,因此来自
myfunc 的全局数据和函数参数对
myfunc2 不可用。例外是 GD
字典中的数据,如上所述。
当一个函数被用于触发器时,字典 TD 包含与事务相关的值。触发器元组在 TD["new"]
和/或 TD["old"] 中,取决于触发器事件。TD["event"]
包含作为字符串的事件(INSERT、UPDATE、DELETE 或
UNKNOWN)。TD["when"] 包含(BEFORE、AFTER 或
UNKNOWN)之一。TD["level"] 包含 ROW、STATEMENT 或
UNKNOWN 之一。TD["name"] 包含触发器的名字,TD["relid"]
包含触发器发生所在表的关系 id。如果触发器是带参数调用的,这些参数可以在
TD["args"][0] 到 TD["args"][(n -1)] 中得到。
如果触发器的 “when” 是 BEFORE,你可以从 Python 函数返回 None 或 "OK"
来表示该元组未被修改,"SKIP" 中止该事件,或者 "MODIFIED" 表示你修改了该元组。
PL/Python 语言模块自动导入一个名为
plpy 的 Python 模块。你可以在
Python 代码中以
plpy. 的形式使用这个模块中的函数和常量。目前
fooplpy 实现了函数
plpy.error("msg")、plpy.fatal("msg")、plpy.debug("msg") 和
plpy.notice("msg")。它们大体上等价于调用 elog(,其中 LEVEL, "msg")LEVEL 是 DEBUG、ERROR、FATAL 或 NOTICE。plpy.error 和 plpy.fatal
实际上会引发一个 Python 异常,如果未被捕获,该异常会使
PL/Python 模块在函数处理器从 Python 解释器返回时调用 elog(ERROR, msg)。从
Python 解释器中长跳转出来可能不太好。raise plpy.ERROR("msg") 和 raise
plpy.FATAL("msg") 等价于调用
plpy.error 或 plpy.fatal。
此外,plpy 模块提供两个分别名为
execute 和 prepare 的函数。带一个查询字符串和一个可选的 limit 参数调用 plpy.execute 会运行该查询,并把结果作为一个结果对象返回。结果对象模拟列表或字典对象。结果对象可以按行号和字段名访问。它有这些额外的方法:nrows() 返回查询返回的行数,status 是
SPI_exec 的返回变量。结果对象可以被修改。
rv = plpy.execute("SELECT * FROM my_table", 5)从 my_table 返回最多 5 行。如果 my_table 有一个列 my_field,可以这样访问它:
foo = rv[i]["my_field"]
第二个函数 plpy.prepare 在查询中有绑定变量时用一个查询字符串和一个参数类型列表调用。
plan = plpy.prepare("SELECT last_name FROM my_users WHERE first_name = $1", [ "text" ])
text 是你将作为 $1 传递的变量的类型。准备好之后你用函数 plpy.execute 来运行它。
rv = plpy.execute(plan, [ "name" ], 5)
调用 plpy.execute 时 limit
参数是可选的。
当你用 PL/Python 模块准备一个计划时,它会被自动保存。阅读 SPI 文档(第 21 章)了解这意味着什么。要点是如果你这样做
plan = plpy.prepare("SOME QUERY")
plan = plpy.prepare("SOME OTHER QUERY")你就在泄漏内存,因为我不知道有什么办法释放一个已保存的计划。而使用未保存计划的替代方案(对我来说)更加痛苦。