Struct SearchContext

pub struct SearchContext<'ctx> {
    pub index: &'ctx Index,
    pub txn: &'ctx RoTxn<'ctx>,
    pub db_cache: DatabaseCache<'ctx>,
    pub word_interner: DedupInterner<String>,
    pub phrase_interner: DedupInterner<Phrase>,
    pub term_interner: Interner<QueryTerm>,
    pub phrase_docids: PhraseDocIdsCache,
    pub restricted_fids: Option<RestrictedFids>,
    pub prefix_search: PrefixSearch,
    pub vector_store_stats: Option<VectorStoreStats>,
}

A structure used throughout the execution of a search query.

Fields

index: &'ctx Index

txn: &'ctx RoTxn<'ctx>

db_cache: DatabaseCache<'ctx>

word_interner: DedupInterner<String>

phrase_interner: DedupInterner<Phrase>

term_interner: Interner<QueryTerm>

phrase_docids: PhraseDocIdsCache

restricted_fids: Option<RestrictedFids>

prefix_search: PrefixSearch

vector_store_stats: Option<VectorStoreStats>

Implementations

impl<'ctx> SearchContext<'ctx>

pub fn get_words_fst(&mut self) -> Result<Set<Cow<'ctx, [u8]>>>

pub fn word_docids( &mut self, universe: Option<&RoaringBitmap>, word: Word, ) -> Result<Option<RoaringBitmap>>

pub fn word_prefix_docids( &mut self, universe: Option<&RoaringBitmap>, prefix: Word, ) -> Result<Option<RoaringBitmap>>

pub fn get_db_word_pair_proximity_docids( &mut self, universe: Option<&RoaringBitmap>, word1: Interned<String>, word2: Interned<String>, proximity: u8, ) -> Result<Option<RoaringBitmap>>

pub fn get_db_word_pair_proximity_docids_len( &mut self, universe: Option<&RoaringBitmap>, word1: Interned<String>, word2: Interned<String>, proximity: u8, ) -> Result<Option<u64>>

pub fn get_db_word_prefix_pair_proximity_docids( &mut self, universe: Option<&RoaringBitmap>, word1: Interned<String>, prefix2: Interned<String>, proximity: u8, ) -> Result<Option<RoaringBitmap>>

pub fn get_db_prefix_word_pair_proximity_docids( &mut self, universe: Option<&RoaringBitmap>, left_prefix: Interned<String>, right: Interned<String>, proximity: u8, ) -> Result<Option<RoaringBitmap>>

pub fn get_db_word_fid_docids( &mut self, universe: Option<&RoaringBitmap>, word: Interned<String>, fid: u16, ) -> Result<Option<RoaringBitmap>>

pub fn get_db_word_prefix_fid_docids( &mut self, universe: Option<&RoaringBitmap>, word_prefix: Interned<String>, fid: u16, ) -> Result<Option<RoaringBitmap>>

pub fn get_db_word_fids(&mut self, word: Interned<String>) -> Result<Vec<u16>>

pub fn get_db_word_prefix_fids( &mut self, word_prefix: Interned<String>, ) -> Result<Vec<u16>>

pub fn get_db_word_position_docids( &mut self, universe: Option<&RoaringBitmap>, word: Interned<String>, position: u16, ) -> Result<Option<RoaringBitmap>>

pub fn get_db_word_prefix_position_docids( &mut self, universe: Option<&RoaringBitmap>, word_prefix: Interned<String>, position: u16, ) -> Result<Option<RoaringBitmap>>

pub fn get_db_word_positions( &mut self, word: Interned<String>, ) -> Result<Vec<u16>>

pub fn get_db_word_prefix_positions( &mut self, word_prefix: Interned<String>, ) -> Result<Vec<u16>>

impl SearchContext<'_>

pub fn get_phrase_docids( &mut self, phrase: Interned<Phrase>, ) -> Result<&RoaringBitmap>

Get the document ids associated with the given phrase

impl<'ctx> SearchContext<'ctx>

pub fn new(index: &'ctx Index, txn: &'ctx RoTxn<'ctx>) -> Result<Self>

pub fn is_prefix_search_allowed(&self) -> bool

pub fn attributes_to_search_on( &mut self, attributes_to_search_on: &'ctx [String], ) -> Result<()>