Skip to content

Commit 321f7d3

Browse files
committed
update export doc
1 parent 821ebde commit 321f7d3

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

tidb-cloud/serverless-export.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,30 @@ Exporting data to local file has the following limitations:
3636

3737
### Amazon S3
3838

39-
To export data to Amazon S3, you need to provide one of the following access methods for your Amazon S3 bucket:
39+
To export data to Amazon S3, you need to provide the following information:
4040

41-
- [Access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html): make sure the access key has these permissions: `s3:PutObject` and `s3:ListBucket`.
42-
- [Role arn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html): make sure the role arn has these permissions: `s3:PutObject` and `s3:ListBucket`.
41+
- uri: `s3://<bucket-name>/<file-path>`
42+
- one of the following access methods:
43+
- [access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html): make sure the access key has the `s3:PutObject` and `s3:ListBucket` permissions.
44+
- [role arn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html): make sure the role arn has the `s3:PutObject` and `s3:ListBucket` permissions.
4345

4446
### Google Cloud Storage
4547

46-
To export data to Google Cloud Storage, you need to provide a **base64 encoded** [service account key](https://cloud.google.com/iam/docs/creating-managing-service-account-keys) for your Google Cloud Storage bucket. Make sure the service account key has these permissions: `storage.objects.create`. You may also need `storage.objects.delete` permission when you export to a non-empty folder.
48+
To export data to Google Cloud Storage, you need to provide the following information:
49+
50+
- uri: `gs://<bucket-name>/<file-path>`
51+
- access method: a **base64 encoded** [service account key](https://cloud.google.com/iam/docs/creating-managing-service-account-keys) for your bucket. Make sure the service account key has the `storage.objects.create` permission.
4752

4853
> **Note:**
4954
>
5055
> Only supported in TiDB Cloud CLI now.
5156
5257
### Azure Blob Storage
5358

54-
To export data to Azure Blob Storage, you need to provide a [shared access signature (SAS) token](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview) for your Azure Blob Storage container. Make sure the SAS token has the `Read` and `Write` permissions on the `Container` and `Object` resources.
59+
To export data to Azure Blob Storage, you need to provide the following information:
60+
61+
- uri: `azure://<account-name>.blob.core.windows.net/<container-name>/<file-path>`
62+
- access method: a [shared access signature (SAS) token](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview) for your Azure Blob Storage container. Make sure the SAS token has the `Read` and `Write` permissions on the `Container` and `Object` resources.
5563

5664
> **Note:**
5765
>
@@ -177,7 +185,7 @@ You can compress the exported parquet data using the following algorithms:
177185
- **Exported data**: choose the databases and tables you want to export.
178186
- **Data format**: choose one of the **SQL File** and **CSV**.
179187
- **Compression**: choose one of the **Gzip**, **Snappy**, **Zstd**, and **None**.
180-
- **File URI**: enter the URI of the Amazon S3.
188+
- **File URI**: enter the URI of the Amazon S3 with the `s3://<bucket-name>/<file-path>` format.
181189
- **Bucket Access**
182190
- **AWS Role Arn**: enter the ARN of the role that has the permission to access the bucket.
183191
- **AWS Access Key ID**: enter the access key ID and access key secret that has the permission to access the bucket.
@@ -194,15 +202,15 @@ You can compress the exported parquet data using the following algorithms:
194202
ticloud serverless export create -c <cluster-id> --s3.uri <uri> --s3.access-key-id <access-key-id> --s3.secret-access-key <secret-access-key> --filter "database.table"
195203
```
196204

197-
- s3.uri: The URI of the Amazon S3 bucket with the `s3://<bucket-name>/path` format.
205+
- s3.uri: The Amazon S3 URI with the `s3://<bucket-name>/<file-path>` format.
198206
- s3.access-key-id: The access key ID of the user who has the permission to access the bucket.
199207
- s3.secret-access-key: The access key secret of the user who has the permission to access the bucket.
200208

201209
```shell
202210
ticloud serverless export create -c <cluster-id> --s3.uri <uri> --s3.role-arn <role-arn> --filter "database.table"
203211
```
204212

205-
- s3.uri: The URI of the Amazon S3 bucket with the `s3://<bucket-name>/path` format.
213+
- s3.uri: The URI of the Amazon S3 bucket with the `s3://<bucket-name>/<file-path>` format.
206214
- s3.role-arn: The ARN of the role that has the permission to access the bucket.
207215

208216
</div>
@@ -216,7 +224,7 @@ You can only export data to Google Cloud Storage using the TiDB Cloud CLI now.
216224
ticloud serverless export create -c <cluster-id> --gcs.uri <uri> --gcs.service-account-key <service-account-key> --filter "database.table"
217225
```
218226

219-
- gcs.uri: The URI of the Google Cloud Storage bucket with the `gs://<bucket-name>/path` format.
227+
- gcs.uri: The URI of the Google Cloud Storage bucket with the `gs://<bucket-name>/<file-path>` format.
220228
- gcs.service-account-key: The base64 encoded service account key.
221229

222230
### Export data to Azure Blob Storage
@@ -227,7 +235,7 @@ You can only export data to Azure Blob Storage using the TiDB Cloud CLI now.
227235
ticloud serverless export create -c <cluster-id> --azblob.uri <uri> --azblob.sas-token <sas-token> --filter "database.table"
228236
```
229237

230-
- azblob.uri: The URI of the Azure Blob Storage with the `azure://<account-name>.blob.core.windows.net/<container-name>/path` format.
238+
- azblob.uri: The URI of the Azure Blob Storage with the `azure://<account-name>.blob.core.windows.net/<container-name>/<file-path>` format.
231239
- azblob.sas-token: The account SAS token of the Azure Blob Storage.
232240

233241
### Cancel an export task

0 commit comments

Comments
 (0)