This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 7c14bf61a88 [doc][catalog] add show catalog command doc (#2675)
7c14bf61a88 is described below
commit 7c14bf61a88cf79aac3ca06cf4754b3f2eca0be1
Author: Petrichor <[email protected]>
AuthorDate: Mon Aug 4 06:38:18 2025 +0800
[doc][catalog] add show catalog command doc (#2675)
## Versions
The documentation changes are based on the ShowCatalogStmt.java
implementation:
https://github.com/apache/doris/blob/branch-2.1/fe/fe-core/src/main/java/org/apache/doris/analysis/ShowCatalogStmt.java
and
https://github.com/apache/doris/blob/master/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/commands/ShowCatalogCommand.java
- [x] dev
- [x] 3.0
- [x] 2.1
- [ ] 2.0
## Languages
- [x] Chinese
- [x] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---
.../sql-statements/catalog/SHOW-CATALOG.md | 65 +++++++++-------------
.../catalog/{SHOW-CATALOG.md => SHOW-CATALOGS.md} | 0
.../sql-statements/catalog/SHOW-CATALOG.md | 59 ++++++++------------
.../catalog/{SHOW-CATALOG.md => SHOW-CATALOGS.md} | 0
.../sql-statements/catalog/SHOW-CATALOG.md | 59 ++++++++------------
.../catalog/{SHOW-CATALOG.md => SHOW-CATALOGS.md} | 0
.../sql-statements/catalog/SHOW-CATALOG.md | 58 +++++++------------
.../catalog/{SHOW-CATALOG.md => SHOW-CATALOGS.md} | 0
sidebars.json | 1 +
.../sql-statements/catalog/SHOW-CATALOG.md | 63 ++++++++-------------
.../catalog/{SHOW-CATALOG.md => SHOW-CATALOGS.md} | 0
.../sql-statements/catalog/SHOW-CATALOG.md | 65 +++++++++-------------
.../catalog/{SHOW-CATALOG.md => SHOW-CATALOGS.md} | 0
versioned_sidebars/version-2.1-sidebars.json | 1 +
versioned_sidebars/version-3.0-sidebars.json | 1 +
15 files changed, 141 insertions(+), 231 deletions(-)
diff --git a/docs/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/docs/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
index 4ba7d877795..6780c752e17 100644
--- a/docs/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
+++ b/docs/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
@@ -1,26 +1,22 @@
---
{
- "title": "SHOW CATALOGS",
- "language": "en"
+ "title": "SHOW CATALOG",
+ "language": "en"
}
---
## Description
-This statement is used for view created catalogs
+Shows properties of specified catalog
## Syntax
```sql
-SHOW CATALOGS [LIKE <catalog_name>]
+SHOW CATALOG <catalog_name>
```
-illustrate:
-1. LIKE: Fuzzy query can be performed according to the catalog name
-
-
-## Optional Parameters
+## Required Parameters
**1. `<catalog_name>`**
@@ -28,47 +24,36 @@ The name of the catalog to be displayed.
## Return Value
-| Column Name | Description |
-|---|---|
-| CatalogId | Unique ID of the data catalog |
-| CatalogName | Name of the data catalog. The default built-in catalog is
named "internal" and cannot be modified. |
-| Type | Type of the data catalog |
-| IsCurrent | Indicates whether it is the currently active data catalog |
-| CreateTime | Creation time |
-| LastUpdateTime | Last updated time |
-| Comment | comments about the catalog |
+| Column Name | Description |
+|-------------|-------------------------------|
+| Key | Configuration property name. |
+| Value | Configuration property value. |
## Access Control Requirements
+
| Privilege
| Object | Notes |
|:---------------------------------------------------------------------------------------------|:--------|:------------------------------------------|
| ADMIN_PRIV / SELECT_PRIV / LOAD_PRIV / ALTER_PRIV / CREATE_PRIV /
SHOW_VIEW_PRIV / DROP_PRIV | Catalog | One of the above permissions is
required. |
-
## Examples
-1. View the data catalogs that have been created currently
+1. View specific catalog configuration details
```sql
- SHOW CATALOGS;
+ show catalog test_mysql;
```
```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
- | 0 | internal | internal | yes | UNRECORDED
| NULL | Doris internal catalog |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
-
-2. Fuzzy query by catalog name
-
- ```sql
- SHOW CATALOGS LIKE 'hi%';
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Value
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | checksum | fdf55dcef04b09f2eaf42b75e61ccc9a
|
+ | create_time | 2025-02-17 17:21:13.099
|
+ | driver_class | com.mysql.cj.jdbc.Driver
|
+ | driver_url | mysql-connector-j-8.3.0.jar
|
+ | jdbc_url | jdbc:mysql://127.0.0.1:3306/db
|
+ | password | *XXX
|
+ | type | jdbc
|
+ | use_meta_cache | true
|
+ | user | root
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
```
- ```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
\ No newline at end of file
diff --git a/docs/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/docs/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
similarity index 100%
copy from docs/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
copy to docs/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
index ef7b42124ae..ca271ff3e53 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
@@ -1,25 +1,22 @@
---
{
- "title": "SHOW-CATALOGS",
+ "title": "SHOW-CATALOG",
"language": "zh-CN"
}
---
## 描述
-该语句用于显示已存在是数据目录（catalog）
+该语句用于显示已存在是数据目录（catalog）属性
## 语法
```sql
-SHOW CATALOGS [LIKE <catalog_name>]
+SHOW CATALOG <catalog_name>
```
-说明：
-LIKE：可按照 CATALOG 名进行模糊查询
-
-## 可选参数
+## 必填参数
**1. `<catalog_name>`**
@@ -28,47 +25,35 @@ LIKE：可按照 CATALOG 名进行模糊查询
## 返回值
-| Column name | Description |
-|---|---|
-| CatalogId | 数据目录唯一 ID |
-| CatalogName | 数据目录名称，其中 internal 是默认内置的 catalog，不可修改 |
-| Type | 数据目录类型 |
-| IsCurrent | 是否为当前正在使用的数据目录 |
-| CreateTime | 创建时间 |
-| LastUpdateTime | 最后更新时间 |
-| Comment | 备注 |
-
## 权限控制
+
| 权限（Privilege）
| 对象（Object） | 说明（Notes） |
|:---------------------------------------------------------------------------------------------|:-----------|:---------------|
| ADMIN_PRIV / SELECT_PRIV / LOAD_PRIV / ALTER_PRIV / CREATE_PRIV /
SHOW_VIEW_PRIV / DROP_PRIV | Catalog | 需要有上述权限中的一种就可以 |
+
## 示例
-1. 查看当前已创建的数据目录
+1. 查看创建的数据目录属性
```sql
- SHOW CATALOGS;
+ SHOW CATALOG test_mysql;
```
```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
- | 0 | internal | internal | yes | UNRECORDED
| NULL | Doris internal catalog |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Value
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | checksum | fdf55dcef04b09f2eaf42b75e61ccc9a
|
+ | create_time | 2025-02-17 17:21:13.099
|
+ | driver_class | com.mysql.cj.jdbc.Driver
|
+ | driver_url | mysql-connector-j-8.3.0.jar
|
+ | jdbc_url | jdbc:mysql://127.0.0.1:3306/db
|
+ | password | *XXX
|
+ | type | jdbc
|
+ | use_meta_cache | true
|
+ | user | root
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ ```
-2. 按照目录名进行模糊搜索
- ```sql
- SHOW CATALOGS LIKE 'hi%';
- ```
- ```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
similarity index 100%
copy from
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
copy to
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
index a6542d36e31..55c0017ed32 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
@@ -1,25 +1,22 @@
---
{
- "title": "SHOW CATALOGS",
+ "title": "SHOW-CATALOG",
"language": "zh-CN"
}
---
## 描述
-该语句用于显示已存在是数据目录（catalog）
+该语句用于显示已存在是数据目录（catalog）属性
## 语法
```sql
-SHOW CATALOGS [LIKE <catalog_name>]
+SHOW CATALOG <catalog_name>
```
-说明：
-LIKE：可按照 CATALOG 名进行模糊查询
-
-## 可选参数
+## 必填参数
**1. `<catalog_name>`**
@@ -28,47 +25,35 @@ LIKE：可按照 CATALOG 名进行模糊查询
## 返回值
-| Column name | Description |
-|---|---|
-| CatalogId | 数据目录唯一 ID |
-| CatalogName | 数据目录名称，其中 internal 是默认内置的 catalog，不可修改 |
-| Type | 数据目录类型 |
-| IsCurrent | 是否为当前正在使用的数据目录 |
-| CreateTime | 创建时间 |
-| LastUpdateTime | 最后更新时间 |
-| Comment | 备注 |
-
## 权限控制
+
| 权限（Privilege）
| 对象（Object） | 说明（Notes） |
|:---------------------------------------------------------------------------------------------|:-----------|:---------------|
| ADMIN_PRIV / SELECT_PRIV / LOAD_PRIV / ALTER_PRIV / CREATE_PRIV /
SHOW_VIEW_PRIV / DROP_PRIV | Catalog | 需要有上述权限中的一种就可以 |
+
## 示例
-1. 查看当前已创建的数据目录
+1. 查看创建的数据目录属性
```sql
- SHOW CATALOGS;
+ SHOW CATALOG test_mysql;
```
```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
- | 0 | internal | internal | yes | UNRECORDED
| NULL | Doris internal catalog |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Value
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | checksum | fdf55dcef04b09f2eaf42b75e61ccc9a
|
+ | create_time | 2025-02-17 17:21:13.099
|
+ | driver_class | com.mysql.cj.jdbc.Driver
|
+ | driver_url | mysql-connector-j-8.3.0.jar
|
+ | jdbc_url | jdbc:mysql://127.0.0.1:3306/db
|
+ | password | *XXX
|
+ | type | jdbc
|
+ | use_meta_cache | true
|
+ | user | root
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ ```
-2. 按照目录名进行模糊搜索
- ```sql
- SHOW CATALOGS LIKE 'hi%';
- ```
- ```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
similarity index 100%
copy from
i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
copy to
i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
index 3bedcaa1d13..8fe53817f79 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
@@ -1,25 +1,22 @@
---
{
- "title": "SHOW-CATALOGS",
+ "title": "SHOW-CATALOG",
"language": "zh-CN"
}
---
## 描述
-该语句用于显示已存在是数据目录（catalog）
+该语句用于显示已存在是数据目录（catalog）属性
## 语法
```sql
-SHOW CATALOGS [LIKE <catalog_name>]
+SHOW CATALOG <catalog_name>
```
-说明：
-LIKE：可按照 CATALOG 名进行模糊查询
-
-## 可选参数
+## 必填参数
**1. `<catalog_name>`**
@@ -28,17 +25,8 @@ LIKE：可按照 CATALOG 名进行模糊查询
## 返回值
-| Column name | Description |
-|---|---|
-| CatalogId | 数据目录唯一 ID |
-| CatalogName | 数据目录名称，其中 internal 是默认内置的 catalog，不可修改 |
-| Type | 数据目录类型 |
-| IsCurrent | 是否为当前正在使用的数据目录 |
-| CreateTime | 创建时间 |
-| LastUpdateTime | 最后更新时间 |
-| Comment | 备注 |
-
## 权限控制
+
| 权限（Privilege）
| 对象（Object） | 说明（Notes） |
|:---------------------------------------------------------------------------------------------|:-----------|:---------------|
| ADMIN_PRIV / SELECT_PRIV / LOAD_PRIV / ALTER_PRIV / CREATE_PRIV /
SHOW_VIEW_PRIV / DROP_PRIV | Catalog | 需要有上述权限中的一种就可以 |
@@ -47,31 +35,25 @@ LIKE：可按照 CATALOG 名进行模糊查询
## 示例
-1. 查看当前已创建的数据目录
+1. 查看创建的数据目录属性
```sql
- SHOW CATALOGS;
+ SHOW CATALOG test_mysql;
```
```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
- | 0 | internal | internal | yes | UNRECORDED
| NULL | Doris internal catalog |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
-
-2. 按照目录名进行模糊搜索
-
- ```sql
- SHOW CATALOGS LIKE 'hi%';
- ```
- ```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Value
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | checksum | fdf55dcef04b09f2eaf42b75e61ccc9a
|
+ | create_time | 2025-02-17 17:21:13.099
|
+ | driver_class | com.mysql.cj.jdbc.Driver
|
+ | driver_url | mysql-connector-j-8.3.0.jar
|
+ | jdbc_url | jdbc:mysql://127.0.0.1:3306/db
|
+ | password | *XXX
|
+ | type | jdbc
|
+ | use_meta_cache | true
|
+ | user | root
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
similarity index 100%
copy from
i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
copy to
i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
diff --git a/sidebars.json b/sidebars.json
index 9d485e443a4..fb9a9c7bc43 100644
--- a/sidebars.json
+++ b/sidebars.json
@@ -2015,6 +2015,7 @@
"sql-manual/sql-statements/catalog/DROP-CATALOG",
"sql-manual/sql-statements/catalog/SHOW-CREATE-CATALOG",
"sql-manual/sql-statements/catalog/SHOW-CATALOG",
+
"sql-manual/sql-statements/catalog/SHOW-CATALOGS",
"sql-manual/sql-statements/catalog/REFRESH"
]
},
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
index 60bab53902e..56706205037 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
@@ -1,25 +1,22 @@
---
{
- "title": "SHOW CATALOGS",
+ "title": "SHOW CATALOG",
"language": "en"
}
---
## Description
-This statement is used for view created catalogs
+Shows properties of specified catalog
## Syntax
```sql
-SHOW CATALOGS [LIKE <catalog_name>]
+SHOW CATALOG <catalog_name>
```
-illustrate:
-1. LIKE: Fuzzy query can be performed according to the catalog name
-
-## Optional Parameters
+## Required Parameters
**1. `<catalog_name>`**
@@ -27,48 +24,36 @@ The name of the catalog to be displayed.
## Return Value
-| Column Name | Description |
-|---|---|
-| CatalogId | Unique ID of the data catalog |
-| CatalogName | Name of the data catalog. The default built-in catalog is
named "internal" and cannot be modified. |
-| Type | Type of the data catalog |
-| IsCurrent | Indicates whether it is the currently active data catalog |
-| CreateTime | Creation time |
-| LastUpdateTime | Last updated time |
-| Comment | comments about the catalog |
+| Column Name | Description |
+|-------------|-------------------------------|
+| Key | Configuration property name. |
+| Value | Configuration property value. |
## Access Control Requirements
+
| Privilege
| Object | Notes |
|:---------------------------------------------------------------------------------------------|:--------|:------------------------------------------|
| ADMIN_PRIV / SELECT_PRIV / LOAD_PRIV / ALTER_PRIV / CREATE_PRIV /
SHOW_VIEW_PRIV / DROP_PRIV | Catalog | One of the above permissions is
required. |
-
## Examples
-1. View the data catalogs that have been created currently
+1. View specific catalog configuration details
```sql
- SHOW CATALOGS;
+ show catalog test_mysql;
```
```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
- | 0 | internal | internal | yes | UNRECORDED
| NULL | Doris internal catalog |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
-
-2. Fuzzy query by catalog name
-
- ```sql
- SHOW CATALOGS LIKE 'hi%';
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Value
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | checksum | fdf55dcef04b09f2eaf42b75e61ccc9a
|
+ | create_time | 2025-02-17 17:21:13.099
|
+ | driver_class | com.mysql.cj.jdbc.Driver
|
+ | driver_url | mysql-connector-j-8.3.0.jar
|
+ | jdbc_url | jdbc:mysql://127.0.0.1:3306/db
|
+ | password | *XXX
|
+ | type | jdbc
|
+ | use_meta_cache | true
|
+ | user | root
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
```
- ```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
-
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
similarity index 100%
copy from
versioned_docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
copy to
versioned_docs/version-2.1/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
index 0aab148fb28..6780c752e17 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
@@ -1,26 +1,22 @@
---
{
- "title": "SHOW CATALOGS",
- "language": "en"
+ "title": "SHOW CATALOG",
+ "language": "en"
}
---
## Description
-This statement is used for view created catalogs
+Shows properties of specified catalog
## Syntax
```sql
-SHOW CATALOGS [LIKE <catalog_name>]
+SHOW CATALOG <catalog_name>
```
-illustrate:
-1. LIKE: Fuzzy query can be performed according to the catalog name
-
-
-## Optional Parameters
+## Required Parameters
**1. `<catalog_name>`**
@@ -28,47 +24,36 @@ The name of the catalog to be displayed.
## Return Value
-| Column Name | Description |
-|---|---|
-| CatalogId | Unique ID of the data catalog |
-| CatalogName | Name of the data catalog. The default built-in catalog is
named "internal" and cannot be modified. |
-| Type | Type of the data catalog |
-| IsCurrent | Indicates whether it is the currently active data catalog |
-| CreateTime | Creation time |
-| LastUpdateTime | Last updated time |
-| Comment | comments about the catalog |
+| Column Name | Description |
+|-------------|-------------------------------|
+| Key | Configuration property name. |
+| Value | Configuration property value. |
## Access Control Requirements
+
| Privilege
| Object | Notes |
|:---------------------------------------------------------------------------------------------|:--------|:------------------------------------------|
| ADMIN_PRIV / SELECT_PRIV / LOAD_PRIV / ALTER_PRIV / CREATE_PRIV /
SHOW_VIEW_PRIV / DROP_PRIV | Catalog | One of the above permissions is
required. |
-
## Examples
-1. View the data catalogs that have been created currently
+1. View specific catalog configuration details
```sql
- SHOW CATALOGS;
+ show catalog test_mysql;
```
```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
- | 0 | internal | internal | yes | UNRECORDED
| NULL | Doris internal catalog |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- ```
-
-2. Fuzzy query by catalog name
-
- ```sql
- SHOW CATALOGS LIKE 'hi%';
- ```
- ```sql
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | CatalogId | CatalogName | Type | IsCurrent | CreateTime
| LastUpdateTime | Comment |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
- | 130100 | hive | hms | | 2023-12-25 16:11:41.687
| 2023-12-25 20:43:18 | NULL |
-
+-----------+-------------+----------+-----------+-------------------------+---------------------+------------------------+
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Value
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | checksum | fdf55dcef04b09f2eaf42b75e61ccc9a
|
+ | create_time | 2025-02-17 17:21:13.099
|
+ | driver_class | com.mysql.cj.jdbc.Driver
|
+ | driver_url | mysql-connector-j-8.3.0.jar
|
+ | jdbc_url | jdbc:mysql://127.0.0.1:3306/db
|
+ | password | *XXX
|
+ | type | jdbc
|
+ | use_meta_cache | true
|
+ | user | root
|
+
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
```
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
similarity index 100%
copy from
versioned_docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOG.md
copy to
versioned_docs/version-3.0/sql-manual/sql-statements/catalog/SHOW-CATALOGS.md
diff --git a/versioned_sidebars/version-2.1-sidebars.json
b/versioned_sidebars/version-2.1-sidebars.json
index a5d71702710..e1e379624f0 100644
--- a/versioned_sidebars/version-2.1-sidebars.json
+++ b/versioned_sidebars/version-2.1-sidebars.json
@@ -1828,6 +1828,7 @@
"sql-manual/sql-statements/catalog/ALTER-CATALOG",
"sql-manual/sql-statements/catalog/DROP-CATALOG",
"sql-manual/sql-statements/catalog/SHOW-CATALOG",
+
"sql-manual/sql-statements/catalog/SHOW-CATALOGS",
"sql-manual/sql-statements/catalog/SHOW-CREATE-CATALOG",
"sql-manual/sql-statements/catalog/REFRESH"
]
diff --git a/versioned_sidebars/version-3.0-sidebars.json
b/versioned_sidebars/version-3.0-sidebars.json
index 2541acf69ba..6baf1d045cb 100644
--- a/versioned_sidebars/version-3.0-sidebars.json
+++ b/versioned_sidebars/version-3.0-sidebars.json
@@ -1905,6 +1905,7 @@
"sql-manual/sql-statements/catalog/DROP-CATALOG",
"sql-manual/sql-statements/catalog/SHOW-CREATE-CATALOG",
"sql-manual/sql-statements/catalog/SHOW-CATALOG",
+
"sql-manual/sql-statements/catalog/SHOW-CATALOGS",
"sql-manual/sql-statements/catalog/REFRESH"
]
},
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
