pxf

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.

Manage the PXF configuration and the PXF service instance on the local Greenplum Database host.

Synopsis

pxf <command> [<option>]

where <command> is:

cluster
help
init
restart
start
status
stop
sync
version

Description

The pxf utility manages the PXF configuration and the PXF service instance on the local Greenplum Database host.

You can initialize PXF on the master, master standby, or a specific segment host. You can also synchronize the PXF configuration from the master to these hosts.

You can start, stop, or restart the PXF service instance on a specific segment host, or display the status of the PXF service instance running on a segment host.

(Use the pxf cluster command to initialize PXF on all hosts, synchronize the PXF configuration to the Greenplum Database cluster, or to start, stop, or display the status of the PXF service instance on all segment hosts in the cluster.)

Commands

cluster
Manage the PXF configuration and the PXF service instance on all Greenplum Database hosts. See pxf cluster.

help
Display the pxf management utility help message and then exit.

init
Initialize the PXF service instance on the host. When you initialize PXF, you must identify the PXF user configuration directory via an environment variable named $PXF_CONF. If you do not set $PXF_CONF prior to initializing PXF, PXF prompts you to accept or decline the default user configuration directory, $HOME/pxf, during the initialization process. See Options.

restart
Restart the PXF service instance running on the segment host.

start
Start the PXF service instance on the segment host.

status
Display the status of the PXF service instance running on the segment host.

stop
Stop the PXF service instance running on the segment host.

sync
Synchronize the PXF configuration from the master to a specific Greenplum Database standby master or segment host. You must run pxf sync on the master host. See Options.

version
Display the PXF version and then exit.

Options

The pxf init command takes the following option:

-y
Do not prompt, use the default $PXF_CONF directory location if the environment variable is not set.

The pxf sync command, run on the Greenplum Database master host, takes the following option:

<gphost>
The Greenplum Database host to which to synchronize the PXF configuration. <gphost> must identify the standy master host or a segment host.

Examples

Start the PXF service instance on the local segment host:

$ $GPHOME/pxf/bin/pxf start

See Also

pxf cluster