Struct DocIdRule 

pub struct DocIdRule {
    pub template: IdTemplate,
    pub set_routing: bool,
}

Rule to construct a document _id.

In SharedIndex placement the partition id MUST appear in the template so ids cannot collide across tenants sharing one physical index (docs/03). osproxy-tenancy enforces this.

Examples

use osproxy_spi::{DocIdRule, IdTemplate};

let rule = DocIdRule::new(IdTemplate::new("{partition}:{body.order_id}"))
    .with_routing(true);
assert!(rule.set_routing);
assert!(rule.template.references_partition());

Fields

template: IdTemplate

The id template, e.g. {partition}:{body.natural_key}.

set_routing: bool

Also set OpenSearch _routing to the partition id, so the document lands on a deterministic shard for the partition.

Implementations

impl DocIdRule

pub fn new(template: IdTemplate) -> Self

Constructs a rule from a template, with routing off.

pub fn with_routing(self, set_routing: bool) -> Self

Sets set_routing (builder style).

Trait Implementations

impl Clone for DocIdRule

fn clone(&self) -> DocIdRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocIdRule

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

Formats the value using the given formatter.

impl Eq for DocIdRule

impl PartialEq for DocIdRule

fn eq(&self, other: &DocIdRule) -> 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 DocIdRule