Skip to content

Commit

Permalink
dumpling: Update README (#58679)
Browse files Browse the repository at this point in the history
  • Loading branch information
dveeden authored Jan 3, 2025
1 parent 4721bc3 commit 135686a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 178 deletions.
22 changes: 8 additions & 14 deletions dumpling/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,31 @@
🥟 Dumpling
============

[![Build Status](https://travis-ci.org/pingcap/dumpling.svg?branch=master)](https://travis-ci.org/pingcap/dumpling)
[![codecov](https://codecov.io/gh/pingcap/dumpling/branch/master/graph/badge.svg)](https://codecov.io/gh/pingcap/dumpling)
[![API Docs](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/pingcap/dumpling)
[![Go Report Card](https://goreportcard.com/badge/github.com/pingcap/dumpling)](https://goreportcard.com/report/github.com/pingcap/dumpling)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpingcap%2Fdumpling.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpingcap%2Fdumpling?ref=badge_shield)
[![API Docs](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/pingcap/tidb/dumpling)

**Dumpling** is a tool and a Go library for creating SQL dump from a MySQL-compatible database.
**Dumpling** is a tool and a Go library for creating an SQL dump from a MySQL-compatible database.
It is intended to replace `mysqldump` and `mydumper` when targeting TiDB.

You may read the [design document](https://github.com/pingcap/community/blob/master/rfc/2019-12-06-dumpling.md), [English user guide](docs/en/user-guide.md) and [中文使用手册](docs/cn/user-guide.md) for details.
You may read the original [design document](https://github.com/pingcap/community/blob/master/archive/misc/rfc/2019-12-06-dumpling.md). The end-user documentation is available here: [en](https://docs.pingcap.com/tidb/stable/dumpling-overview), [zh](https://docs.pingcap.com/zh/tidb/stable/dumpling-overview), [ja](https://docs.pingcap.com/ja/tidb/stable/dumpling-overview).

Features
--------

> Dumpling is currently in early development stage, and most features are incomplete. Contributions are welcomed!
> Dumpling is in active development. Contributions are welcomed!
- [x] SQL dump is split into multiple files (like `mydumper`) for easy management.
- [x] Export multiple tables in parallel to speed up execution.
- [x] Multiple output formats: SQL, CSV, ...
- [ ] Write to cloud storage (S3, GCS) natively
- [x] Write to cloud storage (S3, GCS) natively
- [x] Advanced table filtering

Any questions? Let's discuss on [TiDB Internals forum](https://internals.tidb.io/)!
Any questions? Discord, Slack and other contact options can be found [here](https://docs.pingcap.com/tidb/stable/support)

Building
--------

0. Under directory `tidb`
1. Install Go 1.16 or above
1. Install Go 1.23.4 or above
2. Run `make build_dumpling` to compile. The output is in `bin/dumpling`.
3. Run `make dumpling_unit_test` to run the unit tests.
4. Run `make dumpling_integration_test` to run integration tests. For integration test:
Expand All @@ -46,6 +42,4 @@ Building
License
-------

Dumpling is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details.

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpingcap%2Fdumpling.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpingcap%2Fdumpling?ref=badge_large)
Dumpling is under the Apache 2.0 license. See the [LICENSE](../LICENSE) file for details.
82 changes: 0 additions & 82 deletions dumpling/docs/cn/user-guide.md

This file was deleted.

82 changes: 0 additions & 82 deletions dumpling/docs/en/user-guide.md

This file was deleted.

0 comments on commit 135686a

Please sign in to comment.