Fetching contributors…
Cannot retrieve contributors at this time
147 lines (97 sloc) 5 KB
title summary category
Loader Instructions
Use Loader to load data to TiDB.

Loader Instructions

What is Loader?

Loader is a data import tool to load data to TiDB.

Download the Binary.

Why did we develop Loader?

Since tools like mysqldump will take us days to migrate massive amounts of data, we used the mydumper/myloader suite to multi-thread export and import data. During the process, we found that mydumper works well. However, as myloader lacks functions of error retry and savepoint, it is inconvenient for us to use. Therefore, we developed loader, which reads the output data files of mydumper and imports data to TiDB through the MySQL protocol.

What can Loader do?

  • Multi-thread import data

  • Support table level concurrent import and scattered hot spot write

  • Support concurrent import of a single large table and scattered hot spot write

  • Support mydumper data format

  • Support error retry

  • Support savepoint

  • Improve the speed of importing data through system variable



  • Do not import the mysql system database from the MySQL instance to the downstream TiDB instance.
  • If mydumper uses the -m parameter, the data is exported without the table structure and the loader can not import the data.
  • If you use the default checkpoint-schema parameter, after importing the data of a database, run drop database tidb_loader before you begin to import the next database.
  • It is recommended to specify the checkpoint-schema = "tidb_loader" parameter when importing data.

Parameter description

  -L string: the log level setting, which can be set as debug, info, warn, error, fatal (default: "info")

  -P int: the port of TiDB (default: 4000)

  -V boolean: prints version and exit

  -c string: config file

  -checkpoint-schema string: the database name of checkpoint. In the execution process, loader will constantly update this database. After recovering from an interruption, loader will get the process of the last run through this database. (default: "tidb_loader")

  -d string: the storage directory of data that need to import (default: "./")

  -h string: the host of TiDB (default: "")

  -p string: the account and password of TiDB

  -pprof-addr string: the pprof address of Loader. It tunes the performance of Loader (default: ":10084")

  -t int: the number of thread,increase this as TiKV nodes increase (default: 16)

  -u string: the user name of TiDB (default: "root")

Configuration file

Apart from command line parameters, you can also use configuration files. The format is shown as below:

# Loader log level, which can be set as "debug", "info", "warn", "error" and "fatal" (default: "info")
log-level = "info"

# Loader log file
log-file = "loader.log"

# Directory of the dump to import (default: "./")
dir = "./"

# Loader pprof address, used to tune the performance of Loader (default: "")
pprof-addr = ""

# The checkpoint data is saved to TiDB, and the schema name is defined here.
checkpoint-schema = "tidb_loader"

# Number of threads restoring concurrently for worker pool (default: 16). Each worker restore one file at a time.
pool-size = 16

# The target database information
host = ""
user = "root"
password = ""
port = 4000

# The sharding synchronising rules support wildcharacter.
# 1. The asterisk character (*, also called "star") matches zero or more characters,
#    for example, "doc*" matches "doc" and "document" but not "dodo";
#    asterisk character must be in the end of the wildcard word,
#    and there is only one asterisk in one wildcard word.
# 2. The question mark '?' matches exactly one character.
#    [[route-rules]]
#    pattern-schema = "shard_db_*"
#    pattern-table = "shard_table_*"
#    target-schema = "shard_db"
#    target-table = "shard_table"

Usage example

Command line parameter:

./bin/loader -d ./test -h -u root -P 4000

Or use configuration file "config.toml":

./bin/loader -c=config.toml


The scenario of synchronising data from sharded tables

Loader supports importing data from sharded tables into one table within one database according to the route-rules. Before synchronising, check the following items:

  • Whether the sharding rules can be represented using the route-rules syntax.
  • Whether the sharded tables contain monotone increasing primary keys, or whether there are conflicts in the unique indexes or the primary keys after the combination.

To combine tables, start the route-rules parameter in the configuration file of Loader:

  • To use the table combination function, it is required to fill the pattern-schema and target-schema.
  • If the pattern-table and target-table are NULL, the table name is not combined or converted.
pattern-schema = "example_db"
pattern-table = "table_*"
target-schema = "example_db"
target-table = "table"