From cf2f55b3afe5bd1ef9cbf6442b72fce8b9423684 Mon Sep 17 00:00:00 2001 From: Roc Marshal Date: Thu, 3 Jun 2021 20:13:11 +0800 Subject: [PATCH 1/5] [FLINK-23028][docs] Improve documentation for pages of SQL. --- docs/content.zh/docs/dev/table/sql/alter.md | 4 +++- docs/content.zh/docs/dev/table/sql/create.md | 4 +++- docs/content.zh/docs/dev/table/sql/drop.md | 18 ++++++++++++++++-- docs/content.zh/docs/dev/table/sql/use.md | 2 +- docs/content/docs/dev/table/sql/drop.md | 15 ++++++++++++++- docs/content/docs/dev/table/sql/use.md | 2 +- 6 files changed, 38 insertions(+), 7 deletions(-) diff --git a/docs/content.zh/docs/dev/table/sql/alter.md b/docs/content.zh/docs/dev/table/sql/alter.md index e288ede54d4a2..73d7e9c2c13e9 100644 --- a/docs/content.zh/docs/dev/table/sql/alter.md +++ b/docs/content.zh/docs/dev/table/sql/alter.md @@ -180,12 +180,14 @@ ALTER DATABASE [catalog_name.]db_name SET (key1=val1, key2=val2, ...) ## ALTER FUNCTION -{% highlight sql%} +```sql ALTER [TEMPORARY|TEMPORARY SYSTEM] FUNCTION [IF EXISTS] [catalog_name.][db_name.]function_name AS identifier [LANGUAGE JAVA|SCALA|PYTHON] ``` +``` + 修改一个有 catalog 和数据库命名空间的 catalog function ，需要指定一个新的 identifier ，可指定 language tag 。若函数不存在，删除会抛出异常。 如果 language tag 是 JAVA 或者 SCALA ，则 identifier 是 UDF 实现类的全限定名。关于 JAVA/SCALA UDF 的实现，请参考 [自定义函数]({{< ref "docs/dev/table/functions/udfs" >}})。 diff --git a/docs/content.zh/docs/dev/table/sql/create.md b/docs/content.zh/docs/dev/table/sql/create.md index d0ef2815309ba..82777e4e0e03f 100644 --- a/docs/content.zh/docs/dev/table/sql/create.md +++ b/docs/content.zh/docs/dev/table/sql/create.md @@ -573,12 +573,14 @@ CREATE [TEMPORARY] VIEW [IF NOT EXISTS] [catalog_name.][db_name.]view_name {{< top >}} ## CREATE FUNCTION -{% highlight sql%} +```sql CREATE [TEMPORARY|TEMPORARY SYSTEM] FUNCTION [IF NOT EXISTS] [[catalog_name.]db_name.]function_name AS identifier [LANGUAGE JAVA|SCALA|PYTHON] ``` +``` + 创建一个有 catalog 和数据库命名空间的 catalog function ，需要指定一个 identifier ，可指定 language tag 。 若 catalog 中，已经有同名的函数注册了，则无法注册。 如果 language tag 是 JAVA 或者 SCALA ，则 identifier 是 UDF 实现类的全限定名。关于 JAVA/SCALA UDF 的实现，请参考 [自定义函数]({{< ref "docs/dev/table/functions/udfs" >}})。 diff --git a/docs/content.zh/docs/dev/table/sql/drop.md b/docs/content.zh/docs/dev/table/sql/drop.md index cc921a3aed4d7..cf69ec2c2ef2b 100644 --- a/docs/content.zh/docs/dev/table/sql/drop.md +++ b/docs/content.zh/docs/dev/table/sql/drop.md @@ -28,10 +28,11 @@ under the License. -DROP 语句用于从当前或指定的 [Catalog]({{< ref "docs/dev/table/catalogs" >}}) 中删除一个已经注册的表、视图或函数。 +DROP 语句可用于删除指定的 catalog，也可用于从当前或指定的 [Catalog]({{< ref "docs/dev/table/catalogs" >}}) 中删除一个已经注册的表、视图或函数。 Flink SQL 目前支持以下 DROP 语句： +- DROP CATALOG - DROP TABLE - DROP DATABASE - DROP VIEW @@ -146,6 +147,18 @@ Flink SQL> SHOW TABLES; {{< /tab >}} {{< /tabs >}} +## DROP CATALOG + +```sql +DROP CATALOG [IF EXISTS] catalog_name +``` + +删除给定的 catalog name 的 catalog。 + +**IF EXISTS** + +如果目标 catalog 不存在，则不会生效。 + ## DROP TABLE ```sql @@ -199,10 +212,11 @@ Flink 没有使用 CASCADE / RESTRICT 关键字来维护视图的依赖关系， ## DROP FUNCTION -{% highlight sql%} +```sql DROP [TEMPORARY|TEMPORARY SYSTEM] FUNCTION [IF EXISTS] [catalog_name.][db_name.]function_name; ``` +``` 删除一个有 catalog 和数据库命名空间的 catalog function。若需要删除的函数不存在，则会产生异常。 **TEMPORARY** diff --git a/docs/content.zh/docs/dev/table/sql/use.md b/docs/content.zh/docs/dev/table/sql/use.md index 8728873556f6b..b4e7dc461bbd4 100644 --- a/docs/content.zh/docs/dev/table/sql/use.md +++ b/docs/content.zh/docs/dev/table/sql/use.md @@ -243,7 +243,7 @@ Flink SQL> SHOW FULL MODULES; {{< top >}} -## USE CATLOAG +## USE CATALOG ```sql USE CATALOG catalog_name diff --git a/docs/content/docs/dev/table/sql/drop.md b/docs/content/docs/dev/table/sql/drop.md index bb697f3ca7fd8..0a3cf482a9b4c 100644 --- a/docs/content/docs/dev/table/sql/drop.md +++ b/docs/content/docs/dev/table/sql/drop.md @@ -26,10 +26,11 @@ under the License. # DROP Statements -DROP statements are used to remove a registered table/view/function from current or specified [Catalog]({{< ref "docs/dev/table/catalogs" >}}). +DROP statements are used to remove a catalog with given catalog name or to remove a registered table/view/function from current or specified [Catalog]({{< ref "docs/dev/table/catalogs" >}}). Flink SQL supports the following DROP statements for now: +- DROP CATALOG - DROP TABLE - DROP DATABASE - DROP VIEW @@ -138,6 +139,18 @@ Flink SQL> SHOW TABLES; {{< /tab >}} {{< /tabs >}} +## DROP CATALOG + +```sql +DROP CATALOG [IF EXISTS] catalog_name +``` + +Drop a catalog with the given catalog name. + +**IF EXISTS** + +If the catalog does not exist, nothing happens. + ## DROP TABLE ```sql diff --git a/docs/content/docs/dev/table/sql/use.md b/docs/content/docs/dev/table/sql/use.md index 4a5f62f21deef..1df34d2f27085 100644 --- a/docs/content/docs/dev/table/sql/use.md +++ b/docs/content/docs/dev/table/sql/use.md @@ -244,7 +244,7 @@ Flink SQL> SHOW FULL MODULES; {{< top >}} -## USE CATLOAG +## USE CATALOG ```sql USE CATALOG catalog_name From 73e2b93d058388233da2103ff79a8e80f6c9872d Mon Sep 17 00:00:00 2001 From: Roc Marshal Date: Thu, 3 Jun 2021 20:16:47 +0800 Subject: [PATCH 2/5] [FLINK-23028][docs] Improve documentation for pages of SQL. --- docs/content/docs/dev/table/sql/drop.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/docs/dev/table/sql/drop.md b/docs/content/docs/dev/table/sql/drop.md index 0a3cf482a9b4c..ea42486cfc42e 100644 --- a/docs/content/docs/dev/table/sql/drop.md +++ b/docs/content/docs/dev/table/sql/drop.md @@ -26,7 +26,7 @@ under the License. # DROP Statements -DROP statements are used to remove a catalog with given catalog name or to remove a registered table/view/function from current or specified [Catalog]({{< ref "docs/dev/table/catalogs" >}}). +DROP statements are used to remove a catalog with given catalog name or used to remove a registered table/view/function from current or specified [Catalog]({{< ref "docs/dev/table/catalogs" >}}). Flink SQL supports the following DROP statements for now: From 9b02043b069598084957c5f5d37172f680e69046 Mon Sep 17 00:00:00 2001 From: Roc Marshal <64569824+RocMarshal@users.noreply.github.com> Date: Fri, 11 Jun 2021 17:05:55 +0800 Subject: [PATCH 3/5] Update docs/content/docs/dev/table/sql/drop.md Co-authored-by: David Anderson --- docs/content/docs/dev/table/sql/drop.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/docs/dev/table/sql/drop.md b/docs/content/docs/dev/table/sql/drop.md index ea42486cfc42e..f4a6ca30ea9a7 100644 --- a/docs/content/docs/dev/table/sql/drop.md +++ b/docs/content/docs/dev/table/sql/drop.md @@ -26,7 +26,7 @@ under the License. # DROP Statements -DROP statements are used to remove a catalog with given catalog name or used to remove a registered table/view/function from current or specified [Catalog]({{< ref "docs/dev/table/catalogs" >}}). +DROP statements are used to remove a catalog with the given catalog name or to remove a registered table/view/function from the current or specified [Catalog]({{< ref "docs/dev/table/catalogs" >}}). Flink SQL supports the following DROP statements for now: From 5f4822454e7916a76f87f6ffa745b810a82b9996 Mon Sep 17 00:00:00 2001 From: Roc Marshal Date: Fri, 18 Jun 2021 18:11:41 +0800 Subject: [PATCH 4/5] [FLINK-23028][docs] Improve documentation for pages of SQL. --- docs/content.zh/docs/dev/table/sql/alter.md | 2 -- docs/content.zh/docs/dev/table/sql/create.md | 2 -- docs/content.zh/docs/dev/table/sql/drop.md | 1 - 3 files changed, 5 deletions(-) diff --git a/docs/content.zh/docs/dev/table/sql/alter.md b/docs/content.zh/docs/dev/table/sql/alter.md index 73d7e9c2c13e9..179802682758e 100644 --- a/docs/content.zh/docs/dev/table/sql/alter.md +++ b/docs/content.zh/docs/dev/table/sql/alter.md @@ -186,8 +186,6 @@ ALTER [TEMPORARY|TEMPORARY SYSTEM] FUNCTION AS identifier [LANGUAGE JAVA|SCALA|PYTHON] ``` -``` - 修改一个有 catalog 和数据库命名空间的 catalog function ，需要指定一个新的 identifier ，可指定 language tag 。若函数不存在，删除会抛出异常。 如果 language tag 是 JAVA 或者 SCALA ，则 identifier 是 UDF 实现类的全限定名。关于 JAVA/SCALA UDF 的实现，请参考 [自定义函数]({{< ref "docs/dev/table/functions/udfs" >}})。 diff --git a/docs/content.zh/docs/dev/table/sql/create.md b/docs/content.zh/docs/dev/table/sql/create.md index 82777e4e0e03f..e1c83b7695e9d 100644 --- a/docs/content.zh/docs/dev/table/sql/create.md +++ b/docs/content.zh/docs/dev/table/sql/create.md @@ -579,8 +579,6 @@ CREATE [TEMPORARY|TEMPORARY SYSTEM] FUNCTION AS identifier [LANGUAGE JAVA|SCALA|PYTHON] ``` -``` - 创建一个有 catalog 和数据库命名空间的 catalog function ，需要指定一个 identifier ，可指定 language tag 。 若 catalog 中，已经有同名的函数注册了，则无法注册。 如果 language tag 是 JAVA 或者 SCALA ，则 identifier 是 UDF 实现类的全限定名。关于 JAVA/SCALA UDF 的实现，请参考 [自定义函数]({{< ref "docs/dev/table/functions/udfs" >}})。 diff --git a/docs/content.zh/docs/dev/table/sql/drop.md b/docs/content.zh/docs/dev/table/sql/drop.md index cf69ec2c2ef2b..76962b813e8cb 100644 --- a/docs/content.zh/docs/dev/table/sql/drop.md +++ b/docs/content.zh/docs/dev/table/sql/drop.md @@ -216,7 +216,6 @@ Flink 没有使用 CASCADE / RESTRICT 关键字来维护视图的依赖关系， DROP [TEMPORARY|TEMPORARY SYSTEM] FUNCTION [IF EXISTS] [catalog_name.][db_name.]function_name; ``` -``` 删除一个有 catalog 和数据库命名空间的 catalog function。若需要删除的函数不存在，则会产生异常。 **TEMPORARY** From 934f681b09f52fb1168265edba97b95c4fb9bd2d Mon Sep 17 00:00:00 2001 From: Roc Marshal Date: Thu, 24 Jun 2021 12:03:50 +0800 Subject: [PATCH 5/5] Update based on gaoyunhaii's comments --- docs/content.zh/docs/dev/table/sql/drop.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content.zh/docs/dev/table/sql/drop.md b/docs/content.zh/docs/dev/table/sql/drop.md index 76962b813e8cb..779bd5f88b81f 100644 --- a/docs/content.zh/docs/dev/table/sql/drop.md +++ b/docs/content.zh/docs/dev/table/sql/drop.md @@ -153,11 +153,11 @@ Flink SQL> SHOW TABLES; DROP CATALOG [IF EXISTS] catalog_name ``` -删除给定的 catalog name 的 catalog。 +删除给定名字的 catalog。 **IF EXISTS** -如果目标 catalog 不存在，则不会生效。 +如果目标 catalog 不存在，则不会执行任何操作。 ## DROP TABLE