Skip to content

kineticadb/kinetica-udf-api-python

Repository files navigation

Kinetica Logo

Kinetica Python UDF API

Overview

This is the 7.2 version of the server-side Python UDF API for Kinetica. UDFs are server-side programs written in this API and then installed, configured, and initiated through a separate client-side management API. These two APIs are independent of each other and do not need to be written in the same language; e.g., a UDF can be written in the Python UDF API and managed in SQL (from Workbench, KiSQL, or other database client).

The source code for this project can be found at https://github.com/kineticadb/kinetica-udf-api-python

For changes to the client-side API, please refer to CHANGELOG.md.

API

This repository contains the Kinetica Python UDF API solely contained in the kinetica-proc.py file.

This file will be available within the server environment and can be imported into the UDF as follows:

from kinetica_proc import ProcData

Example

This repository also contains several example projects in the examples directory, which implement UDFs in the Python UDF API.

Apache Arrow

The Kinetica Python UDF API supports Apache Arrow natively. A few examples that demonstrate using Apache Arrow with Kinetica are available:

UDF Reference Documentation

For information about UDFs in Kinetica, please see the User-Defined Functions sections of the Kinetica documentation:

Support

For bugs, please submit an issue on Github.

For support, you can post on stackoverflow under the kinetica tag or Slack.

Contact Us