PostgreSQL 8.3.3문서
Prev	Fast Backward	Chapter 40. PL/Python - Python 수속 언어	Fast Forward	Next

40.1. PL/Python 함수

PL/Python로 작성된 함수는 표준의 CREATE FUNCTION 구문으로 선언됩니다.

CREATE FUNCTION 
funcname
 (
argument-list
)
  RETURNS 
return-type

AS $$
  # PL/Python function body
$$ LANGUAGE plpythonu;

함수 본체는 단순한 Python 스크립트입니다. 함수가 불려 가면, 인자는 args[]배열의 요소로서 또, 이름 첨부의 인자는 통상의 변수로서 Python 스크립트에게 건네집니다. 결과는, Python 코드로부터 통상의 방법, return 또는 yield(결과 세트쿼리 경우)로 돌려주어지는 것입니다.

예를 들어, 2개의 정수 중 큰 수를 돌려주는 함수는 이하와 같이 정의할 수가 있습니다.

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입니다.

PostgreSQL함수 매개변수는 args글로벌 리스트로부터 이용 가능합니다. pymax를 예로 하면, args[0]에는 최초의 인자로서 건네받은 것이 포함되어 args[1]에는 2번째의 인자의 값이 포함됩니다. 다른 방법으로서 위의 예와 같게 이름 첨부 매개변수를 사용할 수가 있습니다. 이름 첨부 매개변수를 사용하는 것으로 통상 가독성이 더합니다.

SQL의 NULL값이 함수에 건네지면, 그 인자값은 Python. 그럼 None가 됩니다. 위의 함수 정의에서는, NULL 입력으로는 잘못한 결과가 돌려주어집니다. 함수 정의에 STRICT를 부여해 PostgreSQL를, NULL값가 건네받았을 경우에 그 함수를 호출하지 않고, 자동적으로 단지 NULL 결과를 돌려주는, 보다 이상적인 동작이 가능 합니다. 그 밖에, 함수 본체로 NULL 입력을 검사할 수도 있습니다.

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

위에서 가리킨 것처럼, PL/Python 함수로부터 SQL NULL값을 돌려주려면, None라는 값을 돌려주세요. 함수를 엄밀하게 하거나 하지 않는 경우에서도, 이것을 실시할 수가 있습니다.

복합형의 인자는 Python의 맵으로서 건네받습니다. 맵의 요소명은 복합형의 속성명입니다. 건네받은 행의 속성값이 NULL의 경우, 맵상에서는 None라고 하는 값이 됩니다. 이하에 예를 나타냅니다.

CREATE TABLE employee (
  name text,
  salary integer,
  age integer
);

CREATE FUNCTION overpaid (e employee)
  RETURNS boolean
AS $$
  if e["salary"] > 200000:
    return True
  if (e["age"] < 30) and (e["salary"] > 100000):
    return True
  return False
$$ LANGUAGE plpythonu;

Python 함수로부터 행 또는 복합형을 돌려주는 방법은 복수 존재합니다. 이하의 예에서는

CREATE TYPE named_value AS (
  name   text,
  value  integer
);

복합형의 결과는 이하와 같이 돌려주어집니다.

순서형(튜플 또는 리스트)형태set 는 불가(인 DEC부를 할 수 없기 때문에)

반환되는 시퀀스 객체는, 결과의 복합형이 가지는 필드와 같은 항목수도 같아야합니다. 0이라고 하는 인덱스의 항목이 복합형의 최초의 필드, 1이 다음의 필드, , , 됩니다. 이하에 예를 나타냅니다.

CREATE FUNCTION make_pair (name text, value integer)
  RETURNS named_value
AS $$
  return [ name, value ]
  # or alternatively, as tuple: return ( name, value )
$$ LANGUAGE plpythonu;

임의의 열로 SQL NULL값를 돌려주려면, 대응하는 위치에 None를 삽입합니다

맵(사전)

결과형의 열의 값은, 렬명을 키로서 가지는 맵으로부터 꺼내집니다. 이하에 예를 나타냅니다.

CREATE FUNCTION make_pair (name text, value integer)
  RETURNS named_value
AS $$
  return { "name": name, "value": value }
$$ LANGUAGE plpythonu;

불필요한 사전의 키와 값의 쌍은 무시됩니다. 존재하지 않는 키는 에러로서 다루어집니다. 임의의 열로 SQL NULL를 돌려주기 위해서는, 대응하는 렬명을 키로서 None를 삽입해 주세요.

객체(__getattr__방법을 제공하는 임의의 객체)

이것은 맵과 같이 동작합니다. 이하에 예를 나타냅니다.

CREATE FUNCTION make_pair (name text, value integer)
  RETURNS named_value
AS $$
  class named_value:
    def __init__ (self, n, v):
      self.name = n
      self.value = v
  return named_value(name, value)

  # or simply
  class nv: pass
  nv.name = name
  nv.value = value
  return nv
$$ LANGUAGE plpythonu;

반환값을 준비하고 있지 않는 경우, Python는 기본값의 None를 돌려줍니다. PL/Python는, Python의 None를 SQL의 NULL값로 변환합니다.

또, PL/Python함수는 스칼라 또는 복합형의 집합을 돌려줄 수도 있습니다. 돌려주어지는 객체는 내부적으로 이터레이터(iterator)에 변환되기 때문에, 복수의 실현 방법이 있습니다. 이하의 예에서는, 이하의 복합형이 존재하는 것을 가정합니다.

CREATE TYPE greeting AS (
  how text,
  who text
);

집합이라는 결과는 이하로부터 돌려주어집니다.

순서형(튜플, 리스트, 세트)

CREATE FUNCTION greet (how text)
  RETURNS SETOF greeting
AS $$
  # return tuple containing lists as composite types
  # all other combinations work also
  return ( [ how, "World" ], [ how, "PostgreSQL" ], [ how, "PL/Python" ] )
$$ LANGUAGE plpythonu;

iterator(__iter__방법과 next 방법을 제공하는 임의의 객체)

CREATE FUNCTION greet (how text)
  RETURNS SETOF greeting
AS $$
  class producer:
    def __init__ (self, how, who):
      self.how = how
      self.who = who
      self.ndx = -1

    def __iter__ (self):
      return self

    def next (self):
      self.ndx += 1
      if self.ndx == len(self.who):
        raise StopIteration
      return ( self.how, self.who[self.ndx] )

  return producer(how, [ "World", "PostgreSQL", "PL/Python" ])
$$ LANGUAGE plpythonu;

제네레이터(yield)

CREATE FUNCTION greet (how text)
  RETURNS SETOF greeting
AS $$
  for who in [ "World", "PostgreSQL", "PL/Python" ]:
    yield ( how, who )
$$ LANGUAGE plpythonu;

Warning

현시점에서는, Python bug #1483133이기 때문에, 일부의 Python 2.4 디버그판(--with-pydebug옵션 첨부로 설정/컴파일 된 Python)이, 집합 결과를 돌려주기 위해서 이테레이터를 사용하는 경우에는 PostgreSQL서버를 크래쉬 시키는 것을 알 수 있습니다. 미치값의 Fedora 4에는 이런 불편이 있습니다. Python 운용판이나 패치 적용이 끝난 Fedora 4에서는 이 문제는 일어나지 않습니다.

글로벌인 SD사전은, 함수 호출간의 데이터 보존을 위해 사용할 수가 있습니다. 이 변수는 사적인 정적 데이터입니다. 글로벌인 GD사전은, 공유 데이터이며, 세션내의 모든 Python 함수로 사용할 수가 있습니다. 주의해 사용해 주세요.

각 함수는, Python interpreter내에서 자신의 실행 환경을 입수합니다. 그 때문에, myfunc에 의한 글로벌 데이터와 함수의 인자는myfunc2로부터 사용할 수 없습니다. 상기로 설명한 대로, GD사전 내의 데이터는 예외입니다.

Prev	Home	Next
PL/Python - Python 수속 언어	Up	트리거 함수