Commands Cheat Sheet

Evaluating engineering tools? Get the comparison in Google Sheets

(Perfect for making buy/build decisions or internal reviews.)

Most-used commands
Your email is safe thing.

Thankyou for your submission

We have sent the cheatsheet on your email!
Oops! Something went wrong while submitting the form.

Connection

./bin/flink --help
Display help menu and available options

./bin/start-cluster.sh
Start a local Flink cluster

./bin/stop-cluster.sh
Stop a running Flink cluster

./bin/taskmanager.sh start|stop
Start/stop a TaskManager instance

Job Management

./bin/flink run
Submit a Flink job

./bin/flink run -d
Submit a job in detached mode

./bin/flink run -c
Submit with specific entry point class

./bin/flink cancel
Cancel a running job

./bin/flink stop
Stop a running job with savepoint

./bin/flink list
List running jobs

./bin/flink list -a
List all jobs (running and completed)

Savepoints & Checkpoints

./bin/flink savepoint [targetDirectory]
Trigger a savepoint

./bin/flink run -s
Run job from a savepoint

./bin/flink cancel -s
Cancel job with savepoint

./bin/flink modify -p
Change parallelism of a job

Monitoring & Debugging

curl http://localhost:8081
Access Flink Web UI via REST API

curl http://localhost:8081/jobs/overview
Get overview of all jobs

curl http://localhost:8081/jobs/
Get details of a specific job

curl http://localhost:8081/taskmanagers
List all task managers

./bin/flink info
Show info about a Flink application

./bin/flink info -c
Show info about a specific class

SQL & Table API

./bin/sql-client.sh
Start the SQL Client CLI

SELECT * FROM table;
SQL query in SQL Client

EXPLAIN PLAN FOR SELECT * FROM table;
Explain execution plan

DESCRIBE table;
Show table schema in SQL Client

Configuration

./conf/flink-conf.yaml
Main configuration file

taskmanager.numberOfTaskSlots
Key config for parallelism

parallelism.default
Default parallelism setting

state.backend
Configure state backend (rocksdb, filesystem, etc.)