lucisearch 0.8.1

Embeddable, in-process search engine — the SQLite/DuckDB of search
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

// Obsidian [[wikilinks]] in doc comments are intentional — they link to
// design and reference docs in docs/. Rustdoc doesn't understand them.
#![allow(rustdoc::broken_intra_doc_links)]

//! `luci` — embeddable, in-process search engine.
//!
//! The SQLite/DuckDB of Elasticsearch: link it in, open a file, search.
//! Indexing JSON documents, term/BM25/vector search, segment merge, and
//! persistence all live in this one crate, organized into modules that
//! mirror the former workspace crates (`core`, `mapping`, `storage`,
//! `analysis`) plus the engine subsystems.
//!
//! See [[luci|engineering vision]], [[architecture-overview]], and
//! [[architecture-segment-layout]] for the design.

// Former leaf crates, now modules.
pub mod analysis;
pub mod core;
pub mod mapping;
pub mod storage;

// Engine subsystems (formerly luci-index).
pub mod agg;
pub mod columnar;
pub mod inverted;
pub mod ip;
pub mod query;
pub mod search;
pub mod segment;
pub mod spatial;
pub mod store;
pub mod vector;

pub mod deletion;
pub mod index;
pub mod merge;
pub mod merge_policy;
pub mod reader;
pub mod writer;

// Top-level re-exports for the high-frequency API surface, so the common
// types stay one path deep (`luci::Index`, `luci::Mapping`, `luci::LuciError`).
pub use crate::core::{
    DocId, FieldId, LuciError, Result, ScoreMode, Scorer, SegmentId, TwoPhaseIterator,
};
pub use crate::index::Index;
pub use crate::mapping::{
    DynamicMode, FieldMapping, FieldType, Mapping, MappingBuilder, QuantizationType,
};

/// Configure the global thread pool for parallel search.
///
/// Must be called before any search operation. Can only be called once
/// per process — subsequent calls return an error.
///
/// If not called, rayon defaults to the number of available CPUs
/// (or the `RAYON_NUM_THREADS` environment variable).
pub fn set_num_threads(num_threads: usize) -> Result<()> {
    rayon::ThreadPoolBuilder::new()
        .num_threads(num_threads)
        .build_global()
        .map_err(|e| LuciError::InvalidQuery(format!("failed to set thread pool: {e}")))
}