| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> |
| |
| <title>Apache Flink 0.10-SNAPSHOT Documentation: Command-Line Interface</title> |
| |
| <link rel="shortcut icon" href="http://flink.apache.org/docs/master/page/favicon.ico" type="image/x-icon"> |
| <link rel="icon" href="http://flink.apache.org/docs/master/page/favicon.ico" type="image/x-icon"> |
| |
| <!-- Bootstrap --> |
| <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> |
| <link rel="stylesheet" href="http://flink.apache.org/docs/master/page/css/flink.css"> |
| <link rel="stylesheet" href="http://flink.apache.org/docs/master/page/css/syntax.css"> |
| <link rel="stylesheet" href="http://flink.apache.org/docs/master/page/css/codetabs.css"> |
| |
| <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> |
| <!-- WARNING: Respond.js doesn't work if you view the page via file:// --> |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| </head> |
| <body> |
| |
| |
| |
| |
| |
| |
| <!-- Top navbar. --> |
| <nav class="navbar navbar-default navbar-fixed-top"> |
| <div class="container"> |
| <!-- The logo. --> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <div class="navbar-logo"> |
| <a href="http://flink.apache.org"><img alt="Apache Flink" src="http://flink.apache.org/docs/master/page/img/navbar-brand-logo.jpg"></a> |
| </div> |
| </div><!-- /.navbar-header --> |
| |
| <!-- The navigation links. --> |
| <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> |
| <ul class="nav navbar-nav"> |
| <li><a href="http://flink.apache.org/docs/master/index.html">Overview<span class="hidden-sm hidden-xs"> 0.10</span></a></li> |
| |
| <!-- Setup --> |
| <li class="dropdown"> |
| <a href="http://flink.apache.org/docs/master/setup" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Setup <span class="caret"></span></a> |
| <ul class="dropdown-menu" role="menu"> |
| <li><a href="http://flink.apache.org/docs/master/setup/building.html">Get Flink 0.10-SNAPSHOT</a></li> |
| |
| <li class="divider"></li> |
| <li role="presentation" class="dropdown-header"><strong>Deployment</strong></li> |
| <li><a href="http://flink.apache.org/docs/master/setup/local_setup.html" class="active">Local</a></li> |
| <li><a href="http://flink.apache.org/docs/master/setup/cluster_setup.html">Cluster (Standalone)</a></li> |
| <li><a href="http://flink.apache.org/docs/master/setup/yarn_setup.html">YARN</a></li> |
| <li><a href="http://flink.apache.org/docs/master/setup/gce_setup.html">GCloud</a></li> |
| <li><a href="http://flink.apache.org/docs/master/setup/flink_on_tez.html">Flink on Tez <span class="badge">Beta</span></a></li> |
| |
| <li class="divider"></li> |
| <li><a href="http://flink.apache.org/docs/master/setup/config.html">Configuration</a></li> |
| </ul> |
| </li> |
| |
| <!-- Programming Guides --> |
| <li class="dropdown"> |
| <a href="http://flink.apache.org/docs/master/apis" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Programming Guides <span class="caret"></span></a> |
| <ul class="dropdown-menu" role="menu"> |
| <li><a href="http://flink.apache.org/docs/master/apis/programming_guide.html"><strong>Batch: DataSet API</strong></a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/streaming_guide.html"><strong>Streaming: DataStream API</strong> <span class="badge">Beta</span></a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/python.html">Python API <span class="badge">Beta</span></a></li> |
| |
| <li class="divider"></li> |
| <li><a href="scala_shell.html">Interactive Scala Shell</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/dataset_transformations.html">Dataset Transformations</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/best_practices.html">Best Practices</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/example_connectors.html">Connectors</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/examples.html">Examples</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/local_execution.html">Local Execution</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/cluster_execution.html">Cluster Execution</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/cli.html">Command Line Interface</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/web_client.html">Web Client</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/iterations.html">Iterations</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/java8.html">Java 8</a></li> |
| <li><a href="http://flink.apache.org/docs/master/apis/hadoop_compatibility.html">Hadoop Compatability <span class="badge">Beta</span></a></li> |
| </ul> |
| </li> |
| |
| <!-- Libraries --> |
| <li class="dropdown"> |
| <a href="http://flink.apache.org/docs/master/libs" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Libraries <span class="caret"></span></a> |
| <ul class="dropdown-menu" role="menu"> |
| <li><a href="http://flink.apache.org/docs/master/libs/spargel_guide.html">Graphs: Spargel</a></li> |
| <li><a href="http://flink.apache.org/docs/master/libs/gelly_guide.html">Graphs: Gelly <span class="badge">Beta</span></a></li> |
| <li><a href="http://flink.apache.org/docs/master/libs/ml/">Machine Learning <span class="badge">Beta</span></a></li> |
| <li><a href="http://flink.apache.org/docs/master/libs/table.html">Relational: Table <span class="badge">Beta</span></a></li> |
| </ul> |
| </li> |
| |
| <!-- Internals --> |
| <li class="dropdown"> |
| <a href="http://flink.apache.org/docs/master/internals" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Internals <span class="caret"></span></a> |
| <ul class="dropdown-menu" role="menu"> |
| <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> |
| <li><a href="http://flink.apache.org/docs/master/internals/how_to_contribute.html">How to Contribute</a></li> |
| <li><a href="http://flink.apache.org/docs/master/internals/coding_guidelines.html">Coding Guidelines</a></li> |
| <li><a href="http://flink.apache.org/docs/master/internals/ide_setup.html">IDE Setup</a></li> |
| <li><a href="http://flink.apache.org/docs/master/internals/logging.html">Logging</a></li> |
| <li class="divider"></li> |
| <li role="presentation" class="dropdown-header"><strong>Internals</strong></li> |
| <li><a href="http://flink.apache.org/docs/master/internals/general_arch.html">Architecture & Process Model</a></li> |
| <li><a href="http://flink.apache.org/docs/master/internals/types_serialization.html">Type Extraction & Serialization</a></li> |
| <li><a href="http://flink.apache.org/docs/master/internals/job_scheduling.html">Jobs & Scheduling</a></li> |
| <li><a href="http://flink.apache.org/docs/master/internals/add_operator.html">How-To: Add an Operator</a></li> |
| </ul> |
| </li> |
| </ul> |
| <form class="navbar-form navbar-right hidden-sm hidden-md" role="search" action="http://flink.apache.org/docs/master/search-results.html"> |
| <div class="form-group"> |
| <input type="text" class="form-control" name="q" placeholder="Search all pages"> |
| </div> |
| <button type="submit" class="btn btn-default">Search</button> |
| </form> |
| </div><!-- /.navbar-collapse --> |
| </div><!-- /.container --> |
| </nav> |
| |
| |
| |
| |
| <!-- Main content. --> |
| <div class="container"> |
| |
| |
| <div class="row"> |
| <div class="col-sm-10 col-sm-offset-1"> |
| <h1>Command-Line Interface</h1> |
| |
| |
| |
| <p>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 <code><flink-home>/bin/flink</code> |
| and connects by default to the running Flink master (JobManager) that was |
| started from the same installation directory.</p> |
| |
| <p>A prerequisite to using the command line interface is that the Flink |
| master (JobManager) has been started (via <code><flink-home>/bin/start- |
| local.sh</code> or <code><flink-home>/bin/start-cluster.sh</code>) or that a YARN |
| environment is available.</p> |
| |
| <p>The command line can be used to</p> |
| |
| <ul id="markdown-toc"> |
| <li><a href="#examples" id="markdown-toc-examples">Examples</a></li> |
| <li><a href="#usage" id="markdown-toc-usage">Usage</a></li> |
| </ul> |
| |
| <h2 id="examples">Examples</h2> |
| |
| <ul> |
| <li> |
| <p>Run example program with no arguments.</p> |
| |
| <div class="highlight"><pre><code>./bin/flink run ./examples/flink-java-examples-0.10-SNAPSHOT-WordCount.jar |
| </code></pre></div> |
| </li> |
| <li> |
| <p>Run example program with arguments for input and result files</p> |
| |
| <div class="highlight"><pre><code>./bin/flink run ./examples/flink-java-examples-0.10-SNAPSHOT-WordCount.jar \ |
| file:///home/user/hamlet.txt file:///home/user/wordcount_out |
| </code></pre></div> |
| </li> |
| <li> |
| <p>Run example program with parallelism 16 and arguments for input and result files</p> |
| |
| <div class="highlight"><pre><code>./bin/flink run -p 16 ./examples/flink-java-examples-0.10-SNAPSHOT-WordCount.jar \ |
| file:///home/user/hamlet.txt file:///home/user/wordcount_out |
| </code></pre></div> |
| </li> |
| <li> |
| <p>Run example program on a specific JobManager:</p> |
| |
| <div class="highlight"><pre><code>./bin/flink run -m myJMHost:6123 \ |
| ./examples/flink-java-examples-0.10-SNAPSHOT-WordCount.jar \ |
| file:///home/user/hamlet.txt file:///home/user/wordcount_out |
| </code></pre></div> |
| </li> |
| <li> |
| <p>Run example program with a specific class as an entry point:</p> |
| |
| <div class="highlight"><pre><code>./bin/flink run -c org.apache.flink.examples.java.wordcount.WordCount \ |
| ./examples/flink-java-examples-0.10-SNAPSHOT-WordCount.jar \ |
| file:///home/user/hamlet.txt file:///home/user/wordcount_out |
| </code></pre></div> |
| </li> |
| <li> |
| <p>Run example program using a <a href="http://flink.apache.org/docs/master/setup/yarn_setup.html#run-a-single-flink-job-on-hadoop-yarn">per-job YARN cluster</a> with 2 TaskManagers:</p> |
| |
| <div class="highlight"><pre><code>./bin/flink run -m yarn-cluster -yn 2 \ |
| ./examples/flink-java-examples-0.10-SNAPSHOT-WordCount.jar \ |
| hdfs:///user/hamlet.txt hdfs:///user/wordcount_out |
| </code></pre></div> |
| </li> |
| <li> |
| <p>Display the optimized execution plan for the WordCount example program as JSON:</p> |
| |
| <div class="highlight"><pre><code>./bin/flink info ./examples/flink-java-examples-0.10-SNAPSHOT-WordCount.jar \ |
| file:///home/user/hamlet.txt file:///home/user/wordcount_out |
| </code></pre></div> |
| </li> |
| <li> |
| <p>List scheduled and running jobs (including their JobIDs):</p> |
| |
| <div class="highlight"><pre><code>./bin/flink list |
| </code></pre></div> |
| </li> |
| <li> |
| <p>List scheduled jobs (including their JobIDs):</p> |
| |
| <div class="highlight"><pre><code>./bin/flink list -s |
| </code></pre></div> |
| </li> |
| <li> |
| <p>List running jobs (including their JobIDs):</p> |
| |
| <div class="highlight"><pre><code>./bin/flink list -r |
| </code></pre></div> |
| </li> |
| <li> |
| <p>Cancel a job:</p> |
| |
| <div class="highlight"><pre><code>./bin/flink cancel <jobID> |
| </code></pre></div> |
| </li> |
| </ul> |
| |
| <h2 id="usage">Usage</h2> |
| |
| <p>The command line syntax is as follows:</p> |
| |
| <div class="highlight"><pre><code>./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. |
| -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. |
| 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) |
| -yq,--yarnquery Display available YARN resources |
| (memory, cores) |
| -yqu,--yarnqueue <arg> Specify YARN queue. |
| -ys,--yarnslots <arg> Number of slots per TaskManager |
| -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. |
| </code></pre></div> |
| |
| </div> |
| |
| <div class="col-sm-10 col-sm-offset-1"> |
| <!-- Disqus thread and some vertical offset --> |
| <div style="margin-top: 75px; margin-bottom: 50px" id="disqus_thread"></div> |
| </div> |
| </div> |
| |
| </div><!-- /.container --> |
| |
| <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> |
| <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> |
| <!-- Include all compiled plugins (below), or include individual files as needed --> |
| <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> |
| <script src="http://flink.apache.org/docs/master/page/js/codetabs.js"></script> |
| |
| <!-- Google Analytics --> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-52545728-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| |
| <!-- Disqus --> |
| <script type="text/javascript"> |
| var disqus_shortname = 'stratosphere-eu'; |
| (function() { |
| var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; |
| dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js'; |
| (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); |
| })(); |
| </script> |
| </body> |
| </html> |
