Skip to content

Commit

Permalink
Refine wording
Browse files Browse the repository at this point in the history
  • Loading branch information
lilin90 authored Oct 8, 2024
1 parent 8349709 commit 3398ebb
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions tikv-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -1935,15 +1935,15 @@ Configuration items related to Raft Engine.

### `spill-dir` <span class="version-mark">New in v8.4.0</span>

+ The auxiliary directory for storing raft log files. When the disk where the `dir` specified is full, new raft logs will be stored under this directory. If this directory does not exist after configuration, it will be created when TiKV is started.
+ If this configuration is not set, it means that the auxiliary directory is disabled.
+ The auxiliary directory for storing Raft log files. When the disk for the `dir` directory is full, new Raft logs will be stored under this directory. If this auxiliary directory does not exist after configuration, it will be automatically created when TiKV is started.
+ If this configuration is not set, the auxiliary directory is not enabled.

> **Note:**
>
> - This configuration is only valid when the `dir` and `spill-dir` of the Raft Engine are specified as different disk drives.
> - After enabling this feature, if you want to disable it, you need to perform the following operations before restarting TiKV. Otherwise, TiKV cannot start.
> 1. Shut down TiKV.
> 2. Copy all the Raft Logs in the `spill-dir` directory to the [`dir`](/tikv-configuration-file.md#dir) directory.
> - This configuration only takes effect when the `dir` and `spill-dir` of the Raft Engine are set to different disk drives.
> - After enabling this feature, if you want to disable it, you need to perform the following operations before restarting TiKV. Otherwise, TiKV will fail to start.
> 1. Stop TiKV.
> 2. Copy all the Raft Logs from the `spill-dir` directory to the [`dir`](/tikv-configuration-file.md#dir) directory.
> 3. Remove this configuration from the TiKV configuration file.
> 4. Restart TiKV.
Expand Down

0 comments on commit 3398ebb

Please sign in to comment.