Overview of the pxf commands

Anton Monakov

The pxf commands are used for managing the PXF configuration and the PXF service instance on a Greengage DB host.

The command’s general syntax is as follows:

$ pxf <command> [<option>]

where <command> is one of the following commands.

Command Description

Command	Description
help	Displays the `pxf` help message
cluster	Manages the PXF configuration and the PXF service instance on all Greengage DB hosts. See pxf cluster for details
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 files from the PXF installation catalog to the Greengage DB installation catalog 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 instance
reset	(Deprecated) The command performs no action and will be removed in a future PXF release
restart	Restarts the PXF service instance on the current host
start	Starts the PXF service instance on the current host
status	Displays the status of the PXF service instance on the current host. Use the `-p` (`--process`) option to only check if the PXF service instance is running, not that it is responsive
stop	Stops the PXF service instance on the current host
sync <gphost>	Synchronizes the PXF configuration ($PXF_BASE) from the master host to a specific Greengage DB host. The command must be run on the master host. It is required to specify the `<gphost>` value that identifies a secondary master host or a segment host. 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
encrypt <password> <encryptor_type>	Encrypts the provided password (`<password>`) using the specified encryptor type (`<encryptor_type>`), `aes256` by default. For the command to work, you need to provide the encryption library JAR file in the $PXF_BASE/lib directory and set the `pxf.ssl.jks-store.path`, the `pxf.ssl.jks-store.password`, and the `pxf.ssl.salt.key` properties in the pxf-application.properties configuration file. These properties can be overridden by using the corresponding `-jksPath`, `-jksPassword`, and `-jksEncryptKeyAlias` command options. The command accepts the following options: `-command <command_type>` — the command type, `encrypt` or `decrypt`. `-message` — the password for encryption. `-encryptionKey` — the encryption key. `-encryptorType` — the encryptor type, `aes256` by default. `-jksEncryptKeyAlias` — the Java keystore encryption key alias. `-jksPassword` — the Java keystore password. `-jksPath` — the Java keystore path. The resulting encrypted string can be then used as the `jdbc.password` value in the JDBC server configuration file
version	Displays the PXF version

help

Displays the pxf help message

cluster

Manages the PXF configuration and the PXF service instance on all Greengage DB hosts. See pxf cluster for details

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

Copies the PXF extension files from the PXF installation catalog to the Greengage DB installation catalog 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 instance

reset

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

restart

Restarts the PXF service instance on the current host

start

Starts the PXF service instance on the current host

status

Displays the status of the PXF service instance on the current host. Use the -p (--process) option to only check if the PXF service instance is running, not that it is responsive

stop

Stops the PXF service instance on the current host

sync <gphost>

Synchronizes the PXF configuration ($PXF_BASE) from the master host to a specific Greengage DB host. The command must be run on the master host. It is required to specify the <gphost> value that identifies a secondary master host or a segment host.

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

encrypt <password> <encryptor_type>

Encrypts the provided password (<password>) using the specified encryptor type (<encryptor_type>), aes256 by default. For the command to work, you need to provide the encryption library JAR file in the $PXF_BASE/lib directory and set the pxf.ssl.jks-store.path, the pxf.ssl.jks-store.password, and the pxf.ssl.salt.key properties in the pxf-application.properties configuration file. These properties can be overridden by using the corresponding -jksPath, -jksPassword, and -jksEncryptKeyAlias command options.

The command accepts the following options:

-command <command_type> — the command type, encrypt or decrypt.
-message — the password for encryption.
-encryptionKey — the encryption key.
-encryptorType — the encryptor type, aes256 by default.
-jksEncryptKeyAlias — the Java keystore encryption key alias.
-jksPassword — the Java keystore password.
-jksPath — the Java keystore path.

The resulting encrypted string can be then used as the jdbc.password value in the JDBC server configuration file

version

Displays the PXF version

JDBC

pxf cluster