Repository: flink Updated Branches: refs/heads/master 5c4cb452f -> e97f4e6df
[docs] Document difference between 'stop' and 'cancel' Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/e97f4e6d Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/e97f4e6d Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/e97f4e6d Branch: refs/heads/master Commit: e97f4e6dfff34ae0c762b0053cdc3f5e73bb87e4 Parents: 5c4cb45 Author: Robert Metzger <[email protected]> Authored: Thu May 5 13:30:53 2016 +0200 Committer: Robert Metzger <[email protected]> Committed: Thu May 5 13:30:53 2016 +0200 ---------------------------------------------------------------------- docs/apis/cli.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/e97f4e6d/docs/apis/cli.md ---------------------------------------------------------------------- diff --git a/docs/apis/cli.md b/docs/apis/cli.md index 6c7bdd6..08a2aa6 100644 --- a/docs/apis/cli.md +++ b/docs/apis/cli.md @@ -112,6 +112,19 @@ The command line can be used to - Stop a job (streaming jobs only): ./bin/flink stop <jobID> + + +The difference between cancelling and stopping a (streaming) job is the following: + +On a cancel call, the operators in a job immediately receive a `cancel()` method call to cancel them as +soon as possible. +If operators are not not stopping after the cancel call, Flink will start interrupting the thread periodically +until it stops. + +A "stop" call is a more graceful way of stopping a running streaming job. Stop is only available for jobs +which use sources that implement the `StoppableFunction` interface. When the user requests to stop a job, +all sources will receive a `stop()` method call. The job will keep running until all sources properly shut down. +This allows the job to finish processing all inflight data. ### Savepoints
