Struct Index

pub struct Index {

    pub external_documents_ids: Database<Str, BEU32>,
    pub word_docids: Database<Str, CboRoaringBitmapCodec>,
    pub exact_word_docids: Database<Str, CboRoaringBitmapCodec>,
    pub word_prefix_docids: Database<Str, CboRoaringBitmapCodec>,
    pub exact_word_prefix_docids: Database<Str, CboRoaringBitmapCodec>,
    pub word_pair_proximity_docids: Database<U8StrStrCodec, CboRoaringBitmapCodec>,
    pub word_position_docids: Database<StrBEU16Codec, CboRoaringBitmapCodec>,
    pub word_fid_docids: Database<StrBEU16Codec, CboRoaringBitmapCodec>,
    pub field_id_word_count_docids: Database<FieldIdWordCountCodec, CboRoaringBitmapCodec>,
    pub word_prefix_position_docids: Database<StrBEU16Codec, CboRoaringBitmapCodec>,
    pub word_prefix_fid_docids: Database<StrBEU16Codec, CboRoaringBitmapCodec>,
    pub facet_id_exists_docids: Database<FieldIdCodec, CboRoaringBitmapCodec>,
    pub facet_id_is_null_docids: Database<FieldIdCodec, CboRoaringBitmapCodec>,
    pub facet_id_is_empty_docids: Database<FieldIdCodec, CboRoaringBitmapCodec>,
    pub facet_id_f64_docids: Database<FacetGroupKeyCodec<OrderedF64Codec>, FacetGroupValueCodec>,
    pub facet_id_string_docids: Database<FacetGroupKeyCodec<StrRefCodec>, FacetGroupValueCodec>,
    pub facet_id_normalized_string_strings: Database<BEU16StrCodec, SerdeJson<BTreeSet<String>>>,
    pub facet_id_string_fst: Database<BEU16, FstSetCodec>,
    pub field_id_docid_facet_f64s: Database<FieldDocIdFacetF64Codec, Unit>,
    pub field_id_docid_facet_strings: Database<FieldDocIdFacetStringCodec, Str>,
    pub embedder_category_id: Database<Str, U8>,
    pub vector_arroy: Database<Unspecified>,
    /* private fields */
}

Fields

external_documents_ids: Database<Str, BEU32>

Maps the external documents ids with the internal document id.

word_docids: Database<Str, CboRoaringBitmapCodec>

A word and all the documents ids containing the word.

exact_word_docids: Database<Str, CboRoaringBitmapCodec>

A word and all the documents ids containing the word, from attributes for which typos are not allowed.

word_prefix_docids: Database<Str, CboRoaringBitmapCodec>

A prefix of word and all the documents ids containing this prefix.

exact_word_prefix_docids: Database<Str, CboRoaringBitmapCodec>

A prefix of word and all the documents ids containing this prefix, from attributes for which typos are not allowed.

word_pair_proximity_docids: Database<U8StrStrCodec, CboRoaringBitmapCodec>

Maps the proximity between a pair of words with all the docids where this relation appears.

word_position_docids: Database<StrBEU16Codec, CboRoaringBitmapCodec>

Maps the word and the position with the docids that corresponds to it.

word_fid_docids: Database<StrBEU16Codec, CboRoaringBitmapCodec>

Maps the word and the field id with the docids that corresponds to it.

field_id_word_count_docids: Database<FieldIdWordCountCodec, CboRoaringBitmapCodec>

Maps the field id and the word count with the docids that corresponds to it.

word_prefix_position_docids: Database<StrBEU16Codec, CboRoaringBitmapCodec>

Maps the word prefix and a position with all the docids where the prefix appears at the position.

word_prefix_fid_docids: Database<StrBEU16Codec, CboRoaringBitmapCodec>

Maps the word prefix and a field id with all the docids where the prefix appears inside the field

facet_id_exists_docids: Database<FieldIdCodec, CboRoaringBitmapCodec>

Maps the facet field id and the docids for which this field exists

facet_id_is_null_docids: Database<FieldIdCodec, CboRoaringBitmapCodec>

Maps the facet field id and the docids for which this field is set as null

facet_id_is_empty_docids: Database<FieldIdCodec, CboRoaringBitmapCodec>

Maps the facet field id and the docids for which this field is considered empty

facet_id_f64_docids: Database<FacetGroupKeyCodec<OrderedF64Codec>, FacetGroupValueCodec>

Maps the facet field id and ranges of numbers with the docids that corresponds to them.

facet_id_string_docids: Database<FacetGroupKeyCodec<StrRefCodec>, FacetGroupValueCodec>

Maps the facet field id and ranges of strings with the docids that corresponds to them.

facet_id_normalized_string_strings: Database<BEU16StrCodec, SerdeJson<BTreeSet<String>>>

Maps the facet field id of the normalized-for-search string facets with their original versions.

facet_id_string_fst: Database<BEU16, FstSetCodec>

Maps the facet field id of the string facets with an FST containing all the facets values.

field_id_docid_facet_f64s: Database<FieldDocIdFacetF64Codec, Unit>

Maps the document id, the facet field id and the numbers.

field_id_docid_facet_strings: Database<FieldDocIdFacetStringCodec, Str>

Maps the document id, the facet field id and the strings.

embedder_category_id: Database<Str, U8>

Maps an embedder name to its id in the arroy store.

vector_arroy: Database<Unspecified>

Vector store based on arroy™.

Implementations

impl Index

pub fn disabled_typos_terms( &self, txn: &RoTxn<'_>, ) -> Result<DisabledTyposTerms>

impl Index

pub fn new_with_creation_dates<P: AsRef<Path>>( options: EnvOpenOptions<WithoutTls>, path: P, created_at: OffsetDateTime, updated_at: OffsetDateTime, creation: bool, ) -> Result<Index>

pub fn new<P: AsRef<Path>>( options: EnvOpenOptions<WithoutTls>, path: P, creation: bool, ) -> Result<Index>

pub fn rollback<P: AsRef<Path>>( options: EnvOpenOptions<WithoutTls>, path: P, requested_version: (u32, u32, u32), ) -> Result<RollbackOutcome>

Attempts to rollback the index at path to the version specified by requested_version.

pub fn write_txn(&self) -> Result<RwTxn<'_>>

Create a write transaction to be able to write into the index.

pub fn read_txn(&self) -> Result<RoTxn<'_, WithoutTls>>

Create a read transaction to be able to read the index.

pub fn static_read_txn(&self) -> Result<RoTxn<'static, WithoutTls>>

Create a static read transaction to be able to read the index without keeping a reference to it.

pub fn path(&self) -> &Path

Returns the canonicalized path where the heed Env of this Index lives.

pub fn used_size(&self) -> Result<u64>

Returns the size used by the index without the cached pages.

pub fn on_disk_size(&self) -> Result<u64>

Returns the real size used by the index.

pub fn map_size(&self) -> usize

Returns the map size the underlying environment was opened with, in bytes.

This value does not represent the current on-disk size of the index.

This value is the maximum between the map size passed during the opening of the index and the on-disk size of the index at the time of opening.

pub fn copy_to_file( &self, file: &mut File, option: CompactionOption, ) -> Result<()>

pub fn copy_to_path<P: AsRef<Path>>( &self, path: P, option: CompactionOption, ) -> Result<File>

pub fn prepare_for_closing(self) -> EnvClosingEvent

Returns an EnvClosingEvent that can be used to wait for the closing event, multiple threads can wait on this event.

Make sure that you drop all the copies of Indexes you have, env closing are triggered when all references are dropped, the last one will eventually close the environment.

pub fn get_version(&self, rtxn: &RoTxn<'_>) -> Result<Option<(u32, u32, u32)>>

Get the version of the database. None if it was never set.

pub fn documents_ids(&self, rtxn: &RoTxn<'_>) -> Result<RoaringBitmap>

Returns the internal documents ids.

pub fn number_of_documents(&self, rtxn: &RoTxn<'_>) -> Result<u64>

Returns the number of documents indexed in the database.

pub fn put_documents_stats( &self, wtxn: &mut RwTxn<'_>, stats: DatabaseStats, ) -> Result<()>

Writes the stats of the documents database.

pub fn documents_stats(&self, rtxn: &RoTxn<'_>) -> Result<Option<DatabaseStats>>

Returns the stats of the documents database.

pub fn primary_key<'t>(&self, rtxn: &'t RoTxn<'_>) -> Result<Option<&'t str>>

Returns the documents primary key, None if it hasn’t been defined.

pub fn external_documents_ids(&self) -> ExternalDocumentsIds

Returns the external documents ids map which associate the external ids with the internal ids (i.e. u32).

pub fn fields_ids_map(&self, rtxn: &RoTxn<'_>) -> Result<FieldsIdsMap>

Returns the fields ids map which associate the documents keys with an internal field id (i.e. u8), this field id is used to identify fields in the obkv documents.

pub fn fields_ids_map_with_metadata( &self, rtxn: &RoTxn<'_>, ) -> Result<FieldIdMapWithMetadata>

Returns the fields ids map with metadata.

This structure is not yet stored in the index, and is generated on the fly.

pub fn fieldids_weights_map( &self, rtxn: &RoTxn<'_>, ) -> Result<FieldidsWeightsMap>

Get the fieldids weights map which associates the field ids to their weights

pub fn delete_fieldids_weights_map(&self, wtxn: &mut RwTxn<'_>) -> Result<bool>

Delete the fieldsids weights map

pub fn max_searchable_attribute_weight( &self, rtxn: &RoTxn<'_>, ) -> Result<Option<Weight>>

pub fn searchable_fields_and_weights<'a>( &self, rtxn: &'a RoTxn<'a>, ) -> Result<Vec<(Cow<'a, str>, FieldId, Weight)>>

pub fn geo_rtree(&self, rtxn: &RoTxn<'_>) -> Result<Option<RTree<GeoPoint>>>

Returns the rtree which associates coordinates to documents ids.

pub fn geo_faceted_documents_ids( &self, rtxn: &RoTxn<'_>, ) -> Result<RoaringBitmap>

Retrieve all the documents ids that are faceted with a _geo field.

pub fn field_distribution(&self, rtxn: &RoTxn<'_>) -> Result<FieldDistribution>

Returns the field distribution which associates every field name with the number of times it occurs in the documents.

pub fn displayed_fields<'t>( &self, rtxn: &'t RoTxn<'_>, ) -> Result<Option<Vec<&'t str>>>

Returns the displayed fields in the order they were set by the user. If it returns None it means that all the attributes are set as displayed in the order of the FieldsIdsMap.

pub fn displayed_fields_ids( &self, rtxn: &RoTxn<'_>, ) -> Result<Option<Vec<FieldId>>>

Identical to displayed_fields, but returns the ids instead.

pub fn remove_hidden_fields( &self, rtxn: &RoTxn<'_>, fields: impl IntoIterator<Item = impl AsRef<str>>, ) -> Result<(BTreeSet<String>, bool)>

pub fn searchable_fields<'t>( &self, rtxn: &'t RoTxn<'_>, ) -> Result<Vec<Cow<'t, str>>>

Returns the searchable fields, those are the fields that are indexed,

pub fn searchable_fields_ids(&self, rtxn: &RoTxn<'_>) -> Result<Vec<FieldId>>

Identical to searchable_fields, but returns the ids instead.

pub fn user_defined_searchable_fields<'t>( &self, rtxn: &'t RoTxn<'t>, ) -> Result<Option<Vec<&'t str>>>

Returns the user defined searchable fields.

pub fn user_defined_searchable_fields_ids( &self, rtxn: &RoTxn<'_>, ) -> Result<Option<Vec<FieldId>>>

Identical to user_defined_searchable_fields, but returns ids instead.

pub fn filterable_attributes_rules( &self, rtxn: &RoTxn<'_>, ) -> Result<Vec<FilterableAttributesRule>>

Returns the filterable attributes rules.

pub fn sortable_fields(&self, rtxn: &RoTxn<'_>) -> Result<HashSet<String>>

Returns the sortable fields names.

pub fn sortable_fields_ids(&self, rtxn: &RoTxn<'_>) -> Result<HashSet<FieldId>>

Identical to sortable_fields, but returns ids instead.

pub fn is_geo_enabled(&self, rtxn: &RoTxn<'_>) -> Result<bool>

Returns true if the geo feature is enabled.

pub fn is_geo_sorting_enabled(&self, rtxn: &RoTxn<'_>) -> Result<bool>

Returns true if the geo sorting feature is enabled.

pub fn is_geo_filtering_enabled(&self, rtxn: &RoTxn<'_>) -> Result<bool>

Returns true if the geo filtering feature is enabled.

pub fn asc_desc_fields(&self, rtxn: &RoTxn<'_>) -> Result<HashSet<String>>

pub fn null_faceted_documents_ids( &self, rtxn: &RoTxn<'_>, field_id: FieldId, ) -> Result<RoaringBitmap>

Retrieve all the documents which contain this field id set as null

pub fn empty_faceted_documents_ids( &self, rtxn: &RoTxn<'_>, field_id: FieldId, ) -> Result<RoaringBitmap>

Retrieve all the documents which contain this field id and that is considered empty

pub fn exists_faceted_documents_ids( &self, rtxn: &RoTxn<'_>, field_id: FieldId, ) -> Result<RoaringBitmap>

Retrieve all the documents which contain this field id

pub fn distinct_field<'a>(&self, rtxn: &'a RoTxn<'_>) -> Result<Option<&'a str>>

pub fn criteria(&self, rtxn: &RoTxn<'_>) -> Result<Vec<Criterion>>

pub fn words_fst<'t>(&self, rtxn: &'t RoTxn<'_>) -> Result<Set<Cow<'t, [u8]>>>

Returns the FST which is the words dictionary of the engine.

pub fn stop_words<'t>( &self, rtxn: &'t RoTxn<'t>, ) -> Result<Option<Set<&'t [u8]>>>

pub fn non_separator_tokens( &self, rtxn: &RoTxn<'_>, ) -> Result<Option<BTreeSet<String>>>

pub fn separator_tokens( &self, rtxn: &RoTxn<'_>, ) -> Result<Option<BTreeSet<String>>>

pub fn allowed_separators( &self, rtxn: &RoTxn<'_>, ) -> Result<Option<BTreeSet<String>>>

pub fn dictionary(&self, rtxn: &RoTxn<'_>) -> Result<Option<BTreeSet<String>>>

pub fn user_defined_synonyms( &self, rtxn: &RoTxn<'_>, ) -> Result<BTreeMap<String, Vec<String>>>

pub fn synonyms( &self, rtxn: &RoTxn<'_>, ) -> Result<HashMap<Vec<String>, Vec<Vec<String>>>>

pub fn words_synonyms<S: AsRef<str>>( &self, rtxn: &RoTxn<'_>, words: &[S], ) -> Result<Option<Vec<Vec<String>>>>

pub fn words_prefixes_fst<'t>( &self, rtxn: &'t RoTxn<'t>, ) -> Result<Set<Cow<'t, [u8]>>>

Returns the FST which is the words prefixes dictionary of the engine.

pub fn word_documents_count( &self, rtxn: &RoTxn<'_>, word: &str, ) -> Result<Option<u64>>

Returns the number of documents ids associated with the given word, it is much faster than deserializing the bitmap and getting the length of it.

pub fn document<'t>( &self, rtxn: &'t RoTxn<'_>, id: DocumentId, ) -> Result<&'t KvReaderU16>

Returns a document by using the document id.

pub fn iter_documents<'a, 't: 'a>( &'a self, rtxn: &'t RoTxn<'t>, ids: impl IntoIterator<Item = DocumentId> + 'a, ) -> Result<impl Iterator<Item = Result<(DocumentId, &'t KvReaderU16)>> + 'a>

Returns an iterator over the requested documents. The next item will be an error if a document is missing.

pub fn documents<'t>( &self, rtxn: &'t RoTxn<'t>, ids: impl IntoIterator<Item = DocumentId>, ) -> Result<Vec<(DocumentId, &'t KvReaderU16)>>

Returns a Vec of the requested documents. Returns an error if a document is missing.

pub fn all_documents<'a, 't: 'a>( &'a self, rtxn: &'t RoTxn<'t>, ) -> Result<impl Iterator<Item = Result<(DocumentId, &'t KvReaderU16)>> + 'a>

Returns an iterator over all the documents in the index.

pub fn external_id_of<'a, 't: 'a>( &'a self, rtxn: &'t RoTxn<'t>, ids: impl IntoIterator<Item = DocumentId> + 'a, ) -> Result<impl IntoIterator<Item = Result<String>> + 'a>

pub fn facets_distribution<'a>( &'a self, rtxn: &'a RoTxn<'a>, ) -> FacetDistribution<'a>

pub fn search<'a>(&'a self, rtxn: &'a RoTxn<'a>) -> Search<'a>

pub fn created_at(&self, rtxn: &RoTxn<'_>) -> Result<OffsetDateTime>

Returns the index creation time.

pub fn updated_at(&self, rtxn: &RoTxn<'_>) -> Result<OffsetDateTime>

Returns the index last updated time.

pub fn authorize_typos(&self, txn: &RoTxn<'_>) -> Result<bool>

pub fn min_word_len_one_typo(&self, txn: &RoTxn<'_>) -> Result<u8>

pub fn min_word_len_two_typos(&self, txn: &RoTxn<'_>) -> Result<u8>

pub fn exact_words<'t>( &self, txn: &'t RoTxn<'t>, ) -> Result<Option<Set<Cow<'t, [u8]>>>>

List the words on which typo are not allowed

pub fn exact_attributes<'t>(&self, txn: &'t RoTxn<'t>) -> Result<Vec<&'t str>>

Returns the exact attributes: attributes for which typo is disallowed.

pub fn exact_attributes_ids(&self, txn: &RoTxn<'_>) -> Result<HashSet<FieldId>>

Returns the list of exact attributes field ids.

pub fn max_values_per_facet(&self, txn: &RoTxn<'_>) -> Result<Option<u64>>

pub fn sort_facet_values_by(&self, txn: &RoTxn<'_>) -> Result<OrderByMap>

pub fn pagination_max_total_hits(&self, txn: &RoTxn<'_>) -> Result<Option<u64>>

pub fn proximity_precision( &self, txn: &RoTxn<'_>, ) -> Result<Option<ProximityPrecision>>

pub fn prefix_search(&self, txn: &RoTxn<'_>) -> Result<Option<PrefixSearch>>

pub fn facet_search(&self, txn: &RoTxn<'_>) -> Result<bool>

pub fn localized_attributes_rules( &self, rtxn: &RoTxn<'_>, ) -> Result<Option<Vec<LocalizedAttributesRule>>>

pub fn embedding_configs( &self, rtxn: &RoTxn<'_>, ) -> Result<Vec<IndexEmbeddingConfig>>

pub fn search_cutoff(&self, rtxn: &RoTxn<'_>) -> Result<Option<u64>>

pub fn embeddings( &self, rtxn: &RoTxn<'_>, docid: DocumentId, ) -> Result<BTreeMap<String, Vec<Embedding>>>

pub fn prefix_settings(&self, rtxn: &RoTxn<'_>) -> Result<PrefixSettings>

pub fn arroy_stats(&self, rtxn: &RoTxn<'_>) -> Result<ArroyStats>

pub fn contains_word(&self, rtxn: &RoTxn<'_>, word: &str) -> Result<bool>

Check if the word is indexed in the index.

This function checks if the word is indexed in the index by looking at the word_docids and exact_word_docids.

Arguments

• rtxn: The read transaction.
• word: The word to check.

pub fn database_sizes( &self, rtxn: &RoTxn<'_>, ) -> Result<IndexMap<&'static str, usize>>

Returns the sizes in bytes of each of the index database at the given rtxn.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.