Conversation
Align the TiDB Cloud Lake VACUUM documentation with the renamed VACUUM DROPPED OBJECTS pages, remove the obsolete SQL-specific page, and refresh the table of contents to point at the current canonical docs. This also adds the legacy alias for VACUUM TABLE so existing links continue to resolve.
lilin90
added
translation/no-need
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
the
size/XXL
|
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:
📝 WalkthroughWalkthroughThe documentation replaces ChangesVACUUM command reference
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Other Merge Risk: 🔵 Low · up to Readers may miss the VACUUM TABLES reference and misunderstand when historical snapshots are eligible for irreversible cleanup. These are localized documentation fixes with no runtime impact. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 2cba7346-7b00-484a-8703-eb348d860fd4
📒 Files selected for processing (14)
TOC-tidb-cloud-lake.mdtidb-cloud-lake/guides/data-purge-and-recycle.mdtidb-cloud-lake/sql/administration-commands.mdtidb-cloud-lake/sql/ddl-table-overview.mdtidb-cloud-lake/sql/drop-table.mdtidb-cloud-lake/sql/optimize-table.mdtidb-cloud-lake/sql/vacuum-all.mdtidb-cloud-lake/sql/vacuum-drop-table-sql.mdtidb-cloud-lake/sql/vacuum-drop-table.mdtidb-cloud-lake/sql/vacuum-dropped-objects.mdtidb-cloud-lake/sql/vacuum-table-sql.mdtidb-cloud-lake/sql/vacuum-table.mdtidb-cloud-lake/sql/vacuum-tables.mdtidb-cloud-lake/sql/vacuum-temporary-files.md
💤 Files with no reviewable changes (3)
- tidb-cloud-lake/sql/vacuum-drop-table.md
- tidb-cloud-lake/sql/vacuum-table-sql.md
- tidb-cloud-lake/sql/vacuum-drop-table-sql.md
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to GitHub limitations.
🟡 Minor · Document the snapshot-count retention override. · tidb-cloud-lake/guides/data-purge-and-recycle.md:79-79
79-79: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDocument the snapshot-count retention override.
When
data_retention_num_snapshots_to_keepis nonzero, it overridesdata_retention_time_in_daysfor table-history VACUUM. The guide omits this rule. Keep the override scoped to table history, not dropped objects.Committable suggestion
-For table history and dropped objects, use `data_retention_time_in_days` (1 day by default). For example, set a 2-day retention period for the current session: +For table history and dropped objects, use `data_retention_time_in_days` (1 day by default). For table history, `data_retention_num_snapshots_to_keep` overrides this setting when it is nonzero. For example, set a 2-day retention period for the current session:
🟡 Minor · Document the snapshot-count retention override. · tidb-cloud-lake/sql/vacuum-table.md:23-33
23-33: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDocument the snapshot-count retention override.
data_retention_num_snapshots_to_keepoverridesdata_retention_time_in_daysduring vacuum operations when it is nonzero. Add this rule so users understand which historical snapshotsVACUUM TABLEcan clean up.Committable suggestion
-Cleanup respects `data_retention_time_in_days` (1 day by default). Historical data that has been removed cannot be queried through Time Travel or restored with Flashback. +Cleanup respects `data_retention_time_in_days` (1 day by default). When `data_retention_num_snapshots_to_keep` is nonzero, it overrides `data_retention_time_in_days` during vacuum operations. Historical data that has been removed cannot be queried through Time Travel or restored with Flashback.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: bc608b09-740c-4158-9f77-f1f7d5878f7d
📒 Files selected for processing (4)
tidb-cloud-lake/guides/data-management.mdtidb-cloud-lake/guides/data-purge-and-recycle.mdtidb-cloud-lake/sql/drop-table.mdtidb-cloud-lake/sql/optimize-table.md
💤 Files with no reviewable changes (1)
- tidb-cloud-lake/guides/data-management.md
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to GitHub limitations.
🟡 Minor · Document snapshot-count retention for VACUUM. · tidb-cloud-lake/guides/data-purge-and-recycle.md:77-92
77-92: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDocument snapshot-count retention for VACUUM.
data_retention_num_snapshots_to_keepdefaults to0and is ignored at that value. When nonzero, it overridesdata_retention_time_in_days; table-level values take precedence over session and global settings, and VACUUM keeps the specified number of most recent snapshots. Add this setting and its precedence to the retention section. Otherwise, users may expect older snapshots to become eligible based on age when count-based retention still preserves them.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 0ea8ae58-11af-4b89-b0f6-d559d61702c5
📒 Files selected for processing (1)
tidb-cloud-lake/sql/vacuum-table.md
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.
1 participant
What is changed, added, or deleted? (Required)
Added, deleted, and updated VACUUM command docs.
Note
This PR also removed
tidb-cloud-lake/guides/data-management.mdbecause it's an outdated index page that won't be used.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?
Summary by CodeRabbit
Documentation
VACUUM ALL,VACUUM TABLES, andVACUUM DROPPED OBJECTS, including scopes, privileges, retention, protections, and failure handling.VACUUM TABLE,VACUUM TEMPORARY FILES, andOPTIMIZE TABLEdocumentation with revised behavior and examples.VACUUM DROP TABLEguidance with dropped-object cleanup documentation.