Indexing parameters

Indexing parameters #

index #

For non-object fields, if set, Pizza would build an index for the field to make it searchable. For object fields, the index parameter overrides the index settings of its sub-fields.

Carried by: most scalar types and object — see each field type. Not carried by the vector types.

index_options #

Controls what information is added to the inverted index. Available options are:

  • docs: Only the doc number is indexed. Can answer the question Does this term exist in this field?
  • freqs: Doc number and term frequencies are indexed. Term frequencies are used to score repeated terms higher than single terms.
  • positions (default): Doc number, term frequencies, and term positions (or order) are indexed. Positions can be used for proximity or phrase queries.
  • offsets: Doc number, term frequencies, positions, and start and end character offsets (which map the term back to the original string) are indexed. Offsets are used by the unified highlighter to speed up highlighting.

Carried by: text, keyword.

norms #

Whether length normalization is indexed for the field (default true when indexed). Turning it off saves space when field lengths carry no scoring signal (e.g. log identifiers).

Carried by: text, keyword.

null_value #

A value substituted for explicit nulls so the document still matches term/terms queries on the field — the substitute is indexed, the source keeps the null.

Carried by: text, keyword, numeric and boolean types, date.

Calendar September 29, 2026
Edit Edit this page