pxf cluster

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

Synopsis

pxf cluster <command> [<option>]

where <command> is:

help
init
register
reset
restart
start
status
stop
sync

Description

The pxf cluster utility command manages PXF on the master, standby master, and on all Greenplum Database segment hosts. You can use the utility to:

  • Initialize PXF configuration on all hosts in the Greenplum Database cluster.
  • Reset the PXF service instance on all hosts to its uninitialized state.
  • Start, stop, and restart the PXF service instance on all segment hosts.
  • Display the status of the PXF service instance on all segment hosts.
  • Synchronize the PXF configuration from the Greenplum Database master host to the standby master and to all segment hosts.
  • Copy the extension files from the PXF installation on each host to the Greenplum installation on the host after a Greenplum upgrade.

pxf cluster requires a running Greenplum Database cluster. You must run the utility on the Greenplum Database master host.

(If you want to manage the PXF service instance on a specific segment host, use the pxf utility. See pxf.)

Commands

help
Display the pxf cluster help message and then exit.

init
Initialize the PXF service instance on the master, standby master, and on all segment hosts. The command also copies the PXF extension files from the PXF installation to the Greenplum installation on each segment host. (Specify the --skip-register option to instruct PXF to skip this initialization step.) When you initialize PXF across your Greenplum Database cluster, 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 returns an error.

register
Copy the PXF extension files from the PXF installation on each 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 on the master, standby master, and on all segment hosts. Resetting removes PXF runtime files and directories, and returns PXF to an uninitialized state. You must stop the PXF service instance running on each segment host before you reset PXF in your Greenplum Database cluster.

restart
Stop, and then start, the PXF service instance on all segment hosts.

start
Start the PXF service instance on all segment hosts.

status
Display the status of the PXF service instance on all segment hosts.

stop
Stop the PXF service instance on all segment hosts.

sync
Synchronize the PXF configuration ($PXF_CONF) from the master to the standby master and to all Greenplum Database segment hosts. 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.
If you have updated the PXF user configuration or added JAR files, you must also restart PXF after you synchronize the PXF configuration.

Options

The pxf cluster init command takes the following option:

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

The pxf cluster sync command takes the following option:

–d | ––delete
Delete any files in the PXF user configuration on the standby master and segment hosts that are not also present on the master host.

Examples

Stop the PXF service instance on all segment hosts:

$ pxf cluster stop

Synchronize the PXF configuration to the standby and all segment hosts, deleting files that do not exist on the master host:

$ pxf cluster sync --delete

See Also

pxf