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

//! Lucene index data stored as repository content: the `:data` directory,
//! the two `jcr:data` encodings, and the filesystem layouts oak-run moves a
//! directory through.
//!
//! `docs/analysis/index-lucene-storage.md` specifies all three. This module
//! deliberately stops at the file boundary: it says what node each Lucene
//! file is stored in and nothing about the bytes inside one, which are the
//! Lucene 4.7.2 format.

pub mod analysis;
pub mod check;
pub mod codec;
pub mod codec_header;
pub mod compound;
pub mod directory;
pub mod documents;
pub mod dump;
pub mod layout;
pub mod read;
pub mod segments;
pub mod writer;

pub use check::{BlobFault, LuceneBlobReport, check_blobs};
pub use codec_header::{CODEC_MAGIC, CodecHeader, header_length, read_codec_header};
pub use compound::{CompoundEntry, CompoundTableOfContents, read_table_of_contents};
pub use directory::{FileEncoding, OakDirectory, OakIndexFile, OakIndexFileReader};
pub use dump::{
    DumpOptions, DumpOutcome, DumpedIndex, NoCheckpointReason, dump_lucene_indexes,
    dump_lucene_indexes_with_progress,
};
pub use layout::{IndexDetails, IndexerInfo, filesystem_directory_name, index_folder_base_name};
pub use read::{LuceneReadError, LuceneResult, Reader};
pub use segments::{
    CommitFile, SegmentEntry, SegmentInfo, commit_generation, read_commit_file, read_segment_info,
    read_segments_gen,
};

/// The directory a Lucene index stores its files in, under the definition.
pub const INDEX_DATA_CHILD_NAME: &str = ":data";

/// The directory the suggester stores its files in.
pub const SUGGEST_DATA_CHILD_NAME: &str = ":suggest-data";

/// `MultiplexersLucene.isIndexDirName`: the default name, or a
/// mount-decorated one.
#[must_use]
pub fn is_index_directory_name(name: &str) -> bool {
    name == INDEX_DATA_CHILD_NAME || name.ends_with("-index-data")
}

/// `MultiplexersLucene.isSuggestIndexDirName`.
#[must_use]
pub fn is_suggest_directory_name(name: &str) -> bool {
    name == SUGGEST_DATA_CHILD_NAME || name.ends_with("-suggest-data")
}