gpsscli
gpsscli
Client command utility for the Greenplum Streaming Server.
Synopsis
gpsscli subcommand [options]
gpsscli history (deprecated)
gpsscli list
gpsscli load
gpsscli progress
gpsscli remove
gpsscli start
gpsscli status
gpsscli stop
gpsscli submit
gpsscli wait
gpsscli {help | -h | --help}
gpsscli --version
Description
The Greenplum Streaming Server (GPSS) includes the
gpsscli
client command utility.
gpsscli provides subcommands to manage
Greenplum Streaming Server load jobs and to view job status, progress,
and history:
Table 1. gpsscli Subcommands
| Subcommand |
Description |
| help |
Display command help |
| history |
Show job history (deprecated) |
| list |
List jobs and their status |
| load |
Run a single-command load |
| progress |
Show job progress |
| remove |
Remove a job |
| start |
Start a job |
| status |
Show job status |
| stop |
Stop a job |
| submit |
Submit a job |
| wait |
Wait for a job to stop |
Options
-
--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.
Note: 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.
-
--gpss-host host
- The GPSS host. The default host address is 127.0.0.1.
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
-
--no-check-ca
- Disable 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.
-
-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.
-
--verbose
- 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.
- --version
- Show the version of the gpsscli utility, and
then exit.
