sv3ndk commented on a change in pull request #16060:
URL: https://github.com/apache/flink/pull/16060#discussion_r663322250
##########
File path:
flink-table/flink-sql-client/src/main/java/org/apache/flink/table/client/cli/CliStrings.java
##########
@@ -73,54 +58,41 @@ private CliStrings() {
formatCommand(
"INSERT OVERWRITE",
"Inserts the results of a SQL SELECT query
into a declared table sink and overwrite existing data."))
- .append(formatCommand("QUIT", "Quits the SQL CLI client."))
- .append(
- formatCommand(
- "RESET",
- "Resets a session configuration property.
Syntax: \"RESET '<key>';\". Use \"RESET;\" for reset all session properties."))
.append(
formatCommand(
"SELECT", "Executes a SQL SELECT query on
the Flink cluster."))
.append(
formatCommand(
- "SET",
- "Sets a session configuration property.
Syntax: \"SET '<key>'='<value>';\". Use \"SET;\" for listing all properties."))
- .append(
- formatCommand(
- "SHOW FUNCTIONS",
- "Shows all user-defined and built-in
functions or only user-defined functions. Syntax: \"SHOW [USER] FUNCTIONS;\""))
- .append(formatCommand("SHOW TABLES", "Shows all registered
tables."))
- .append(
- formatCommand(
- "USE CATALOG",
- "Sets the current catalog. The current
database is set to the catalog's default one. Experimental! Syntax: \"USE
CATALOG <name>;\""))
- .append(
- formatCommand(
- "USE",
- "Sets the current default database.
Experimental! Syntax: \"USE <name>;\""))
+ "EXPLAIN",
+ "Describes the execution plan of a query
or table with the given name."))
.append(
formatCommand(
- "LOAD MODULE",
- "Load a module. Syntax: \"LOAD MODULE
<name> [WITH ('<key1>' = "
- + "'<value1>' [, '<key2>' =
'<value2>', ...])];\""))
+ "BEGIN STATEMENT SET",
+ "Begins a statement set. Syntax: \"BEGIN
STATEMENT SET;\""))
+ .append(formatCommand("END", "Ends a statement set.
Syntax: \"END;\""))
+
.append(
formatCommand(
- "UNLOAD MODULE",
- "Unload a module. Syntax: \"UNLOAD MODULE
<name>;\""))
+ "ADD JAR",
+ "Adds the specified jar file to the
submitted jobs' classloader. Syntax: \"ADD JAR '<path_to_filename>.jar'\""))
.append(
formatCommand(
- "USE MODULES",
- "Enable loaded modules. Syntax: \"USE
MODULES <name1> [, <name2>, ...];\""))
+ "REMOVE JAR",
+ "Removes the specified jar file from the
submitted jobs' classloader. Syntax: \"REMOVE JAR '<path_to_filename>.jar'\""))
.append(
formatCommand(
- "BEGIN STATEMENT SET",
- "Begins a statement set. Syntax: \"BEGIN
STATEMENT SET;\""))
- .append(formatCommand("END", "Ends a statement set.
Syntax: \"END;\""))
+ "SHOW JARS",
+ "Shows the list of user-specified jar
dependencies. This list is impacted by the --jar and --library startup options
as well as the ADD/REMOVE JAR commands."))
.style(AttributedStyle.DEFAULT.underline())
.append("\nHint")
.style(AttributedStyle.DEFAULT)
.append(
": Make sure that a statement ends with \";\" for
finalizing (multi-line) statements.")
+ // About Documentation Link.
+ .style(AttributedStyle.DEFAULT)
+ .append(
+ "\nPlease visit
https://ci.apache.org/projects/flink/flink-docs-stable/docs/dev/table/sql/overview/
for more details.")
Review comment:
Hi,
I know I'm a bit nit-picking here, sorry, although how about giving some
more indication that what the user will find in that page is SQL command they
can type?
Maybe something like:
```
.append("You can also type any Flink SQL statement, please visit
https://ci.apache.org/projects/flink/flink-docs-stable/docs/dev/table/sql/overview/
for more details.")
```
--
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: issues-unsubscr...@flink.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
