[FLINK-16541] Document of table.exec.shuffle-mode is incorrect

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.10.0
• Fix Version/s: 1.10.1, 1.11.0
• Component/s: Documentation
• Labels: pull-request-available
• Assignee: Caizhi Weng
• Reporter: Caizhi Weng
• Created: 11/Mar/20 10:51
• Updated: 16/Mar/20 03:31
• Resolved: 16/Mar/20 03:31

Description

Document of table.exec.shuffle-mode is incorrect. Currently the document states that

Sets exec shuffle mode. Only batch or pipeline can be set.

But "pipeline" is incorrect, the correct configuration is "pipelined". Using pipeline instead of pipelined will throw the following exception.

java.lang.IllegalArgumentException: table.exec.shuffle-mode can only be set to BATCH or PIPELINED
	at org.apache.flink.table.planner.utils.ExecutorUtils.isShuffleModeAllBatch(ExecutorUtils.java:98)
	at org.apache.flink.table.planner.utils.ExecutorUtils.setBatchProperties(ExecutorUtils.java:69)
	at org.apache.flink.table.planner.delegation.BatchExecutor.getStreamGraph(BatchExecutor.java:50)
	at com.ververica.flink.table.gateway.context.ExecutionContext.createPipeline(ExecutionContext.java:272)
	at com.ververica.flink.table.gateway.operation.SelectOperation.executeQueryInternal(SelectOperation.java:246)

Issue Links

• links to: GitHub Pull Request #11386