Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions TOC-tidb-cloud-lake.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
## Get Started

- [Overview](/tidb-cloud-lake/lake-overview.md)
- [Why TiDB Cloud Lake](/tidb-cloud-lake/lake-overview.md#why-lake)
- [Quick Start](/tidb-cloud-lake/lake-quick-start.md)

## Guides
Expand Down
77 changes: 65 additions & 12 deletions tidb-cloud-lake/lake-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,71 @@ TiDB Cloud Lake supports ANSI SQL, semi-structured data processing, vector searc
>
> TiDB Cloud Lake is currently in **public preview**. Feature availability and service limits might change as we continue to improve the product.

## Why {{{ .lake }}}?

{{{ .lake }}} brings analytics, vector, search, and geo workloads together in one cloud-native platform. With storage-compute separation, ANSI SQL support, and managed infrastructure, teams can work on multi-modal data with better flexibility, performance, and cost efficiency.

| Feature | Description | Learn more |
|---|---|---|
| **Unified Engine** | Analytics, vector, search, and geo share one optimizer and runtime. | [TiDB Cloud Lake Architecture](/tidb-cloud-lake/guides/tidb-cloud-lake-architecture.md) |
| **Unified Data** | Structured, semi-structured, unstructured, and vector data share object storage. | [TiDB Cloud Lake Architecture](/tidb-cloud-lake/guides/tidb-cloud-lake-architecture.md) |
| **Analytics Native** | ANSI SQL, windowing, incremental aggregates, and streaming power BI run on the same platform. | [Worksheets](/tidb-cloud-lake/guides/worksheet.md) |
| **Vector Native** | Embeddings, vector indexes, and semantic retrieval all run in SQL. | [Vector Search](/tidb-cloud-lake/guides/vector-search-guide.md) |
| **Search Native** | Full-text search and inverted indexes power hybrid retrieval. | [Full-Text Index](/tidb-cloud-lake/guides/full-text-index.md) |
| **Geo Native** | Geospatial indexes and functions power map and location services. | [Geo Analytics](/tidb-cloud-lake/guides/geo-analytics.md) |
## Why {{{ .lake }}}? {#why-lake}

{{{ .lake }}} brings analytics, data engineering, search, and AI workloads together in one cloud-native platform. It combines independently scalable compute, object-storage-based data management, SQL access, and built-in multimodal capabilities in a managed service.

### Scale compute independently from storage

{{{ .lake }}} separates compute from storage. Data is stored in durable, cost-effective object storage, while warehouses provide independently managed compute resources. You can choose a warehouse size for each workload, resize it as demand changes, and use separate warehouses for data loading and query execution. This architecture lets you scale compute without moving or duplicating the underlying data.

For more information, see [TiDB Cloud Lake Architecture](/tidb-cloud-lake/guides/tidb-cloud-lake-architecture.md) and [Warehouses](/tidb-cloud-lake/guides/warehouse.md).

### Keep costs transparent and predictable

The main cost components are straightforward:

- **Warehouse compute** is billed per second while a warehouse is running. By default, a warehouse automatically suspends after five minutes of inactivity. A suspended warehouse does not consume compute resources.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@awxxxxxx PTAL

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🔎 Supported by static analysis

🏁 Script executed:

rg -n -i 'AUTO_SUSPEND|auto.?suspend|suspend.*warehouse|warehouse.*suspend|inactive.*cluster|release.*cluster' tidb-cloud-lake
sed -n '20,36p' tidb-cloud-lake/lake-overview.md

Repository: pingcap/docs

Length of output: 12397


🏁 Script executed:

printf '%s\n' '--- create warehouse SQL reference ---'
sed -n '24,40p' tidb-cloud-lake/sql/create-warehouse.md
printf '%s\n' '--- warehouse guide ---'
sed -n '34,52p' tidb-cloud-lake/guides/warehouse.md
sed -n '128,150p' tidb-cloud-lake/guides/warehouse.md
printf '%s\n' '--- lake architecture ---'
fd -i '.*lake.*architecture.*' tidb-cloud-lake
for f in $(fd -i '.*lake.*architecture.*' tidb-cloud-lake); do
  sed -n '1,180p' "$f"
done
printf '%s\n' '--- pricing and overview references ---'
sed -n '26,38p' tidb-cloud-lake/guides/pricing-billing.md
sed -n '26,33p' tidb-cloud-lake/lake-overview.md

Repository: pingcap/docs

Length of output: 13392


🤖 get_repo_knowledge executed:

get_repo_knowledge pingcap/docs /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c/learnings

Length of output: 1584


Use the documented warehouse auto-suspend default.

The warehouse reference defines the default AUTO_SUSPEND value as 600 seconds, or ten minutes. Replace “five minutes” with “ten minutes.”

Committable replacement
-**Warehouse compute** is billed per second while a warehouse is running. By default, a warehouse automatically suspends after five minutes of inactivity. A suspended warehouse does not consume compute resources.
+**Warehouse compute** is billed per second while a warehouse is running. By default, a warehouse automatically suspends after ten minutes of inactivity. A suspended warehouse does not consume compute resources.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Warehouse compute** is billed per second while a warehouse is running. By default, a warehouse automatically suspends after five minutes of inactivity. A suspended warehouse does not consume compute resources.
- **Warehouse compute** is billed per second while a warehouse is running. By default, a warehouse automatically suspends after ten minutes of inactivity. A suspended warehouse does not consume compute resources.

- **Storage** is billed according to the amount of data stored in object storage.
- **Cloud services** are billed according to API request usage.
- **Service hosting** for data integration services is billed per second while they are running.

Administrators can set a monthly spending limit. You can monitor usage and billing history. For details, see [TiDB Cloud Lake Pricing & Billing](/tidb-cloud-lake/guides/pricing-billing.md) and [Managing Costs](/tidb-cloud-lake/guides/manage-costs.md).

### Run high-performance analytics at scale

{{{ .lake }}} is designed for analytical workloads such as interactive dashboards, ad hoc exploration, large-scale scans, and concurrent queries. Its optimizer uses techniques such as predicate pushdown, join reordering, and scan pruning to reduce unnecessary work.

For workload-specific optimization, you can use cluster keys to organize related data into adjacent storage blocks, materialized views to persist recurring query results, and specialized indexes and result caching to accelerate common access patterns. The appropriate strategy depends on your query filters, data distribution, and update patterns.

For more information, see [Performance Optimization](/tidb-cloud-lake/guides/performance-optimization.md), [Cluster Key](/tidb-cloud-lake/guides/cluster-key-performance.md), and [Materialized View](/tidb-cloud-lake/sql/materialized-view.md).

### Build data pipelines in the platform

{{{ .lake }}} provides built-in primitives for data ingestion and incremental processing:

- [Stages](/tidb-cloud-lake/guides/stage-overview.md) provide managed locations and interfaces for loading, querying, and unloading files.
- [Streams](/tidb-cloud-lake/guides/track-and-transform-data-via-streams.md) capture table changes for incremental processing.
- [Tasks](/tidb-cloud-lake/guides/automate-data-loading-with-tasks.md) run SQL on a schedule or when a stream contains new rows.
- [Data integration](/tidb-cloud-lake/guides/data-integration-overview.md) provides a visual interface for importing or continuously synchronizing data from supported external systems.

Together, these capabilities support batch ingestion, change data capture (CDC), incremental ETL, scheduled transformations, and downstream analytical tables without requiring every pipeline to rely on separate orchestration tooling.

### Replicate TiDB Cloud data continuously

TiDB Cloud Data Pipeline replicates full and incremental data from a TiDB Cloud instance to {{{ .lake }}} without requiring a third-party ETL tool. It first exports a full snapshot of the selected tables, and then continuously replicates row changes, including inserts, updates, and deletes, so that analytical data stays current.

You can use this integration to:

- Replicate operational TiDB data to an analytical warehouse.
- Keep dashboards and reports up to date.
- Make continuously updated data available to analytics, search, vector, and AI workloads in {{{ .lake }}}.

Data Pipeline uses TiCDC for incremental replication and an external stage to transfer data between TiDB Cloud and {{{ .lake }}}. Availability and restrictions depend on your TiDB Cloud plan. For details, see [Data Pipeline to TiDB Cloud Lake](/tidb-cloud/data-pipeline/data-pipeline-overview.md).

### Work with structured and semi-structured data

You can use SQL to store, query, clean, and transform relational and semi-structured data in the same platform. The `VARIANT` data type preserves nested **JSON** structures, while JSON path expressions let you access nested fields, virtual columns accelerate frequently queried paths, and inverted indexes support text search.

This is useful for application events, logs, user activity data, API payloads, and AI agent traces, which often have evolving schemas and can be costly to flatten up front.

To protect sensitive data, you can apply row access policies (an experimental feature) to filter rows at query time and masking policies to redact column values, including selected keys in `VARIANT` data. For more information, see [JSON & Search](/tidb-cloud-lake/guides/json-search.md), [Row Access Policy](/tidb-cloud-lake/guides/row-access-policy.md), and [Masking Policy](/tidb-cloud-lake/guides/masking-policy.md).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@awxxxxxx Since row access policy is still experimental, please help confirm whether we should keep it here or remove it and adjust wording?


### Combine analytics, search, and AI workloads

Full-text search, [vector search](/tidb-cloud-lake/guides/vector-search-guide.md), [geospatial analysis](/tidb-cloud-lake/guides/geo-analytics.md), and SQL analytics run on the same data platform. You can use [full-text indexes](/tidb-cloud-lake/guides/full-text-index.md) (inverted indexes) for keyword-oriented retrieval, vector indexes for semantic similarity search, and SQL predicates and joins to combine retrieval results with structured business data.

This unified approach supports use cases such as product and business analytics, application-event analysis, search and recommendations, retrieval-augmented generation (RAG), and AI-agent trace analysis without requiring a separate data copy for each workload. For an end-to-end example, see [Multimodal Data Analytics](/tidb-cloud-lake/guides/multimodal-data-analytics.md).

## Get Started

Expand Down
Loading