Skip to content

lake: fix factual errors and inconsistencies in TiDB Cloud Lake docs - #24453

Merged
ti-chi-bot[bot] merged 6 commits into
pingcap:release-8.5from
yahonda:lake-fix-factual-errors
Oct 20, 2026
Merged

ti-chi-bot[bot] merged 6 commits into
pingcap:release-8.5from
yahonda:lake-fix-factual-errors

Conversation

@yahonda

@yahonda yahonda commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

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 on release-8.5, so this PR targets release-8.5.

File Before After Evidence
sql/least-ignore-nulls.md Returns the maximum value from a set of values Returns the minimum value LEAST_IGNORE_NULLS returns the least value
sql/date-sub.md the number of units of time that you want to add ... that you want to subtract DATE_SUB subtracts the interval
sql/factorial.md Returns the factorial logarithm of x Returns the factorial of x The function returns the factorial
sql/date-time-functions.md DATE_BETWEEN: "Checks if a date is between two other dates", DATE_BETWEEN('2024-06-04', '2024-06-01', '2024-06-10') → true "Returns the number of complete units between two dates as an integer", DATE_BETWEEN(MONTH, '2025-07-31', '2025-10-01') → 2 Matches the syntax and the example in date-between.md
sql/create-task.md runs after the successful completion of task1 and task2 ... of task1 The SQL example has only AFTER task1
sql/create-aggregating-index.md standard Aggregate Functions "(e.g., AVG, SUM, MIN, MAX, COUNT and GROUP BY)"; both links point to _index.md queries with standard Aggregate Functions "(e.g., AVG, SUM, MIN, MAX, and COUNT), optionally with GROUP BY"; links point to aggregate-functions.md and window-functions-overview.md GROUP BY is a clause, not an aggregate function. The links pointed to the docs home page
sql/input-output-file-formats.md EWKT, WKB, WKB, EWKB, GEOJSON EWKT, WKT, WKB, EWKB, GEOJSON system-settings.md lists "WKT", "WKB", "EWKT", "EWKB", "GeoJSON" for geometry_output_format
guides/privileges.md Table Privileges, OWNERSHIP: "Grants full control over a database" "... over a table" Copied from the Database Privileges table
sql/task.md TASK ERROR INTEGRATION PAYLOAD TASK ERROR NOTIFICATION PAYLOAD Title of the linked page
guides/unload-ndjson-file.md ## Unloading TSV File ## Unloading NDJSON File The page is about NDJSON; the heading was copied from the TSV page. No link uses the old anchor
sql/window-funnel.md for the user to SELECT a phone for the user to select a phone An ordinary verb, not the SQL keyword
sql/qualify.md a query with a QUALIFY statement clause a query with a QUALIFY clause QUALIFY is a clause
sql/flashback-table.md The command only existing tables to their prior states. The command only restores existing tables to their prior states. Missing verb
guides/lakehouse-etl.md ...via a single COPY pipeline. to refresh the shared tables in {{{ .lake }}}. They want to refresh {{{ .lake }}}'s shared tables via a single COPY pipeline. Duplicated, dangling clause
guides/json-search.md ...without replicating it to an external system. JSON without copying it out of {{{ .lake }}}. ...without replicating it to an external system. Leftover fragment

The "4/7" support coverage wording in guides/support-services.md is moved to #24454 because no source confirms "24/7".

Each fix also applies to the front matter summary where 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.

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified guidance for filtering JSON in .lake and refreshing shared tables with a single COPY pipeline.
    • Corrected SQL reference details for table ownership, aggregate queries with optional GROUP BY, task prerequisites, date subtraction and differences, factorials, flashback behavior, geometry formats, and minimum values when ignoring NULL.
    • Updated the NDJSON unloading heading and task notification terminology, and refined QUALIFY links and wording.
    • Clarified the documented DATE_BETWEEN result and the window-funnel example.

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>
@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 0c521206-aa27-46e4-9c43-445728a70344
📥 Commits

Reviewing files that changed from the base of the PR and between e6e95e1 and 7dac04b.

📒 Files selected for processing: 4
  • tidb-cloud-lake/guides/json-search.md
  • tidb-cloud-lake/guides/lakehouse-etl.md
  • tidb-cloud-lake/guides/unload-ndjson-file.md
  • tidb-cloud-lake/sql/qualify.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

This pull request edits TiDB Cloud Lake guides and SQL reference pages. It updates descriptions of documented behavior, examples, terminology, links, and a page heading. The supplied summaries show no implementation or API changes.

Changes: Documentation corrections

Layer / File(s) Summary
Guide wording and labels
tidb-cloud-lake/guides/json-search.md, tidb-cloud-lake/guides/lakehouse-etl.md, tidb-cloud-lake/guides/privileges.md, tidb-cloud-lake/guides/unload-ndjson-file.md
Guide text removes repeated wording, describes shared-table refresh and table ownership, and updates the NDJSON heading.
SQL function and format descriptions
tidb-cloud-lake/sql/create-aggregating-index.md, tidb-cloud-lake/sql/date-sub.md, tidb-cloud-lake/sql/date-time-functions.md, tidb-cloud-lake/sql/factorial.md, tidb-cloud-lake/sql/least-ignore-nulls.md, tidb-cloud-lake/sql/input-output-file-formats.md
SQL reference text updates aggregate-query guidance, function descriptions and examples, and the GEOMETRY_FORMAT values.
SQL command and example text
tidb-cloud-lake/sql/create-task.md, tidb-cloud-lake/sql/flashback-table.md, tidb-cloud-lake/sql/qualify.md, tidb-cloud-lake/sql/task.md, tidb-cloud-lake/sql/window-funnel.md
Command and example pages update task dependency wording, flashback wording, QUALIFY terminology and link, a task table entry, and example capitalization.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 7dac0

The documentation changes align with the checked-in examples and references, and no concrete misleading or broken guidance was established. No actionable merge-blocking risk remains.

### Architecture Summary

Architecture risk: 🔵 Low · up to 7dac0

The change affects 1 system.

Changed systems: tidb-cloud-lake

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — tidb-cloud-lake (service) was modified; 15 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in tidb-cloud-lake/sql/create-aggregating-index.md: The guidance now says GROUP BY is optional when using standard aggregate functions, and links to the aggregate-functions and window-functions documentation pages. The listed unsupported clauses and error message are unchanged.
  • observed — Modified behavior in tidb-cloud-lake/sql/create-task.md: The Task Dependencies example description now says process_orders runs after task1, removing the previous reference to task2.
  • observed — Modified behavior in tidb-cloud-lake/sql/date-sub.md: The <value> description changes from describing units to add to describing units to subtract.
  • observed — Modified behavior in tidb-cloud-lake/sql/date-time-functions.md: The DATE_BETWEEN description and example change from a boolean range check to an integer count of complete units, illustrated with MONTH returning 2.
Pre-merge checks: Passed 5
Passed Passed checks: 5 passed
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: correcting factual errors and inconsistencies in TiDB Cloud Lake documentation.
Description check Passed The description is complete and follows the repository template. It explains the changes and rationale, identifies the v8.5 target, provides a related reference, records AI involvement, and addresses …
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 14, 2026
@lilin90 lilin90 self-assigned this Oct 14, 2026
@lilin90 lilin90 added the translation/no-need No need to translate this PR. label Oct 14, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Oct 14, 2026
@lilin90 lilin90 added the lake Related to TiDB Cloud Lake docs. label Oct 14, 2026
@lilin90
lilin90 requested review from awxxxxxx and lilin90 and a balanced review from Copilot October 14, 2026 03:08

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The 24/7 support commitment remains unverified, and several changed summaries and an aggregating-index restriction need clarification.

5 open findings
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.

Comment thread tidb-cloud-lake/guides/support-services.md Outdated
Comment thread tidb-cloud-lake/sql/create-aggregating-index.md Outdated
Comment thread tidb-cloud-lake/guides/json-search.md
Comment thread tidb-cloud-lake/guides/lakehouse-etl.md
Comment thread tidb-cloud-lake/sql/qualify.md Outdated
yahonda and others added 2 commits October 14, 2026 14:05
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>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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., with for 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
📥 Commits

Reviewing files that changed from the base of the PR and between 727dea6 and 3be6e80.

📒 Files selected for processing: 15
  • tidb-cloud-lake/guides/json-search.md
  • tidb-cloud-lake/guides/lakehouse-etl.md
  • tidb-cloud-lake/guides/privileges.md
  • tidb-cloud-lake/guides/unload-ndjson-file.md
  • tidb-cloud-lake/sql/create-aggregating-index.md
  • tidb-cloud-lake/sql/create-task.md
  • tidb-cloud-lake/sql/date-sub.md
  • tidb-cloud-lake/sql/date-time-functions.md
  • tidb-cloud-lake/sql/factorial.md
  • tidb-cloud-lake/sql/flashback-table.md
  • tidb-cloud-lake/sql/input-output-file-formats.md
  • tidb-cloud-lake/sql/least-ignore-nulls.md
  • tidb-cloud-lake/sql/qualify.md
  • tidb-cloud-lake/sql/task.md
  • tidb-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.

Comment thread tidb-cloud-lake/guides/privileges.md Outdated
Comment thread tidb-cloud-lake/sql/qualify.md Outdated
yahonda and others added 2 commits October 14, 2026 14:29
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread tidb-cloud-lake/sql/qualify.md Outdated
Comment thread tidb-cloud-lake/guides/json-search.md Outdated
Comment thread tidb-cloud-lake/guides/unload-ndjson-file.md Outdated
Comment thread tidb-cloud-lake/guides/lakehouse-etl.md Outdated
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 14, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 14, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-10-14 06:00:48.13831108 +0000 UTC m=+797257.885541929: ☑️ agreed by lilin90.

@lilin90 lilin90 added type/enhancement The issue or PR belongs to an enhancement. ONCALL Relates to documentation oncall. labels Oct 14, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

@awxxxxxx: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In 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.

@lilin90 lilin90 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/approve

@ti-chi-bot

ti-chi-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the approved label Oct 20, 2026
@lilin90 lilin90 added the lgtm label Oct 20, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 5bed595 into pingcap:release-8.5 Oct 20, 2026
12 checks passed
@yahonda
yahonda deleted the lake-fix-factual-errors branch October 21, 2026 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lake Related to TiDB Cloud Lake docs. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. ONCALL Relates to documentation oncall. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR. type/enhancement The issue or PR belongs to an enhancement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants