Struct tantivy::DemuxMapping

pub struct DemuxMapping { /* private fields */ }

DemuxMapping can be used to reorganize data from multiple segments.

DemuxMapping is useful in a multitenant settings, in which each document might actually belong to a different tenant. It allows to reorganize documents as follows:

e.g. if you have two tenant ids TENANT_A and TENANT_B and two segments with the documents (simplified) Seg 1 [TENANT_A, TENANT_B] Seg 2 [TENANT_A, TENANT_B]

You may want to group your documents to Seg 1 [TENANT_A, TENANT_A] Seg 2 [TENANT_B, TENANT_B]

Demuxing is the tool for that. Semantically you can define a mapping from [old segment ordinal, old doc_id] -> [new segment ordinal].

Implementations

impl DemuxMapping

pub fn add(&mut self, segment_mapping: DocIdToSegmentOrdinal)

Adds a DocIdToSegmentOrdinal. The order of the pus calls defines the old segment ordinal. e.g. first push = ordinal 0.

pub fn get_old_num_segments(&self) -> usize

Returns the old number of segments.

Trait Implementations

impl Debug for DemuxMapping

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

Formats the value using the given formatter.

impl Default for DemuxMapping

fn default() -> DemuxMapping

Returns the “default value” for a type.