pxf cluster

Last Updated February 14, 2025

Manage the VMware Tanzu Greenplum platform extension framework (PXF) configuration and the PXF Service instance on all PXF hosts.

Synopsis

pxf cluster <command> [<option>]

where <command> is:

help
migrate
prepare
register
restart
start
status
stop
sync

Description

The pxf cluster utility command manages a default PXF cluster. The default PXF cluster is deployed collocated with the Greenplum cluster, which means the PXF Service instances are deployed on the Greenplum coordinator host, Greenplum standby coordinator host and all Greenplum segment hosts. The default PXF cluster can also be deployed on hosts outside the Greenplum cluster. The utility configures the default PXF cluster according to the default cluster configuration files under $PXF_BASE/clusters/default. For more information about configuring the default PXF cluster, see Configuring PXF. The utility requires that $PXF_HOME and $PXF_BASE both be set. You can use the utility to:

Prepare a new runtime configuration directory $PXF_BASE/clusters/default for the default PXF cluster on the Greenplum coordinator host.
Synchronize the runtime configuration under the directory $PXF_BASE/clusters/default from the Greenplum coordinator host to all hosts in the Greenplum cluster and any external PXF hosts.
Copy the PXF extension control file from the PXF installation to the Greenplum installation on each Greenplum host, and set the Greenplum configuration parameter pxf.pxf_base to be $PXF_BASE after a Greenplum upgrade.
Start, stop, and restart the PXF Service instances on each host in the PXF cluster.
Display the status of the PXF Service instances on each host in the PXF cluster.
Migrate PXF 6 configuration from $PXF_BASE to $PXF_BASE/clusters/default for the default PXF cluster on the Greenplum coordinator host.

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

If you want to manage the PXF Service instance on a specific host, use the pxf utility. For more information, see pxf.

Commands

help

Display the pxf cluster help message and then exit.

migrate

Migrate the configuration from the PXF 6 $PXF_BASE directory to the new nested runtime configuration directory $PXF_BASE/clusters/default used for the default PXF cluster on the Greenplum coordinator host for PXF 7. When you run the command, you must identify the existing PXF 6 $PXF_BASE directory. PXF does an in-place migration from the PXF 6 configuration to the nested $PXF_BASE/clusters/default directory, copying and merging files and directories as necessary.

Note: You must manually migrate any adl-site.xml customizations to the abfss-site.xml file, and any keytab files under $PXF_BASE/keytabs to $PXF_BASE/clusters/default/keytabs for the Greenplum coodfinator host, Greenplum standby coordinator host and each PXF host.

prepare

Prepare a new nested runtime configuration directory $PXF_BASE/clusters/default for the default PXF cluster on the coordinator. When you run the command, you must identify the top level runtime configuration directory via an environment variable named PXF_BASE. PXF copies runtime configuration file templates and directories to the $PXF_BASE/clusters/default directory on the Greenplum coordinator host.

Copy the PXF extension control file from the PXF installation to the Greenplum installation on each Greenplum host, and set the Greenplum configuration parameter pxf.pxf_base to be $PXF_BASE. This command requires that $GPHOME be set. This command is either run after a fresh installation of PXF 7.x or run after you upgrade your Greenplum Database installation.

restart

Stop, and then start, the PXF Service instance on each host in the PXF cluster.

start

Start the PXF Service instance on each host in the PXF cluster.

status

Display the status of the PXF Service instance on each host in the PXF cluster.

stop

Stop the PXF Service instance on each host in the PXF cluster.

sync

Synchronize the runtime configuration under the directory $PXF_BASE/clusters/default from the Greenplum coordinator host to all hosts in the Greenplum cluster as well as all PXF 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 below.

If you have updated the PXF user configuration or add new JAR or native library dependencies, you must also restart PXF after you synchronize the PXF configuration.

Options

The pxf cluster sync command takes the following option:

–d | ––delete

Delete any files in the PXF user configuration on the Greenplum standby coordinator host, Greenplum segment hosts and any external PXF hosts that are not also present on the coordinator host.

The pxf cluster [prepare|register|migrate] commands have detailed output but these output will not be shown by default. Use the following option to enable the detailed output:

–v | ––verbose

Show additional details for the command.

Examples

Stop the PXF Service instance on all PXF hosts:

$ pxf cluster stop

Synchronize the PXF configuration to all hosts in the Greenplum cluster and any external PXF hosts, deleting files that do not exist on the Greenplum coordinator host:

$ pxf cluster sync --delete

Show detailed output when setting the Greenplum parameter configuration pxf.pxf_base to be $PXF_BASE with pxf cluster register:

$ PXF_BASE=$PXF_BASE pxf cluster register --verbose

Tanzu Greenplum Platform Extension Framework 7.0.0-beta.1