mirrors/scylladb
1
0
Fork 0
mirror of https://github.com/scylladb/scylladb.git synced 2026-05-12 19:02:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: document sstables quarantine subdirectory

Browse Source 
Add documentation for the quarantine/ subdirectory that holds SSTables
isolated due to validation failures or corruption. Document the scrub
operation's quarantine_mode parameter options and the drop_quarantined_sstables
API operation.

Also update the directory hierarchy example to include the quarantine directory.

Fixes #10742

Signed-off-by: Shreyas Ganesh <vansi.ganeshs@gmail.com>

Closes scylladb/scylladb#27023
This commit is contained in:
Shreyas Ganesh
2025-11-14 12:33:58 -05:00
committed by Botond Dénes
parent 825d81dde2
commit 4488a4fb06
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/dev/sstables-directory-structure.md
View File

@@ -28,6 +28,7 @@ Scylla uses the following directory structure to store all its SSTables, for exa
│   │   │   ├── ...
│   │   │   └── mc-1-big-TOC.txt
│   │   ├── staging
│   │   ├── quarantine
│   │   └── upload
│   └── cf-7ec943202fc611e9a130000000000000
│   ├── snapshots
@@ -36,6 +37,7 @@ Scylla uses the following directory structure to store all its SSTables, for exa
│   │   ├── ks-cf-ka-3-TOC.txt
│   │   └── manifest.json
│   ├── staging
│     ├── quarantine
│   └── upload
├── system
│   ├── schema_columnfamilies-45f5b36024bc3f83a3631034ea4fa697
@@ -167,6 +169,21 @@ The per-table directory may contain several sub-directories, as listed below:
Used for ingesting external SSTables into Scylla on startup.
* Quarantine directory (`quarantine`)
A sub-directory holding SSTables that have been quarantined, typically due to
validation failures or corruption detected during scrub operations.
Quarantined SSTables are isolated to prevent them from being read or used by the
database. They can be inspected manually for debugging purposes or removed using
the `drop_quarantined_sstables` API operation.
The scrub operation can be configured to handle quarantined SSTables using the
`quarantine_mode` parameter with the following options:
- `INCLUDE`: Process both regular and quarantined SSTables (default)
- `EXCLUDE`: Skip quarantined SSTables during scrub
- `ONLY`: Process only quarantined SSTables
* Temporary SSTable directory (`<generation>.sstable`)
A directory created when writing new SSTables.