gpsscli start

(Re)start one or more VMware Tanzu Greenplum streaming server jobs.

Synopsis

gpsscli start {<job_name> | <job_id>}
     [--all] [--quit-at-eof]
     [{--force-reset-earliest | --force-reset-latest | --force-reset-timestamp <tstamp>}]
     [--skip-explain]
     [--config <gpsscliconfig.json>]
     [--gpss-host <host>] [--gpss-port <port>]
     [-U | --username <client_auth_user> -P | --password <client_auth_passwd>]
     [--no-check-ca] [-l | --log-dir <directory>] [--verbose]

gpsscli start {-h | --help}

Description

The gpsscli start command (re)starts a job submitted to a specific Tanzu Greenplum streaming server (GPSS) instance. You identify the name of the job. You can also identify the data offset from which you want the operation to begin.

Specify the --all flag to the command to (re)start all previously submitted jobs.

When you start a job, you initiate the data load operation. The job transitions from the Submitted or Stopped state to the Running state.

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

job_name | job_id

The identifier of a previously-submitted GPSS job. You can specify a job name when you run gpsscli submit, or the command returns a unique job identifier.

--all

Start all previously submitted jobs that are not currently running.

--quit-at-eof

When you specify this option, gpsscli start reads all pending data, stops the job, and then exits. The default behaviour of gpsscli start is to start the job and then exit.

gpsscli start ignores job retry SCHEDULE configuration settings when it is invoked with the --quit-at-eof flag.

--force-reset-earliest

gpsscli start returns an error if its recorded offset does not match that of the data source. Re-run gpsscli start and specify the --force‑reset‑earliest option to resume the load operation from the earliest available data offset known to the data source.

Note

gpsscli start supports this option only when loading from a Kafka or RabbitMQ stream data source.

Note

--force-reset-earliest specified on the command line takes precedence over a FALLBACK_OFFSET/fallback_offset set in the jobconfig.yaml when the job was submitted.

--force-reset-latest

gpsscli start returns an error if its recorded offset does not match that of the data source. Re-run gpsscli start and specify the --force‑reset‑latest option to load only new data emitted from the data source.

Note

gpsscli start supports this option only when loading from a Kafka or RabbitMQ stream data source.

Note

--force-reset-latest specified on the command line takes precedence over a FALLBACK_OFFSET/fallback_offset set in the jobconfig.yaml when the job was submitted.

--force-reset-timestamp tstamp

Specify the --force‑reset‑timestamp option to load messages published since the specified time. tstamp must specify epoch time in milliseconds, and is bounded by the earliest message time and the current time.

Note

gpsscli start supports this option only when loading from a Kafka or RabbitMQ stream data source.

--skip-explain

Instructs GPSS to skip the explain SQL check step in its internal processing.

Note

gpsscli start supports this option only when loading from a Kafka data source.

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

Examples

Start the GPSS job identified by the name nsync_121118:

$ gpsscli start nsync_121118

See Also

gpss, gpsscli list, gpsscli submit