Skip to main content
Version: 2.3.7

user-command

Command Line Tool

The SeaTunnel Engine provides a command line tool for managing the jobs of the SeaTunnel Engine. You can use the command line tool to submit, stop, pause, resume, delete jobs, view job status and monitoring metrics, etc.

You can obtain the help information of the command line tool through the following command:

sh bin/seatunnel.sh -h

The output is as follows:


Usage: seatunnel.sh [options]
  Options:
    --async                         Run the job asynchronously. When the job is submitted, the client will exit (default: false).
    -can, --cancel-job              Cancel the job by JobId.
    --check                         Whether to check the config (default: false).
    -cj, --close-job                Close the client and the task will also be closed (default: true).
    -cn, --cluster                  The name of the cluster.
    -c, --config                    Config file.
    --decrypt                       Decrypt the config file. When both --decrypt and --encrypt are specified, only --encrypt will take effect (default: false). 
    -m, --master, -e, --deploy-mode SeaTunnel job submit master, support [local, cluster] (default: cluster).
    --encrypt                       Encrypt the config file. When both --decrypt and --encrypt are specified, only --encrypt will take effect (default: false). 
    --get_running_job_metrics       Get metrics for running jobs (default: false).
    -h, --help                      Show the usage message.
    -j, --job-id                    Get the job status by JobId.
    -l, --list                      List the job status (default: false).
    --metrics                       Get the job metrics by JobId.
    -n, --name                      The SeaTunnel job name (default: SeaTunnel).
    -r, --restore                   Restore with savepoint by jobId.
    -s, --savepoint                 Savepoint the job by jobId.
    -i, --variable                  Variable substitution, such as -i city=beijing, or -i date=20190318. We use ',' as a separator. When inside "", ',' are treated as normal characters instead of delimiters. (default: []).

Submitting Jobs​

sh bin/seatunnel.sh --config $SEATUNNEL_HOME/config/v2.batch.config.template

The --async parameter allows the job to run in the background. When the job is submitted, the client will exit.

sh bin/seatunnel.sh --config $SEATUNNEL_HOME/config/v2.batch.config.template --async

The -n or --name parameter can specify the name of the job.

sh bin/seatunnel.sh --config $SEATUNNEL_HOME/config/v2.batch.config.template --async -n myjob

Viewing The Job List​

sh bin/seatunnel.sh -l

This command will output the list of all jobs in the current cluster (including completed historical jobs and running jobs).

Viewing The Job Status​

sh bin/seatunnel.sh -j <jobId>

This command will output the status information of the specified job.

Getting The Monitoring Information Of Running Jobs​

sh bin/seatunnel.sh --get_running_job_metrics

This command will output the monitoring information of running jobs.

Getting the Monitoring Information of a Specified Job​

The --metrics parameter can get the monitoring information of a specified job.

sh bin/seatunnel.sh --metrics <jobId>

Pausing Jobs​

sh bin/seatunnel.sh -s <jobId>

This command will pause the specified job. Note that only jobs with checkpoints enabled support pausing jobs (real-time synchronization jobs have checkpoints enabled by default, and batch jobs do not have checkpoints enabled by default and need to configure checkpoint.interval in env to enable checkpoints).

Pausing a job is in the smallest unit of split. That is, after pausing a job, it will wait for the currently running split to finish running and then pause. After the task is resumed, it will continue to run from the paused split.

Resuming Jobs​

sh bin/seatunnel.sh -r <jobId> -c $SEATUNNEL_HOME/config/v2.batch.config.template

This command will resume the specified job. Note that only jobs with checkpoints enabled support resuming jobs (real-time synchronization jobs have checkpoints enabled by default, and batch jobs do not have checkpoints enabled by default and need to configure checkpoint.interval in env to enable checkpoints).

Resuming a job requires the jobId and the configuration file of the job.

Both failed jobs and jobs paused by seatunnel.sh -s <jobId> can be resumed by this command.

Canceling Jobs​

sh bin/seatunnel.sh -can &lt;jobId&gt;

This command will cancel the specified job. After canceling the job, the job will be stopped and its status will become CANCELED.

All breakpoint information of the canceled job will be deleted and cannot be resumed by seatunnel.sh -r <jobId>.