Command-Line Interface

Flink provides a Command-Line Interface (CLI) to run programs that are packagedas JAR files, and control their execution. The CLI is partof any Flink setup, available in local single node setups and indistributed setups. It is located under <flink-home>/bin/flinkand connects by default to the running Flink master (JobManager) that wasstarted from the same installation directory.

The command line can be used to

  • submit jobs for execution,
  • cancel a running job,
  • provide information about a job,
  • list running and waiting jobs,
  • trigger and dispose savepoints, andA prerequisite to using the command line interface is that the Flinkmaster (JobManager) has been started (via<flink-home>/bin/start-cluster.sh) or that a YARN environment isavailable.

Examples

Job Submission Examples

These examples about how to submit a job in CLI.

  • Run example program with no arguments:
  1. ./bin/flink run ./examples/batch/WordCount.jar
  • Run example program with arguments for input and result files:
  1. ./bin/flink run ./examples/batch/WordCount.jar \
  2.                      --input file:///home/user/hamlet.txt --output file:///home/user/wordcount_out
  • Run example program with parallelism 16 and arguments for input and result files:
  1. ./bin/flink run -p 16 ./examples/batch/WordCount.jar \
  2.                      --input file:///home/user/hamlet.txt --output file:///home/user/wordcount_out
  • Run example program with flink log output disabled:
  1.     ./bin/flink run -q ./examples/batch/WordCount.jar
  • Run example program in detached mode:
  1.     ./bin/flink run -d ./examples/batch/WordCount.jar
  • Run example program on a specific JobManager:
  1. ./bin/flink run -m myJMHost:8081 \
  2.                        ./examples/batch/WordCount.jar \
  3.                        --input file:///home/user/hamlet.txt --output file:///home/user/wordcount_out
  • Run example program with a specific class as an entry point:
  1. ./bin/flink run -c org.apache.flink.examples.java.wordcount.WordCount \
  2.                        ./examples/batch/WordCount.jar \
  3.                        --input file:///home/user/hamlet.txt --output file:///home/user/wordcount_out
  1. ./bin/flink run -m yarn-cluster -yn 2 \
  2.                        ./examples/batch/WordCount.jar \
  3.                        --input hdfs:///user/hamlet.txt --output hdfs:///user/wordcount_out
  • Run Python Table program:
  1. ./bin/flink run -py examples/python/table/batch/word_count.py
  • Run Python Table program with pyFiles:
  1. ./bin/flink run -py examples/python/table/batch/word_count.py \
  2.                         -pyfs file:///user.txt,hdfs:///$namenode_address/username.txt
  • Run Python Table program with pyFiles and pyModule:
  1. ./bin/flink run -pym batch.word_count -pyfs examples/python/table/batch
  • Run Python Table program with parallelism 16:
  1. ./bin/flink run -p 16 -py examples/python/table/batch/word_count.py
  • Run Python Table program with flink log output disabled:
  1. ./bin/flink run -q -py examples/python/table/batch/word_count.py
  • Run Python Table program in detached mode:
  1. ./bin/flink run -d -py examples/python/table/batch/word_count.py
  • Run Python Table program on a specific JobManager:
  1. ./bin/flink run -m myJMHost:8081 \
  2.                        -py examples/python/table/batch/word_count.py
  1. ./bin/flink run -m yarn-cluster -yn 2 \
  2.                        -py examples/python/table/batch/word_count.py

Job Management Examples

These examples about how to manage a job in CLI.

  • Display the optimized execution plan for the WordCount example program as JSON:
  1. ./bin/flink info ./examples/batch/WordCount.jar \
  2.                         --input file:///home/user/hamlet.txt --output file:///home/user/wordcount_out
  • List scheduled and running jobs (including their JobIDs):
  1. ./bin/flink list
  • List scheduled jobs (including their JobIDs):
  1. ./bin/flink list -s
  • List running jobs (including their JobIDs):
  1. ./bin/flink list -r
  • List all existing jobs (including their JobIDs):
  1. ./bin/flink list -a
  • List running Flink jobs inside Flink YARN session:
  1. ./bin/flink list -m yarn-cluster -yid <yarnApplicationID> -r
  • Cancel a job:
  1. ./bin/flink cancel <jobID>
  • Cancel a job with a savepoint (deprecated; use “stop” instead):
  1. ./bin/flink cancel -s [targetDirectory] <jobID>
  • Gracefully stop a job with a savepoint (streaming jobs only):
  1. ./bin/flink stop [-p targetDirectory] [-d] <jobID>

Savepoints

Savepoints are controlled via the command line client:

Trigger a Savepoint

  1. ./bin/flink savepoint <jobId> [savepointDirectory]

This will trigger a savepoint for the job with ID jobId, and returns the path of the created savepoint. You need this path to restore and dispose savepoints.

Furthermore, you can optionally specify a target file system directory to store the savepoint in. The directory needs to be accessible by the JobManager.

If you don’t specify a target directory, you need to have configured a default directory. Otherwise, triggering the savepoint will fail.

Trigger a Savepoint with YARN

  1. ./bin/flink savepoint <jobId> [savepointDirectory] -yid <yarnAppId>

This will trigger a savepoint for the job with ID jobId and YARN application ID yarnAppId, and returns the path of the created savepoint.

Everything else is the same as described in the above Trigger a Savepoint section.

Stop

Use the stop to gracefully stop a running streaming job with a savepoint.

  1. ./bin/flink stop [-p targetDirectory] [-d] <jobID>

A “stop” call is a more graceful way of stopping a running streaming job, as the “stop” signal flows fromsource to sink. When the user requests to stop a job, all sources will be requested to send the last checkpoint barrierthat will trigger a savepoint, and after the successful completion of that savepoint, they will finish by calling theircancel() method. If the -d flag is specified, then a MAX_WATERMARK will be emitted before the last checkpointbarrier. This will result all registered event-time timers to fire, thus flushing out any state that is waiting fora specific watermark, e.g. windows. The job will keep running until all sources properly shut down. This allows the job to finish processing all in-flight data.

Cancel with a savepoint (deprecated)

You can atomically trigger a savepoint and cancel a job.

  1. ./bin/flink cancel -s [savepointDirectory] <jobID>

If no savepoint directory is configured, you need to configure a default savepoint directory for the Flink installation (see Savepoints).

The job will only be cancelled if the savepoint succeeds.

Note: Cancelling a job with savepoint is deprecated. Use "stop" instead.

Restore a savepoint

  1. ./bin/flink run -s <savepointPath> ...

The run command has a savepoint flag to submit a job, which restores its state from a savepoint. The savepoint path is returned by the savepoint trigger command.

By default, we try to match all savepoint state to the job being submitted. If you want to allow to skip savepoint state that cannot be restored with the new job you can set the allowNonRestoredState flag. You need to allow this if you removed an operator from your program that was part of the program when the savepoint was triggered and you still want to use the savepoint.

  1. ./bin/flink run -s <savepointPath> -n ...

This is useful if your program dropped an operator that was part of the savepoint.

Dispose a savepoint

  1. ./bin/flink savepoint -d <savepointPath>

Disposes the savepoint at the given path. The savepoint path is returned by the savepoint trigger command.

If you use custom state instances (for example custom reducing state or RocksDB state), you have to specify the path to the program JAR with which the savepoint was triggered in order to dispose the savepoint with the user code class loader:

  1. ./bin/flink savepoint -d <savepointPath> -j <jarFile>

Otherwise, you will run into a ClassNotFoundException.

Usage

The command line syntax is as follows:

  1. ./flink <ACTION> [OPTIONS] [ARGUMENTS]
  3. The following actions are available:
  5. Action "run" compiles and runs a program.
  7.   Syntax: run [OPTIONS] <jar-file> <arguments>
  8.   "run" action options:
  9.      -c,--class <classname>               Class with the program entry point
  10.                                           ("main()" method or "getPlan()" method).
  11.                                           Only needed if the JAR file does not
  12.                                           specify the class in its manifest.
  13.      -C,--classpath <url>                 Adds a URL to each user code
  14.                                           classloader  on all nodes in the
  15.                                           cluster. The paths must specify a
  16.                                           protocol (e.g. file://) and be
  17.                                           accessible on all nodes (e.g. by means
  18.                                           of a NFS share). You can use this
  19.                                           option multiple times for specifying
  20.                                           more than one URL. The protocol must
  21.                                           be supported by the {@link
  22.                                           java.net.URLClassLoader}.
  23.      -d,--detached                        If present, runs the job in detached
  24.                                           mode
  25.      -n,--allowNonRestoredState           Allow to skip savepoint state that
  26.                                           cannot be restored. You need to allow
  27.                                           this if you removed an operator from
  28.                                           your program that was part of the
  29.                                           program when the savepoint was
  30.                                           triggered.
  31.      -p,--parallelism <parallelism>       The parallelism with which to run the
  32.                                           program. Optional flag to override the
  33.                                           default value specified in the
  34.                                           configuration.
  35.      -py,--python <python-file>           Python script with the program entry 
  36.                                           point.The dependent resources can be 
  37.                                           configured with the `--pyFiles` option.
  38.      -pyfs,--pyFiles <python-files>       Attach custom python files for job. 
  39.                                           Comma can be used as the separator to 
  40.                                           specify multiple files. The standard 
  41.                                           python resource file suffixes such as 
  42.                                           .py/.egg/.zip are all supported.
  43.                                           (eg:--pyFiles file:///tmp/myresource.zip
  44.                                           ,hdfs:///$namenode_address/myresource2.zip)
  45.      -pym,--pyModule <python-module>      Python module with the program entry 
  46.                                           point. This option must be used in 
  47.                                           conjunction with ` --pyFiles`.                                                                                                                
  48.      -q,--sysoutLogging                   If present, suppress logging output to
  49.                                           standard out.
  50.      -s,--fromSavepoint <savepointPath>   Path to a savepoint to restore the job
  51.                                           from (for example
  52.                                           hdfs:///flink/savepoint-1537).
  53.      -sae,--shutdownOnAttachedExit        If the job is submitted in attached
  54.                                           mode, perform a best-effort cluster
  55.                                           shutdown when the CLI is terminated
  56.                                           abruptly, e.g., in response to a user
  57.                                           interrupt, such as typing Ctrl + C.
  58.   Options for yarn-cluster mode:
  59.      -d,--detached                        If present, runs the job in detached
  60.                                           mode
  61.      -m,--jobmanager <arg>                Address of the JobManager (master) to
  62.                                           which to connect. Use this flag to
  63.                                           connect to a different JobManager than
  64.                                           the one specified in the
  65.                                           configuration.
  66.      -sae,--shutdownOnAttachedExit        If the job is submitted in attached
  67.                                           mode, perform a best-effort cluster
  68.                                           shutdown when the CLI is terminated
  69.                                           abruptly, e.g., in response to a user
  70.                                           interrupt, such as typing Ctrl + C.
  71.      -yat,--yarnapplicationType <arg>     Set a custom application type for the
  72.                                           application on YARN
  73.      -yD <property=value>                 use value for given property
  74.      -yd,--yarndetached                   If present, runs the job in detached
  75.                                           mode (deprecated; use non-YARN
  76.                                           specific option instead)
  77.      -yh,--yarnhelp                       Help for the Yarn session CLI.
  78.      -yid,--yarnapplicationId <arg>       Attach to running YARN session
  79.      -yj,--yarnjar <arg>                  Path to Flink jar file
  80.      -yjm,--yarnjobManagerMemory <arg>    Memory for JobManager Container
  81.                                           with optional unit (default: MB)
  82.      -yn,--yarncontainer <arg>            Number of YARN container to allocate
  83.                                           (=Number of Task Managers)
  84.      -ynm,--yarnname <arg>                Set a custom name for the application
  85.                                           on YARN
  86.      -yq,--yarnquery                      Display available YARN resources
  87.                                           (memory, cores)
  88.      -yqu,--yarnqueue <arg>               Specify YARN queue.
  89.      -ys,--yarnslots <arg>                Number of slots per TaskManager
  90.      -yst,--yarnstreaming                 Start Flink in streaming mode
  91.      -yt,--yarnship <arg>                 Ship files in the specified directory
  92.                                           (t for transfer), multiple options are 
  93.                                           supported.
  94.      -ytm,--yarntaskManagerMemory <arg>   Memory per TaskManager Container
  95.                                           with optional unit (default: MB)
  96.      -yz,--yarnzookeeperNamespace <arg>   Namespace to create the Zookeeper
  97.                                           sub-paths for high availability mode
  98.      -ynl,--yarnnodeLabel <arg>           Specify YARN node label for 
  99.                                           the YARN application 
  100.      -z,--zookeeperNamespace <arg>        Namespace to create the Zookeeper
  101.                                           sub-paths for high availability mode
  103.   Options for default mode:
  104.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
  105.                                      to connect. Use this flag to connect to a
  106.                                      different JobManager than the one specified
  107.                                      in the configuration.
  108.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
  109.                                      for high availability mode
  113. Action "info" shows the optimized execution plan of the program (JSON).
  115.   Syntax: info [OPTIONS] <jar-file> <arguments>
  116.   "info" action options:
  117.      -c,--class <classname>           Class with the program entry point ("main()"
  118.                                       method or "getPlan()" method). Only needed
  119.                                       if the JAR file does not specify the class
  120.                                       in its manifest.
  121.      -p,--parallelism <parallelism>   The parallelism with which to run the
  122.                                       program. Optional flag to override the
  123.                                       default value specified in the
  124.                                       configuration.
  127. Action "list" lists running and scheduled programs.
  129.   Syntax: list [OPTIONS]
  130.   "list" action options:
  131.      -r,--running     Show only running programs and their JobIDs
  132.      -s,--scheduled   Show only scheduled programs and their JobIDs
  133.   Options for yarn-cluster mode:
  134.      -m,--jobmanager <arg>            Address of the JobManager (master) to
  135.                                       which to connect. Use this flag to connect
  136.                                       to a different JobManager than the one
  137.                                       specified in the configuration.
  138.      -yid,--yarnapplicationId <arg>   Attach to running YARN session
  139.      -z,--zookeeperNamespace <arg>    Namespace to create the Zookeeper
  140.                                       sub-paths for high availability mode
  142.   Options for default mode:
  143.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
  144.                                      to connect. Use this flag to connect to a
  145.                                      different JobManager than the one specified
  146.                                      in the configuration.
  147.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
  148.                                      for high availability mode
  152. Action "stop" stops a running program with a savepoint (streaming jobs only).
  154.   Syntax: stop [OPTIONS] <Job ID>
  155.   "stop" action options:
  156.      -d,--drain                           Send MAX_WATERMARK before taking the
  157.                                           savepoint and stopping the pipelne.
  158.      -p,--savepointPath <savepointPath>   Path to the savepoint (for example
  159.                                           hdfs:///flink/savepoint-1537). If no
  160.                                           directory is specified, the configured
  161.                                           default will be used
  162.                                           ("state.savepoints.dir").
  163.   Options for yarn-cluster mode:
  164.      -m,--jobmanager <arg>            Address of the JobManager (master) to
  165.                                       which to connect. Use this flag to connect
  166.                                       to a different JobManager than the one
  167.                                       specified in the configuration.
  168.      -yid,--yarnapplicationId <arg>   Attach to running YARN session
  169.      -z,--zookeeperNamespace <arg>    Namespace to create the Zookeeper
  170.                                       sub-paths for high availability mode
  172.   Options for default mode:
  173.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
  174.                                      to connect. Use this flag to connect to a
  175.                                      different JobManager than the one specified
  176.                                      in the configuration.
  177.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
  178.                                      for high availability mode
  182. Action "cancel" cancels a running program.
  184.   Syntax: cancel [OPTIONS] <Job ID>
  185.   "cancel" action options:
  186.      -s,--withSavepoint <targetDirectory>   **DEPRECATION WARNING**: Cancelling
  187.                                             a job with savepoint is deprecated.
  188.                                             Use "stop" instead.
  189.                                             Trigger savepoint and cancel job.
  190.                                             The target directory is optional. If
  191.                                             no directory is specified, the
  192.                                             configured default directory
  193.                                             (state.savepoints.dir) is used.
  194.   Options for yarn-cluster mode:
  195.      -m,--jobmanager <arg>            Address of the JobManager (master) to
  196.                                       which to connect. Use this flag to connect
  197.                                       to a different JobManager than the one
  198.                                       specified in the configuration.
  199.      -yid,--yarnapplicationId <arg>   Attach to running YARN session
  200.      -z,--zookeeperNamespace <arg>    Namespace to create the Zookeeper
  201.                                       sub-paths for high availability mode
  203.   Options for default mode:
  204.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
  205.                                      to connect. Use this flag to connect to a
  206.                                      different JobManager than the one specified
  207.                                      in the configuration.
  208.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
  209.                                      for high availability mode
  213. Action "savepoint" triggers savepoints for a running job or disposes existing ones.
  215.   Syntax: savepoint [OPTIONS] <Job ID> [<target directory>]
  216.   "savepoint" action options:
  217.      -d,--dispose <arg>       Path of savepoint to dispose.
  218.      -j,--jarfile <jarfile>   Flink program JAR file.
  219.   Options for yarn-cluster mode:
  220.      -m,--jobmanager <arg>            Address of the JobManager (master) to
  221.                                       which to connect. Use this flag to connect
  222.                                       to a different JobManager than the one
  223.                                       specified in the configuration.
  224.      -yid,--yarnapplicationId <arg>   Attach to running YARN session
  225.      -z,--zookeeperNamespace <arg>    Namespace to create the Zookeeper
  226.                                       sub-paths for high availability mode
  228.   Options for default mode:
  229.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
  230.                                      to connect. Use this flag to connect to a
  231.                                      different JobManager than the one specified
  232.                                      in the configuration.
  233.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
  234.                                      for high availability mode