Struct tantivy::IndexBuilder

pub struct IndexBuilder { /* private fields */ }

IndexBuilder can be used to create an index.

Use in conjunction with SchemaBuilder. Global index settings can be configured with IndexSettings

Examples

use tantivy::schema::*;
use tantivy::{Index, IndexSettings, IndexSortByField, Order};

let mut schema_builder = Schema::builder();
let id_field = schema_builder.add_text_field("id", STRING);
let title_field = schema_builder.add_text_field("title", TEXT);
let body_field = schema_builder.add_text_field("body", TEXT);
let number_field = schema_builder.add_u64_field(
    "number",
    NumericOptions::default().set_fast(Cardinality::SingleValue),
);

let schema = schema_builder.build();
let settings = IndexSettings{sort_by_field: Some(IndexSortByField{field:"number".to_string(), order:Order::Asc}), ..Default::default()};
let index = Index::builder().schema(schema).settings(settings).create_in_ram();

Implementations

impl IndexBuilder

pub fn new() -> Self

Creates a new IndexBuilder

pub fn settings(self, settings: IndexSettings) -> Self

Set the settings

pub fn schema(self, schema: Schema) -> Self

Set the schema

pub fn create_in_ram(self) -> Result<Index, TantivyError>

Creates a new index using the RAMDirectory.

The index will be allocated in anonymous memory. This should only be used for unit tests.

pub fn create_in_dir<P: AsRef<Path>>(self, directory_path: P) -> Result<Index>

Creates a new index in a given filepath. The index will use the MMapDirectory.

If a previous index was in this directory, it returns an IndexAlreadyExists error.

pub fn create_from_tempdir(self) -> Result<Index>

Creates a new index in a temp directory.

The index will use the MMapDirectory in a newly created directory. The temp directory will be destroyed automatically when the Index object is destroyed.

The temp directory is only used for testing the MmapDirectory. For other unit tests, prefer the RAMDirectory, see: create_in_ram.

pub fn open_or_create<T: Into<Box<dyn Directory>>>(
    self,
    dir: T
) -> Result<Index>

Opens or creates a new index in the provided directory

Trait Implementations

impl Default for IndexBuilder

fn default() -> Self

Returns the “default value” for a type.