Skip to content

Commit b910e45

Browse files
BohuTANGBohuTANG
authored
improve guides index (#2303)
1 parent 9b59575 commit b910e45

File tree

4 files changed

+41
-22
lines changed

4 files changed

+41
-22
lines changed

‎docs/en/guides/50-unload-data/index.md‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,23 @@ title: Unload Data from Databend
33
slug: /unload-data
44
---
55

6-
Databend makes it easy to export data to an external location in various file formats like `CSV`, `TSV`, `NDJSON`, and `Parquet`, using the `COPY INTO` command.
6+
Databend's `COPY INTO` command exports data to various file formats and storage locations with flexible formatting options.
77

8-
This guide will show you how to bulk unloading data from Databend:
8+
## Supported File Formats
99

10-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
1110

12-
<IndexOverviewList />
11+
| Format | Example Syntax | Primary Use Case |
12+
|--------|---------------|------------------|
13+
| [**Unload Parquet File**](/guides/unload-data/unload-parquet) | `FILE_FORMAT = (TYPE = PARQUET)` | Analytics workloads, efficient storage |
14+
| [**Unload CSV File**](/guides/unload-data/unload-csv) | `FILE_FORMAT = (TYPE = CSV)` | Data exchange, universal compatibility |
15+
| [**Unload TSV File**](/guides/unload-data/unload-tsv) | `FILE_FORMAT = (TYPE = TSV)` | Tabular data with comma values |
16+
| [**Unload NDJSON File**](/guides/unload-data/unload-ndjson) | `FILE_FORMAT = (TYPE = NDJSON)` | Semi-structured data, flexible schemas |
17+
18+
## Storage Destinations
19+
20+
21+
| Destination | Example | When to Use |
22+
|-------------|---------|-------------|
23+
| **Named Stage** | `COPY INTO my_stage FROM my_table` | For repeated exports to the same location |
24+
| **S3-Compatible Storage** | `COPY INTO 's3://bucket/path/' FROM my_table` | Cloud object storage with Amazon S3 |
25+

‎docs/en/guides/55-performance/index.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: Performance Optimization
33
---
44

5-
Databend provides various optimization features to accelerate query performance across different scenarios.
5+
Databend primarily accelerates query performance through **various indexing technologies**, including data clustering, result caching, and specialized indexes, helping you significantly improve query response times.
66

77
## Optimization Features
88

9-
| Feature | Category | Description | Example Use Case |
10-
|---------|----------|-------------|------------------|
11-
| [**Cluster Key**](00-cluster-key.md) | **Storage** | Automatic data organization for large table queries | `CLUSTER BY (date, region)` for time-series data |
12-
| [**Query Result Cache**](query-result-cache.md) | **Caching** | Automatic caching for repeated queries | Dashboard queries, daily reports |
13-
| [**Virtual Column**](01-virtual-column.md) | **Semi-Structured** | Automatic acceleration for VARIANT data queries | JSON data with frequently accessed nested fields |
14-
| [**Aggregating Index**](02-aggregating-index.md) | **Aggregation** | Automatic indexing for aggregation queries | `SUM(sales) GROUP BY region` queries |
15-
| [**Full-Text Index**](03-fulltext-index.md) | **Text Search** | Automatic indexing for text search queries | `WHERE MATCH(content, 'keyword')` searches |
16-
| [**Ngram Index**](ngram-index.md) | **Pattern Matching** | Automatic indexing for wildcard LIKE queries | `WHERE name LIKE '%john%'` searches |
9+
| Feature | Purpose | When to Use |
10+
|---------|---------|------------|
11+
| [**Cluster Key**](00-cluster-key.md) | Automatically organize data physically for optimal query performance | When you have large tables with frequent filtering on specific columns, especially time-series or categorical data |
12+
| [**Query Result Cache**](query-result-cache.md) | Automatically store and reuse results of identical queries | When your applications run the same analytical queries repeatedly, such as in dashboards or scheduled reports |
13+
| [**Virtual Column**](01-virtual-column.md) | Automatically accelerate access to fields within JSON/VARIANT data | When you frequently query specific paths within semi-structured data and need sub-second response times |
14+
| [**Aggregating Index**](02-aggregating-index.md) | Precompute and store common aggregation results | When your analytical workloads frequently run SUM, COUNT, AVG queries on large datasets |
15+
| [**Full-Text Index**](03-fulltext-index.md) | Enable lightning-fast semantic text search capabilities | When you need advanced text search functionality like relevance scoring and fuzzy matching |
16+
| [**Ngram Index**](ngram-index.md) | Accelerate pattern matching with wildcards | When your queries use LIKE operators with wildcards (especially '%keyword%') on large text columns |
1717

1818
## Feature Availability
1919

‎docs/en/guides/56-security/index.md‎

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

6-
Databend provides various methods to protect your data, ensure privacy, and maintain system reliability:
5+
Databend offers **enterprise-grade security and reliability features** that safeguard your data throughout its lifecycle. From controlling who can access your data to protecting against network threats and recovering from operational errors, Databend's **multi-layered security approach** helps you maintain data integrity, compliance, and business continuity.
76

8-
<IndexOverviewList />
7+
| Security Feature | Purpose | When to Use |
8+
|-----------------|---------|------------|
9+
| [**Access Control**](/guides/security/access-control) | Manage user permissions | When you need to control data access with role-based security and object ownership |
10+
| [**Network Policy**](/guides/security/network-policy) | Restrict network access | When you want to limit connections to specific IP ranges even with valid credentials |
11+
| [**Password Policy**](/guides/security/password-policy) | Set password requirements | When you need to enforce password complexity, rotation, and account lockout rules |
12+
| [**Masking Policy**](/guides/security/masking-policy) | Hide sensitive data | When you need to protect confidential data while still allowing authorized access |
13+
| [**Fail-Safe**](/guides/security/fail-safe) | Prevent data loss | When you need to recover accidentally deleted data from S3-compatible storage |
14+
| [**Recovery from Errors**](/guides/security/recovery-from-operational-errors) | Fix operational mistakes | When you need to recover from dropped databases/tables or incorrect data modifications |

‎docs/en/guides/57-data-management/index.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ title: Data Management
44

55
# Data Management
66

7-
| Category | Description | Key Features | Common Operations | Documentation |
8-
|----------|-------------|--------------|------------------|---------------|
9-
| **Data Lifecycle** | Create and manage objects | • Database & Table <br/>• External Tables<br/>• Streams & Views<br/>• Indexes & Stages | • CREATE/DROP/ALTER<br/>• SHOW TABLES<br/>• DESCRIBE TABLE | [Details](./01-data-lifecycle.md) |
10-
| **Data Recovery** | Access and restore past data | • Time Travel<br/>• Flashback Tables<br/>• Backup & Restore<br/>• AT & UNDROP | • SELECT ... AT<br/>• FLASHBACK TABLE<br/>• BENDSAVE BACKUP | [Details](./02-data-recovery.md) |
11-
| **Data Protection** | Secure access and prevent loss | • Network Policies<br/>• Access Control<br/>• Time Travel & Fail-safe<br/>• Data Encryption | • NETWORK POLICY<br/>• GRANT/REVOKE<br/>• CREATE USER/ROLE | [Details](./03-data-protection.md) |
12-
| **Data Purge** | Free up storage space | • VACUUM Commands<br/>• Retention Policies<br/>• Orphan File Cleanup<br/>• Temporary File Management | • VACUUM TABLE<br/>• VACUUM DROP TABLE<br/>• DATA_RETENTION_TIME | [Details](./04-data-recycle.md) |
7+
| Category | Description | Key Features | Common Operations |
8+
|----------|-------------|--------------|------------------|
9+
| **[Data Lifecycle](./01-data-lifecycle.md)** | Create and manage objects | • Database & Table <br/>• External Tables<br/>• Streams & Views<br/>• Indexes & Stages | • CREATE/DROP/ALTER<br/>• SHOW TABLES<br/>• DESCRIBE TABLE |
10+
| **[Data Recovery](./02-data-recovery.md)** | Access and restore past data | • Time Travel<br/>• Flashback Tables<br/>• Backup & Restore<br/>• AT & UNDROP | • SELECT ... AT<br/>• FLASHBACK TABLE<br/>• BENDSAVE BACKUP |
11+
| **[Data Protection](./03-data-protection.md)** | Secure access and prevent loss | • Network Policies<br/>• Access Control<br/>• Time Travel & Fail-safe<br/>• Data Encryption | • NETWORK POLICY<br/>• GRANT/REVOKE<br/>• USER/ROLE |
12+
| **[Data Recycle](./04-data-recycle.md)** | Free up storage space | • VACUUM Commands<br/>• Retention Policies<br/>• Orphan File Cleanup<br/>• Temporary File Management | • VACUUM TABLE<br/>• VACUUM DROP TABLE<br/>• DATA_RETENTION_TIME |

0 commit comments

Comments
 (0)