SHOW Statements

    Flink SQL supports the following SHOW statements for now:

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

    Java

    SHOW statements can be executed with the method of the TableEnvironment. The executeSql() method returns objects for a successful SHOW operation, otherwise will throw an exception.

    The following examples show how to run a SHOW statement in TableEnvironment.

    Scala

    SHOW statements can be executed with the executeSql() method of the TableEnvironment. The executeSql() method returns objects for a successful SHOW operation, otherwise will throw an exception.

    The following examples show how to run a SHOW statement in TableEnvironment.

    Python

    SHOW statements can be executed with the execute_sql() method of the TableEnvironment. The execute_sql() method returns objects for a successful SHOW operation, otherwise will throw an exception.

    SQL CLI

    SHOW statements can be executed in SQL CLI.

    The following examples show how to run a SHOW statement in SQL CLI.

    Java

    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. // )
    37. // create a view
    38. tEnv.executeSql("CREATE VIEW my_view AS ...")
    39. // show views
    40. tEnv.executeSql("SHOW VIEWS").print()
    41. // +-----------+
    42. // | view name |
    43. // +-----------+
    44. // |   my_view |
    45. // +-----------+
    47. // show functions
    48. tEnv.executeSql("SHOW FUNCTIONS").print()
    49. // +---------------+
    50. // | function name |
    51. // +---------------+
    52. // |           mod |
    53. // |        sha256 |
    54. // |           ... |
    55. // +---------------+
    57. // create a user defined function
    58. tEnv.executeSql("CREATE FUNCTION f1 AS ...")
    59. // show user defined functions
    60. tEnv.executeSql("SHOW USER FUNCTIONS").print()
    61. // +---------------+
    62. // +---------------+
    63. // |            f1 |
    64. // |           ... |
    65. // +---------------+
    67. // show modules
    68. tEnv.executeSql("SHOW MODULES").print()
    70. // | module name |
    71. // +-------------+
    72. // |        core |
    73. // +-------------+
    75. // show full modules
    76. tEnv.executeSql("SHOW FULL MODULES").print()
    77. // +-------------+-------+
    78. // | module name |  used |
    79. // +-------------+-------+
    80. // |        core |  true |
    81. // |        hive | false |
    82. // +-------------+-------+

    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. # create a view
    37. table_env.execute_sql("CREATE VIEW my_view AS ...")
    38. # show views
    39. table_env.execute_sql("SHOW VIEWS").print()
    40. # +-----------+
    41. # | view name |
    42. # +-----------+
    43. # |   my_view |
    44. # +-----------+
    46. # show functions
    47. table_env.execute_sql("SHOW FUNCTIONS").print()
    48. # +---------------+
    49. # | function name |
    50. # +---------------+
    51. # |           mod |
    52. # |        sha256 |
    53. # |           ... |
    54. # +---------------+
    56. # create a user defined function
    57. table_env.execute_sql("CREATE FUNCTION f1 AS ...")
    58. # show user defined functions
    59. table_env.execute_sql("SHOW USER FUNCTIONS").print()
    60. # +---------------+
    61. # | function name |
    62. # |            f1 |
    63. # |           ... |
    64. # +---------------+
    66. # show modules
    68. # +-------------+
    69. # | module name |
    70. # +-------------+
    71. # |        core |
    72. # +-------------+
    74. # show full modules
    75. table_env.execute_sql("SHOW FULL MODULES").print()
    76. # +-------------+-------+
    77. # | module name |  used |
    78. # +-------------+-------+
    79. # |        core |  true |
    80. # |        hive | false |
    81. # +-------------+-------+

    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. )
    21. Flink SQL> CREATE VIEW my_view AS ...;
    22. [INFO] View has been created.
    24. Flink SQL> SHOW VIEWS;
    25. my_view
    27. Flink SQL> SHOW FUNCTIONS;
    28. mod
    29. sha256
    30. ...
    32. Flink SQL> CREATE FUNCTION f1 AS ...;
    33. [INFO] Function has been created.
    35. Flink SQL> SHOW USER FUNCTIONS;
    36. f1
    37. ...
    39. Flink SQL> SHOW MODULES;
    40. +-------------+
    41. | module name |
    42. +-------------+
    43. |        core |
    44. +-------------+
    45. 1 row in set
    48. Flink SQL> SHOW FULL MODULES;
    49. +-------------+------+
    50. | module name | used |
    51. +-------------+------+
    52. |        core | true |
    53. +-------------+------+
    54. 1 row in set
    56. Flink SQL> SHOW JARS;
    57. /path/to/addedJar.jar

    SHOW CATALOGS

    Show all catalogs.

    SHOW CURRENT CATALOG

    1. SHOW CURRENT CATALOG

    Show current catalog.

    1. SHOW DATABASES

    SHOW CURRENT DATABASE

    1. SHOW CURRENT DATABASE

    Show current database.

    SHOW TABLES

    Show all tables in the current catalog and the current database.

    1. SHOW CREATE TABLE

    Show create table statement for specified table.

    Attention Currently SHOW CREATE TABLE only supports table that is created by Flink SQL DDL.

    SHOW VIEWS

    1. SHOW VIEWS

    Show all views in the current catalog and the current database.

    SHOW FUNCTIONS

      Show all functions including system functions and user-defined functions in the current catalog and current database.

      USER Show only user-defined functions in the current catalog and current database.

      Show all enabled module names with resolution order.

      FULL Show all loaded modules and enabled status with resolution order.

      SHOW JARS

      1. SHOW JARS

      Attention Currently SHOW JARS only works in the SQL CLI.