Skip to content

Changefeed ess cloud storage - #24541

Open
ginkgoch wants to merge 6 commits into
pingcap:release-8.5from
ginkgoch:changefeed-ess-cloud-storage
Open

ginkgoch wants to merge 6 commits into
pingcap:release-8.5from
ginkgoch:changefeed-ess-cloud-storage

Conversation

@ginkgoch

@ginkgoch ginkgoch commented Oct 22, 2026 •

Copy link
Copy Markdown
Collaborator

First-time contributors' checklist

What is changed, added, or deleted? (Required)

Essential changefeed supports cloud storage, need to update the doc.

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)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 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)?

  • Related code change PR links (if applicable):
  • This PR is translated from:
  • Other reference 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

Summary by CodeRabbit

  • Documentation
    • Added cloud storage changefeed links to the TiDB Cloud Essential table of contents and overview.
    • Expanded the guide with Essential plan availability, changefeed limits, and Amazon S3 and Alibaba Cloud OSS setup instructions, including plan-specific permissions and connection testing.
    • Updated the data pipeline guide with console-based setup instructions for an S3 changefeed, including the destination path, authentication options, starting point, and data format settings.

@ti-chi-bot

ti-chi-bot Bot commented Oct 22, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign breezewish for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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 contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 22, 2026
@coderabbitai

coderabbitai Bot commented Oct 22, 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
📝 Walkthrough

The documentation adds TiDB Cloud Essential to cloud storage changefeed guidance. It also replaces API-based lake pipeline setup instructions with console setup steps.

Changes: TiDB Cloud Essential changefeed documentation

Layer / File(s) Summary
Availability and documentation entry point
TOC-tidb-cloud-essential.md, tidb-cloud/essential-changefeed-overview.md, tidb-cloud/changefeed-sink-to-cloud-storage.md
The table of contents and overview link to the cloud storage sink guide. The guide describes Essential changefeed availability and its limit of 10 changefeeds per instance.
Cloud storage destination setup
tidb-cloud/changefeed-sink-to-cloud-storage.md
The guide adds Essential destination selection and S3 region requirements. It specifies plan-specific OSS permissions and policy examples, and includes Essential in connection testing.
Lake pipeline setup
tidb-cloud/data-pipeline-essential-sink-to-lake.md
The guide replaces API instructions with console steps for the S3 path, authentication, snapshot TSO, and Canal-JSON settings.

Priority: ➖ Normal

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

Change: Other

Merge Risk: 🔵 Low · up to fda86

Essential users may see the wrong cloud storage setup instructions. Add the plan selector before merging if possible; the issue is localized and has a straightforward workaround.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title "Changefeed ess cloud storage" is partially related. It names the core subject (changefeed, Essential, cloud storage) but uses the abbreviation "ess" and no verb. It does not state that the …
Description check Passed The description states the purpose in one line: Essential changefeed supports cloud storage, so the doc needs an update. It meets the template's required section for what changed. It does not name the…
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.
Full details: Title check

Explanation

The title "Changefeed ess cloud storage" is partially related. It names the core subject (changefeed, Essential, cloud storage) but uses the abbreviation "ess" and no verb. It does not state that the docs now cover cloud storage sink support for Essential changefeeds. The changeset also updates the Essential overview, the cloud storage guide, the Essential sink-to-lake tutorial, and the TOC, which the title does not mention. The title is not vague or unrelated, so it does not fail or become inconclusive.

Full details: Description check

Explanation

The description states the purpose in one line: Essential changefeed supports cloud storage, so the doc needs an update. It meets the template's required section for what changed. It does not name the affected files, describe the plan-specific changes (limits, S3 and OSS details, console steps), or give the related PR or file links. The version checkboxes are all unticked, and the template's required version field has no selection. The description is brief but gives the core intent, so it is mostly complete.

Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

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

@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: 1


ℹ️ Review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between a90ebc8 and dbc50e6.

📒 Files selected for processing: 3
  • TOC-tidb-cloud-essential.md
  • tidb-cloud/changefeed-sink-to-cloud-storage.md
  • tidb-cloud/data-pipeline-essential-sink-to-lake.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.

Comment thread tidb-cloud/changefeed-sink-to-cloud-storage.md
Comment thread tidb-cloud/data-pipeline-essential-sink-to-lake.md Outdated
Comment thread tidb-cloud/changefeed-sink-to-cloud-storage.md Outdated
Comment thread tidb-cloud/changefeed-sink-to-cloud-storage.md Outdated

@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: 1


ℹ️ Review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between dbc50e6 and 727cb20.

📒 Files selected for processing: 2
  • tidb-cloud/changefeed-sink-to-cloud-storage.md
  • tidb-cloud/data-pipeline-essential-sink-to-lake.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.

Comment thread tidb-cloud/data-pipeline-essential-sink-to-lake.md

@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: 1


ℹ️ Review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between 727cb20 and fda8699.

📒 Files selected for processing: 1
  • tidb-cloud/essential-changefeed-overview.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/essential-changefeed-overview.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants