Module tantivy::fastfield[][src]

Expand description

Column oriented field storage for tantivy.

It is the equivalent of Lucene’s DocValues.

Fast fields is a column-oriented fashion storage of tantivy.

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

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

Fields have to be declared as FAST in the schema. Currently only 64-bits integers (signed or unsigned) are supported.

They are stored in a bit-packed fashion so that their memory usage is directly linear with the amplitude of the values stored.

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

Structs

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.

Set of deleted DocIds.

The facet reader makes it possible to access the list of facets associated to 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 regroup all of the fast field writers.

Fast field writer for ints. The fast field writer just keeps the values in memory.

Reader for a multivalued u64 fast field.

Writer for multi-valued (as in, more than one value per document) int fast field.

Enums

DynamicFastFieldReader wraps different readers to access the various encoded fastfield data

Traits

FastFieldDataAccess is the trait to access fast field data during serialization and estimation.

FastFieldReader is the trait to access fast field data.

Trait for types that are allowed for fast fields: (u64, i64 and f64).

Trait for BytesFastFieldReader and MultiValuedFastFieldReader to return the length of data for a doc_id

Functions

Write a delete BitSet

Type Definitions

Result when trying to access a fast field reader.