Skip to content

Commit 5439af3

Browse files
BohuTANGBohuTANG
authored
refine ddl/function index.md (#2378)
* refine ddl/function index.md * fix the broken link * reorder the sql functions
1 parent b067744 commit 5439af3

File tree

84 files changed

+1886
-651
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+1886
-651
lines changed

‎docs/en/sql-reference/10-sql-commands/00-ddl/00-database/index.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
---
2-
title: Database
2+
title: Database
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54

6-
This page provides reference information for the database-related commands in Databend.
5+
This page provides a comprehensive overview of database operations in Databend, organized by functionality for easy reference.
76

8-
<IndexOverviewList />
7+
## Database Creation & Management
8+
9+
| Command | Description |
10+
|---------|-------------|
11+
| [CREATE DATABASE](ddl-create-database.md) | Creates a new database |
12+
| [ALTER DATABASE](ddl-alter-database.md) | Modifies a database |
13+
| [DROP DATABASE](ddl-drop-database.md) | Removes a database |
14+
| [USE DATABASE](ddl-use-database.md) | Sets the current working database |
15+
| [UNDROP DATABASE](undrop-database.md) | Recovers a dropped database |
16+
17+
## Database Information
18+
19+
| Command | Description |
20+
|---------|-------------|
21+
| [SHOW DATABASES](show-databases.md) | Lists all databases |
22+
| [SHOW CREATE DATABASE](show-create-database.md) | Shows the CREATE DATABASE statement for a database |
23+
| [SHOW DROP DATABASES](show-drop-databases.md) | Lists dropped databases that can be recovered |
24+
25+
:::note
26+
Database operations are foundational for organizing your data in Databend. Make sure you have appropriate privileges before executing these commands.
27+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/01-table/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Table Commands
2+
title: Table
33
---
44

55
This page provides a comprehensive overview of table operations in Databend, organized by functionality for easy reference.

‎docs/en/sql-reference/10-sql-commands/00-ddl/02-user/index.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,37 @@
11
---
2-
title: User & Role
2+
title: User & Role
33
---
44

5-
This page provides reference information for the user and role related commands in Databend.
5+
This page provides a comprehensive overview of user and role operations in Databend, organized by functionality for easy reference.
66

7-
## User and Role Management:
7+
## User Management
88

9-
- [CREATE USER](01-user-create-user.md)
10-
- [DROP USER](02-user-drop-user.md)
11-
- [CREATE ROLE](04-user-create-role.md)
12-
- [SET ROLE](04-user-set-role.md)
13-
- [DROP ROLE](05-user-drop-role.md)
9+
| Command | Description |
10+
|---------|-------------|
11+
| [CREATE USER](01-user-create-user.md) | Creates a new user account |
12+
| [ALTER USER](03-user-alter-user.md) | Modifies an existing user account |
13+
| [DROP USER](02-user-drop-user.md) | Removes a user account |
14+
| [DESC USER](01-user-desc-user.md) | Shows detailed information about a user |
15+
| [SHOW USERS](02-user-show-users.md) | Lists all users in the system |
1416

15-
## Permissions Management:
17+
## Role Management
1618

17-
- [GRANT](10-grant.md)
18-
- [REVOKE](11-revoke.md)
19+
| Command | Description |
20+
|---------|-------------|
21+
| [CREATE ROLE](04-user-create-role.md) | Creates a new role |
22+
| [DROP ROLE](05-user-drop-role.md) | Removes a role |
23+
| [SET ROLE](04-user-set-role.md) | Sets the current active role for the session |
24+
| [SET SECONDARY ROLES](04-user-set-2nd-roles.md) | Sets secondary roles for the session |
25+
| [SHOW ROLES](04-user-show-roles.md) | Lists all roles in the system |
1926

20-
## Information Retrieval:
27+
## Privilege Management
2128

22-
- [DESC USER](01-user-desc-user.md)
23-
- [SHOW USERS](02-user-show-users.md)
24-
- [SHOW ROLES](04-user-show-roles.md)
25-
- [SHOW GRANTS](22-show-grants.md)
29+
| Command | Description |
30+
|---------|-------------|
31+
| [GRANT](10-grant.md) | Assigns privileges to users or roles |
32+
| [REVOKE](11-revoke.md) | Removes privileges from users or roles |
33+
| [SHOW GRANTS](22-show-grants.md) | Shows privileges granted to users or roles |
2634

27-
## User Modification:
28-
29-
- [ALTER USER](03-user-alter-user.md)
35+
:::note
36+
Proper user and role management is essential for database security. Always follow the principle of least privilege when granting permissions.
37+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/03-stage/index.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,37 @@
11
---
2-
title: Stage Commands
2+
title: Stage
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54

6-
This page provides reference information for the stage-related commands in Databend.
5+
This page provides a comprehensive overview of stage operations in Databend, organized by functionality for easy reference.
76

8-
<IndexOverviewList />
7+
## Stage Management
98

10-
Related topics:
9+
| Command | Description |
10+
|---------|-------------|
11+
| [CREATE STAGE](01-ddl-create-stage.md) | Creates a new stage for storing files |
12+
| [DROP STAGE](02-ddl-drop-stage.md) | Removes a stage |
13+
| [PRESIGN](presign.md) | Generates a pre-signed URL for stage access |
14+
15+
## Stage Operations
16+
17+
| Command | Description |
18+
|---------|-------------|
19+
| [LIST STAGE](04-ddl-list-stage.md) | Lists files in a stage |
20+
| [REMOVE STAGE](05-ddl-remove-stage.md) | Removes files from a stage |
21+
22+
## Stage Information
23+
24+
| Command | Description |
25+
|---------|-------------|
26+
| [DESC STAGE](03-ddl-desc-stage.md) | Shows detailed information about a stage |
27+
| [SHOW STAGES](06-ddl-show-stages.md) | Lists all stages in the current or specified database |
28+
29+
## Related Topics
1130

1231
- [Working with Stages](/guides/load-data/stage/)
1332
- [Loading from Stage](/guides/load-data/load/stage)
14-
- [Querying & Transforming](/guides/load-data/transform/querying-stage)
33+
- [Querying & Transforming](/guides/load-data/transform/querying-stage)
34+
35+
:::note
36+
Stages in Databend are used as temporary storage locations for data files that you want to load into tables or unload from tables.
37+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/04-sequence/index.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
---
22
title: Sequence
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54

6-
This page provides reference information for sequence-related commands in Databend.
5+
This page provides a comprehensive overview of sequence operations in Databend, organized by functionality for easy reference.
76

8-
<IndexOverviewList />
7+
## Sequence Management
8+
9+
| Command | Description |
10+
|---------|-------------|
11+
| [CREATE SEQUENCE](create-sequence.md) | Creates a new sequence generator |
12+
| [DROP SEQUENCE](drop-sequence.md) | Removes a sequence generator |
13+
14+
## Sequence Information
15+
16+
| Command | Description |
17+
|---------|-------------|
18+
| [DESC SEQUENCE](desc-sequence.md) | Shows detailed information about a sequence |
19+
| [SHOW SEQUENCES](show-sequences.md) | Lists all sequences in the current or specified database |
20+
21+
:::note
22+
Sequences in Databend are used to generate unique numeric values in a sequential order, commonly used for primary keys or other unique identifiers.
23+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/04-stream/index.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
---
22
title: Stream
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54

6-
This page provides reference information for the stream-related commands in Databend. For more information about stream, see [Tracking and Transforming Data via Streams](/guides/load-data/continuous-data-pipelines/stream).
5+
This page provides a comprehensive overview of stream operations in Databend, organized by functionality for easy reference.
76

8-
<IndexOverviewList />
7+
## Stream Management
8+
9+
| Command | Description |
10+
|---------|-------------|
11+
| [CREATE STREAM](create-stream.md) | Creates a new stream to track changes in a table |
12+
| [DROP STREAM](drop-stream.md) | Removes a stream |
13+
14+
## Stream Information
15+
16+
| Command | Description |
17+
|---------|-------------|
18+
| [DESC STREAM](desc-stream.md) | Shows detailed information about a stream |
19+
| [SHOW STREAMS](show-streams.md) | Lists all streams in the current or specified database |
20+
21+
## Related Topics
22+
23+
- [Tracking and Transforming Data via Streams](/guides/load-data/continuous-data-pipelines/stream)
24+
25+
:::note
26+
Streams in Databend are used to track and capture changes to tables, enabling continuous data pipelines and real-time data processing.
27+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/04-task/index.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
---
22
title: Task
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54

6-
This page provides reference information for the task-related commands in Databend Cloud.
5+
This page provides a comprehensive overview of task operations in Databend, organized by functionality for easy reference.
76

8-
<IndexOverviewList />
7+
## Task Management
98

9+
| Command | Description |
10+
|---------|-------------|
11+
| [CREATE TASK](01-ddl-create_task.md) | Creates a new scheduled task |
12+
| [ALTER TASK](02-ddl-alter-task.md) | Modifies an existing task |
13+
| [DROP TASK](03-ddl-drop-task.md) | Removes a task |
14+
| [EXECUTE TASK](04-ddl-execute-task.md) | Manually executes a task |
15+
16+
## Task Information
17+
18+
| Command | Description |
19+
|---------|-------------|
20+
| [TASK ERROR INTEGRATION PAYLOAD](10-task-error-integration-payload.md) | Shows the error payload format for task error notifications |
21+
22+
:::note
23+
Tasks in Databend allow you to schedule and automate SQL commands for execution at specified intervals.
24+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/05-view/index.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
11
---
22
title: View
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54

6-
This page provides reference information for the view-related commands in Databend.
5+
This page provides a comprehensive overview of view operations in Databend, organized by functionality for easy reference.
76

8-
<IndexOverviewList />
7+
## View Management
8+
9+
| Command | Description |
10+
|---------|-------------|
11+
| [CREATE VIEW](ddl-create-view.md) | Creates a new view based on a query |
12+
| [ALTER VIEW](ddl-alter-view.md) | Modifies an existing view |
13+
| [DROP VIEW](ddl-drop-view.md) | Removes a view |
14+
15+
## View Information
16+
17+
| Command | Description |
18+
|---------|-------------|
19+
| [DESC VIEW](desc-view.md) | Shows detailed information about a view |
20+
| [SHOW VIEWS](show-views.md) | Lists all views in the current or specified database |
21+
22+
:::note
23+
Views in Databend are named queries stored in the database that can be referenced like tables. They provide a way to simplify complex queries and control access to underlying data.
24+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/06-clusterkey/index.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
11
---
22
title: Cluster Key
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54

6-
This page provides reference information for the cluster key-related commands in Databend. For more information about cluster key, see [Cluster Key](/guides/performance/cluster-key).
5+
This page provides a comprehensive overview of cluster key operations in Databend, organized by functionality for easy reference.
76

8-
<IndexOverviewList />
7+
## Cluster Key Management
8+
9+
| Command | Description |
10+
|---------|-------------|
11+
| [SET CLUSTER KEY](dml-set-cluster-key.md) | Creates or replaces a cluster key for a table |
12+
| [ALTER CLUSTER KEY](dml-alter-cluster-key.md) | Modifies an existing cluster key |
13+
| [DROP CLUSTER KEY](dml-drop-cluster-key.md) | Removes a cluster key from a table |
14+
| [RECLUSTER TABLE](dml-recluster-table.md) | Reorganizes table data based on the cluster key |
15+
16+
## Related Topics
17+
18+
- [Cluster Key](/guides/performance/cluster-key)
19+
20+
:::note
21+
Cluster keys in Databend are used to physically organize data in tables to improve query performance by co-locating related data.
22+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/07-aggregating-index/index.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
---
2-
title: AGGREGATING INDEX
2+
title: Aggregating Index
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54
import EEFeature from '@site/src/components/EEFeature';
65

76
<EEFeature featureName='AGGREGATING INDEX'/>
87

9-
This page provides reference information for the aggregating index-related commands in Databend. For more information about aggregating index, see [Aggregating Index](/guides/performance/aggregating-index).
8+
This page provides a comprehensive overview of aggregating index operations in Databend, organized by functionality for easy reference.
109

11-
<IndexOverviewList />
10+
## Aggregating Index Management
11+
12+
| Command | Description |
13+
|---------|-------------|
14+
| [CREATE AGGREGATING INDEX](create-aggregating-index.md) | Creates a new aggregating index for a table |
15+
| [DROP AGGREGATING INDEX](drop-aggregating-index.md) | Removes an aggregating index |
16+
| [REFRESH AGGREGATING INDEX](refresh-aggregating-index.md) | Updates an aggregating index with the latest data |
17+
18+
## Related Topics
19+
20+
- [Aggregating Index](/guides/performance/aggregating-index)
21+
22+
:::note
23+
Aggregating indexes in Databend are used to improve the performance of aggregate queries by pre-computing and storing aggregate results.
24+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/07-inverted-index/index.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
---
2-
title: INVERTED INDEX
2+
title: Inverted Index
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54
import EEFeature from '@site/src/components/EEFeature';
65

76
<EEFeature featureName='INVERTED INDEX'/>
87

9-
This page provides reference information for the inverted index-related commands in Databend. For more information about inverted index, see [Full-Text Index](/guides/performance/fulltext-index).
8+
This page provides a comprehensive overview of inverted index operations in Databend, organized by functionality for easy reference.
109

11-
<IndexOverviewList />
10+
## Inverted Index Management
11+
12+
| Command | Description |
13+
|---------|-------------|
14+
| [CREATE INVERTED INDEX](create-inverted-index.md) | Creates a new inverted index for full-text search |
15+
| [DROP INVERTED INDEX](drop-inverted-index.md) | Removes an inverted index |
16+
| [REFRESH INVERTED INDEX](refresh-inverted-index.md) | Updates an inverted index with the latest data |
17+
18+
## Related Topics
19+
20+
- [Full-Text Index](/guides/performance/fulltext-index)
21+
22+
:::note
23+
Inverted indexes in Databend enable efficient full-text search capabilities for text data, allowing for fast keyword searches across large text columns.
24+
:::

‎docs/en/sql-reference/10-sql-commands/00-ddl/07-ngram-index/index.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
---
2-
title: NGRAM INDEX
2+
title: Ngram Index
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54
import EEFeature from '@site/src/components/EEFeature';
65

76
<EEFeature featureName='NGRAM INDEX'/>
87

9-
This page provides reference information for the Ngram index-related commands in Databend.
8+
This page provides a comprehensive overview of Ngram index operations in Databend, organized by functionality for easy reference.
109

11-
<IndexOverviewList />
10+
## Ngram Index Management
11+
12+
| Command | Description |
13+
|---------|-------------|
14+
| [CREATE NGRAM INDEX](create-ngram-index.md) | Creates a new Ngram index for efficient substring search |
15+
| [DROP NGRAM INDEX](drop-ngram-index.md) | Removes an Ngram index |
16+
17+
:::note
18+
Ngram indexes in Databend enable efficient substring and pattern matching searches within text data, improving performance for LIKE and similar operations.
19+
:::

0 commit comments

Comments
 (0)