Using the PXF Java SDK

A newer version of this documentation is available. Use the version menu above to view the most up-to-date release of the Greenplum 5.x documentation.

The Greenplum Platform Extension Framework (PXF) SDK provides the Java classes and interfaces that you use to create connectors to new external data sources, data formats, and data access APIs from Greenplum Database. You can extend PXF functionality without changing Greenplum Database when you use the PXF Java SDK.

PXF in Greenplum Database has its roots in the Apache HAWQ project. You can contribute to Greenplum PXF development via the open source github repositories for PXF Server Plugins and the Greenplum PXF Extension/Client.

Topic Overview

Topics in this guide include:

  • PXF Developer Concepts

    This topic introduces important concepts for PXF developers including external tables, connectors, and plug-ins, and how PXF uses these entities within Greenplum Database to access external data sources.

  • Introducing the PXF API

    This topic introduces the PXF API.

  • Building a Connector

    This topic describes the process to build a connector. This topic also introduces the Demo connector, an example PXF connector to the local file system, and includes an exercise to build this connector.

  • Deploying a Connector

    This topic describes the process required to register and deploy a connector to a Greenplum Database cluster. It also includes an exercise to deploy the Demo connector and verify that the connector was deployed successfully.