This is an automated email from the ASF dual-hosted git repository.
yuxia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 3c452de8922 [FLINK-32460][doc] Add doc for show procedures statement
(#23076)
3c452de8922 is described below
commit 3c452de8922784d58e0ebd68f5303e9459cc1d58
Author: yuxia Luo <[email protected]>
AuthorDate: Thu Jul 27 09:31:31 2023 +0800
[FLINK-32460][doc] Add doc for show procedures statement (#23076)
---
docs/content.zh/docs/dev/table/sql/show.md | 22 ++++++++++++++++++++++
docs/content/docs/dev/table/sql/show.md | 19 +++++++++++++++++++
2 files changed, 41 insertions(+)
diff --git a/docs/content.zh/docs/dev/table/sql/show.md
b/docs/content.zh/docs/dev/table/sql/show.md
index 76d42780cff..c6464b70815 100644
--- a/docs/content.zh/docs/dev/table/sql/show.md
+++ b/docs/content.zh/docs/dev/table/sql/show.md
@@ -39,12 +39,15 @@ SHOW CREATE 语句用于打印给定对象的创建 DDL 语句。当前的 SHOW
- SHOW TABLES
- SHOW CREATE TABLE
- SHOW COLUMNS
+- SHOW PARTITIONS
+- SHOW PROCEDURES
- SHOW VIEWS
- SHOW CREATE VIEW
- SHOW FUNCTIONS
- SHOW MODULES
- SHOW FULL MODULES
- SHOW JARS
+- SHOW JOBS
## 执行 SHOW 语句
@@ -799,6 +802,25 @@ show partitions table1 partition (id=1002);
2 rows in set
```
+## SHOW PROCEDURES
+
+```sql
+SHOW PROCEDURES [ ( FROM | IN ) [catalog_name.]database_name ] [ [NOT] (LIKE |
ILIKE) <sql_like_pattern> ]
+```
+
+展示指定 catalog 和 database 下的所有 procedure。
+如果没有指定 catalog 和 database，则将使用当前 catalog 和 当前 database。另外可以用
`<sql_like_pattern>` 来过滤要返回的 procedure。
+
+**LIKE**
+根据可选的 `LIKE` 语句与 `<sql_like_pattern>` 是否模糊匹配的所有 procedure。
+
+`LIKE` 子句中 SQL 正则式的语法与 `MySQL` 方言中的语法相同。
+* `%` 匹配任意数量的字符, 也包括0数量字符, `\%` 匹配一个 `%` 字符.
+* `_` 只匹配一个字符, `\_` 匹配一个 `_` 字符.
+
+**ILIKE**
+它的行为和 LIKE 相同，只是对于大小写是不敏感的。
+
## SHOW VIEWS
```sql
diff --git a/docs/content/docs/dev/table/sql/show.md
b/docs/content/docs/dev/table/sql/show.md
index 726b09d5722..31002724502 100644
--- a/docs/content/docs/dev/table/sql/show.md
+++ b/docs/content/docs/dev/table/sql/show.md
@@ -39,6 +39,7 @@ Flink SQL supports the following SHOW statements for now:
- SHOW CREATE TABLE
- SHOW COLUMNS
- SHOW PARTITIONS
+- SHOW PROCEDURES
- SHOW VIEWS
- SHOW CREATE VIEW
- SHOW FUNCTIONS
@@ -800,6 +801,24 @@ show partitions table1 partition (id=1002);
2 rows in set
```
+## SHOW PROCEDURES
+
+```sql
+SHOW PROCEDURES [ ( FROM | IN ) [catalog_name.]database_name ] [ [NOT] (LIKE |
ILIKE) <sql_like_pattern> ]
+```
+
+Show all procedures for an optionally specified database. If no database is
specified then the procedures are returned from the current database.
Additionally, a `<sql_like_pattern>` can be used to filter the procedures.
+
+**LIKE**
+Show all procedures with a `LIKE` clause, whose name is similar to the
`<sql_like_pattern>`.
+
+The syntax of the SQL pattern in the `LIKE` clause is the same as that of the
`MySQL` dialect.
+* `%` matches any number of characters, even zero characters, and `\%` matches
one `%` character.
+* `_` matches exactly one character, `\_` matches one `_` character.
+
+**ILIKE**
+The same behavior as `LIKE` but the SQL pattern is case-insensitive.
+
## SHOW VIEWS
```sql
