pxf

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
register
reset
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 or reset 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.

You can copy the extension files from a PXF installation on the host to the Greenplum installation on the host after a Greenplum upgrade.

(Use the pxf cluster command to copy extension files to, initialize, or reset 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. The command also copies the PXF extension files from the PXF installation to the Greenplum installation on the host. (Specify the --skip-register option to instruct PXF to skip this initialization step.) 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.

register
Copy the PXF extension files from the PXF installation on the host to the Greenplum installation on the host. This command requires that $GPHOME be set, and is typically run after you upgrade your Greenplum Database installation.

reset
Reset the PXF service instance running on the host. Resetting removes PXF runtime files and directories, and returns PXF to an uninitialized state. You must stop the PXF service instance running on a segment host before you reset PXF on the host.

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 ($PXF_CONF) from the master to a specific Greenplum Database standby master or segment host. You must run pxf sync on the master host. By default, this command updates files on and copies files to the remote. You can instruct PXF to also delete files during the synchronization; see Options.

version
Display the PXF version and then exit.

Options

The pxf init command takes the following options:

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

––skip-register
Do not copy the PXF extension files to the Greenplum installation directory on the segment host.

The pxf reset command takes the following option:

–f | ––force
Do not prompt before resetting the PXF service instance; reset without user interaction.

The pxf sync command, which you must run on the Greenplum Database master host, takes the following option and argument:

–d | ––delete
Delete any files in the PXF user configuration on <gphost> that are not also present on the master host. If you specify this option, you must provide it on the command line before <gphost>.

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

Examples

Start the PXF service instance on the local segment host:

$ pxf start

See Also

pxf cluster