PXF provides two related commands. Run pxf <command> to act on the local host only, or pxf cluster <command> to run the same action across every host in the cluster over SSH, using the coordinator's PXF_HOME, PXF_BASE, and other environment variables. Use the pxf cluster form for routine cluster administration, covered in Managing the PXF cluster.
Cluster commands
Run these from the coordinator host.
pxf cluster prepare
Creates $PXF_BASE on every host and copies the default configuration templates from $PXF_HOME/conf into it. See Initializing and starting PXF for usage in context.
pxf cluster prepare
pxf cluster register
Installs the PXF extension's control, SQL, and shared library files under $GPHOME on every host. Needed because make install only places these files under $GPHOME on the coordinator. See Installing PXF for usage in context.
pxf cluster register
pxf cluster start
Starts the PXF service on every host. See Starting, stopping, and restarting PXF for usage in context.
pxf cluster start
pxf cluster stop
Stops the PXF service on every host. See Starting, stopping, and restarting PXF for usage in context.
pxf cluster stop
pxf cluster restart
Stops, then starts, the PXF service on every host. See Starting, stopping, and restarting PXF for usage in context.
pxf cluster restart
pxf cluster status
Reports whether the PXF service is both running and responsive on every host. See Monitoring PXF for usage in context.
pxf cluster status
pxf cluster sync
Copies $PXF_BASE/{conf,lib,servers} from the coordinator to every other host. See Applying a configuration change and Relocating $PXF_BASE for usage in context.
pxf cluster sync [options]
| Option | Description |
|---|---|
--delete | Also remove files on the remote hosts that no longer exist on the coordinator. |
Example:
pxf cluster sync --delete
pxf cluster migrate
Migrates configuration from an older PXF installation into a new $PXF_BASE.
pxf cluster migrate
pxf cluster init
(Deprecated) Installs the PXF extension under $GPHOME. Use pxf cluster register instead.
pxf cluster init
pxf cluster reset
(Deprecated) No operation.
pxf cluster reset
Local commands
Run these on a single host to act on that host's PXF instance only.
pxf prepare
Creates $PXF_BASE on the local host and copies the default configuration templates into it. Equivalent to pxf cluster prepare, scoped to this host.
pxf prepare
pxf register
Installs the PXF extension under $GPHOME on the local host. Useful after a WHPG upgrade.
pxf register
pxf start
Starts the local PXF service instance.
pxf start
pxf stop
Stops the local PXF service instance.
pxf stop
pxf restart
Restarts the local PXF service instance.
pxf restart
pxf status
Reports whether the local PXF service instance is running.
pxf status
pxf sync
Copies $PXF_BASE/{conf,lib,servers} from the local host to another host. Unlike pxf cluster sync, you specify the target host explicitly.
pxf sync <hostname> [options]
| Option | Description |
|---|---|
--delete | Also remove files on <hostname> that no longer exist locally. |
Example:
pxf sync sdw3 --delete
pxf migrate
Migrates configuration from an older PXF installation into a new $PXF_BASE on the local host.
pxf migrate
pxf version
Shows the PXF server version.
pxf version
pxf init
(Deprecated) Installs the PXF extension under $GPHOME on the local host. Use pxf register instead.
pxf init
pxf reset
(Deprecated) No operation.
pxf reset