Skip to content

Commit cde9ec1

Browse files
authored
lightning: clarify backends and import modes (#12154)
1 parent 6d97712 commit cde9ec1

File tree

4 files changed

+8
-3
lines changed

4 files changed

+8
-3
lines changed

tidb-lightning/tidb-lightning-logical-import-mode.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ The logical import mode is one of the two import modes supported by TiDB Lightni
99

1010
If your TiDB cluster already contains data and provides service for external applications, it is recommended to import data in the logical import mode. The behavior of the logical import mode is the same as executing normal SQL statements, and thus it guarantees ACID compliance.
1111

12+
The backend for the logical import mode is `tidb`.
13+
1214
## Environment requirements
1315

1416
**Operating system**:

tidb-lightning/tidb-lightning-overview.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,13 @@ TiDB Lightning can read data from the following sources:
2626

2727
TiDB Lightning supports two import modes, configured by `backend`. The import mode determines the way data is imported into TiDB.
2828

29-
- [Physical Import Mode](/tidb-lightning/tidb-lightning-physical-import-mode.md): TiDB Lightning first encodes data into key-value pairs and stores them in a local temporary directory, then uploads these key-value pairs to each TiKV node, and finally calls the TiKV Ingest interface to insert data into TiKV's RocksDB. If you need to perform initial import, consider the physical import mode, which has higher import speed.
29+
- [Physical Import Mode](/tidb-lightning/tidb-lightning-physical-import-mode.md): TiDB Lightning first encodes data into key-value pairs and stores them in a local temporary directory, then uploads these key-value pairs to each TiKV node, and finally calls the TiKV Ingest interface to insert data into TiKV's RocksDB. If you need to perform initial import, consider the physical import mode, which has higher import speed. The backend for the physical import mode is `local`.
3030

31-
- [Logical Import Mode](/tidb-lightning/tidb-lightning-logical-import-mode.md): TiDB Lightning first encodes the data into SQL statements and then runs these SQL statements directly for data import. If the cluster to be imported is in production, or if the target table to be imported already contains data, use the logical import mode.
31+
- [Logical Import Mode](/tidb-lightning/tidb-lightning-logical-import-mode.md): TiDB Lightning first encodes the data into SQL statements and then runs these SQL statements directly for data import. If the cluster to be imported is in production, or if the target table to be imported already contains data, use the logical import mode. The backend for the logical import mode is `tidb`.
3232

3333
| Import mode | Physical Import Mode | Logical Import Mode |
3434
|:---|:---|:---|
35+
| Backend | `local` | `tidb` |
3536
| Speed | Fast (100~500 GiB/hour) | Low (10~50 GiB/hour)|
3637
| Resource consumption| High | Low |
3738
| Network bandwidth consumption | High | Low |

tidb-lightning/tidb-lightning-physical-import-mode-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: Learn how to use the physical import mode in TiDB Lightning.
55

66
# Use Physical Import Mode
77

8-
This document introduces how to use the physical import mode in TiDB Lightning, including writing the configuration file, tuning performance, and configuring disk quota.
8+
This document introduces how to use the [physical import mode](/tidb-lightning/tidb-lightning-physical-import-mode.md) in TiDB Lightning, including writing the configuration file, tuning performance, and configuring disk quota.
99

1010
## Configure and use the physical import mode
1111

tidb-lightning/tidb-lightning-physical-import-mode.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Physical import mode is an efficient and fast import mode that inserts data dire
99

1010
Before you use the physical import mode, make sure to read [Requirements and restrictions](#requirements-and-restrictions).
1111

12+
The backend for the physical import mode is `local`.
13+
1214
## Implementation
1315

1416
1. Before importing data, TiDB Lightning automatically switches the TiKV nodes to "import mode", which improves write performance and stops auto-compaction. TiDB Lightning determines whether to pause global scheduling according to the TiDB cluster version.

0 commit comments

Comments
 (0)