Expand description

Column oriented field storage for tantivy.

It is the equivalent of Lucene’s DocValues.

A fast field is a column-oriented fashion storage for tantivy.

It is designed for the fast random access of some document fields given a document id.

Fast fields are useful when a field is required for all or most of the DocSet: for instance for scoring, grouping, aggregation, filtering, or faceting.

Fields have to be declared as FAST in the schema. Currently supported fields are: u64, i64, f64, bytes and text.

Fast fields are stored in with different codecs. The best codec is detected automatically, when serializing.

Read access performance is comparable to that of an array lookup.

Structs

Set of alive DocIds.
Reader for byte array fast fields
Writer for byte array (as in, any number of bytes per document) fast fields
CompositeFastFieldSerializer is in charge of serializing fastfields on disk.
The facet reader makes it possible to access the list of facets associated with a given document in a specific segment.
FastFieldNotAvailableError is returned when the user requested for a fast field reader, and the field was not defined in the schema as a fast field.
Provides access to all of the BitpackedFastFieldReader.
The FastFieldsWriter groups all of the fast field writers.
Fast field writer for ints. The fast field writer just keeps the values in memory.
Index to resolve value range for given doc_id. Starts at 0.
Writer for multi-valued (as in, more than one value per document) int fast field.
Reader for a multivalued u64 fast field.
Writer for multi-valued (as in, more than one value per document) int fast field.
Reader for a multivalued u128 fast field.

Enums

The fast field type

Traits

Column provides columnar access on a field.
Trait for types that are allowed for fast fields: (u64, i64 and f64, bool, DateTime).

Functions

Intersects two AliveBitSets in a new one. The two bitsets need to have the same max_value.
Write an alive BitSet

Type Definitions

Result when trying to access a fast field reader.