gpsscli

Client command utility for the Greenplum Streaming Server.

Synopsis

gpsscli <subcommand> [<options>]

gpsscli convert
gpsscli dryrun
gpsscli list
gpsscli load
gpsscli progress
gpsscli remove
gpsscli start
gpsscli status
gpsscli stop
gpsscli submit
gpsscli wait

gpsscli {help | -h | --help}

gpsscli {-v | --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 and progress:

Subcommand	Description
convert	Convert a version 1 or 2 load configuration file to version 3 (Beta) format
dryrun	Perform a trial load without writing to Greenplum Database
help	Display command help
list	List jobs and their status
load	Run one or more single-command load
progress	Show job progress
remove	Remove one or more jobs
start	Start one or more jobs
status	Show job status
stop	Stop one or more jobs
submit	Submit one or more jobs
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.

--color

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 deactivate by default.

GPSS ignores the --color option if you also specify --csv-log.

--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 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

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.

--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.

-v | --version

Show the versions of gpsscli and the gpss server, and then exit. You may need to also specify the --gpss-host and/or --gpss-port options to identify the server.

See Also

gpsscli convert, gpsscli dryrun, gpsscli list, gpsscli load, gpsscli progress, gpsscli remove, gpsscli start, gpsscli status, gpsscli stop, gpsscli submit, gpsscli wait