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
70
71
72
73
74
75
76
77
78

//! The write path: building segments, archives, and repository state.
//!
//! Everything below this module ultimately serves one contract: a store
//! written by `froe` must be indistinguishable, to Oak and AEM, from a
//! store written by Oak itself (one documented rendering residue:
//! extreme-subnormal doubles; see
//! [`crate::content::property::double_to_text`]). Byte layouts,
//! durability ordering, file naming, and locking all follow the
//! specifications in `docs/analysis/` extracted from the Java
//! implementation. Writing requires a Unix operating system entropy
//! source; the writable store refuses to open on Windows.

pub mod backup;
pub mod commit;
pub mod compaction;
/// Cutpoints the write path calls at its durability boundaries, and the
/// probes that arm them. The cutpoints sit wherever a run touches disk —
/// the tar writer, the sweep, the journal rewrite, the maintenance apply —
/// so this belongs to the write path rather than to any one of them.
#[cfg(test)]
mod fault_injection;
pub mod identifier_generator;
pub mod index;
/// The one maintenance pipeline: plan, confirm, and apply a compaction and
/// everything it reclaims. Its surface is re-exported below, so callers name
/// the operation rather than the module it happens to live in.
pub(crate) mod maintenance;
/// Segments written and read back in memory, for a caller that must turn a
/// tree it holds into node states without touching a store.
pub(crate) mod memory_segments;
pub mod record_writer;
pub mod repository_lock;
pub mod segment_builder;
pub mod store_writer;
pub mod tar_writer;

pub use backup::{
    RecoveryOutcome, backup, backup_with_progress, recover_journal, recover_journal_with_progress,
    restore, restore_with_progress,
};
pub use commit::{
    CheckpointDescription, create_checkpoint, list_checkpoints, release_checkpoint,
    remove_all_checkpoints, remove_checkpoints, remove_unreferenced_checkpoints,
    replace_content_root,
};
pub use compaction::{
    CompactionKind, SubtreeOmissions, deep_copy_super_root_omitting_subtrees,
    deep_copy_super_root_sharing, deep_copy_super_root_with_progress, deep_copy_tree,
    deep_copy_tree_across_stores_with_progress, deep_copy_tree_with_progress,
};
pub use identifier_generator::{new_bulk_segment_identifier, new_data_segment_identifier};
pub use index::lucene_import::{
    ImportedIndex, LuceneImportOptions, LuceneImportOutcome, LuceneImportPlan, PlannedImport,
    PreparedLuceneImport, lucene_import, lucene_import_with_progress, plan_lucene_import,
};
pub use index::{
    DefinitionReport, NoWorkReason, PreparedReindex, ReindexAction, ReindexOptions, ReindexOutcome,
    ReindexPlan, ReindexWarning, WorkDirectory, plan_reindex, plan_reindex_with_progress, reindex,
    reindex_with_progress,
};
pub use maintenance::{
    ArchiveIndexSurvey, CompactedGeneration, CompactionAction, CompactionOptions,
    CompactionOutcome, CompactionPlan, ExternalBinaryFootprint, FileDeletionFailure,
    JournalLineRemoval, JournalRemovalReason, OrphanedVersionHistoryReport, PreparedCompaction,
    RecoveryBackupPolicy, RecoveryBackupSurvey, StaleArchiveReason, compact, compact_with_progress,
    plan_compaction, plan_compaction_with_progress, survey_archive_indexes,
    survey_recovery_backups,
};
pub use record_writer::{
    BulkBlockSharing, ChildNodesToWrite, PropertyToWrite, PropertyValuesToWrite, RecordWriter,
    SegmentSink, sort_properties_for_template,
};
pub use repository_lock::RepositoryLock;
pub use segment_builder::{
    BuiltSegment, GarbageCollectionGeneration, SegmentBufferBuilder, SegmentBufferFull,
};
pub use store_writer::{ArchiveRewritePolicy, StoreSink, WritableRepository};
pub use tar_writer::TarArchiveWriter;