Improve SlotColumn's code comment. (#28447)
Improve SlotColumn's code comment to include how LedgerCleanupService manages the clean-up of a SlotColumn.
This commit is contained in:
parent
ca115594ff
commit
9be7ada68d
|
@ -627,6 +627,11 @@ pub trait ProtobufColumn: Column {
|
||||||
|
|
||||||
/// SlotColumn is a trait for slot-based column families. Its index is
|
/// SlotColumn is a trait for slot-based column families. Its index is
|
||||||
/// essentially Slot (or more generally speaking, has a 1:1 mapping to Slot).
|
/// essentially Slot (or more generally speaking, has a 1:1 mapping to Slot).
|
||||||
|
///
|
||||||
|
/// The clean-up of any LedgerColumn that implements SlotColumn is managed by
|
||||||
|
/// [`LedgerCleanupService`], which will periodically deprecate and purge
|
||||||
|
/// oldest entries that are older than the latest root in order to maintain the
|
||||||
|
/// configured --limit-ledger-size under the validator argument.
|
||||||
pub trait SlotColumn<Index = u64> {}
|
pub trait SlotColumn<Index = u64> {}
|
||||||
|
|
||||||
impl<T: SlotColumn> Column for T {
|
impl<T: SlotColumn> Column for T {
|
||||||
|
|
Loading…
Reference in New Issue