Skip to content

cloud: document Premium manual import mapping - #23504

Open
alastori wants to merge 8 commits into
pingcap:release-8.5from
alastori:docs/premium-import-manual-mapping
Open

cloud: document Premium manual import mapping#23504
alastori wants to merge 8 commits into
pingcap:release-8.5from
alastori:docs/premium-import-manual-mapping

Conversation

@alastori

@alastori alastori commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

This PR aligns the TiDB Cloud import documentation with the current console and file-matching behavior:

  • Documents Premium manual source-pattern mappings and multiple target-table mappings.
  • Corrects wildcard guidance across the related import pages: *, ?, and [] for Destination Mapping, and * and [] for Source Files Mapping and IMPORT INTO.
  • Updates the related CSV, Parquet, and IMPORT INTO references with the wildcard syntax for the workflow they document.
  • Corrects the TiDB X limitations table to reflect direct SQL IMPORT INTO support on Starter and Essential.
  • Preserves the existing non-Premium Aurora Snapshot restrictions while clarifying Premium mapping and pre-check behavior.

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)?

Validation

  • ./scripts/markdownlint on all nine changed documentation files
  • python3 scripts/file-format-lint.py on all nine changed documentation files
  • python3 scripts/check-manual-line-breaks.py on all nine changed documentation files
  • git diff --check
  • Verified the documented wildcard behavior against current TiDB Cloud workflows and IMPORT INTO.

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
    • Clarified CSV and Parquet file-pattern mapping relative to source URIs.
    • Documented automatic and manual source-to-table mappings, including wildcard usage and multiple mappings per import.
    • Added plan-specific import limitations and Premium Aurora Snapshot guidance.
    • Expanded import workflows with pre-check, review, and troubleshooting instructions for missing files, incorrect URIs, and zero-row results.
    • Updated S3 import guidance to require a top-level folder URI and support additional storage providers.

@ti-chi-bot

ti-chi-bot Bot commented Aug 12, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 12, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 12, 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 qiancai 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

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review 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

Walkthrough

The documentation defines source-file mapping rules, plan-specific limitations, and Premium import workflows for Amazon S3 and Alibaba OSS. It covers folder URIs, automatic and manual mappings, pre-checks, completion verification, and troubleshooting.

Changes

Data import mapping documentation

Layer / File(s) Summary
Mapping rules and plan limitations
tidb-cloud/naming-conventions-for-data-import.md, tidb-cloud/premium/import-from-s3-premium.md
The documentation defines relative CSV and Parquet source patterns, per-table mappings, plan restrictions, and multiple mappings per S3 import job.
Premium CSV import workflows
tidb-cloud/premium/import-csv-files-premium.md
The Amazon S3 and Alibaba OSS workflows document top-level folder URIs, automatic and manual mappings, pre-checks, import completion, and troubleshooting.
Premium S3 mapping configuration
tidb-cloud/premium/import-from-s3-premium.md
The mapping step documents top-level folder URIs, source patterns, destination tables, wildcards, and additional mappings.

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

Suggested labels: area/tidb-cloud, for-cloud-release

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Title check ✅ Passed The title clearly identifies the main change: documenting Premium manual import mapping.
Description check ✅ Passed The description covers the required change, affected version, references, validation, AI involvement, and change-type checklist.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 Aug 12, 2026
@alastori

Copy link
Copy Markdown
Collaborator Author

@xuanyu66 PTAL

@alastori

Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@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


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 3e65ba8f-8d09-485c-9c82-07a997dc8dbe

📥 Commits

Reviewing files that changed from the base of the PR and between a26c149 and a69e4ac.

📒 Files selected for processing (3)
  • tidb-cloud/naming-conventions-for-data-import.md
  • tidb-cloud/premium/import-csv-files-premium.md
  • tidb-cloud/premium/import-from-s3-premium.md

Comment thread tidb-cloud/premium/import-csv-files-premium.md Outdated
Comment thread tidb-cloud/premium/import-from-s3-premium.md Outdated
@ti-chi-bot ti-chi-bot Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 12, 2026
@alastori

Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@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

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 3c86eb4a-6cee-459c-ab84-7ec6c5b5fa2c

📥 Commits

Reviewing files that changed from the base of the PR and between a26c149 and 096fcf3.

📒 Files selected for processing (3)
  • tidb-cloud/naming-conventions-for-data-import.md
  • tidb-cloud/premium/import-csv-files-premium.md
  • tidb-cloud/premium/import-from-s3-premium.md

Comment thread tidb-cloud/premium/import-csv-files-premium.md Outdated
@alastori

Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@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


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 37fd6fdb-01f1-4b7e-880f-adbff914e034

📥 Commits

Reviewing files that changed from the base of the PR and between a26c149 and 827aa73.

📒 Files selected for processing (3)
  • tidb-cloud/naming-conventions-for-data-import.md
  • tidb-cloud/premium/import-csv-files-premium.md
  • tidb-cloud/premium/import-from-s3-premium.md

Comment thread tidb-cloud/naming-conventions-for-data-import.md Outdated
Comment thread tidb-cloud/premium/import-csv-files-premium.md Outdated
@alastori

Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@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

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 80ba5d4d-89f5-45fd-8afb-8878355db144

📥 Commits

Reviewing files that changed from the base of the PR and between a26c149 and 4f7dbfe.

📒 Files selected for processing (3)
  • tidb-cloud/naming-conventions-for-data-import.md
  • tidb-cloud/premium/import-csv-files-premium.md
  • tidb-cloud/premium/import-from-s3-premium.md

Comment thread tidb-cloud/premium/import-from-s3-premium.md Outdated
@alastori
alastori marked this pull request as ready for review August 12, 2026 23:09
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 12, 2026
@CLAassistant

CLAassistant commented Aug 14, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.


</CustomContent>

In the mapping step of the import wizard, deselect **Use TiDB file naming conventions for automatic mapping**, and then fill in the **Source**, **Target Database**, and **Target Table** fields. The **Source** field accepts a file name pattern relative to the source URI and supports the `*` and `?` wildcards.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The ? wildcard is not supported on the Premium import path. Premium import runs on IMPORT INTO, whose file matching only supports the * and [] wildcards — see the official IMPORT INTO documentation:

In the fileLocation parameter, you can specify a single file, or use the * and [] wildcards to match multiple files for import.

On this path, a ? in the pattern is silently treated as a literal character, so a pattern like my-data?.csv matches no files and only surfaces as an "empty data set" warning at pre-check time. (? does work in the legacy Dedicated custom mapping, where the backend translates it into a regex ., but that does not apply to Premium.)

Suggest changing this to "supports the * and [] wildcards" (or scoping the wording per plan). The same claim also appears in tidb-cloud/premium/import-csv-files-premium.md (both storage provider tabs) and tidb-cloud/premium/import-from-s3-premium.md.

@alastori alastori Aug 19, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, confirmed. I updated the affected pages so the wildcard wording follows the visible mapping workflow:

Scope File-pattern behavior Customer-issued SQL IMPORT INTO
TiDB Self-Managed v8.5 * and []; ? is literal Supported
Starter with Destination Mapping *, ?, and [] Supported
Essential and Premium with Source Files Mapping * and []; ? is literal Supported
Dedicated with Destination Mapping *, ?, and [] Documented for Amazon S3 and GCS

The Starter and Essential SQL availability entries were also verified, so the TiDB X limitations table is corrected in this PR. The public wording uses service plans and visible workflow labels without exposing architecture generations.

@alastori
alastori marked this pull request as draft August 20, 2026 23:19
@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 20, 2026
@alastori
alastori marked this pull request as ready for review August 20, 2026 23:26
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

3 participants