pxf cluster

Manage the PXF configuration and the PXF Service instance on all SynxDB hosts.

Synopsis

pxf cluster <command> [<option>]

where <command> is:

help
init (deprecated)
migrate
prepare
register
reset (deprecated)
restart
start
status
stop
sync

Description

The pxf cluster utility command manages PXF on the coordinator host, standby coordinator host, and on all SynxDB segment hosts. You can use the utility to:

  • Start, stop, and restart the PXF Service instance on the coordinator host, standby coordinator host, and all segment hosts.
  • Display the status of the PXF Service instance on the coordinator host, standby coordinator host, and all segment hosts.
  • Synchronize the PXF configuration from the SynxDB coordinator host to the standby coordinator and to all segment hosts.
  • Copy the PXF extension control file from the PXF installation on each host to the SynxDB installation on the host after a SynxDB upgrade.
  • Prepare a new $PXF_BASE runtime configuration directory.
  • Migrate PXF 5 $PXF_CONF configuration to $PXF_BASE.

pxf cluster requires a running SynxDB cluster. You must run the utility on the SynxDB coordinator 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 (deprecated)
The command is equivalent to the register command.
migrate
Migrate the configuration in a PXF 5 $PXF_CONF directory to $PXF_BASE on each SynxDB 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 $PXF_BASE, copying and merging files and directories as necessary.
Note: You must manually migrate any pxf-log4j.properties customizations to the pxf-log4j2.xml file.
prepare
Prepare a new $PXF_BASE directory on each SynxDB 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 control file from the PXF installation on each host to the SynxDB 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 after you upgrade your SynxDB installation.
reset (deprecated)
The command is a no-op.
restart
Stop, and then start, the PXF Service instance on the coordinator host, standby coordinator host, and all segment hosts.
start
Start the PXF Service instance on the coordinator host, standby coordinator host, and all segment hosts.
status
Display the status of the PXF Service instance on the coordinator host, standby coordinator host, and all segment hosts.
stop
Stop the PXF Service instance on the coordinator host, standby coordinator host, and all segment hosts.
sync
Synchronize the PXF configuration ($PXF_BASE) from the coordinator host to the standby coordinator host and to all SynxDB 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 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 standby coordinator host and segment hosts that are not also present on the coordinator host.

Examples

Stop the PXF Service instance on the coordinator host, standby coordinator host, and all segment hosts:

$ pxf cluster stop

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

$ pxf cluster sync --delete

See Also

pxf