Skip to content

[pingcap/tidb#46609] support s3 profile for dumpling #21456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
+9 −1
Open

[pingcap/tidb#46609] support s3 profile for dumpling #21456

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4636869
[pingcap/tidb#46609] support s3 profile for dumpling
takaidohigasi Jul 23, 2025
075514a
Update dumpling-overview.md
takaidohigasi Jul 23, 2025
4b35d6b
Update dumpling-overview.md
takaidohigasi Aug 21, 2025
2319931
add example usage for profile and default config
takaidohigasi Aug 21, 2025
15d0dd7
Merge branch '46609-support-s3-profile-for-dumpling' of https://githu…
takaidohigasi Aug 21, 2025
511f7cf
docs: clarify that dumpling reads AWS credentials from ~/.aws/credent…
takaidohigasi Aug 21, 2025
870cc2c
fix s3 option example
takaidohigasi Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion dumpling-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,12 +233,20 @@ export AWS_ACCESS_KEY_ID=${AccessKey}
export AWS_SECRET_ACCESS_KEY=${SecretKey}
```

Dumpling also supports reading credential files from `~/.aws/credentials`. For more information about URI parameter descriptions, see [URI Formats of External Storage Services](/external-storage-uri.md).
Dumpling also supports reading credential files from `~/.aws/credentials` and authenticating with AWS profiles. For more information about URI parameter descriptions, see [URI Formats of External Storage Services](/external-storage-uri.md).

To use the default credentials from `~/.aws/credentials`:

```shell
tiup dumpling -u root -P 4000 -h 127.0.0.1 -r 200000 -o "s3://${Bucket}/${Folder}"
```

To use a specific AWS profile:

```shell
tiup dumpling -u root -P 4000 -h 127.0.0.1 -r 200000 -o "s3://${Bucket}/${Folder}" --s3.profile=my.profile
Copy link
Contributor

Choose a reason for hiding this comment

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

In the code PR pingcap/tidb#62199 the format should be

... -o "s3://${Bucket}/${Folder}/?profile=my_profile"

Can you double check --s3.profile will also work?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes it was noted merged PR description

```

### Filter the exported data

#### Use the `--where` option to filter data
Expand Down