Skip to content

Commit a98cba9

Browse files
authored
clarify lightning post-restore description (#9433)
1 parent 6f9ef14 commit a98cba9

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

tidb-lightning/tidb-lightning-configuration.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -400,11 +400,11 @@ max-allowed-packet = 67_108_864
400400
# Private key of this service. Default to copy of `security.key-path`
401401
# key-path = "/path/to/lightning.key"
402402

403-
# In the physical import mode, when data importing is complete, tidb-lightning can
403+
# In the physical import mode, when data importing is complete, TiDB Lightning can
404404
# automatically perform the Checksum and Analyze operations. It is recommended
405405
# to leave these as true in the production environment.
406406
# The execution order: Checksum -> Analyze.
407-
# In the logical import mode, Checksum and Analyze is not needed, and they are always
407+
# Note that in the logical import mode, Checksum and Analyze is not needed, and they are always
408408
# skipped in the actual operation.
409409
[post-restore]
410410
# Specifies whether to perform `ADMIN CHECKSUM TABLE <table>` for each table to verify data integrity after importing.
@@ -413,7 +413,9 @@ max-allowed-packet = 67_108_864
413413
# - "optional": Perform admin checksum. If checksum fails, TiDB Lightning will report a WARN log but ignore any error.
414414
# - "off": Do not perform checksum.
415415
# Note that since v4.0.8, the default value has changed from "true" to "required".
416-
# For backward compatibility, bool values "true" and "false" are also allowed for this field.
416+
# Note:
417+
# 1. Checksum failure usually means import exception (data loss or inconsistency). It is recommended to always enable checksum.
418+
# 2. For backward compatibility, bool values "true" and "false" are also allowed for this field.
417419
# "true" is equivalent to "required" and "false" is equivalent to "off".
418420
checksum = "required"
419421
# Specifies whether the ADMIN CHECKSUM TABLE <table> operation is executed via TiDB.
@@ -425,16 +427,6 @@ checksum-via-sql = "false"
425427
# Options available for this field are the same as `checksum`. However, the default value for this field is "optional".
426428
analyze = "optional"
427429

428-
# If the value is set to `true`, a level-1 compaction is performed
429-
# every time a table is imported.
430-
# The default value is `false`.
431-
level-1-compact = false
432-
433-
# If the value is set to `true`, a full compaction on the whole
434-
# TiKV cluster is performed at the end of the import.
435-
# The default value is `false`.
436-
compact = false
437-
438430
# Configures the background periodic actions.
439431
# Supported units: h (hour), m (minute), s (second).
440432
[cron]

0 commit comments

Comments
 (0)