fs: adding SDKs - #23957
fs: adding SDKs#23957guangleibao wants to merge 7 commits into
Conversation
ti-chi-bot
Bot
added
first-time-contributor
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. 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⚙️ Run configurationConfiguration used: Repository: pingcap/docs/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe documentation adds a TiDB Cloud Filesystem SDK guide with credential details, regional server URLs, and links to six language SDK guides. It also documents usage limits for organizations without a registered credit card and adds navigation links. ChangesFilesystem SDK documentation
Filesystem usage limits
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Other Suggested reviewers: Merge Risk: 🔵 Low · up to The new guidance can send users to unsupported endpoints and mislead them about which limits stop writes. The impact is bounded because supported regions remain listed and the affected limit scopes are narrow; the documentation is mergeable with owner awareness, though both passages should be corrected. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 2 systems. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 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: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: pingcap/docs/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 86bb5b3a-2e4a-46bd-a618-0086953e0435
📒 Files selected for processing (3)
TOC-tidb-cloud-filesystem.mdtidb-cloud-filesystem/filesystem-intro.mdtidb-cloud-filesystem/filesystem-sdks.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.
| |`gcp-us-east1`|`https://gcp-us-east-1.drive9.ai`| FS token| | ||
| |`azure-centralus`|`https://azure-centralus.drive9.ai`|FS token| |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Remove the unsupported region entries.
Line 28 and Line 29 list gcp-us-east1 and azure-centralus as TiDB Cloud Filesystem regions. The current Filesystem regions guide lists only AWS us-east-1, AWS us-west-2, AWS ap-southeast-1, and Alibaba Cloud Singapore. It does not list GCP or Azure. (docs.pingcap.com)
Remove the unsupported region entries
-|`gcp-us-east1`|`https://gcp-us-east-1.drive9.ai`| FS token|
-|`azure-centralus`|`https://azure-centralus.drive9.ai`|FS token|📝 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.
| |`gcp-us-east1`|`https://gcp-us-east-1.drive9.ai`| FS token| | |
| |`azure-centralus`|`https://azure-centralus.drive9.ai`|FS token| |
There was a problem hiding this comment.
The GPC line should be
|gcp-us-east1|https://gcp-us-east1.drive9.ai| FS token|
There was a problem hiding this comment.
@guangleibao, thanks for clarifying. My request to remove the GCP row was incorrect. Keep the row with this endpoint:
|`gcp-us-east1`|`https://gcp-us-east1.drive9.ai`| FS token|Does TiDB Cloud Filesystem also support azure-centralus? That part of the finding remains open.
✏️ Learnings added
Learnt from: guangleibao
Repo: pingcap/docs PR: 23957
File: tidb-cloud-filesystem/filesystem-sdks.md:28-29
Timestamp: 2026-10-02T02:44:27.389Z
Learning: In `tidb-cloud-filesystem/filesystem-sdks.md`, TiDB Cloud Filesystem supports the `gcp-us-east1` region. Its Drive9 SDK/API server URL is `https://gcp-us-east1.drive9.ai`, authenticated with a filesystem token. Do not recommend removing this region merely because the published regions guide does not list it.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
You are interacting with an AI system.
There was a problem hiding this comment.
The GPC line should be
|
gcp-us-east1|https://gcp-us-east1.drive9.ai| FS token|
@qiancai FYI
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: pingcap/docs/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: f553ddb6-00fb-445d-abb4-2853ba8bbb84
📒 Files selected for processing (1)
tidb-cloud-filesystem/manage-filesystem-limits.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.
|
|
||
| ## When a file system reaches a limit | ||
|
|
||
| When a file system hits one of these limits, your existing files stay readable and the file system **stops accepting new writes**. The TiDB Cloud console shows a warning. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Scope the write-stop behavior to each limit.
The regional limit controls creation of another file system. The 500 MB limit rejects a write to an individual file. Only the file-count and total-storage limits stop new writes across the file system.
Suggested fix
When a file system reaches its 2,000-file or 2 GB total-storage limit, existing files stay readable, but the file system stops accepting new writes. When a file exceeds the 500 MB per-file limit, the write to that file is rejected. The one-file-system-per-region limit applies when you create another file system in that region. The TiDB Cloud console shows a warning.
There was a problem hiding this comment.
The suggested fix is good. Should be accepted.
qiancai
added
area/tidb-cloud
ti-chi-bot
Bot
removed
the
missing-translation-status
|
[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 |
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
ti-chi-bot
Bot
added
size/XL
2 participants
First-time contributors' checklist
What is changed, added, or deleted? (Required)
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