Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc]modify catalog docs #1903

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[doc]modify catalog docs #1903

wants to merge 3 commits into from

Conversation

ixzc
Copy link
Contributor

@ixzc ixzc commented Jan 22, 2025

modify catalog docs

Versions

  • dev
  • 3.0
  • 2.1
  • 2.0

Languages

  • Chinese
  • English

Docs Checklist

  • Checked by AI
  • Test Cases Built

Copy link
Contributor

@morrySnow morrySnow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

请严格按照实例给出的排版书写。缺少

  1. 参数章节
  2. 权限控制章节


This statement is used to set properties of the specified catalog. (administrator only)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This statement is used to set properties of the specified catalog. (administrator only)
This statement is used to set properties of the specified catalog.


1) Rename the catalog
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

放到语法章节

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

缺少参数章节

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

缺少权限控制章节

Comment on lines 35 to 36
CREATE CATALOG [IF NOT EXISTS] <catalog_name> [comment]
PROPERTIES ("key"="value", ...);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

参数都要被尖括号包裹

Suggested change
CREATE CATALOG [IF NOT EXISTS] <catalog_name> [comment]
PROPERTIES ("key"="value", ...);
CREATE CATALOG [IF NOT EXISTS] <catalog_name> [ COMMENT <comment>]
PROPERTIES ("<key>"="<value>", ...);


```sql
CREATE CATALOG [IF NOT EXISTS] catalog_name [comment]
CREATE CATALOG [IF NOT EXISTS] <catalog_name> [comment]
PROPERTIES ("key"="value", ...);
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

缺少参数章节

@KassieZ KassieZ added has comments Some comments not resolved yet and removed request review labels Jan 24, 2025
@ixzc ixzc requested a review from morrySnow January 24, 2025 09:34
Copy link
Contributor

@morrySnow morrySnow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

只评论了第一个发现问题的地方,麻烦检查修改一下所有的文档

```

## Required Parameters

### 1. `<catalog_name>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

用加粗,而不是H3 header

Suggested change
### 1. `<catalog_name>`
** 1. `<catalog_name>` **

REFRESH TABLE [catalog_name.][database_name.]table_name;
REFRESH CATALOG <catalog_name>;
REFRESH DATABASE <[catalog_name.]database_name>;
REFRESH TABLE <[catalog_name.][database_name.]table_name>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
REFRESH TABLE <[catalog_name.][database_name.]table_name>;
REFRESH TABLE [[<catalog_name.>]<database_name>.]<table_name>;

REFRESH DATABASE [catalog_name.]database_name;
REFRESH TABLE [catalog_name.][database_name.]table_name;
REFRESH CATALOG <catalog_name>;
REFRESH DATABASE <[catalog_name.]database_name>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
REFRESH DATABASE <[catalog_name.]database_name>;
REFRESH DATABASE [<catalog_name.>]<database_name>;

@ixzc ixzc requested a review from morrySnow January 25, 2025 01:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has comments Some comments not resolved yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants