ryanvanhuuksloot commented on code in PR #28054:
URL: https://github.com/apache/flink/pull/28054#discussion_r3453027705


##########
docs/content/docs/concepts/sql-table-concepts/overview.md:
##########
@@ -278,20 +278,24 @@ Flink SQL> COMPILE PLAN 'file:///path/to/plan.json' FOR 
INSERT INTO enriched_ord
 - SQL Syntax
 
     ```sql
-    COMPILE PLAN [IF NOT EXISTS] <plan_file_path> FOR 
<insert_statement>|<statement_set>;
-    
+    -- Write the compiled plan to a file:
+    COMPILE PLAN '<plan_file_path>' [IF NOT EXISTS] FOR 
<insert_statement>|<statement_set>;
+
+    -- Or return the compiled plan inline as a single-row, single-column 
STRING result set:
+    COMPILE PLAN FOR <insert_statement>|<statement_set>;

Review Comment:
   @davidradl I'd say that the write syntax is the strange syntax here. It is 
the same reason that EXPLAIN doesn't write to a file. Someone must have added 
it as a shortcut but SQL shouldn't write to a filepath like that.
   
   If anything, I'd like to remove that syntax. I'm of the opinion that this 
COMPILE PLAN that returns the plan is the correct implementation and we should 
merge this.
   
   What do you think?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to