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 (deprecated)
migrate
prepare
register
reset (deprecated)
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 use the utility to:

  • Synchronize the PXF configuration from the master to the standby master or to a segment host.
  • Start, stop, or restart the PXF Service instance on the master, standby master, or a specific segment host, or display the status of the PXF Service instance running on the master, standby master, or a segment host.
  • Copy the PXF extension control file from a PXF installation on the host to the Greenplum installation on the host after a Greenplum upgrade.
  • Prepare a new $PXF_BASE runtime configuration directory on the host.

(Use the pxf cluster command to prepare a new $PXF_BASE on all hosts, copy the PXF extension control file to $GPHOME 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 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 (deprecated)
The command is equivalent to the register command.

migrate
Migrate the configuration in a PXF 5 $PXF_CONF directory to $PXF_BASE on the host. When you run the command, you must identify the PXF 5 configuration directory via an environment variable named PXF_CONF. PXF migrates the version 5 configuration to the current $PXF_BASE, copying and merging files and directories as necessary.
You must manually migrate any pxf-log4j.properties customizations to the pxf-log4j2.xml file.

prepare
Prepare a new $PXF_BASE directory on the host. When you run the command, you must identify the new PXF runtime configuration directory via an environment variable named PXF_BASE. PXF copies runtime configuration file templates and directories to this $PXF_BASE.

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 run once after you install PXF 6.x the first time, or run when you upgrade your Greenplum Database installation.

reset (deprecated)
The command is a no-op.

restart
Restart the PXF Service instance running on the local master, standby master, or segment host.

start
Start the PXF Service instance on the local master, standby master, or segment host.

status
Display the status of the PXF Service instance running on the local master, standby master, or segment host.

stop
Stop the PXF Service instance running on the local master, standby master, or segment host.

sync
Synchronize the PXF configuration ($PXF_BASE) 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 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 Greenplum host:

$ pxf start

See Also

pxf cluster