Skip to main content

SqliteIndex

Struct SqliteIndex 

Source
pub struct SqliteIndex { /* private fields */ }
Expand description

SQLite-backed sparse index using FTS5 for BM25 search.

Unlike BM25Index (in-memory HashMap), this persists to disk and delegates BM25 scoring to SQLite’s FTS5 extension.

The Connection is wrapped in a Mutex to satisfy the Send + Sync bounds required by SparseIndex. Mutex<T> is Sync when T: Send, and rusqlite::Connection is Send. SQLite in WAL mode supports concurrent readers via separate connections; this single-connection design serializes access within one process.

Implementations§

Source§

impl SqliteIndex

Source

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open or create an index at the given path.

Source

pub fn open_in_memory() -> Result<Self>

Open an in-memory index (for testing).

Source

pub fn document_count(&self) -> Result<usize>

Get document count.

Source

pub fn chunk_count(&self) -> Result<usize>

Get chunk count.

Source

pub fn needs_reindex(&self, path: &str, hash: &[u8; 32]) -> Result<bool>

Check if a document needs reindexing by fingerprint.

Source

pub fn insert_document( &self, doc_id: &str, title: Option<&str>, source: Option<&str>, content: &str, chunks: &[(String, String)], fingerprint: Option<(&str, &[u8; 32])>, ) -> Result<()>

Batch-insert a document and its chunks within a transaction.

Source

pub fn remove_document(&self, doc_id: &str) -> Result<()>

Remove a document and its chunks.

Explicitly deletes chunks first (which fires FTS5 sync triggers), then deletes the document row.

Source

pub fn list_fingerprints(&self) -> Result<Vec<(String, Vec<u8>)>>

List all tracked fingerprints (path → blake3 hash).

Used by incremental indexing to detect deleted or changed files.

Source

pub fn remove_by_source(&self, source: &str) -> Result<usize>

Remove all documents (and their chunks) with a given source path.

Used by incremental indexing to remove stale documents before re-inserting.

Source

pub fn search_fts(&self, query: &str, k: usize) -> Result<Vec<FtsResult>>

FTS5 BM25 search. Returns results ordered by descending relevance.

Source

pub fn get_chunk(&self, chunk_id: &str) -> Result<Option<String>>

Get chunk content by ID.

Source

pub fn get_metadata(&self, key: &str) -> Result<Option<String>>

Get a metadata value by key.

Source

pub fn set_metadata(&self, key: &str, value: &str) -> Result<()>

Set a metadata key-value pair.

Source

pub fn optimize(&self) -> Result<()>

Vacuum and optimize the database.

Trait Implementations§

Source§

impl Debug for SqliteIndex

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl SparseIndex for SqliteIndex

Source§

fn add(&mut self, chunk: &Chunk)

Index a chunk
Source§

fn add_batch(&mut self, chunks: &[Chunk])

Index multiple chunks
Source§

fn search(&self, query: &str, k: usize) -> Vec<(ChunkId, f32)>

Search for matching chunks
Source§

fn remove(&mut self, chunk_id: ChunkId)

Remove a chunk from the index
Source§

fn len(&self) -> usize

Get the number of indexed documents
Source§

fn is_empty(&self) -> bool

Check if the index is empty

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,