EXPLAIN Statements

EXPLAIN statements are used to explain the logical and optimized query plans of a query or an INSERT statement.

Run an EXPLAIN statement

Java

EXPLAIN statements can be executed with the executeSql() method of the TableEnvironment. The executeSql() method returns explain result for a successful EXPLAIN operation, otherwise will throw an exception.

The following examples show how to run an EXPLAIN statement in TableEnvironment.

Scala

EXPLAIN statements can be executed with the executeSql() method of the TableEnvironment. The executeSql() method returns explain result for a successful EXPLAIN operation, otherwise will throw an exception.

The following examples show how to run an EXPLAIN statement in TableEnvironment.

Python

EXPLAIN statements can be executed with the execute_sql() method of the TableEnvironment. The execute_sql() method returns explain result for a successful EXPLAIN operation, otherwise will throw an exception.

The following examples show how to run an EXPLAIN statement in TableEnvironment.

SQL CLI

EXPLAIN statements can be executed in SQL CLI.

The following examples show how to run an EXPLAIN statement in SQL CLI.

Java

  1. StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
  2. StreamTableEnvironment tEnv = StreamTableEnvironment.create(env);
  4. // register a table named "Orders"
  5. tEnv.executeSql("CREATE TABLE MyTable1 (`count` bigint, word VARCHAR(256)) WITH ('connector' = 'datagen')");
  6. tEnv.executeSql("CREATE TABLE MyTable2 (`count` bigint, word VARCHAR(256)) WITH ('connector' = 'datagen')");
  8. // explain SELECT statement through TableEnvironment.explainSql()
  9. String explanation = tEnv.explainSql(
  10.   "SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' " +
  11.   "UNION ALL " + 
  12.   "SELECT `count`, word FROM MyTable2");
  13. System.out.println(explanation);
  15. // explain SELECT statement through TableEnvironment.executeSql()
  16. TableResult tableResult = tEnv.executeSql(
  17.   "EXPLAIN PLAN FOR " + 
  18.   "SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' " +
  19.   "UNION ALL " + 
  20.   "SELECT `count`, word FROM MyTable2");
  21. tableResult.print();
  23. TableResult tableResult2 = tEnv.executeSql(
  24.   "EXPLAIN ESTIMATED_COST, CHANGELOG_MODE, JSON_EXECUTION_PLAN " + 
  25.   "SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' " +
  26.   "UNION ALL " + 
  27.   "SELECT `count`, word FROM MyTable2");
  28. tableResult2.print();

Scala

  1. val env = StreamExecutionEnvironment.getExecutionEnvironment()
  2. val tEnv = StreamTableEnvironment.create(env)
  4. // register a table named "Orders"
  5. tEnv.executeSql("CREATE TABLE MyTable1 (`count` bigint, word VARCHAR(256)) WITH ('connector' = 'datagen')")
  6. tEnv.executeSql("CREATE TABLE MyTable2 (`count` bigint, word VARCHAR(256)) WITH ('connector' = 'datagen')")
  8. // explain SELECT statement through TableEnvironment.explainSql()
  9. val explanation = tEnv.explainSql(
  10.   "SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' " +
  11.   "UNION ALL " + 
  12.   "SELECT `count`, word FROM MyTable2")
  13. println(explanation)
  15. // explain SELECT statement through TableEnvironment.executeSql()
  16. val tableResult = tEnv.executeSql(
  17.   "EXPLAIN PLAN FOR " + 
  18.   "SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' " +
  19.   "UNION ALL " + 
  20.   "SELECT `count`, word FROM MyTable2")
  21. tableResult.print()
  23. val tableResult2 = tEnv.executeSql(
  24.   "EXPLAIN ESTIMATED_COST, CHANGELOG_MODE, JSON_EXECUTION_PLAN " + 
  25.   "SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' " +
  26.   "UNION ALL " + 
  27.   "SELECT `count`, word FROM MyTable2")
  28. tableResult2.print()

Python

  1. table_env = StreamTableEnvironment.create(...)
  3. t_env.execute_sql("CREATE TABLE MyTable1 (`count` bigint, word VARCHAR(256)) WITH ('connector' = 'datagen')")
  4. t_env.execute_sql("CREATE TABLE MyTable2 (`count` bigint, word VARCHAR(256)) WITH ('connector' = 'datagen')")
  6. # explain SELECT statement through TableEnvironment.explain_sql()
  7. explanation1 = t_env.explain_sql(
  8.     "SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' "
  9.     "UNION ALL "
  10.     "SELECT `count`, word FROM MyTable2")
  11. print(explanation1)
  13. # explain SELECT statement through TableEnvironment.execute_sql()
  14. table_result = t_env.execute_sql(
  15.     "EXPLAIN PLAN FOR "
  16.     "SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' "
  17.     "UNION ALL "
  18.     "SELECT `count`, word FROM MyTable2")
  19. table_result.print()
  21. table_result2 = t_env.execute_sql(
  22.     "EXPLAIN ESTIMATED_COST, CHANGELOG_MODE, JSON_EXECUTION_PLAN "
  23.     "SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' "
  24.     "UNION ALL "
  25.     "SELECT `count`, word FROM MyTable2")
  26. table_result2.print()

SQL CLI

  1. Flink SQL> CREATE TABLE MyTable1 (`count` bigint, word VARCHAR(256)) WITH ('connector' = 'datagen');
  2. [INFO] Table has been created.
  4. Flink SQL> CREATE TABLE MyTable2 (`count` bigint, word VARCHAR(256)) WITH ('connector' = 'datagen');
  5. [INFO] Table has been created.
  7. Flink SQL> EXPLAIN PLAN FOR SELECT `count`, word FROM MyTable1 WHERE word LIKE 'F%' 
  8. > UNION ALL 
  9. > SELECT `count`, word FROM MyTable2;
  11. Flink SQL> EXPLAIN ESTIMATED_COST, CHANGELOG_MODE, JSON_EXECUTION_PLAN SELECT `count`, word FROM MyTable1 
  12. > WHERE word LIKE 'F%' 
  13. > UNION ALL 
  14. > SELECT `count`, word FROM MyTable2;

The EXPLAIN result is:

EXPLAIN PLAN

  1. == Abstract Syntax Tree ==
  2. LogicalUnion(all=[true])
  3. :- LogicalProject(count=[$0], word=[$1])
  4. :  +- LogicalFilter(condition=[LIKE($1, _UTF-16LE'F%')])
  5. :     +- LogicalTableScan(table=[[default_catalog, default_database, MyTable1]])
  6. +- LogicalProject(count=[$0], word=[$1])
  7.    +- LogicalTableScan(table=[[default_catalog, default_database, MyTable2]])
  9. == Optimized Physical Plan ==
  10. Union(all=[true], union=[count, word])
  11. :- Calc(select=[count, word], where=[LIKE(word, _UTF-16LE'F%')])
  12. :  +- TableSourceScan(table=[[default_catalog, default_database, MyTable1]], fields=[count, word])
  13. +- TableSourceScan(table=[[default_catalog, default_database, MyTable2]], fields=[count, word])
  15. == Optimized Execution Plan ==
  16. Union(all=[true], union=[count, word])
  17. :- Calc(select=[count, word], where=[LIKE(word, _UTF-16LE'F%')])
  18. :  +- TableSourceScan(table=[[default_catalog, default_database, MyTable1]], fields=[count, word])
  19. +- TableSourceScan(table=[[default_catalog, default_database, MyTable2]], fields=[count, word])

EXPLAIN PLAN WITH DETAILS

  1. == Abstract Syntax Tree ==
  2. LogicalUnion(all=[true])
  3. :- LogicalProject(count=[$0], word=[$1])
  4. :  +- LogicalFilter(condition=[LIKE($1, _UTF-16LE'F%')])
  5. :     +- LogicalTableScan(table=[[default_catalog, default_database, MyTable1]])
  6. +- LogicalProject(count=[$0], word=[$1])
  7.    +- LogicalTableScan(table=[[default_catalog, default_database, MyTable2]])
  9. == Optimized Physical Plan ==
  10. Union(all=[true], union=[count, word], changelogMode=[I]): rowcount = 1.05E8, cumulative cost = {3.1E8 rows, 3.05E8 cpu, 4.0E9 io, 0.0 network, 0.0 memory}
  11. :- Calc(select=[count, word], where=[LIKE(word, _UTF-16LE'F%')], changelogMode=[I]): rowcount = 5000000.0, cumulative cost = {1.05E8 rows, 1.0E8 cpu, 2.0E9 io, 0.0 network, 0.0 memory}
  12. :  +- TableSourceScan(table=[[default_catalog, default_database, MyTable1]], fields=[count, word], changelogMode=[I]): rowcount = 1.0E8, cumulative cost = {1.0E8 rows, 1.0E8 cpu, 2.0E9 io, 0.0 network, 0.0 memory}
  13. +- TableSourceScan(table=[[default_catalog, default_database, MyTable2]], fields=[count, word], changelogMode=[I]): rowcount = 1.0E8, cumulative cost = {1.0E8 rows, 1.0E8 cpu, 2.0E9 io, 0.0 network, 0.0 memory}
  15. == Optimized Execution Plan ==
  16. Union(all=[true], union=[count, word])
  17. :- Calc(select=[count, word], where=[LIKE(word, _UTF-16LE'F%')])
  18. :  +- TableSourceScan(table=[[default_catalog, default_database, MyTable1]], fields=[count, word])
  19. +- TableSourceScan(table=[[default_catalog, default_database, MyTable2]], fields=[count, word])
  21. == Physical Execution Plan ==
  22. {
  23.   "nodes" : [ {
  24.     "id" : 37,
  25.     "type" : "Source: TableSourceScan(table=[[default_catalog, default_database, MyTable1]], fields=[count, word])",
  26.     "pact" : "Data Source",
  27.     "contents" : "Source: TableSourceScan(table=[[default_catalog, default_database, MyTable1]], fields=[count, word])",
  28.     "parallelism" : 1
  29.   }, {
  30.     "id" : 38,
  31.     "type" : "Calc(select=[count, word], where=[LIKE(word, _UTF-16LE'F%')])",
  32.     "pact" : "Operator",
  33.     "contents" : "Calc(select=[count, word], where=[LIKE(word, _UTF-16LE'F%')])",
  34.     "parallelism" : 1,
  35.     "predecessors" : [ {
  36.       "id" : 37,
  37.       "ship_strategy" : "FORWARD",
  38.       "side" : "second"
  39.     } ]
  40.   }, {
  41.     "id" : 39,
  42.     "type" : "Source: TableSourceScan(table=[[default_catalog, default_database, MyTable2]], fields=[count, word])",
  43.     "pact" : "Data Source",
  44.     "contents" : "Source: TableSourceScan(table=[[default_catalog, default_database, MyTable2]], fields=[count, word])",
  45.     "parallelism" : 1
  46.   } ]

ExplainDetails

  1. Print the plan for the statement with specified ExplainDetails.
  3. ESTIMATED_COST: generates cost information on physical node estimated by optimizer, 
  4. e.g. TableSourceScan(..., cumulative cost ={1.0E8 rows, 1.0E8 cpu, 2.4E9 io, 0.0 network, 0.0 memory})
  6. CHANGELOG_MODE:generates changelog mode for every physical rel node. 
  7. e.g. GroupAggregate(..., changelogMode=[I,UA,D])
  9. JSON_EXECUTION_PLAN: generates the execution plan in json format of the program.

Syntax

  1. EXPLAIN [([ExplainDetail[, ExplainDetail]*]) | PLAN FOR] <query_statement_or_insert_statement_or_statement_set>
  3. statement_set:
  4. EXECUTE STATEMENT SET
  5. BEGIN
  6. insert_statement;
  7. ...
  8. insert_statement;
  9. END;

For query syntax, please refer to Queries page. For insert syntax, please refer to INSERT page.