Struct FieldMapping 

pub struct FieldMapping {
    pub name: String,
    pub field_type: FieldType,
    pub stored: bool,
    pub indexed: bool,
    pub doc_values: bool,
    pub norms: bool,
    pub analyzer: Option<String>,
    pub search_analyzer: Option<String>,
    pub parent_field: Option<String>,
    pub copy_to: Vec<String>,
}

A single field’s mapping: its name, type, and indexing flags.

Flags control which index structures are built for this field:

• stored: include in the document store (retrievable via _source)
• indexed: add to the inverted index (searchable)
• doc_values: create columnar storage (sortable, aggregatable)
• norms: store field norms for [[best-matching-25|BM25]] scoring

See [[architecture-api-surface#Schema Definition]] and [[architecture-indexing-pipeline]].

Fields

name: String

Field name as it appears in documents.

field_type: FieldType

Data type.

stored: bool

Whether to include this field’s value in the document store.

indexed: bool

Whether to add this field to the inverted index for search.

doc_values: bool

Whether to create columnar (doc_values) storage for sorting and aggregations.

norms: bool

Whether to store field length norms for BM25 scoring. Only meaningful for Text fields.

analyzer: Option<String>

Analyzer name for Text fields. None uses the default analyzer.

search_analyzer: Option<String>

Search-time analyzer name. If set, queries against this field use this analyzer instead of analyzer. See [[feature-analysis-pipeline]].

parent_field: Option<String>

If this is a multi-field sub-field, the name of the parent field. The parent’s source value is routed to this sub-field during indexing. None for top-level fields. See [[feature-mapping-multi-fields]].

copy_to: Vec<String>

Copy this field’s value to target fields at index time. See [[feature-mapping-copy-to]].

Implementations

impl FieldMapping

pub fn new(name: impl Into<String>, field_type: FieldType) -> Self

Create a mapping with sensible defaults for the given field type.

Default flags per type:

Type	stored	indexed	doc_values	norms
Text	true	true	false	true
Keyword	true	true	true	false
Numeric/Boolean/Date	true	true	true	false

pub fn stored(self, stored: bool) -> Self

Set the stored flag.

pub fn indexed(self, indexed: bool) -> Self

Set the indexed flag.

pub fn doc_values(self, doc_values: bool) -> Self

Set the doc_values flag.

pub fn norms(self, norms: bool) -> Self

Set the norms flag.

pub fn analyzer(self, analyzer: impl Into<String>) -> Self

Set the analyzer name (only meaningful for Text fields).

pub fn search_analyzer(self, analyzer: impl Into<String>) -> Self

Set the search-time analyzer name (only meaningful for Text fields). See [[feature-analysis-pipeline]].

Trait Implementations

impl Clone for FieldMapping

fn clone(&self) -> FieldMapping

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FieldMapping

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for FieldMapping

impl PartialEq for FieldMapping

fn eq(&self, other: &FieldMapping) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FieldMapping