title: “Command-Line Interface”
Flink provides a command-line interface to run programs that are packaged as JAR files, and control their execution. The command line interface is part of any Flink setup, available in local single node setups and in distributed setups. It is located under <flink-home>/bin/flink
and connects by default to the running Flink master (JobManager) that was started from the same installation directory.
A prerequisite to using the command line interface is that the Flink master (JobManager) has been started (via <flink-home>/bin/start- local.sh
or <flink-home>/bin/start-cluster.sh
) or that a YARN environment is available.
The command line can be used to
Run example program with no arguments.
./bin/flink run ./examples/batch/WordCount.jar
Run example program with arguments for input and result files
./bin/flink run ./examples/batch/WordCount.jar \ file:///home/user/hamlet.txt file:///home/user/wordcount_out
Run example program with parallelism 16 and arguments for input and result files
./bin/flink run -p 16 ./examples/batch/WordCount.jar \ file:///home/user/hamlet.txt file:///home/user/wordcount_out
Run example program with flink log output disabled
./bin/flink run -q ./examples/batch/WordCount.jar
Run example program in detached mode
./bin/flink run -d ./examples/batch/WordCount.jar
Run example program on a specific JobManager:
./bin/flink run -m myJMHost:6123 \ ./examples/batch/WordCount.jar \ file:///home/user/hamlet.txt file:///home/user/wordcount_out
Run example program with a specific class as an entry point:
./bin/flink run -c org.apache.flink.examples.java.wordcount.WordCount \ ./examples/batch/WordCount.jar \ file:///home/user/hamlet.txt file:///home/user/wordcount_out
Run example program using a per-job YARN cluster with 2 TaskManagers:
./bin/flink run -m yarn-cluster -yn 2 \ ./examples/batch/WordCount.jar \ hdfs:///user/hamlet.txt hdfs:///user/wordcount_out
Display the optimized execution plan for the WordCount example program as JSON:
./bin/flink info ./examples/batch/WordCount.jar \ file:///home/user/hamlet.txt file:///home/user/wordcount_out
List scheduled and running jobs (including their JobIDs):
./bin/flink list
List scheduled jobs (including their JobIDs):
./bin/flink list -s
List running jobs (including their JobIDs):
./bin/flink list -r
Cancel a job:
./bin/flink cancel <jobID>
Stop a job (streaming jobs only):
./bin/flink stop <jobID>
Savepoints are controlled via the command line client:
{% highlight bash %} ./bin/flink savepoint {% endhighlight %}
Returns the path of the created savepoint. You need this path to restore and dispose savepoints.
{% highlight bash %} ./bin/flink run -s ... {% endhighlight %}
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.
{% highlight bash %} ./bin/flink savepoint -d {% endhighlight %}
Disposes the savepoint at the given path. The savepoint path is returned by the savepoint trigger command.
The command line syntax is as follows:
./flink <ACTION> [OPTIONS] [ARGUMENTS] The following actions are available: Action "run" compiles and runs a program. Syntax: run [OPTIONS] <jar-file> <arguments> "run" action options: -c,--class <classname> Class with the program entry point ("main" method or "getPlan()" method. Only needed if the JAR file does not specify the class in its manifest. -C,--classpath <url> Adds a URL to each user code classloader on all nodes in the cluster. The paths must specify a protocol (e.g. file://) and be accessible on all nodes (e.g. by means of a NFS share). You can use this option multiple times for specifying more than one URL. The protocol must be supported by the {@link java.net.URLClassLoader}. -d,--detached If present, runs the job in detached mode -m,--jobmanager <host:port> Address of the JobManager (master) to which to connect. Specify 'yarn-cluster' as the JobManager to deploy a YARN cluster for the job. Use this flag to connect to a different JobManager than the one specified in the configuration. -p,--parallelism <parallelism> The parallelism with which to run the program. Optional flag to override the default value specified in the configuration. -q,--sysoutLogging If present, supress logging output to standard out. -s,--fromSavepoint <savepointPath> Path to a savepoint to reset the job back to (for example file:///flink/savepoint-1537). Additional arguments if -m yarn-cluster is set: -yD <arg> Dynamic properties -yd,--yarndetached Start detached -yj,--yarnjar <arg> Path to Flink jar file -yjm,--yarnjobManagerMemory <arg> Memory for JobManager Container [in MB] -yn,--yarncontainer <arg> Number of YARN container to allocate (=Number of Task Managers) -ynm,--yarnname <arg> Set a custom name for the application on YARN -yq,--yarnquery Display available YARN resources (memory, cores) -yqu,--yarnqueue <arg> Specify YARN queue. -ys,--yarnslots <arg> Number of slots per TaskManager -yst,--yarnstreaming Start Flink in streaming mode -yt,--yarnship <arg> Ship files in the specified directory (t for transfer) -ytm,--yarntaskManagerMemory <arg> Memory per TaskManager Container [in MB] Action "info" shows the optimized execution plan of the program (JSON). Syntax: info [OPTIONS] <jar-file> <arguments> "info" action options: -c,--class <classname> Class with the program entry point ("main" method or "getPlan()" method. Only needed if the JAR file does not specify the class in its manifest. -m,--jobmanager <host:port> Address of the JobManager (master) to which to connect. Specify 'yarn-cluster' as the JobManager to deploy a YARN cluster for the job. Use this flag to connect to a different JobManager than the one specified in the configuration. -p,--parallelism <parallelism> The parallelism with which to run the program. Optional flag to override the default value specified in the configuration. Action "list" lists running and scheduled programs. Syntax: list [OPTIONS] "list" action options: -m,--jobmanager <host:port> Address of the JobManager (master) to which to connect. Specify 'yarn-cluster' as the JobManager to deploy a YARN cluster for the job. Use this flag to connect to a different JobManager than the one specified in the configuration. -r,--running Show only running programs and their JobIDs -s,--scheduled Show only scheduled programs and their JobIDs Action "cancel" cancels a running program. Syntax: cancel [OPTIONS] <Job ID> "cancel" action options: -m,--jobmanager <host:port> Address of the JobManager (master) to which to connect. Specify 'yarn-cluster' as the JobManager to deploy a YARN cluster for the job. Use this flag to connect to a different JobManager than the one specified in the configuration. Action "stop" stops a running program (streaming jobs only). There are no strong consistency guarantees for a stop request. Syntax: stop [OPTIONS] <Job ID> "stop" action options: -m,--jobmanager <host:port> Address of the JobManager (master) to which to connect. Use this flag to connect to a different JobManager than the one specified in the configuration. Action "savepoint" triggers savepoints for a running job or disposes existing ones. Syntax: savepoint [OPTIONS] <Job ID> "savepoint" action options: -d,--dispose <savepointPath> Disposes an existing savepoint. -m,--jobmanager <host:port> Address of the JobManager (master) to which to connect. Specify 'yarn-cluster' as the JobManager to deploy a YARN cluster for the job. Use this flag to connect to a different JobManager than the one specified in the configuration.