Add comment block for Orphans column family. (#28340)

Add comment block for Orphans column family.
This commit is contained in:
Yueh-Hsuan Chiang 2022-10-16 23:47:02 -07:00 committed by GitHub
parent 5d172151a2
commit f910f2d7eb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions

View File

@ -145,7 +145,12 @@ pub mod columns {
pub struct SlotMeta;
#[derive(Debug)]
/// The orphans column
/// The orphans column.
///
/// This column family tracks whether a slot has a parent. Slots without a
/// parent are by definition orphan slots. Orphans will have an entry in
/// this column family with true value. Once an orphan slot has a parent,
/// its entry in this column will be deleted.
///
/// index type: u64 (see `SlotColumn`)
/// value type: bool