# tidb-cloud-backup

**Repository Path**: mirrors_pingcap/tidb-cloud-backup

## Basic Information

- **Project Name**: tidb-cloud-backup
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-10-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TiDB cloud backup

## Build

### uploader
```shell
go build -o bin/uploader upload/main.go
```

### downloader
``` shell
go build -o bin/downloader download/main.go
```

### metabackup
``` shell
go build -o bin/etcdbackuper etcdbackup/main.go
```

### build image
``` shell
docker build -t pingcap/tidb-cloud-backup .
```

## Run

Ref [here](https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually) to get google application credentials with cloud storage permission.

And then go to GCP console to create a cloud storage bucket.

```shell
ts=$(date +%Y-%m-%dT%H%M%S)

docker run -v $PWD/tidb_backup_${ts}:/backup pingcap/tidb-cloud-backup /mydumper \
    --outputdir=/backup \
    --host=<tidb-host> \
    --port=4000 \
    --user=root \
    --password=<password>

docker run -v $PWD/tidb_backup_${ts}:/tidb_backup_${ts} \
    -v /path/to/google-application-credentials:/gcp-credentials.json
    -e GOOGLE_APPLICATION_CREDENTIALS=/gcp-credentials.json
    pingcap/tidb-cloud-backup uploader \
    --cloud=gcp \
    --bucket=<bucket-name> \
    --backup-dir=/tidb_backup_${ts}

docker run -v /path/to/google-application-credentials:/gcp-credentials.json \
    -v /path/to/destDir:/data \
    -e GOOGLE_APPLICATION_CREDENTIALS=/gcp-credentials.json
    pingcap/tidb-cloud-backup downloader \
    --cloud=gcp \
    --bucket=<bucket-name> \
    --srcDir=<src-dir-in-bucket> \
    --destDir=/data
```