Repository navigation
lake: fix factual errors and inconsistencies in TiDB Cloud Lake docs - #24453
Conversation
Fix descriptions that contradict the examples or other pages in the Lake docs, for example LEAST_IGNORE_NULLS returning the maximum, DATE_SUB adding units, the DATE_BETWEEN summary row, the CREATE TASK AFTER example, the GEOMETRY output format values, and the Table OWNERSHIP privilege. Also fix garbled sentences in two guides and "4/7" support coverage, which is likely "24/7". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
There was a problem hiding this comment.
🟡 Changes recommended
The 24/7 support commitment remains unverified, and several changed summaries and an aggregating-index restriction need clarification.
5 open findings
Verify authoritative source before claiming 24/7 support · New Clarify that GROUP BY is optional for aggregating indexes · New Shorten duplicated scenario summary to the required length · New Replace duplicated scenario with a concise search snippet · New Shorten front matter summary to the required search snippet length · New
What changed in this PR
Corrects factual and wording inconsistencies across TiDB Cloud Lake documentation on release-8.5.
Changes:
- Corrects SQL function, privilege, task, and file-format descriptions.
- Repairs misleading headings, links, and scenario text.
- Changes documented Severity 1 support coverage.
| File | Description |
|---|---|
sql/window-funnel.md |
Corrects verb capitalization. |
sql/task.md |
Corrects linked page title. |
sql/qualify.md |
Removes redundant terminology. |
sql/least-ignore-nulls.md |
Corrects return-value description. |
sql/input-output-file-formats.md |
Corrects geometry format values. |
sql/flashback-table.md |
Restores a missing verb. |
sql/factorial.md |
Corrects function behavior. |
sql/date-time-functions.md |
Corrects DATE_BETWEEN documentation. |
sql/date-sub.md |
Corrects argument semantics. |
sql/create-task.md |
Aligns explanation with its example. |
sql/create-aggregating-index.md |
Corrects links and aggregate terminology. |
guides/unload-ndjson-file.md |
Corrects the format heading. |
guides/support-services.md |
Changes support coverage to 24/7. |
guides/privileges.md |
Corrects table ownership scope. |
guides/lakehouse-etl.md |
Removes duplicated scenario text. |
guides/json-search.md |
Removes a leftover fragment. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
The examples on the same page and in the aggregating index guide create indexes without GROUP BY. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Revert the "4/7" to "24/7" change. No source confirms "24/7", so it is moved to the confirmation issue instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🔇 Additional comments: 8
tidb-cloud-lake/guides/json-search.md: 1
3-3: LGTM!Also applies to: 8-8
tidb-cloud-lake/guides/lakehouse-etl.md: 1
3-3: LGTM!Also applies to: 8-8
tidb-cloud-lake/sql/date-sub.md: 1
21-21: LGTM!tidb-cloud-lake/sql/date-time-functions.md: 1
61-61: LGTM!tidb-cloud-lake/sql/factorial.md: 1
3-3: LGTM!Also applies to: 8-8
tidb-cloud-lake/sql/input-output-file-formats.md: 1
202-202: LGTM!tidb-cloud-lake/sql/least-ignore-nulls.md: 1
3-3: LGTM!Also applies to: 8-8
tidb-cloud-lake/sql/create-aggregating-index.md-16-16: 1
16-16: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
⚠️ Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.Replace
e.g.,withfor example.The Vale check flags this abbreviation on the changed line.
- When creating aggregating indexes, limit their usage to queries with standard [Aggregate Functions](/tidb-cloud-lake/sql/aggregate-functions.md) (for example, AVG, SUM, MIN, MAX, and COUNT), optionally with GROUP BY, while keeping in mind that GROUPING SETS, [Window Functions](/tidb-cloud-lake/sql/window-functions-overview.md), [LIMIT](/tidb-cloud-lake/sql/select.md#limit-clause), and [ORDER BY](/tidb-cloud-lake/sql/select.md#order-by-clause) are not accepted, or you will get an error: `Currently create aggregating index just support simple query, like: SELECT ... FROM ... WHERE ... GROUP BY ...`.As per path instructions, “For every actionable issue, provide a GitHub committable suggestion block.”
Sources: Path instructions, Linters/SAST tools
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
2285b649-adfe-47ad-aa08-4cceab064b7c
📒 Files selected for processing: 15
tidb-cloud-lake/guides/json-search.mdtidb-cloud-lake/guides/lakehouse-etl.mdtidb-cloud-lake/guides/privileges.mdtidb-cloud-lake/guides/unload-ndjson-file.mdtidb-cloud-lake/sql/create-aggregating-index.mdtidb-cloud-lake/sql/create-task.mdtidb-cloud-lake/sql/date-sub.mdtidb-cloud-lake/sql/date-time-functions.mdtidb-cloud-lake/sql/factorial.mdtidb-cloud-lake/sql/flashback-table.mdtidb-cloud-lake/sql/input-output-file-formats.mdtidb-cloud-lake/sql/least-ignore-nulls.mdtidb-cloud-lake/sql/qualify.mdtidb-cloud-lake/sql/task.mdtidb-cloud-lake/sql/window-funnel.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
[LGTM Timeline notifier]Timeline:
|
|
@awxxxxxx: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lilin90 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |


What is changed, added or deleted? (Required)
Fix descriptions in the TiDB Cloud Lake docs (
tidb-cloud-lake/) that contradict their own examples, the reference pages, or other pages. These were found while reviewing the Japanese translation of the Lake docs, and the Japanese docs inherit them. The Lake docs exist only onrelease-8.5, so this PR targetsrelease-8.5.DATE_BETWEEN('2024-06-04', '2024-06-01', '2024-06-10')→trueDATE_BETWEEN(MONTH, '2025-07-31', '2025-10-01')→2date-between.mdAFTER task1_index.mdaggregate-functions.mdandwindow-functions-overview.mdEWKT,WKB,WKB,EWKB,GEOJSONEWKT,WKT,WKB,EWKB,GEOJSONsystem-settings.mdlists "WKT", "WKB", "EWKT", "EWKB", "GeoJSON" forgeometry_output_format## Unloading TSV File## Unloading NDJSON FileThe "4/7" support coverage wording in
guides/support-services.mdis moved to #24454 because no source confirms "24/7".Each fix also applies to the front matter
summarywhere the same sentence appears.Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
🤖 Generated with Claude Code
Summary by CodeRabbit
.lakeand refreshing shared tables with a single COPY pipeline.GROUP BY, task prerequisites, date subtraction and differences, factorials, flashback behavior, geometry formats, and minimum values when ignoringNULL.DATE_BETWEENresult and the window-funnel example.