--- title: taosdump --- ## 简介 taosdump 是一个支持从运行中的 TDengine 服务器或集群中备份数据并将备份的数据恢复 到相同或另一个运行中的 TDengine 服务器或集群中的工具应用程序。 taosdump 可以用数据库、超级表或普通表作为逻辑数据单元备份，也可以对数据库、超级 表和普通表中指定时间段内的数据记录进行备份。您可以指定数据备份的目录路径，如果 不指定位置，taosdump 默认会将数据备份到当前目录。 如果指定的位置已经有数据文件，taosdump 会提示用户并立即退出，避免数据被覆盖。 如果您看到提示，请小心操作。 taosdump 是一个逻辑备份工具。它不打算或不应被期望用于备份任何原始数据、环境设置、 硬件信息、服务端配置或集群的拓扑结构。它使用 [Apache AVRO](https://avro.apache.org/)作为数据文件格式来存储备份数据。 ## 常用使用场景 ### taosdump 备份数据 1. 指定 -A 或 --all-databases 参数指定所有数据库； 2. 使用 -D db1,db2,... 参数备份指定的多个数据库； 3. 使用 dbname stbname1 stbname2 tbname1 tbname2 ... 参数方式备份指定数据库中的某些个超级表或普通表，注意这种输入序列第一个参数为数据库名称，且只支持一个数据库，第二个和之后的参数为该数据库中的超级表或普通表名称，中间以空格分隔； 4. TDengine 服务器或集群通常会包含一个系统数据库，名为 log，这个数据库内的数据为 TDengine 自我运行的数据，taosdump 默认不会对 log 库进行备份。如果有特定需求对 log 库进行备份，可以使用 -a 或 --allow-sys 命令行参数。 5. taosdump 1.4.1 之后的版本提供 -n 参数和 -L 参数，用于备份数据时不使用转义字符和“宽容”模式，可以在表名、列名、标签名没使用转义字符的情况下减少备份数据时间和备份数据占用空间。如果不确定符合使用 -n 和 -L 条件时请使用默认参数进行“严格”模式进行备份。转义字符的说明请参考[官方文档](https://tdengine.com/docs/cn/v2.0/taos-sql)。 6. taosdump 1.4.1 之后的版本提供 -I 参数，用于解析 avro 文件 schema 和数据，如果指定 -s 参数将只解析 schema。 7. taosdump 1.4.2 之后的备份使用 -B 参数指定的批次数，默认值为 16384，如果在某些环境下由于网络速度或磁盘性能不足导致 "Error actual dump .. batch .." 可以通过 -B 参数挑战为更小的值进行尝试。 ### taosdump 恢复数据 1. -i 加上数据文件所在路径作为参数进行备份指定路径下的数据文件。如前面提及，不应该使用同一个目录备份不同数据集合，也不应该在同一路径多次备份同一数据集，否则备份数据会造成覆盖或多次备份。 2. taosdump 内部使用 TDengine stmt binding API 进行恢复数据的写入，为提高数据恢复性能，目前使用 16384 为一次写入批次。如果备份数据中有比较多列数据，可能会导致产生 "WAL size exceeds limit" 错误，此时可以通过使用 -B 参数调整为一个更小的值进行尝试。 ## 详细命令行参数列表 以下为 taosdump 详细命令行参数列表： ``` Usage: taosdump [OPTION...] dbname [tbname ...] or: taosdump [OPTION...] --databases db1,db2,... or: taosdump [OPTION...] --all-databases or: taosdump [OPTION...] -i inpath or: taosdump [OPTION...] -o outpath -h, --host=HOST Server host dumping data from. Default is localhost. -p, --password User password to connect to server. Default is taosdata. -P, --port=PORT Port to connect -u, --user=USER User name used to connect to server. Default is root. -c, --config-dir=CONFIG_DIR Configure directory. Default is /etc/taos -i, --inpath=INPATH Input file path. -o, --outpath=OUTPATH Output file path. -r, --resultFile=RESULTFILE DumpOut/In Result file path and name. -a, --allow-sys Allow to dump system database -A, --all-databases Dump all databases. -D, --databases=DATABASES Dump inputted databases. Use comma to separate databases' name. -N, --without-property Dump database without its properties. -s, --schemaonly Only dump tables' schema. -y, --answer-yes Input yes for prompt. It will skip data file checking! -d, --avro-codec=snappy Choose an avro codec among null, deflate, snappy, and lzma. -S, --start-time=START_TIME Start time to dump. Either epoch or ISO8601/RFC3339 format is acceptable. ISO8601 format example: 2017-10-01T00:00:00.000+0800 or 2017-10-0100:00:00:000+0800 or '2017-10-01 00:00:00.000+0800' -E, --end-time=END_TIME End time to dump. Either epoch or ISO8601/RFC3339 format is acceptable. ISO8601 format example: 2017-10-01T00:00:00.000+0800 or 2017-10-0100:00:00.000+0800 or '2017-10-01 00:00:00.000+0800' -B, --data-batch=DATA_BATCH Number of data per query/insert statement when backup/restore. Default value is 16384. If you see 'error actual dump .. batch ..' when backup or if you see 'WAL size exceeds limit' error when restore, please adjust the value to a smaller one and try. The workable value is related to the length of the row and type of table schema. -I, --inspect inspect avro file content and print on screen -L, --loose-mode Using loose mode if the table name and column name use letter and number only. Default is NOT. -n, --no-escape No escape char '`'. Default is using it. -T, --thread-num=THREAD_NUM Number of thread for dump in file. Default is 5. -g, --debug Print debug info. -?, --help Give this help list --usage Give a short usage message -V, --version Print program version Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options. Report bugs to . ```