tantivy-cli 0.24.0

Command line interface for Tantivy, a search engine library.
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use clap::ArgMatches;
use std::convert::From;
use std::path::Path;
use std::path::PathBuf;
use tantivy::schema::Schema;
use tantivy::space_usage::PerFieldSpaceUsage;
use tantivy::Index;

pub fn run_inspect_cli(matches: &ArgMatches) -> Result<(), String> {
    let index_directory = PathBuf::from(matches.get_one::<String>("index").unwrap());
    run_inspect(&index_directory).map_err(|e| format!("{:?}", e))
}

fn run_inspect(directory: &Path) -> tantivy::Result<()> {
    let index = Index::open_in_dir(directory)?;
    let schema = index.schema();
    let searcher = index.reader()?.searcher();
    let segments = searcher.segment_readers();
    println!();
    println!("===============================================================================");
    println!("Inspect index report");
    println!("===============================================================================\n");
    println!("1. General infos");
    println!("===============================================================================");
    println!("Index directory: {:?}", directory);
    println!("Number of segments: {}", segments.len());
    let space_usage = searcher.space_usage()?;
    println!("Total bytes: {}", space_usage.total());
    println!();
    for (i, (segment_reader, segment_space_usage)) in segments
        .iter()
        .zip(space_usage.segments().iter())
        .enumerate()
    {
        let section_count = i + 2;
        println!(
            "{}. Space usage for segment: `{}`",
            section_count,
            segment_reader.segment_id().uuid_string()
        );
        println!("==============================================================================");
        println!("Num docs: {}", segment_space_usage.num_docs());
        println!("Store space usage:");
        println!("Total bytes: {}", segment_space_usage.store().total());
        println!(
            "Offset bytes: {}",
            segment_space_usage.store().offsets_usage()
        );
        println!();
        println!("{}.1 Term dictionnary space usage", section_count);
        println!("--------------------------------");
        let per_field_space_usage = segment_space_usage.termdict();
        println!("Total bytes: {}", per_field_space_usage.total());
        print_fields_space_usage(&schema, per_field_space_usage);
        println!();

        println!("{}.2 Fast field space usage", section_count);
        println!("--------------------------------");
        let fast_field_space_usage = segment_space_usage.fast_fields();
        println!("Total bytes: {}", fast_field_space_usage.total());
        print_fields_space_usage(&schema, fast_field_space_usage);
        println!();

        println!("{}.3 Postings space usage", section_count);
        println!("--------------------------------");
        let postings_space_usage = segment_space_usage.postings();
        println!("Total bytes: {}", postings_space_usage.total());
        print_fields_space_usage(&schema, postings_space_usage);
        println!();

        println!("{}.4 Positions space usage", section_count);
        println!("--------------------------------");
        let positions_space_usage = segment_space_usage.positions();
        println!("Total bytes: {}", positions_space_usage.total());
        print_fields_space_usage(&schema, positions_space_usage);
        println!();
    }

    println!();
    println!("----------------------------- END OF REPORT ----------------------------------");
    Ok(())
}

fn print_fields_space_usage(schema: &Schema, per_field_space_usage: &PerFieldSpaceUsage) {
    println!("Total bytes: {}", per_field_space_usage.total());
    for (field, field_space_usage) in per_field_space_usage.fields() {
        let field_name = schema.get_field_name(*field);
        println!(
            "Field `{}` bytes: {}",
            field_name,
            field_space_usage.total()
        );
    }
}