Greenplum PL/Python Language Extension

    Parent topic: Greenplum Database Reference Guide

    PL/Python is a loadable procedural language. With the Greenplum Database PL/Python extension, you can write a Greenplum Database user-defined functions in Python that take advantage of Python features and modules to quickly build robust database applications.

    You can run PL/Python code blocks as anonymous code blocks. See the DO command in the Greenplum Database Reference Guide.

    The Greenplum Database PL/Python extension is installed by default with Greenplum Database. Greenplum Database installs a version of Python and PL/Python. This is location of the Python installation that Greenplum Database uses:

    • Greenplum Database does not support PL/Python triggers.
    • PL/Python is available only as a Greenplum Database untrusted language.
    • Updatable cursors ( and DELETE...WHERE CURRENT OF) are not supported.

    Enabling and Removing PL/Python support

    The PL/Python language is installed with Greenplum Database. To create and run a PL/Python user-defined function (UDF) in a database, you must register the PL/Python language with the database.

    Enabling PL/Python Support

    For each database that requires its use, register the PL/Python language with the SQL command CREATE LANGUAGE or the Greenplum Database utility createlang. Because PL/Python is an untrusted language, only superusers can register PL/Python with a database. For example, running this command as the gpadmin system user registers PL/Python with the database named testdb:

    1. $ createlang plpythonu -d testdb

    PL/Python is registered as an untrusted language.

    Removing PL/Python Support

    For a database that no longer requires the PL/Python language, remove support for PL/Python with the SQL command DROP LANGUAGE or the Greenplum Database droplang utility. Because PL/Python is an untrusted language, only superusers can remove support for the PL/Python language from a database. For example, running this command as the gpadmin system user removes support for PL/Python from the database named testdb:

    1. $ droplang plpythonu -d testdb

    When you remove support for PL/Python, the PL/Python user-defined functions that you created in the database will no longer work.

    The body of a PL/Python user-defined function is a Python script. When the function is called, its arguments are passed as elements of the array args[]. Named arguments are also passed as ordinary variables to the Python script. The result is returned from the PL/Python function with return statement, or yield statement in case of a result-set statement.

    PL/Python translates Python’s None into the SQL null value

    Data Type Mapping

    The Greenplum to Python data type mapping follows.

    1 When the UDF return type is boolean, the Greenplum Database evaluates the return value for truth according to Python rules. That is, 0 and empty string are false, but notably 'f' is true.

    Example:

    1. CREATE OR REPLACE FUNCTION pybool_func(a int) RETURNS boolean AS $$
    2. # container: plc_python3_shared
    3.     if (a > 0):
    4.         return True
    5.     else:
    6.         return False
    7. $$ LANGUAGE plcontainer;
    9. SELECT pybool_func(-1);
    11.  pybool_func
    12. -------------
    13.  f
    14. (1 row)

    Arrays and Lists

    You pass SQL array values into PL/Python functions with a Python list. Similarly, PL/Python functions return SQL array values as a Python list. In the typical PL/Python usage pattern, you will specify an array with [].

    The following example creates a PL/Python function that returns an array of integers:

    1. CREATE FUNCTION return_py_int_array()
    2.   RETURNS int[]
    3. AS $$
    4.   return [1, 11, 21, 31]
    5. $$ LANGUAGE plpythonu;
    7. SELECT return_py_int_array();
    8.  return_py_int_array 
    9. ---------------------
    10.  {1,11,21,31}
    11. (1 row)

    PL/Python treats multi-dimensional arrays as lists of lists. You pass a multi-dimensional array to a PL/Python function using nested Python lists. When a PL/Python function returns a multi-dimensional array, the inner lists at each level must all be of the same size.

    The following example creates a PL/Python function that takes a multi-dimensional array of integers as input. The function displays the type of the provided argument, and returns the multi-dimensional array:

    1. CREATE FUNCTION return_multidim_py_array(x int4[]) 
    2.   RETURNS int4[]
    3. AS $$
    4.   plpy.info(x, type(x))
    5.   return x
    6. $$ LANGUAGE plpythonu;
    8. SELECT * FROM return_multidim_py_array(ARRAY[[1,2,3], [4,5,6]]);
    9. INFO:  ([[1, 2, 3], [4, 5, 6]], <type 'list'>)
    10. CONTEXT:  PL/Python function "return_multidim_py_type"
    11.  return_multidim_py_array 
    12. --------------------------
    13.  {{1,2,3},{4,5,6}}
    14. (1 row)

    PL/Python also accepts other Python sequences, such as tuples, as function arguments for backwards compatibility with Greenplum versions where multi-dimensional arrays were not supported. In such cases, the Python sequences are always treated as one-dimensional arrays because they are ambiguous with composite types.

    You pass composite-type arguments to a PL/Python function using Python mappings. The element names of the mapping are the attribute names of the composite types. If an attribute has the null value, its mapping value is None.

    You can return a composite type result as a sequence type (tuple or list). You must specify a composite type as a tuple, rather than a list, when it is used in a multi-dimensional array. You cannot return an array of composite types as a list because it would be ambiguous to determine whether the list represents a composite type or another array dimension. In the typical usage pattern, you will specify composite type tuples with ().

    In the following example, you create a composite type and a PL/Python function that returns an array of the composite type:

    1. CREATE TYPE type_record AS (
    2.   first text,
    3. );
    5. CREATE FUNCTION composite_type_as_list()
    6.   RETURNS type_record[]
    7. AS $$              
    8.   return [[('first', 1), ('second', 1)], [('first', 2), ('second', 2)], [('first', 3), ('second', 3)]];
    9. $$ LANGUAGE plpythonu;
    11. SELECT * FROM composite_type_as_list();
    12.                                composite_type_as_list                           
    13. ------------------------------------------------------------------------------------
    14.  {{"(first,1)","(second,1)"},{"(first,2)","(second,2)"},{"(first,3)","(second,3)"}}
    15. (1 row)

    Refer to the PostgreSQL documentation for additional information on PL/Python handling of arrays and composite types.

    Set-Returning Functions

    A Python function can return a set of scalar or composite types from any sequence type (for example: tuple, list, set).

    In the following example, you create a composite type and a Python function that returns a SETOF of the composite type:

    1. CREATE TYPE greeting AS (
    2.   how text,
    3.   who text
    4. );
    6. CREATE FUNCTION greet (how text)
    7.   RETURNS SETOF greeting
    8. AS $$
    9.   # return tuple containing lists as composite types
    10.   # all other combinations work also
    11.   return ( {"how": how, "who": "World"}, {"how": how, "who": "Greenplum"} )
    12. $$ LANGUAGE plpythonu;
    14. select greet('hello');
    15.        greet
    16. -------------------
    17.  (hello,World)
    18.  (hello,Greenplum)

    Executing and Preparing SQL Queries

    The PL/Python plpy module provides two Python functions to execute an SQL query and prepare an execution plan for a query, plpy.execute and plpy.prepare. Preparing the execution plan for a query is useful if you run the query from multiple Python functions.

    PL/Python also supports the plpy.subtransaction() function to help manage plpy.execute calls in an explicit subtransaction. See Explicit Subtransactions in the PostgreSQL documentation for additional information about plpy.subtransaction().

    plpy.execute

    Calling plpy.execute with a query string and an optional limit argument causes the query to be run and the result to be returned in a Python result object. The result object emulates a list or dictionary object. The rows returned in the result object can be accessed by row number and column name. The result set row numbering starts with 0 (zero). The result object can be modified. The result object has these additional methods:

    • nrows that returns the number of rows returned by the query.
    • status which is the SPI_execute() return value.

    For example, this Python statement in a PL/Python user-defined function executes a query.

    1. rv = plpy.execute("SELECT * FROM my_table", 5)
    1. my_col_data = rv[i]["my_column"]

    Since the function returns a maximum of 5 rows, the index i can be an integer between 0 and 4.

    plpy.prepare

    The function plpy.prepare prepares the execution plan for a query. It is called with a query string and a list of parameter types, if you have parameter references in the query. For example, this statement can be in a PL/Python user-defined function:

    1. plan = plpy.prepare("SELECT last_name FROM my_users WHERE 
    2.   first_name = $1", [ "text" ])

    The string text is the data type of the variable that is passed for the variable $1. After preparing a statement, you use the function plpy.execute to run it:

    1. rv = plpy.execute(plan, [ "Fred" ], 5)

    The third argument is the limit for the number of rows returned and is optional.

    When you prepare an execution plan using the PL/Python module the plan is automatically saved. See the Postgres Server Programming Interface (SPI) documentation for information about the execution plans .

    To make effective use of saved plans across function calls you use one of the Python persistent storage dictionaries SD or GD.

    The global dictionary SD is available to store data between function calls. This variable is private static data. The global dictionary GD is public data, available to all Python functions within a session. Use GD with care.

    Each function gets its own execution environment in the Python interpreter, so that global data and function arguments from myfunc are not available to myfunc2. The exception is the data in the GD dictionary, as mentioned previously.

    This example uses the SD dictionary:

    Handling Python Errors and Messages

    The Python module plpy implements these functions to manage errors and messages:

    • plpy.debug
    • plpy.log
    • plpy.info
    • plpy.notice
    • plpy.warning
    • plpy.error
    • plpy.fatal
    • plpy.debug

    The message functions plpy.error and plpy.fatal raise a Python exception which, if uncaught, propagates out to the calling query, causing the current transaction or subtransaction to be aborted. The functions raise plpy.ERROR(msg) and raise plpy.FATAL(msg) are equivalent to calling plpy.error and plpy.fatal, respectively. The other message functions only generate messages of different priority levels.

    Whether messages of a particular priority are reported to the client, written to the server log, or both is controlled by the Greenplum Database server configuration parameters log_min_messages and client_min_messages. For information about the parameters see the Greenplum Database Reference Guide.

    Using the dictionary GD To Improve PL/Python Performance

    In terms of performance, importing a Python module is an expensive operation and can affect performance. If you are importing the same module frequently, you can use Python global variables to load the module on the first invocation and not require importing the module on subsequent calls. The following PL/Python function uses the GD persistent storage dictionary to avoid importing a module if it has already been imported and is in the GD.

    1. psql=#
    2.    CREATE FUNCTION pytest() returns text as $$ 
    3.       if 'mymodule' not in GD:
    4.         import mymodule
    5.         GD['mymodule'] = mymodule
    6.     return GD['mymodule'].sumd([1,2,3])
    7. $$;

    Installing Python Modules

    When you install a Python module on Greenplum Database, the Greenplum Database Python environment must have the module added to it across all segment hosts and mirror hosts in the cluster. When expanding Greenplum Database, you must add the Python modules to the new segment hosts. You can use the Greenplum Database utilities gpssh and gpscp run commands on Greenplum Database hosts and copy files to the hosts. For information about the utilities, see the Greenplum Database Utility Guide.

    As part of the Greenplum Database installation, the gpadmin user environment is configured to use Python that is installed with Greenplum Database.

    To check the Python environment, you can use the which command:

    1. which python

    The command returns the location of the Python installation. The Python installed with Greenplum Database is in the Greenplum Database ext/python directory.

    1. /<path_to_greenplum-db>/ext/python/bin/python

    When running shell commands on remote hosts with gpssh, you can specify the -s option. When the option is specified, gpssh sources the greenplum_path.sh file before running commands on the remote hosts. For example, this command should display the Python installed with Greenplum Database on each host.

    1. gpssh -f gpdb_hosts which python

    If it does not, you can add the -s to source greenplum_path.sh on the remote hosts before running the command.

    1. gpssh -s -f gpdb_hosts which python

    To display the list of currently installed Python modules, run this command.

    1. python -c "help('modules')"

    Run gpssh in interactive mode to display Python modules on remote hosts. This example starts gpssh in interactive mode and lists the Python modules on the Greenplum Database host sdw1.

    1. $ gpssh -s -h sdw1
    2. => python -c "help('modules')"
    3. . . . 
    4. => exit
    5. $

    Greenplum Database provides a collection of data science-related Python libraries that can be used with the Greenplum Database PL/Python language. You can download these libraries in .gppkg format from . For information about the libraries, see Python Data Science Module Package.

    These sections describe installing and testing Python modules:

    The Python utility pip installs Python packages that contain Python modules and other resource files from versioned archive files.

    Run this command to install pip.

    1. python -m ensurepip --default-pip

    The command runs the ensurepip module to bootstrap (install and configure) the pip utility from the local Python installation.

    You can run this command to ensure the pip, setuptools and wheel projects are current. Current Python projects ensure that you can install Python packages from source distributions or pre-built distributions (wheels).

    1. python -m pip install --upgrade pip setuptools wheel

    You can use gpssh to run the commands on the Greenplum Database hosts. This example runs gpssh in interactive mode to install pip on the hosts listed in the file gpdb_hosts.

    1. $ gpssh -s -f gpdb_hosts
    2. => python -m ensurepip --default-pip
    3. [centos6-mdw1] Ignoring indexes: https://pypi.python.org/simple
    4. [centos6-mdw1] Collecting setuptools
    5. [centos6-mdw1] Collecting pip
    6. [centos6-mdw1] Successfully installed pip-8.1.1 setuptools-20.10.1
    7. [centos6-sdw1] Ignoring indexes: https://pypi.python.org/simple
    8. [centos6-sdw1] Collecting setuptools
    9. [centos6-sdw1] Collecting pip
    10. [centos6-sdw1] Installing collected packages: setuptools, pip
    12. => exit
    13. $

    The => is the inactive prompt for gpssh. The utility displays the output from each host. The exit command exits from gpssh interactive mode.

    1. gpssh -s -f gpdb_hosts python -m pip install --upgrade pip setuptools wheel

    The utility displays the output from each host.

    For more information about installing Python packages, see https://packaging.python.org/tutorials/installing-packages/.

    Installing Python Packages with pip

    After installing pip, you can install Python packages. This command installs the numpy and scipy packages.

    The --user option attempts to avoid conflicts when installing Python packages.

    You can use gpssh to run the command on the Greenplum Database hosts.

    For information about these and other Python packages, see References.

    Building and Installing Python Modules Locally

    If you are building a Python module, you must ensure that the build creates the correct executable. For example on a Linux system, the build should create a 64-bit executable.

    Before building a Python module to be installed, ensure that the appropriate software to build the module is installed and properly configured. The build environment is required only on the host where you build the module.

    You can use the Greenplum Database utilities gpssh and gpscp to run commands on Greenplum Database hosts and to copy files to the hosts.

    Testing Installed Python Modules

    You can create a simple PL/Python user-defined function (UDF) to validate that Python a module is available in the Greenplum Database. This example tests the NumPy module.

    This PL/Python UDF imports the NumPy module. The function returns SUCCESS if the module is imported, and FAILURE if an import error occurs.

    1. CREATE OR REPLACE FUNCTION plpy_test(x int)
    2. returns text
    3. as $$
    4.   try:
    5.       from numpy import *
    6.       return 'SUCCESS'
    7.   except ImportError, e:
    8.       return 'FAILURE'
    9. $$ language plpythonu;

    Create a table that contains data on each Greenplum Database segment instance. Depending on the size of your Greenplum Database installation, you might need to generate more data to ensure data is distributed to all segment instances.

    1. CREATE TABLE DIST AS (SELECT x FROM generate_series(1,50) x ) DISTRIBUTED RANDOMLY ;

    This SELECT command runs the UDF on the segment hosts where data is stored in the primary segment instances.

    1. SELECT gp_segment_id, plpy_test(x) AS status
    2.   FROM dist
    3.   GROUP BY gp_segment_id, status
    4.   ORDER BY gp_segment_id, status;

    The SELECT command returns SUCCESS if the UDF imported the Python module on the Greenplum Database segment instance. If the SELECT command returns FAILURE, you can find the segment host of the segment instance host. The Greenplum Database system table gp_segment_configuration contains information about mirroring and segment configuration. This command returns the host name for a segment ID.

    1. SELECT hostname, content AS seg_ID FROM gp_segment_configuration
    2.   WHERE content = <seg_id> ;

    If FAILURE is returned, these are some possible causes:

    • A problem accessing required libraries. For the NumPy example, a Greenplum Database might have a problem accessing the OpenBLAS libraries or the Python libraries on a segment host.

      Make sure you get no errors when running command on the segment host as the gpadmin user. This gpssh command tests importing the numpy module on the segment host mdw1.

      1. gpssh -s -h mdw1 python -c "import numpy"

    • If the Python import command does not return an error, environment variables might not be configured in the Greenplum Database environment. For example, the Greenplum Database might not have been restarted after installing the Python Package on the host system.

    This PL/Python UDF returns the maximum of two integers:

    1. CREATE FUNCTION pymax (a integer, b integer)
    2.   RETURNS integer
    3. AS $$
    4.   if (a is None) or (b is None):
    5.       return None
    6.   if a > b:
    7.      return a
    8.   return b
    9. $$ LANGUAGE plpythonu;

    You can use the STRICT property to perform the null handling instead of using the two conditional statements.

    1. CREATE FUNCTION pymax (a integer, b integer) 
    2.   RETURNS integer AS $$ 
    3. return max(a,b) 
    4. $$ LANGUAGE plpythonu STRICT ;

    You can run the user-defined function pymax with SELECT command. This example runs the UDF and shows the output.

    1. SELECT ( pymax(123, 43));
    2. column1
    3. ---------
    4.      123
    5. (1 row)

    This example that returns data from an SQL query that is run against a table. These two commands create a simple table and add data to the table.

    1. CREATE TABLE sales (id int, year int, qtr int, day int, region text)
    2.   DISTRIBUTED BY (id) ;
    4. INSERT INTO sales VALUES
    5.  (1, 2014, 1,1, 'usa'),
    6.  (2, 2002, 2,2, 'europe'),
    7.  (3, 2014, 3,3, 'asia'),
    8.  (4, 2014, 4,4, 'usa'),
    9.  (5, 2014, 1,5, 'europe'),
    10.  (6, 2014, 2,6, 'asia'),
    11.  (7, 2002, 3,7, 'usa') ;

    This PL/Python UDF executes a SELECT command that returns 5 rows from the table. The Python function returns the REGION value from the row specified by the input value. In the Python function, the row numbering starts from 0. Valid input for the function is an integer between 0 and 4.

    1. CREATE OR REPLACE FUNCTION mypytest(a integer) 
    2.   RETURNS text 
    3. AS $$ 
    4.   rv = plpy.execute("SELECT * FROM sales ORDER BY id", 5)
    5.   region = rv[a]["region"]
    6.   return region
    7. $$ language plpythonu;

    Running this SELECT statement returns the REGION column value from the third row of the result set.

    1. SELECT mypytest(2) ;

    This command deletes the UDF from the database.

    This example executes the PL/Python function in the previous example as an anonymous block with the DO command. In the example, the anonymous block retrieves the input value from a temporary table.

    1. CREATE TEMP TABLE mytemp AS VALUES (2) DISTRIBUTED RANDOMLY;
    3. DO $$ 
    4.   temprow = plpy.execute("SELECT * FROM mytemp", 1)
    5.   myval = temprow[0]["column1"]
    6.   rv = plpy.execute("SELECT * FROM sales ORDER BY id", 5)
    7.   region = rv[myval]["region"]
    9. $$ language plpythonu;

    References

    Technical References

    For information about the Python language, see https://www.python.org/.

    For information about PL/Python see the PostgreSQL documentation at .

    For information about Python Package Index (PyPI), see https://pypi.python.org/pypi.

    • SciPy library provides user-friendly and efficient numerical routines such as routines for numerical integration and optimization. The SciPy site includes other similar Python libraries .