TiDB Lightning 配置参数

你可以使用配置文件或命令行配置 TiDB Lightning。本文主要介绍 TiDB Lightning 的全局配置、任务配置和 TiKV Importer 的配置,以及如何使用命令行进行参数配置。

配置文件

TiDB Lightning 的配置文件分为“全局”和“任务”两种类别,二者在结构上兼容。只有当服务器模式开启时,全局配置和任务配置才会有区别;默认情况下,服务器模式为禁用状态,此时 TiDB Lightning 只会执行一个任务,且全局和任务配置使用同一配置文件。

TiDB Lightning 全局配置

### tidb-lightning 全局配置 [lightning] # 用于进度展示 web 界面、拉取 Prometheus 监控项、暴露调试数据和提交导入任务(服务器模式下)的 HTTP 端口。设置为 0 时为禁用状态。 status-addr = ':8289' # 服务器模式,默认值为 false,命令启动后会开始导入任务。如果改为 true,命令启动后会等待用户在 web 界面上提交任务。 # 详情参见“TiDB Lightning web 界面”文档 server-mode = false # 日志 level = "info" file = "tidb-lightning.log" max-size = 128 # MB max-days = 28 max-backups = 14

TiDB Lightning 任务配置

### tidb-lightning 任务配置 [lightning] # 启动之前检查集群是否满足最低需求,以及运行过程中检查 TiKV 的可用存储空间是否大于 10%。 # check-requirements = true # 引擎文件的最大并行数。 # 每张表被切分成一个用于存储索引的“索引引擎”和若干存储行数据的“数据引擎”。 # 这两项设置控制两种引擎文件的最大并发数。 # 这两项设置的值会影响 tikv-importer 的内存和磁盘用量。 # 两项数值之和不能超过 tikv-importer 的 max-open-engines 的设定。 index-concurrency = 2 table-concurrency = 6 # 数据的并发数。默认与逻辑 CPU 的数量相同。 # 混合部署的情况下可以将其大小配置为逻辑 CPU 数的 75%,以限制 CPU 的使用。 # region-concurrency = # I/O 最大并发数。I/O 并发量太高时,会因硬盘内部缓存频繁被刷新 # 而增加 I/O 等待时间,导致缓存未命中和读取速度降低。 # 对于不同的存储介质,此参数可能需要调整以达到最佳效率。 io-concurrency = 5 [security] # 指定集群中用于 TLS 连接的证书和密钥。 # CA 的公钥证书。如果留空,则禁用 TLS。 # ca-path = "/path/to/ca.pem" # 此服务的公钥证书。 # cert-path = "/path/to/lightning.pem" # 该服务的密钥。 # key-path = "/path/to/lightning.key" [checkpoint] # 是否启用断点续传。 # 导入数据时,TiDB Lightning 会记录当前表导入的进度。 # 所以即使 TiDB Lightning 或其他组件异常退出,在重启时也可以避免重复再导入已完成的数据。 enable = true # 存储断点的数据库名称。 schema = "tidb_lightning_checkpoint" # 存储断点的方式。 # - file:存放在本地文件系统。 # - mysql:存放在兼容 MySQL 的数据库服务器。 driver = "file" # dsn 是数据源名称 (data source name),表示断点的存放位置。 # 若 driver = "file",则 dsn 为断点信息存放的文件路径。 #若不设置该路径,则默认存储路径为“/tmp/CHECKPOINT_SCHEMA.pb”。 # 若 driver = "mysql",则 dsn 为“用户:密码@tcp(地址:端口)/”格式的 URL。 # 若不设置该 URL,则默认会使用 [tidb] 部分指定的 TiDB 服务器来存储断点。 # 为减少目标 TiDB 集群的压力,建议指定另一台兼容 MySQL 的数据库服务器来存储断点。 # dsn = "/tmp/tidb_lightning_checkpoint.pb" # 所有数据导入成功后是否保留断点。设置为 false 时为删除断点。 # 保留断点有利于进行调试,但会泄漏关于数据源的元数据。 # keep-after-success = false [tikv-importer] # 选择后端:“importer” 或 “local” 或 “tidb” # "local":通过在本地排序生成 SST 文件的方式导入数据,适用于快速导入大量数据,但导入期间下游 TiDB 无法对外提供服务,并且导入的目标表必须为空。 # "importer": 和 “local“ 原理类似,但需要额外部署 “tikv-importer“ 组件。如无特殊情况,推荐使用 “local” 后端。 # "tidb":通过执行 SQL 语句的方式导入数据,速度较慢,但导入期间下游 TiDB 可正常提供服务,导入的目标表可以不为空。 # backend = "local" # 当后端是 “importer” 时,tikv-importer 的监听地址(需改为实际地址)。 addr = "172.16.31.10:8287" # 当后端是 “tidb” 时,插入重复数据时执行的操作。 # - replace:新数据替代已有数据 # - ignore:保留已有数据,忽略新数据 # - error:中止导入并报错 # on-duplicate = "replace" # 当后端是 “local” 时,控制生成 SST 文件的大小,最好跟 TiKV 里面的 Region 大小保持一致,默认是 96 MB。 # region-split-size = 100_663_296 # 当后端是 “local” 时,一次请求中发送的 KV 数量。 # send-kv-pairs = 32768 # 当后端是 “local” 时,本地进行 KV 排序的路径。如果磁盘性能较低(如使用机械盘),建议设置成与 `data-source-dir` 不同的磁盘,这样可有效提升导入性能。 # sorted-kv-dir = "" # 当后端是 “local” 时,TiKV 写入 KV 数据的并发度。当 TiDB Lightning 和 TiKV 直接网络传输速度超过万兆的时候,可以适当增加这个值。 # range-concurrency = 16 [mydumper] # 设置文件读取的区块大小,确保该值比数据源的最长字符串长。 read-block-size = "64KiB" # 默认值 # (源数据文件)单个导入区块大小的最小值。 # TiDB Lightning 根据该值将一张大表分割为多个数据引擎文件。 # batch-size = 107_374_182_400 # Byte (默认为 100 GB) # 引擎文件需按顺序导入。由于并行处理,多个数据引擎几乎在同时被导入, # 这样形成的处理队列会造成资源浪费。因此,为了合理分配资源,TiDB Lightning # 稍微增大了前几个区块的大小。该参数也决定了比例系数,即在完全并发下 # “导入”和“写入”过程的持续时间比。这个值可以通过计算 1 GiB 大小的 # 单张表的(导入时长/写入时长)得到。在日志文件中可以看到精确的时间。 # 如果“导入”更快,区块大小的差异就会更小;比值为 0 时则说明区块大小一致。 # 取值范围为(0 <= batch-import-ratio < 1)。 batch-import-ratio = 0.75 # 本地源数据目录或外部存储 URL data-source-dir = "/data/my_database" # 如果 no-schema = true,那么 TiDB Lightning 假设目标 TiDB 集群上 # 已有表结构,并且不会执行 `CREATE TABLE` 语句。 no-schema = false # 指定包含 `CREATE TABLE` 语句的表结构文件的字符集。只支持下列选项: # - utf8mb4:表结构文件必须使用 UTF-8 编码,否则会报错。 # - gb18030:表结构文件必须使用 GB-18030 编码,否则会报错。 # - auto:自动判断文件编码是 UTF-8 还是 GB-18030,两者皆非则会报错(默认)。 # - binary:不尝试转换编码。 # 注意:**数据** 文件始终解析为 binary 文件。 character-set = "auto" # “严格”格式的导入数据可加快处理速度。 # strict-format = true 要求: # 在 CSV 文件的所有记录中,每条数据记录的值不可包含字符换行符(U+000A 和 U+000D,即 \r 和 \n) # 甚至被引号包裹的字符换行符都不可包含,即换行符只可用来分隔行。 # 导入数据源为严格格式时,TiDB Lightning 会快速定位大文件的分割位置进行并行处理。 # 但是如果输入数据为非严格格式,可能会将一条完整的数据分割成两部分,导致结果出错。 # 为保证数据安全而非追求处理速度,默认值为 false。 strict-format = false # 如果 strict-format = true,TiDB Lightning 会将 CSV 大文件分割为多个文件块进行并行处理。max-region-size 是分割后每个文件块的最大大小。 # max-region-size = "256MiB" # 默认值 # 只导入与该通配符规则相匹配的表。详情见相应章节。 filter = ['*.*'] # 配置 CSV 文件的解析方式。 [mydumper.csv] # 字段分隔符,应为单个 ASCII 字符。 separator = ',' # 引用定界符,可为单个 ASCII 字符或空字符串。 delimiter = '"' # CSV 文件是否包含表头。 # 如果 header = true,将跳过首行。 header = true # CSV 文件是否包含 NULL。 # 如果 not-null = true,CSV 所有列都不能解析为 NULL。 not-null = false # 如果 not-null = false(即 CSV 可以包含 NULL), # 为以下值的字段将会被解析为 NULL。 null = '\N' # 是否对字段内“\“进行转义 backslash-escape = true # 如果有行以分隔符结尾,删除尾部分隔符。 trim-last-separator = false [tidb] # 目标集群的信息。tidb-server 的地址,填一个即可。 host = "172.16.31.1" port = 4000 user = "root" password = "" # 表结构信息从 TiDB 的“status-port”获取。 status-port = 10080 # pd-server 的地址,填一个即可。 pd-addr = "172.16.31.4:2379" # tidb-lightning 引用了 TiDB 库,并生成产生一些日志。 # 设置 TiDB 库的日志等级。 log-level = "error" # 设置 TiDB 会话变量,提升 Checksum 和 Analyze 的速度。 # 各参数定义可参阅”控制 Analyze 并发度“文档 build-stats-concurrency = 20 distsql-scan-concurrency = 100 index-serial-scan-concurrency = 20 checksum-table-concurrency = 16 # 解析和执行 SQL 语句的默认 SQL 模式。 sql-mode = "ONLY_FULL_GROUP_BY,NO_ENGINE_SUBSTITUTION" # `max-allowed-packet` 设置数据库连接允许的最大数据包大小, # 对应于系统参数中的 `max_allowed_packet`。 如果设置为 0, # 会使用下游数据库 global 级别的 `max_allowed_packet`。 max-allowed-packet = 67_108_864 # SQL 连接是否使用 TLS。可选值为: # - "":如果配置了 [tidb.security] 部分的配置项,则 SQL 连接强制使用 TLS(与取值为 "cluster" 的行为相同),否则使用未加密的连接 # - "false":与取值为 "" 的行为相同 # - "cluster":强制使用 TLS 并使用 [tidb.security] 部分中指定的 CA 验证服务器的证书 # - "skip-verify":强制使用 TLS,但不验证服务器的证书(不安全)。如果服务器不支持 TLS,则会退回到未加密的连接 # - "preferred":与取值为 "skip-verify" 的行为相同 # tls = "" # 指定证书和密钥用于 TLS 连接 MySQL。 # 默认为 [security] 部分的副本。 # [tidb.security] # CA 的公钥证书。设置为空字符串可禁用 SQL 的 TLS。 # ca-path = "/path/to/ca.pem" # 该服务的公钥证书。默认为 `security.cert-path` 的副本 # cert-path = "/path/to/lightning.pem" # 此服务的私钥。默认为 `security.key-path` 的副本 # key-path = "/path/to/lightning.key" # 对于 Local Backend 和 Importer Backend 模式,数据导入完成后,TiDB Lightning 可以自动执行 Checksum 和 Analyze 操作。 # 在生产环境中,建议总是开启 Checksum 和 Analyze。 # 执行的顺序为:Checksum -> Analyze。 # 注意:对于 TiDB Backend, 无须执行这两个阶段,因此在实际运行时总是会直接跳过。 [post-restore] # 配置是否在导入完成后对每一个表执行 `ADMIN CHECKSUM TABLE <table>` 操作来验证数据的完整性。 # 可选的配置项: # - "required"(默认)。在导入完成后执行 CHECKSUM 检查,如果 CHECKSUM 检查失败,则会报错退出。 # - "optional"。在导入完成后执行 CHECKSUM 检查,如果报错,会输出一条 WARN 日志并忽略错误。 # - "off"。导入结束后不执行 CHECKSUM 检查。 # 默认值为 "required"。从 v4.0.8 开始,checksum 的默认值由此前的 "true" 改为 "required"。 # # 注意: # 1. Checksum 对比失败通常表示导入异常(数据丢失或数据不一致),因此建议总是开启 Checksum。 # 2. 考虑到与旧版本的兼容性,依然可以在本配置项设置 `true` 和 `false` 两个布尔值,其效果与 `required` 和 `off` 相同。 checksum = "required" # 配置是否在 CHECKSUM 结束后对所有表逐个执行 `ANALYZE TABLE <table>` 操作。 # 此配置的可选配置项与 `checksum` 相同,但默认值为 "optional"。 analyze = "optional" # 设置周期性后台操作。 # 支持的单位:h(时)、m(分)、s(秒)。 [cron] # TiDB Lightning 自动刷新导入模式状态的持续时间,该值应小于 TiKV 对应的设定值。 switch-mode = "5m" # 在日志中打印导入进度的持续时间。 log-progress = "5m"

TiKV Importer 配置参数

# TiKV Importer 配置文件模版 # 日志文件 log-file = "tikv-importer.log" # 日志等级:trace, debug, info, warn, error 和 off log-level = "info" # 状态服务器的监听地址。 # Prometheus 可以从这个地址抓取监控指标。 status-server-address = "0.0.0.0:8286" [server] # tikv-importer 的监听地址,tidb-lightning 需要连到这个地址进行数据写入。 addr = "0.0.0.0:8287" # gRPC 服务器的线程池大小。 grpc-concurrency = 16 [metric] # 当使用 Prometheus Pushgateway 时会涉及相关设置。通常可以通过 Prometheus 从 状态服务器地址中抓取指标。 # 给 Prometheus 客户端推送的 job 名称。 job = "tikv-importer" # 给 Prometheus 客户端推送的间隔。 interval = "15s" # Prometheus Pushgateway 的地址。 address = "" [rocksdb] # background job 的最大并发数。 max-background-jobs = 32 [rocksdb.defaultcf] # 数据在刷新到硬盘前能存于内存的容量上限。 write-buffer-size = "1GB" # 内存中写缓冲器的最大数量。 max-write-buffer-number = 8 # 各个压缩层级使用的算法。 # 第 0 层的算法用于压缩 KV 数据。 # 第 6 层的算法用于压缩 SST 文件。 # 第 1 至 5 层的算法目前尚未使用。 compression-per-level = ["lz4", "no", "no", "no", "no", "no", "lz4"] [rocksdb.writecf] # 同上 compression-per-level = ["lz4", "no", "no", "no", "no", "no", "lz4"] [security] # TLS 证书的路径。空字符串表示禁用安全连接。 # ca-path = "" # cert-path = "" # key-path = "" [import] # 存储引擎文件的文件夹路径 import-dir = "/mnt/ssd/data.import/" # 处理 RPC 请求的线程数 num-threads = 16 # 导入 job 的并发数。 num-import-jobs = 24 # 预处理 Region 最长时间。 # max-prepare-duration = "5m" # 把要导入的数据切分为这个大小的 Region。 #region-split-size = "512MB" # 设置 stream-channel-window 的大小。 # channel 满了之后 stream 会处于阻塞状态。 # stream-channel-window = 128 # 同时打开引擎文档的最大数量。 max-open-engines = 8 # Importer 上传至 TiKV 的最大速度(字节/秒)。 # upload-speed-limit = "512MB" # 目标存储可用空间比率(store_available_space/store_capacity)的最小值。 # 如果目标存储空间的可用比率低于该值,Importer 将会暂停上传 SST # 来为 PD 提供足够时间进行 Regions 负载均衡。 min-available-ratio = 0.05

命令行参数

tidb-lightning

使用 tidb-lightning 可以对下列参数进行配置:

参数描述对应配置项
--config filefile 读取全局设置。如果没有指定则使用默认设置。
-V输出程序的版本
-d directory读取数据的本地目录或外部存储 URLmydumper.data-source-dir
-L level日志的等级: debug、info、warn、error 或 fatal (默认为 info)lightning.log-level
-f rule表库过滤的规则 (可多次指定)mydumper.filter
--backend backend选择后端的模式:localimportertidbtikv-importer.backend
--log-file file日志文件路径(默认值为 /tmp/lightning.log.{timestamp}, 设置为 '-' 表示日志输出到终端)lightning.log-file
--status-addr ip:portTiDB Lightning 服务器的监听地址lightning.status-port
--importer host:portTiKV Importer 的地址tikv-importer.addr
--pd-urls host:portPD endpoint 的地址tidb.pd-addr
--tidb-host hostTiDB Server 的 hosttidb.host
--tidb-port portTiDB Server 的端口(默认为 4000)tidb.port
--tidb-status portTiDB Server 的状态端口的(默认为 10080)tidb.status-port
--tidb-user user连接到 TiDB 的用户名tidb.user
--tidb-password password连接到 TiDB 的密码tidb.password
--no-schema忽略表结构文件,直接从 TiDB 中获取表结构信息mydumper.no-schema
--enable-checkpoint bool是否启用断点 (默认值为 true)checkpoint.enable
--analyze level导入后分析表信息,可选值为 required、optional(默认值)、offpost-restore.analyze
--checksum level导入后比较校验和,可选值为 required(默认值)、optional、offpost-restore.checksum
--check-requirements bool开始任务之前检查集群版本兼容性,以及运行过程中检查 TiKV 的可用存储空间是否大于 10%(默认值为 true)lightning.check-requirements
--ca fileTLS 连接的 CA 证书路径security.ca-path
--cert fileTLS 连接的证书路径security.cert-path
--key fileTLS 连接的私钥路径security.key-path
--server-mode在服务器模式下启动 TiDB Lightninglightning.server-mode

如果同时对命令行参数和配置文件中的对应参数进行更改,命令行参数将优先生效。例如,在 cfg.toml 文件中,不管对日志等级做出什么修改,运行 ./tidb-lightning -L debug --config cfg.toml 命令总是将日志级别设置为 “debug”。

tidb-lightning-ctl

使用 tidb-lightning-ctl 可以对下列参数进行配置:

参数描述
--compact执行 full compact
--switch-mode mode将每个 TiKV Store 切换到指定模式(normal 或 import)
--fetch-mode打印每个 TiKV Store 的当前模式
--import-engine uuid将 TiKV Importer 上关闭的引擎文件导入到 TiKV 集群
--cleanup-engine uuid删除 TiKV Importer 上的引擎文件
--checkpoint-dump folder将当前的断点以 CSV 格式存储到文件夹中
--checkpoint-error-destroy tablename删除断点,如果报错则删除该表
--checkpoint-error-ignore tablename忽略指定表中断点的报错
--checkpoint-remove tablename无条件删除表的断点

tablename 必须是`db`.`tbl` 中的限定表名(包括反引号),或关键词 all

此外,上表中所有 tidb-lightning 的参数也适用于 tidb-lightning-ctl

tikv-importer

使用 tikv-importer 可以对下列参数进行配置:

参数描述对应配置项
-C, --config filefile 读取配置。如果没有指定,则使用默认设置
-V, --version输出程序的版本
-A, --addr ip:portTiKV Importer 服务器的监听地址server.addr
--status-server ip:port状态服务器的监听地址status-server-address
--import-dir dir引擎文件的存储目录import.import-dir
--log-level level日志的等级: trace、debug、info、warn、error 或 offlog-level
--log-file file日志文件路径log-file