gpsscli submit

A newer version of this documentation is available. Use the version menu above to view the most up-to-date release of the Greenplum 5.x documentation.

gpsscli submit

Submit a job to a Greenplum Stream Server.

Synopsis

gpsscli submit config.yaml [--name job_name]
     [--gpss-host host] [--gpss-port port]
     [-l | --log-dir directory] [-v | --verbose]

gpsscli submit {-h | --help}

Description

The gpsscli submit command submits a load job to a specific Greenplum Stream Server (GPSS) instance. When you run the command, you provide a YAML-formatted configuration file that defines the job parameters.

You may choose a name to identify the job. If you do not provide a name, the command returns a unique job identifier.

When you submit a job, GPSS registers the job in its job list. A job is in the Stopped state after it is submitted.

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

Options

config.yaml
The YAML-formatted configuration file that defines the job parameters. If the filename provided is not an absolute path, Greenplum Database assumes the file system location is relative to the current working directory.
Note: GPSS uses a YAML configuration file to uniquely identify a load operation. Submit a configuration file only once. If you submit the same configuration file more than once, GPSS will create the job, but it will eventually error out.
--name job_name
Use job_name to identify the job. If you do not provide a name, the command returns a unique job identifier.
--gpss-host host
Specify the GPSS host. The default host address is 127.0.0.1.
--gpss-port port
Specify the GPSS port number. The default port number is 5000.
-l | --log-dir directory
Specify 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.
-v | --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.

Examples

Submit a GPSS job named nsync_121118 whose load parameters are defined by the configuration file named loadcfg.yaml:

$ gpsscli submit --name nsync_121118 loadcfg.yaml

See Also

gpss, gpsscli.yaml