Struct tantivy::schema::SchemaBuilder

pub struct SchemaBuilder { /* private fields */ }

Tantivy has a very strict schema. You need to specify in advance whether a field is indexed or not, stored or not, and RAM-based or not.

This is done by creating a schema object, and setting up the fields one by one. It is for the moment impossible to remove fields.

Examples

use tantivy::schema::*;

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 schema = schema_builder.build();

Implementations

impl SchemaBuilder

pub fn new() -> SchemaBuilder

Create a new SchemaBuilder

pub fn add_u64_field<T: Into<NumericOptions>>(
    &mut self,
    field_name_str: &str,
    field_options: T
) -> Field

Adds a new u64 field. Returns the associated field handle

Caution

Appending two fields with the same name will result in the shadowing of the first by the second one. The first field will get a field id but only the second one will be indexed

pub fn add_i64_field<T: Into<NumericOptions>>(
    &mut self,
    field_name_str: &str,
    field_options: T
) -> Field

Adds a new i64 field. Returns the associated field handle

Caution

Appending two fields with the same name will result in the shadowing of the first by the second one. The first field will get a field id but only the second one will be indexed

pub fn add_f64_field<T: Into<NumericOptions>>(
    &mut self,
    field_name_str: &str,
    field_options: T
) -> Field

Adds a new f64 field. Returns the associated field handle

Caution

Appending two fields with the same name will result in the shadowing of the first by the second one. The first field will get a field id but only the second one will be indexed

pub fn add_date_field<T: Into<NumericOptions>>(
    &mut self,
    field_name_str: &str,
    field_options: T
) -> Field

Adds a new date field. Returns the associated field handle Internally, Tantivy simply stores dates as i64 UTC timestamps, while the user supplies DateTime values for convenience.

Caution

Appending two fields with the same name will result in the shadowing of the first by the second one. The first field will get a field id but only the second one will be indexed

pub fn add_text_field<T: Into<TextOptions>>(
    &mut self,
    field_name_str: &str,
    field_options: T
) -> Field

Adds a new text field. Returns the associated field handle

Caution

Appending two fields with the same name will result in the shadowing of the first by the second one. The first field will get a field id but only the second one will be indexed

pub fn add_facet_field<T: Into<FacetOptions>>(
    &mut self,
    field_name: &str,
    facet_options: T
) -> Field

Adds a facet field to the schema.

pub fn add_bytes_field<T: Into<BytesOptions>>(
    &mut self,
    field_name: &str,
    field_options: T
) -> Field

Adds a fast bytes field to the schema.

Bytes field are not searchable and are only used as fast field, to associate any kind of payload to a document.

For instance, learning-to-rank often requires to access some document features at scoring time. These can be serializing and stored as a bytes field to get access rapidly when scoring each document.

pub fn add_json_field<T: Into<JsonObjectOptions>>(
    &mut self,
    field_name: &str,
    field_options: T
) -> Field

Adds a json object field to the schema.

pub fn add_field(&mut self, field_entry: FieldEntry) -> Field

Adds a field entry to the schema in build.

pub fn build(self) -> Schema

Finalize the creation of a Schema This will consume your SchemaBuilder

Trait Implementations

impl Default for SchemaBuilder

fn default() -> SchemaBuilder

Returns the “default value” for a type.