Perform a trial load without writing to Greenplum Database.


gpsscli dryrun <loadcfgv3.yaml> [--name <job_name>]
    [-p | --property <template_var=value>]
    [--config <gpsscliconfig.json>]
    [--gpss-host <host>] [--gpss-port <port>]
    [--no-check-ca] [-l | --log-dir <directory>] [--verbose]

gpsscli dryrun {-h | --help}


The gpsscli dryrun command performs a trial load of the job specified by loadcfgv3.yaml. You can use this command to help you diagnose a failed job.


GPSS currently supports running the gpsscli dryrun command only on Kafka, file, and S3 jobs.

gpsscli dryrun reads data from the source and prepares for the load operation without actually inserting the data into Greenplum Database. The command also outputs the underlying SQL commands that GPSS would run to fulfill the job.

If the GPSS instance to which you want to send the request is not running on the default host ( or the default port number (5000), you can specify the GPSS host and/or port via command line options.


The version 3 load configuration file with which to perform a job trial run.
--name job_name
The name to assign to the dry run job.
-p | --property template_var=value
Substitute value for instances of the property value template {{template_var}} referenced in the loadcfgv3.yaml load configuration file.

Instructs GPSS to process errors and display error messages when save_failing_batch is true. By default, the command does not display these messages.


gpsscli dryrun supports this option only when trialing a Kafka load configuration file.

--config gpsscliconfig.json

The GPSS configuration file. This file includes properties that identify the gpss instance that services the command. When SSL encryption is enabled between the GPSS client and server, you also use this file to identify the file system location of the client SSL certificates. Refer to gpss.json for detailed information about the format of this file and the configuration properties supported.


gpsscli subcommands read the configuration specified in the ListenAddress block of the gpsscliconfig.json file, and ignore the gpfdist configuration specified in the Gpfdist block of the file.


Enable the use of color when displaying front-end log messages. When specified, GPSS colors the log level in messages that it writes to stdout. Color is deactivated by default.

GPSS ignores the --color option if you also specify --csv-log.
Write front-end log messages in CSV format. By default, GPSS writes log messages to stdout using spaces between fields for a more human-readable format.
--gpss-host host
The GPSS host. The default host address is If specified, overrides a ListenAddress:Host value provided in gpsscliconfig.json
--gpss-port port
The GPSS port number. The default port number is 5000. If specified, overrides a ListenAddress:Port value provided in gpsscliconfig.json
Deactivate certificate verification when SSL is enabled between the GPSS client and server. By default, GPSS checks the certificate authority (CA) each time that you invoke a gpsscli subcommand.
-U | --username client_auth_username
The user name with which the GPSS server instance authenticates the client.
-P | --password client_auth_passwd
The password with which the GPSS server instance authenticates the client.
-l | --log-dir directory

The directory to which GPSS writes client command log files. GPSS must have write permission to the directory. GPSS creates the log directory if it does not exist.

If you do not provide this option, GPSS writes gpsscli client log files to the $HOME/gpAdminLogs directory.
The default behaviour of the command utility is to display information and error messages to stdout. When you specify the --verbose option, GPSS also outputs debug-level messages about the operation.
-h | --help
Show command utility help, and then exit.


Perform a dry run of the Kafka load job specified by the configuration file named kjobcfgv3.yaml; include error processing in the trial run:

$ gpsscli dryrun --include-error-process kjobcfgv3.yaml

See Also

gpsscli.yaml, gpsscli-v3.yaml (Beta)

check-circle-line exclamation-circle-line close-line
Scroll to top icon