SHOW 语句

SHOW 语句用于列出其相应父对象中的对象，例如 catalog、database、table 和 view、column、function 和 module。有关详细信息和其他选项，请参见各个命令。

SHOW CREATE 语句用于打印给定对象的创建 DDL 语句。当前的 SHOW CREATE 语句仅在打印给定表和视图的 DDL 语句时可用。

目前 Flink SQL 支持下列 SHOW 语句：

  • SHOW CATALOGS
  • SHOW CURRENT CATALOG
  • SHOW DATABASES
  • SHOW CURRENT DATABASE
  • SHOW TABLES
  • SHOW CREATE TABLE
  • SHOW COLUMNS
  • SHOW VIEWS
  • SHOW CREATE VIEW
  • SHOW FUNCTIONS
  • SHOW MODULES
  • SHOW FULL MODULES
  • SHOW JARS

执行 SHOW 语句

Java

可以使用 TableEnvironment 中的 executeSql() 方法执行 SHOW 语句。 若 SHOW 操作执行成功，executeSql() 方法返回所有对象，否则会抛出异常。

以下的例子展示了如何在 TableEnvironment 中执行一个 SHOW 语句。

Scala

可以使用 TableEnvironment 中的 executeSql() 方法执行 SHOW 语句。 若 SHOW 操作执行成功，executeSql() 方法返回所有对象，否则会抛出异常。

以下的例子展示了如何在 TableEnvironment 中执行一个 SHOW 语句。

Python

可以使用 TableEnvironment 中的 execute_sql() 方法执行 SHOW 语句。 若 SHOW 操作执行成功，execute_sql() 方法返回所有对象，否则会抛出异常。

以下的例子展示了如何在 TableEnvironment 中执行一个 SHOW 语句。

SQL CLI

可以在 SQL CLI 中执行 SHOW 语句。

以下的例子展示了如何在 SQL CLI 中执行一个 SHOW 语句。

Java

  1. StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
  2. StreamTableEnvironment tEnv = StreamTableEnvironment.create(env);
  4. // show catalogs
  5. tEnv.executeSql("SHOW CATALOGS").print();
  6. // +-----------------+
  7. // |    catalog name |
  8. // +-----------------+
  9. // | default_catalog |
  10. // +-----------------+
  12. // show current catalog
  13. tEnv.executeSql("SHOW CURRENT CATALOG").print();
  14. // +----------------------+
  15. // | current catalog name |
  16. // +----------------------+
  17. // |      default_catalog |
  18. // +----------------------+
  20. // show databases
  21. tEnv.executeSql("SHOW DATABASES").print();
  22. // +------------------+
  23. // |    database name |
  24. // +------------------+
  25. // | default_database |
  26. // +------------------+
  28. // show current database
  29. tEnv.executeSql("SHOW CURRENT DATABASE").print();
  30. // +-----------------------+
  31. // | current database name |
  32. // +-----------------------+
  33. // |      default_database |
  34. // +-----------------------+
  36. // create a table
  37. tEnv.executeSql("CREATE TABLE my_table (...) WITH (...)");
  38. // show tables
  39. tEnv.executeSql("SHOW TABLES").print();
  40. // +------------+
  41. // | table name |
  42. // +------------+
  43. // |   my_table |
  44. // +------------+
  46. // show create table
  47. tEnv.executeSql("SHOW CREATE TABLE my_table").print();
  48. // CREATE TABLE `default_catalog`.`default_db`.`my_table` (
  49. //   ...
  50. // ) WITH (
  51. //   ...
  52. // )
  54. // show columns
  55. tEnv.executeSql("SHOW COLUMNS FROM my_table LIKE '%f%'").print();
  56. // +--------+-------+------+-----+--------+-----------+
  57. // |   name |  type | null | key | extras | watermark |
  58. // +--------+-------+------+-----+--------+-----------+
  59. // | field2 | BYTES | true |     |        |           |
  60. // +--------+-------+------+-----+--------+-----------+
  63. // create a view
  64. tEnv.executeSql("CREATE VIEW my_view AS SELECT * FROM my_table");
  65. // show views
  66. tEnv.executeSql("SHOW VIEWS").print();
  67. // +-----------+
  68. // | view name |
  69. // +-----------+
  70. // |   my_view |
  71. // +-----------+
  73. // show create view
  74. tEnv.executeSql("SHOW CREATE VIEW my_view").print();
  75. // CREATE VIEW `default_catalog`.`default_db`.`my_view`(`field1`, `field2`, ...) as
  76. // SELECT *
  77. // FROM `default_catalog`.`default_database`.`my_table`
  79. // show functions
  80. tEnv.executeSql("SHOW FUNCTIONS").print();
  81. // +---------------+
  82. // | function name |
  83. // +---------------+
  84. // |           mod |
  85. // |        sha256 |
  86. // |           ... |
  87. // +---------------+
  89. // create a user defined function
  90. tEnv.executeSql("CREATE FUNCTION f1 AS ...");
  91. // show user defined functions
  92. tEnv.executeSql("SHOW USER FUNCTIONS").print();
  93. // +---------------+
  94. // | function name |
  95. // +---------------+
  96. // |            f1 |
  97. // |           ... |
  98. // +---------------+
  100. // show modules
  101. tEnv.executeSql("SHOW MODULES").print();
  102. // +-------------+
  103. // | module name |
  104. // +-------------+
  105. // |        core |
  106. // +-------------+
  108. // show full modules
  109. tEnv.executeSql("SHOW FULL MODULES").print();
  110. // +-------------+-------+
  111. // | module name |  used |
  112. // +-------------+-------+
  113. // |        core |  true |
  114. // |        hive | false |
  115. // +-------------+-------+

Scala

  1. val env = StreamExecutionEnvironment.getExecutionEnvironment()
  2. val tEnv = StreamTableEnvironment.create(env)
  4. // show catalogs
  5. tEnv.executeSql("SHOW CATALOGS").print()
  6. // +-----------------+
  7. // |    catalog name |
  8. // +-----------------+
  9. // | default_catalog |
  10. // +-----------------+
  12. // show databases
  13. tEnv.executeSql("SHOW DATABASES").print()
  14. // +------------------+
  15. // |    database name |
  16. // +------------------+
  17. // | default_database |
  18. // +------------------+
  20. // create a table
  21. tEnv.executeSql("CREATE TABLE my_table (...) WITH (...)")
  22. // show tables
  23. tEnv.executeSql("SHOW TABLES").print()
  24. // +------------+
  25. // | table name |
  26. // +------------+
  27. // |   my_table |
  28. // +------------+
  30. // show create table
  31. tEnv.executeSql("SHOW CREATE TABLE my_table").print()
  32. // CREATE TABLE `default_catalog`.`default_db`.`my_table` (
  33. //  ...
  34. // ) WITH (
  35. //  ...
  36. // )
  38. // show columns
  39. tEnv.executeSql("SHOW COLUMNS FROM my_table LIKE '%f%'").print()
  40. // +--------+-------+------+-----+--------+-----------+
  41. // |   name |  type | null | key | extras | watermark |
  42. // +--------+-------+------+-----+--------+-----------+
  43. // | field2 | BYTES | true |     |        |           |
  44. // +--------+-------+------+-----+--------+-----------+
  46. // create a view
  47. tEnv.executeSql("CREATE VIEW my_view AS SELECT * FROM my_table")
  48. // show views
  49. tEnv.executeSql("SHOW VIEWS").print()
  50. // +-----------+
  51. // | view name |
  52. // +-----------+
  53. // |   my_view |
  54. // +-----------+
  56. // show create view
  57. tEnv.executeSql("SHOW CREATE VIEW my_view").print();
  58. // CREATE VIEW `default_catalog`.`default_db`.`my_view`(`field1`, `field2`, ...) as
  59. // SELECT *
  60. // FROM `default_catalog`.`default_database`.`my_table`
  62. // show functions
  63. tEnv.executeSql("SHOW FUNCTIONS").print()
  64. // +---------------+
  65. // | function name |
  66. // +---------------+
  67. // |           mod |
  68. // |        sha256 |
  69. // |           ... |
  70. // +---------------+
  72. // create a user defined function
  73. tEnv.executeSql("CREATE FUNCTION f1 AS ...")
  74. // show user defined functions
  75. tEnv.executeSql("SHOW USER FUNCTIONS").print()
  76. // +---------------+
  77. // | function name |
  78. // +---------------+
  79. // |            f1 |
  80. // |           ... |
  81. // +---------------+
  83. // show modules
  84. tEnv.executeSql("SHOW MODULES").print()
  85. // +-------------+
  86. // | module name |
  87. // +-------------+
  88. // |        core |
  89. // +-------------+
  91. // show full modules
  92. tEnv.executeSql("SHOW FULL MODULES").print()
  93. // +-------------+-------+
  94. // | module name |  used |
  95. // +-------------+-------+
  96. // |        core |  true |
  97. // |        hive | false |
  98. // +-------------+-------+

Python

  1. table_env = StreamTableEnvironment.create(...)
  3. # show catalogs
  4. table_env.execute_sql("SHOW CATALOGS").print()
  5. # +-----------------+
  6. # |    catalog name |
  7. # +-----------------+
  8. # | default_catalog |
  9. # +-----------------+
  11. # show databases
  12. table_env.execute_sql("SHOW DATABASES").print()
  13. # +------------------+
  14. # |    database name |
  15. # +------------------+
  16. # | default_database |
  17. # +------------------+
  19. # create a table
  20. table_env.execute_sql("CREATE TABLE my_table (...) WITH (...)")
  21. # show tables
  22. table_env.execute_sql("SHOW TABLES").print()
  23. # +------------+
  24. # | table name |
  25. # +------------+
  26. # |   my_table |
  27. # +------------+
  28. # show create table
  29. table_env.executeSql("SHOW CREATE TABLE my_table").print()
  30. # CREATE TABLE `default_catalog`.`default_db`.`my_table` (
  31. #   ...
  32. # ) WITH (
  33. #   ...
  34. # )
  36. # show columns
  37. table_env.execute_sql("SHOW COLUMNS FROM my_table LIKE '%f%'").print()
  38. # +--------+-------+------+-----+--------+-----------+
  39. # |   name |  type | null | key | extras | watermark |
  40. # +--------+-------+------+-----+--------+-----------+
  41. # | field2 | BYTES | true |     |        |           |
  42. # +--------+-------+------+-----+--------+-----------+
  44. # create a view
  45. table_env.execute_sql("CREATE VIEW my_view AS SELECT * FROM my_table")
  46. # show views
  47. table_env.execute_sql("SHOW VIEWS").print()
  48. # +-----------+
  49. # | view name |
  50. # +-----------+
  51. # |   my_view |
  52. # +-----------+
  54. # show create view
  55. table_env.execute_sql("SHOW CREATE VIEW my_view").print()
  56. # CREATE VIEW `default_catalog`.`default_db`.`my_view`(`field1`, `field2`, ...) as
  57. # SELECT *
  58. # FROM `default_catalog`.`default_database`.`my_table`
  60. # show functions
  61. table_env.execute_sql("SHOW FUNCTIONS").print()
  62. # +---------------+
  63. # | function name |
  64. # +---------------+
  65. # |           mod |
  66. # |        sha256 |
  67. # |           ... |
  68. # +---------------+
  70. # create a user defined function
  71. table_env.execute_sql("CREATE FUNCTION f1 AS ...")
  72. # show user defined functions
  73. table_env.execute_sql("SHOW USER FUNCTIONS").print()
  74. # +---------------+
  75. # | function name |
  76. # +---------------+
  77. # |            f1 |
  78. # |           ... |
  79. # +---------------+
  81. # show modules
  82. table_env.execute_sql("SHOW MODULES").print()
  83. # +-------------+
  84. # | module name |
  85. # +-------------+
  86. # |        core |
  87. # +-------------+
  89. # show full modules
  90. table_env.execute_sql("SHOW FULL MODULES").print()
  91. # +-------------+-------+
  92. # | module name |  used |
  93. # +-------------+-------+
  94. # |        core |  true |
  95. # |        hive | false |
  96. # +-------------+-------+

SQL CLI

  2. Flink SQL> SHOW CATALOGS;
  3. default_catalog
  5. Flink SQL> SHOW DATABASES;
  6. default_database
  8. Flink SQL> CREATE TABLE my_table (...) WITH (...);
  9. [INFO] Table has been created.
  11. Flink SQL> SHOW TABLES;
  12. my_table
  14. Flink SQL> SHOW CREATE TABLE my_table;
  15. CREATE TABLE `default_catalog`.`default_db`.`my_table` (
  16.   ...
  17. ) WITH (
  18.   ...
  19. )
  22. Flink SQL> SHOW COLUMNS from MyUserTable LIKE '%f%';
  23. +--------+-------+------+-----+--------+-----------+
  24. |   name |  type | null | key | extras | watermark |
  25. +--------+-------+------+-----+--------+-----------+
  26. | field2 | BYTES | true |     |        |           |
  27. +--------+-------+------+-----+--------+-----------+
  28. 1 row in set
  31. Flink SQL> CREATE VIEW my_view AS SELECT * from my_table;
  32. [INFO] View has been created.
  34. Flink SQL> SHOW VIEWS;
  35. my_view
  37. Flink SQL> SHOW CREATE VIEW my_view;
  38. CREATE VIEW `default_catalog`.`default_db`.`my_view`(`field1`, `field2`, ...) as
  39. SELECT *
  40. FROM `default_catalog`.`default_database`.`my_table`
  42. Flink SQL> SHOW FUNCTIONS;
  43. mod
  44. sha256
  45. ...
  47. Flink SQL> CREATE FUNCTION f1 AS ...;
  48. [INFO] Function has been created.
  50. Flink SQL> SHOW USER FUNCTIONS;
  51. f1
  52. ...
  54. Flink SQL> SHOW MODULES;
  55. +-------------+
  56. | module name |
  57. +-------------+
  58. |        core |
  59. +-------------+
  60. 1 row in set
  63. Flink SQL> SHOW FULL MODULES;
  64. +-------------+------+
  65. | module name | used |
  66. +-------------+------+
  67. |        core | true |
  68. +-------------+------+
  69. 1 row in set
  72. Flink SQL> SHOW JARS;
  73. /path/to/addedJar.jar

SHOW CATALOGS

  1. SHOW CATALOGS

展示所有的 catalog。

SHOW CURRENT CATALOG

  1. SHOW CURRENT CATALOG

显示当前正在使用的 catalog。

SHOW DATABASES

  1. SHOW DATABASES

展示当前 catalog 中所有的 database。

SHOW CURRENT DATABASE

  1. SHOW CURRENT DATABASE

显示当前正在使用的 database。

SHOW TABLES

  1. SHOW TABLES [ ( FROM | IN ) [catalog_name.]database_name ] [ [NOT] LIKE <sql_like_pattern> ]

展示指定库的所有表，如果没有指定库则展示当前库的所有表。另外返回的结果能被一个可选的匹配字符串过滤。

LIKE 根据可选的 LIKE 语句展示给定库中与 <sql_like_pattern> 是否模糊相似的所有表。

LIKE 子句中 sql 正则式的语法与 MySQL 方言中的语法相同。

  • % 匹配任意数量的字符, 也包括0数量字符, \% 匹配一个 % 字符.
  • _ 只匹配一个字符, \_ 匹配一个 _ 字符.

SHOW TABLES 示例

假定在 catalog1 的 db1 库有如下表：

  • person
  • dim

在会话的当前库下有如下表：

  • fights

  • orders

  • 显示指定库的所有表。

  1. show tables from db1;
  2. -- show tables from catalog1.db1;
  3. -- show tables in db1;
  4. -- show tables in catalog1.db1;
  5. +------------+
  6. | table name |
  7. +------------+
  8. |        dim |
  9. |     person |
  10. +------------+
  11. 2 rows in set
  • 显示指定库中相似于指定 SQL 正则式的所有表。
  1. show tables from db1 like '%n';
  2. -- show tables from catalog1.db1 like '%n';
  3. -- show tables in db1 like '%n';
  4. -- show tables in catalog1.db1 like '%n';
  5. +------------+
  6. | table name |
  7. +------------+
  8. |     person |
  9. +------------+
  10. 1 row in set
  • 显示指定库中不相似于指定 SQL 正则式的所有表。
  1. show tables from db1 not like '%n';
  2. -- show tables from catalog1.db1 not like '%n';
  3. -- show tables in db1 not like '%n';
  4. -- show tables in catalog1.db1 not like '%n';
  5. +------------+
  6. | table name |
  7. +------------+
  8. |        dim |
  9. +------------+
  10. 1 row in set
  • 显示当前库中的所有表。
  1. show tables;
  2. +------------+
  3. | table name |
  4. +------------+
  5. |      items |
  6. |     orders |
  7. +------------+
  8. 2 rows in set

SHOW CREATE TABLE

  1. SHOW CREATE TABLE [catalog_name.][db_name.]table_name

展示创建指定表的 create 语句。

Attention 目前 SHOW CREATE TABLE 只支持通过 Flink SQL DDL 创建的表。

SHOW COLUMNS

  1. SHOW COLUMNS ( FROM | IN ) [[catalog_name.]database.]<table_name> [ [NOT] LIKE <sql_like_pattern>]

展示给定表的所有列。

LIKE 根据可选的 LIKE 语句展示给定表中与 <sql_like_pattern> 是否模糊相似的所有列。

LIKE 子句中 sql 正则式的语法与 MySQL 方言中的语法相同。

SHOW COLUMNS 示例

假定在 catalog1 catalog 中的 database1 数据库中有名为 orders 的表，其结构如下所示：

  1. +---------+-----------------------------+-------+-----------+---------------+----------------------------+
  2. |    name |                        type |  null |       key |        extras |                  watermark |
  3. +---------+-----------------------------+-------+-----------+---------------+----------------------------+
  4. |    user |                      BIGINT | false | PRI(user) |               |                            |
  5. | product |                 VARCHAR(32) |  true |           |               |                            |
  6. |  amount |                         INT |  true |           |               |                            |
  7. |      ts |      TIMESTAMP(3) *ROWTIME* |  true |           |               | `ts` - INTERVAL '1' SECOND |
  8. |   ptime | TIMESTAMP_LTZ(3) *PROCTIME* | false |           | AS PROCTIME() |                            |
  9. +---------+-----------------------------+-------+-----------+---------------+----------------------------+
  • 显示指定表中的所有列。
  1. show columns from orders;
  2. -- show columns from database1.orders;
  3. -- show columns from catalog1.database1.orders;
  4. -- show columns in orders;
  5. -- show columns in database1.orders;
  6. -- show columns in catalog1.database1.orders;
  7. +---------+-----------------------------+-------+-----------+---------------+----------------------------+
  8. |    name |                        type |  null |       key |        extras |                  watermark |
  9. +---------+-----------------------------+-------+-----------+---------------+----------------------------+
  10. |    user |                      BIGINT | false | PRI(user) |               |                            |
  11. | product |                 VARCHAR(32) |  true |           |               |                            |
  12. |  amount |                         INT |  true |           |               |                            |
  13. |      ts |      TIMESTAMP(3) *ROWTIME* |  true |           |               | `ts` - INTERVAL '1' SECOND |
  14. |   ptime | TIMESTAMP_LTZ(3) *PROCTIME* | false |           | AS PROCTIME() |                            |
  15. +---------+-----------------------------+-------+-----------+---------------+----------------------------+
  16. 5 rows in set
  • 显示指定表中相似于指定 SQL 正则式的所有列。
  1. show columns from orders like '%r';
  2. -- show columns from database1.orders like '%r';
  3. -- show columns from catalog1.database1.orders like '%r';
  4. -- show columns in orders like '%r';
  5. -- show columns in database1.orders like '%r';
  6. -- show columns in catalog1.database1.orders like '%r';
  7. +------+--------+-------+-----------+--------+-----------+
  8. | name |   type |  null |       key | extras | watermark |
  9. +------+--------+-------+-----------+--------+-----------+
  10. | user | BIGINT | false | PRI(user) |        |           |
  11. +------+--------+-------+-----------+--------+-----------+
  12. 1 row in set
  • 显示指定表中不相似于指定 SQL 正则式的所有列。
  1. show columns from orders not like '%_r';
  2. -- show columns from database1.orders not like '%_r';
  3. -- show columns from catalog1.database1.orders not like '%_r';
  4. -- show columns in orders not like '%_r';
  5. -- show columns in database1.orders not like '%_r';
  6. -- show columns in catalog1.database1.orders not like '%_r';
  7. +---------+-----------------------------+-------+-----+---------------+----------------------------+
  8. |    name |                        type |  null | key |        extras |                  watermark |
  9. +---------+-----------------------------+-------+-----+---------------+----------------------------+
  10. | product |                 VARCHAR(32) |  true |     |               |                            |
  11. |  amount |                         INT |  true |     |               |                            |
  12. |      ts |      TIMESTAMP(3) *ROWTIME* |  true |     |               | `ts` - INTERVAL '1' SECOND |
  13. |   ptime | TIMESTAMP_LTZ(3) *PROCTIME* | false |     | AS PROCTIME() |                            |
  14. +---------+-----------------------------+-------+-----+---------------+----------------------------+
  15. 4 rows in set

SHOW VIEWS

  1. SHOW VIEWS

展示当前 catalog 和当前 database 中所有的视图。

SHOW CREATE VIEW

  1. SHOW CREATE VIEW [catalog_name.][db_name.]view_name

展示创建指定视图的 create 语句。

SHOW FUNCTIONS

  1. SHOW [USER] FUNCTIONS

展示当前 catalog 和当前 database 中所有的 function，包括：系统 function 和用户定义的 function。

USER 仅仅展示当前 catalog 和当前 database 中用户定义的 function。

SHOW MODULES

  1. SHOW [FULL] MODULES

展示当前环境激活的所有 module。

FULL 展示当前环境加载的所有 module 及激活状态。

SHOW JARS

  1. SHOW JARS

展示所有通过 ADD JAR 语句加入到 session classloader 中的 jar。

Attention 当前 SHOW JARS 命令只能在 SQL CLI 中使用。