• 命令行界面
    • Examples
      • 作业提交示例
      • 作业管理示例
      • Savepoints
        • Trigger a Savepoint
        • Trigger a Savepoint with YARN
        • Stop
        • Cancel with a savepoint (deprecated)
        • Restore a savepoint
        • Dispose a savepoint
    • Usage

    命令行界面

    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, and

    A 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
      • 作业提交示例
      • 作业管理示例
      • Savepoints
    • Usage

    Examples

    作业提交示例

    这些示例是关于如何通过脚本提交一个作业

    • 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
    • Run example program using a per-job YARN cluster with 2 TaskManagers:
    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
    • 提交一个Python Table的作业:
    1. ./bin/flink run -py WordCount.py
    • 提交一个有多个依赖的Python Table的作业:
    1. ./bin/flink run -py examples/python/table/batch/word_count.py \
    2.                         -pyfs file:///user.txt,hdfs:///$namenode_address/username.txt
    • 提交一个有多个依赖的Python Table的作业，Python作业的主入口通过pym选项指定:
    1. ./bin/flink run -pym batch.word_count -pyfs examples/python/table/batch
    • 提交一个指定并发度为16的Python Table的作业:
    1. ./bin/flink run -p 16 -py examples/python/table/batch/word_count.py
    • 提交一个关闭flink日志输出的Python Table的作业:
    1. ./bin/flink run -q -py examples/python/table/batch/word_count.py
    • 提交一个运行在detached模式下的Python Table的作业:
    1. ./bin/flink run -d -py examples/python/table/batch/word_count.py
    • 提交一个运行在指定JobManager上的Python Table的作业:
    1. ./bin/flink run -m myJMHost:8081 \
    2.                     -py examples/python/table/batch/word_count.py
    • 提交一个运行在有两个TaskManager的per-job YARN cluster的Python Table的作业:
    1. ./bin/flink run -m yarn-cluster -yn 2 \
    2.                          -py examples/python/table/batch/word_count.py

    作业管理示例

    • 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作业的入口，依赖的资源文件可以通过
    36.                                           `--pyFiles`进行指定。
    37.      -pyfs,--pyFiles <python-files>       指定Python作业依赖的一些自定义的python文件，
    38.                                           如果有多个文件，可以通过逗号(,)进行分隔。支持
    39.                                           常用的python资源文件，例如(.py/.egg/.zip)。
    40.                                           (例如:--pyFiles file:///tmp/myresource.zip
    41.                                           ,hdfs:///$namenode_address/myresource2.zip)
    42.      -pym,--pyModule <python-module>      指定python程序的运行的模块入口，这个选项必须配合
    43.                                           `--pyFiles`一起使用。
    44.      -q,--sysoutLogging                   If present, suppress logging output to
    45.                                           standard out.
    46.      -s,--fromSavepoint <savepointPath>   Path to a savepoint to restore the job
    47.                                           from (for example
    48.                                           hdfs:///flink/savepoint-1537).
    49.      -sae,--shutdownOnAttachedExit        If the job is submitted in attached
    50.                                           mode, perform a best-effort cluster
    51.                                           shutdown when the CLI is terminated
    52.                                           abruptly, e.g., in response to a user
    53.                                           interrupt, such as typing Ctrl + C.
    54.   Options for yarn-cluster mode:
    55.      -d,--detached                        If present, runs the job in detached
    56.                                           mode
    57.      -m,--jobmanager <arg>                Address of the JobManager (master) to
    58.                                           which to connect. Use this flag to
    59.                                           connect to a different JobManager than
    60.                                           the one specified in the
    61.                                           configuration.
    62.      -sae,--shutdownOnAttachedExit        If the job is submitted in attached
    63.                                           mode, perform a best-effort cluster
    64.                                           shutdown when the CLI is terminated
    65.                                           abruptly, e.g., in response to a user
    66.                                           interrupt, such as typing Ctrl + C.
    67.      -yat,--yarnapplicationType <arg>     Set a custom application type for the
    68.                                           application on YARN
    69.      -yD <property=value>                 use value for given property
    70.      -yd,--yarndetached                   If present, runs the job in detached
    71.                                           mode (deprecated; use non-YARN
    72.                                           specific option instead)
    73.      -yh,--yarnhelp                       Help for the Yarn session CLI.
    74.      -yid,--yarnapplicationId <arg>       Attach to running YARN session
    75.      -yj,--yarnjar <arg>                  Path to Flink jar file
    76.      -yjm,--yarnjobManagerMemory <arg>    Memory for JobManager Container
    77.                                           with optional unit (default: MB)
    78.      -yn,--yarncontainer <arg>            Number of YARN container to allocate
    79.                                           (=Number of Task Managers)
    80.      -ynm,--yarnname <arg>                Set a custom name for the application
    81.                                           on YARN
    82.      -yq,--yarnquery                      Display available YARN resources
    83.                                           (memory, cores)
    84.      -yqu,--yarnqueue <arg>               Specify YARN queue.
    85.      -ys,--yarnslots <arg>                Number of slots per TaskManager
    86.      -yst,--yarnstreaming                 Start Flink in streaming mode
    87.      -yt,--yarnship <arg>                 Ship files in the specified directory
    88.                                           (t for transfer), multiple options are
    89.                                           supported.
    90.      -ytm,--yarntaskManagerMemory <arg>   Memory per TaskManager Container
    91.                                           with optional unit (default: MB)
    92.      -yz,--yarnzookeeperNamespace <arg>   Namespace to create the Zookeeper
    93.                                           sub-paths for high availability mode
    94.      -ynl,--yarnnodeLabel <arg>           Specify YARN node label for
    95.                                           the YARN application
    96.      -z,--zookeeperNamespace <arg>        Namespace to create the Zookeeper
    97.                                           sub-paths for high availability mode
    99.   Options for default mode:
    100.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
    101.                                      to connect. Use this flag to connect to a
    102.                                      different JobManager than the one specified
    103.                                      in the configuration.
    104.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
    105.                                      for high availability mode
    109. Action "info" shows the optimized execution plan of the program (JSON).
    111.   Syntax: info [OPTIONS] <jar-file> <arguments>
    112.   "info" action options:
    113.      -c,--class <classname>           Class with the program entry point ("main()"
    114.                                       method or "getPlan()" method). Only needed
    115.                                       if the JAR file does not specify the class
    116.                                       in its manifest.
    117.      -p,--parallelism <parallelism>   The parallelism with which to run the
    118.                                       program. Optional flag to override the
    119.                                       default value specified in the
    120.                                       configuration.
    123. Action "list" lists running and scheduled programs.
    125.   Syntax: list [OPTIONS]
    126.   "list" action options:
    127.      -r,--running     Show only running programs and their JobIDs
    128.      -s,--scheduled   Show only scheduled programs and their JobIDs
    129.   Options for yarn-cluster mode:
    130.      -m,--jobmanager <arg>            Address of the JobManager (master) to
    131.                                       which to connect. Use this flag to connect
    132.                                       to a different JobManager than the one
    133.                                       specified in the configuration.
    134.      -yid,--yarnapplicationId <arg>   Attach to running YARN session
    135.      -z,--zookeeperNamespace <arg>    Namespace to create the Zookeeper
    136.                                       sub-paths for high availability mode
    138.   Options for default mode:
    139.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
    140.                                      to connect. Use this flag to connect to a
    141.                                      different JobManager than the one specified
    142.                                      in the configuration.
    143.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
    144.                                      for high availability mode
    148. Action "stop" stops a running program with a savepoint (streaming jobs only).
    150.   Syntax: stop [OPTIONS] <Job ID>
    151.   "stop" action options:
    152.      -d,--drain                           Send MAX_WATERMARK before taking the
    153.                                           savepoint and stopping the pipelne.
    154.      -p,--savepointPath <savepointPath>   Path to the savepoint (for example
    155.                                           hdfs:///flink/savepoint-1537). If no
    156.                                           directory is specified, the configured
    157.                                           default will be used
    158.                                           ("state.savepoints.dir").
    159.   Options for yarn-cluster mode:
    160.      -m,--jobmanager <arg>            Address of the JobManager (master) to
    161.                                       which to connect. Use this flag to connect
    162.                                       to a different JobManager than the one
    163.                                       specified in the configuration.
    164.      -yid,--yarnapplicationId <arg>   Attach to running YARN session
    165.      -z,--zookeeperNamespace <arg>    Namespace to create the Zookeeper
    166.                                       sub-paths for high availability mode
    168.   Options for default mode:
    169.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
    170.                                      to connect. Use this flag to connect to a
    171.                                      different JobManager than the one specified
    172.                                      in the configuration.
    173.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
    174.                                      for high availability mode
    178. Action "cancel" cancels a running program.
    180.   Syntax: cancel [OPTIONS] <Job ID>
    181.   "cancel" action options:
    182.      -s,--withSavepoint <targetDirectory>   **DEPRECATION WARNING**: Cancelling
    183.                                             a job with savepoint is deprecated.
    184.                                             Use "stop" instead.
    185.                                             Trigger savepoint and cancel job.
    186.                                             The target directory is optional. If
    187.                                             no directory is specified, the
    188.                                             configured default directory
    189.                                             (state.savepoints.dir) is used.
    190.   Options for yarn-cluster mode:
    191.      -m,--jobmanager <arg>            Address of the JobManager (master) to
    192.                                       which to connect. Use this flag to connect
    193.                                       to a different JobManager than the one
    194.                                       specified in the configuration.
    195.      -yid,--yarnapplicationId <arg>   Attach to running YARN session
    196.      -z,--zookeeperNamespace <arg>    Namespace to create the Zookeeper
    197.                                       sub-paths for high availability mode
    199.   Options for default mode:
    200.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
    201.                                      to connect. Use this flag to connect to a
    202.                                      different JobManager than the one specified
    203.                                      in the configuration.
    204.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
    205.                                      for high availability mode
    209. Action "savepoint" triggers savepoints for a running job or disposes existing ones.
    211.   Syntax: savepoint [OPTIONS] <Job ID> [<target directory>]
    212.   "savepoint" action options:
    213.      -d,--dispose <arg>       Path of savepoint to dispose.
    214.      -j,--jarfile <jarfile>   Flink program JAR file.
    215.   Options for yarn-cluster mode:
    216.      -m,--jobmanager <arg>            Address of the JobManager (master) to
    217.                                       which to connect. Use this flag to connect
    218.                                       to a different JobManager than the one
    219.                                       specified in the configuration.
    220.      -yid,--yarnapplicationId <arg>   Attach to running YARN session
    221.      -z,--zookeeperNamespace <arg>    Namespace to create the Zookeeper
    222.                                       sub-paths for high availability mode
    224.   Options for default mode:
    225.      -m,--jobmanager <arg>           Address of the JobManager (master) to which
    226.                                      to connect. Use this flag to connect to a
    227.                                      different JobManager than the one specified
    228.                                      in the configuration.
    229.      -z,--zookeeperNamespace <arg>   Namespace to create the Zookeeper sub-paths
    230.                                      for high availability mode