9.3 9.4 9.5 9.6 10 11 12
问题报告 纠错本页面

45.2. PL/Python 函数

PL/Python 中的函数通过标准的CREATE FUNCTION语法声明:

CREATE FUNCTION funcname (argument-list)
  RETURNS return-type
AS $$
  # PL/Python 函数体
$$ LANGUAGE plpythonu;

函数体就是一个 Python 脚本。当函数被调用时,它的参数被当做列表args的元素传递,命名参数也被作为普通变量传递给 Python 脚本。使用命名参数通常可读性更好。Python 代码会以通常的方式返回结果,即使用return或者yield(在结果集合语句的情况中)。如果没有提供一个返回值,Python 会返回默认的NonePL/Python会把 Python 的None翻译成 SQL 空值。

例如,一个返回两个整数中较大的整数的函数可以定义为:

CREATE FUNCTION pymax (a integer, b integer)
  RETURNS integer
AS $$
  if a > b:
    return a
  return b
$$ LANGUAGE plpythonu;

作为该函数定义给出的 Python 代码会被转换成一个 Python 函数。例如上面的代码会得到:

def __plpython_procedure_pymax_23456():
  if a > b:
    return a
  return b

假定 23456 是PostgreSQL分配给这个函数的 OID。

参数被设置为全局变量。由于 Python 的可见范围规则,这会导致一种后果:在函数内不能把一个参数变量重新赋予给一个涉及该变量名称本身的表达式的值,除非在该代码块中重新声明该变量为全局的。例如,下面的代码无法工作:

CREATE FUNCTION pystrip(x text)
  RETURNS text
AS $$
  x = x.strip()  # 错误
  return x
$$ LANGUAGE plpythonu;

因为对x的赋值让x成为了整个代码块的一个局部变量,并且因此该赋值操作右边的x引用的是一个还未赋值的局部变量x,而不是 PL/Python 函数的参数。通过使用global语句,可以让上面的代码正常工作:

CREATE FUNCTION pystrip(x text)
  RETURNS text
AS $$
  global x
  x = x.strip()  # 现在好了
  return x
$$ LANGUAGE plpythonu;

但是不建议依赖于这类 PL/Python 的实现细节。最好把函数参数当作是只读。