Open search page
Hello, I’m DocuDroid!
Open Ask AI page
Submitting feedback
Thank you for rating our AI Search!
We would be grateful if you could share your thoughts so we can improve our AI Search for you and other readers.
GitHub

Overview of the pxf cluster commands

Anton Monakov

The pxf cluster commands are used for collectively managing PXF services on the Greengage DB master host, standby master host, and all segment hosts.

NOTE

To manage individual PXF service instances on specific segment hosts, use the pxf command.

The command’s general syntax is as follows:

$ pxf cluster <command> [<option>]

where <command> is one of the following commands.

Command Description

help

Displays the pxf cluster help message

init

(Deprecated) The command is equivalent to the register command and will be removed in a future PXF release

migrate

Migrates the configuration in a PXF 5 $PXF_CONF directory to $PXF_BASE on each Greengage DB host. When you run the command, you must identify the PXF 5 configuration directory via the PXF_CONF environment variable. PXF migrates the version 5 configuration to $PXF_BASE by copying and merging files and directories as necessary. Note that you must manually migrate any pxf-log4j.properties customizations to the pxf-log4j2.xml file

prepare

Copies runtime configuration file templates and directories to a new $PXF_BASE directory on each Greengage DB host. The directory must be set via the PXF_BASE environment variable

register

Copies the PXF extension control file from the PXF installation directory to the Greengage DB installation directory on the host. This command requires that the GPHOME environment variable is set. It is run once after installing PXF for the first time or upgrading the Greengage DB installation

reset

(Deprecated) The command performs no action and will be removed in a future PXF release

restart

Restarts the PXF service instance on the master host, standby master host, and all segment hosts

reload

Reloads a modified PXF profile or a server configuration to apply the changes and cleans up the affected connection pools.

The command accepts the following options:

  • -p, --profile — the name of the profile to reload thus terminating all active queries using it. The specified profile is reloaded either on the server specified in --server, or, if --server is not specified, on all servers.

  • -s, --server — the name of the server configuration the profile should be reloaded on. The --profile option is mandatory if --server is specified.

  • -a, --auto — if set, the reload action proceeds without user confirmation.

  • -h, --help — displays the help information about pxf cluster reload.

NOTE

If neither --profile nor --server are specified, all PXF profiles are reloaded on all servers.

start

Starts the PXF service instance on the master host, standby master host, and all segment hosts

status

Displays the status of the PXF service instance on the master host, standby master host, and all segment hosts

stop

Stops the PXF service instance on the master host, standby master host, and all segment hosts

sync

Synchronizes the PXF configuration ($PXF_BASE) from the master host to the standby master host and all Greengage DB segment hosts.

By default, this command updates and copies files on the target host. You can instruct PXF to also delete files during the synchronization by using the -d (--delete) option. If the option is specified, any files in the PXF user configuration on the standby master host and segment hosts that are not also present on the master host are deleted.

When updating the PXF user configuration or adding new JAR or native library dependencies, you must restart PXF after synchronizing the configuration
Previous
pxf