froe 0.12.0

Reader and offline maintenance toolkit for Apache Jackrabbit Oak segment-tar (TarMK) repositories: parse archives and records, extract node data, compact, back up, and recover.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! The writable repository: Oak's read-write file store lifecycle.
//!
//! Opening takes the exclusive repository lock first (a documented,
//! strictly-safer deviation from Java, which creates `journal.log`
//! before locking — a contended open here leaves no trace), then opens
//! the journal handle, then the
//! manifest check-and-update (always rewriting `store.version=2`), then
//! archive initialization with *destructive* generation selection — the
//! newest valid generation letter of each archive number wins and stale
//! letters are deleted; archives without any valid index are backed up
//! to `.bak` names and regenerated from a raw scan — and finally journal
//! binding, bootstrapping the initial `{ "root": {} }` node into a fresh
//! store.
//!
//! Durability follows Oak's contract exactly: segment bytes are appended
//! and fsynced *before* the journal line referencing them is appended
//! and fdatasynced, and a journal line is written only when the head
//! actually moved.
//!
//! Segments written during the session are kept in memory (shared
//! buffers) so reads resolve them immediately; on disk they live in the
//! archives this writer produces.
//!
//! Every test lives with the stage it exercises, including the ones that
//! drive a whole session: a claim about what a sweep publishes belongs
//! beside the sweep even when it is made through `WritableRepository`.

#[cfg(test)]
mod test_support;

mod archive_certificate;
mod archive_numbering;
mod cleanup_apply;
mod file_identity;
mod providers;
mod reclaim;
mod recovery;
mod repair;
mod repository;
mod session;
mod startup;
mod sweep;
mod sweep_plan;

pub(crate) use self::archive_certificate::{
    certify_active_archive, certify_active_archives_with_progress,
};
pub(crate) use self::archive_numbering::next_cleanup_archive_number;
pub(crate) use self::cleanup_apply::apply_standalone_segment_cleanup;
pub(crate) use self::file_identity::{
    archive_file_bytes, preserve_file_metadata, sync_directory_strict,
};
pub use self::reclaim::ArchiveRewritePolicy;
pub(crate) use self::reclaim::{ReclaimRule, predict_post_compaction_reclamation};
#[cfg(unix)]
pub(crate) use self::repair::repair_target_names;
pub(crate) use self::repair::{
    AuthorizeVersionTwoWrite, repair_indexless_archive_numbers, survey_indexless_archive_numbers,
    unrepairable_archives_refusal,
};
pub use self::repository::{StoreSink, WritableRepository};
pub(crate) use self::startup::{RepairedArchive, reject_duplicate_archive_generations};
pub(crate) use self::sweep::is_reclaimable;
pub(crate) use self::sweep_plan::{
    GenerationReclaimRequest, PlannedArchiveSweep, RETAINED_GENERATIONS, SegmentSweepOutcome,
    StandaloneSegmentCompactionOutcome, StandaloneSegmentCompactionPlan,
    measure_unvetoed_reclamation, plan_reclaimed_totals, plan_standalone_segment_cleanup,
    planned_unavailable_segments,
};