Skip to content

Latest commit

 

History

History
128 lines (81 loc) · 5.21 KB

serverless-export.md

File metadata and controls

128 lines (81 loc) · 5.21 KB
Raw
title summary
Export Data from TiDB Serverless
Learn how to export data from TiDB Serverless clusters.

Export Data from TiDB Serverless

TiDB Serverless Export (Beta) is a service that enables you to export data from a TiDB Serverless cluster to local storage or an external storage service. You can use the exported data for backup, migration, data analysis, or other purposes.

While you can also export data using tools such as mysqldump and TiDB Dumpling, TiDB Serverless Export offers a more convenient and efficient way to export data from a TiDB Serverless cluster. It brings the following benefits:

  • Convenience: the export service provides a simple and easy-to-use way to export data from a TiDB Serverless cluster, eliminating the need for additional tools or resources.
  • Isolation: the export service uses separate computing resources, ensuring isolation from the resources used by your online services.
  • Consistency: the export service ensures the consistency of the exported data without causing locks, which does not affect your online services.

Features

This section describes the features of TiDB Serverless Export.

Export location

You can export data to local storage or Amazon S3.

Note:

If the size of the data to be exported is large (more than 100 GiB), it is recommended that you export it to Amazon S3.

Local storage

Exporting data to local storage has the following limitations:

  • Exporting multiple databases to local storage at the same time is not supported.
  • Exported data is saved in the stashing area and will expire after two days. You need to download the exported data in time.
  • If the storage space of stashing area is full, you will not be able to export data to local storage.

Amazon S3

To export data to Amazon S3, you need to provide an access key for your S3 bucket. Make sure the access key has read and write access for your S3 bucket, including at least these permissions: s3:PutObject and s3:ListBucket.

Data filtering

You can filter data by specifying the database and table you want to export. If you specify a database without specifying a table, all tables in that specified database will be exported. If you do not specify a database when you export data to Amazon S3, all databases in the cluster will be exported.

Note:

You must specify the database when you export data to local storage.

Data formats

You can export data in the following formats:

  • SQL (default): export data in SQL format.
  • CSV: export data in CSV format.

The schema and data are exported according to the following naming conventions:

Item Not compressed Compressed
Database schema {database}-schema-create.sql {database}-schema-create.sql.{compression-type}
Table schema {database}.{table}-schema.sql {database}.{table}-schema.sql.{compression-type}
Data {database}.{table}.{0001}.{sql|csv} {database}.{table}.{0001}.{sql|csv}.{compression-type}

Data compression

You can compress the exported data using the following algorithms:

  • gzip (default): compress the exported data with gzip.
  • snappy: compress the exported data with snappy.
  • zstd: compress the exported data with zstd.
  • none: do not compress the exported data.

Cancel export

You can cancel an export task that is in the running state.

Examples

Currently, you can manage export tasks using TiDB Cloud CLI.

Export data to local storage

  1. Create an export task that specifies the database and table you want to export:

    ticloud serverless export create -c <cluster-id> --database <database> --table <table>

    You will get an export ID from the output.

  2. After the export is successful, download the exported data to your local storage:

    ticloud serverless export download -c <cluster-id> -e <export-id>

Export data to Amazon S3

ticloud serverless export create -c <cluster-id> --bucket-uri <bucket-uri> --access-key-id <access-key-id> --secret-access-key <secret-access-key>

Export with the CSV format

ticloud serverless export create -c <cluster-id> --file-type CSV

Export the whole database

ticloud serverless export create -c <cluster-id> --database <database>

Export with snappy compression

ticloud serverless export create -c <cluster-id> --compress snappy

Cancel an export task

ticloud serverless export cancel -c <cluster-id> -e <export-id>

Pricing

The export service is free during the beta period. You only need to pay for the Request Units (RUs) generated during the export process of successful or canceled tasks. For failed export tasks, you will not be charged.