Struct Join 

pub struct Join {
    pub table: TableName,
    pub kind: JoinKind,
    pub primary_key: ColumnName,
    pub nullable: bool,
    pub filters: Option<Vec<Filter>>,
    pub order_by: Option<Vec<OrderBy>>,
    pub limit: Option<u64>,
    pub fields: Vec<Field>,
    pub on: Vec<ColumnPair>,
    pub indexed: bool,
}

Folds rows from a related table into the document. The kind names the relationship — which side carries the key, and whether one row or many fold in; filters, order_by, and limit narrow and shape the rows that come back.

Fields

table: TableName

kind: JoinKind

primary_key: ColumnName

nullable: bool

Whether the folded-in object may be absent. Only meaningful for a to-one join (belongs_to/has_one); a to-many join is always a non-null array. A to-one join defaults to nullable unless the schema marks it required.

filters: Option<Vec<Filter>>

order_by: Option<Vec<OrderBy>>

limit: Option<u64>

fields: Vec<Field>

on: Vec<ColumnPair>

Extra column equalities on the hop, ANDed with the key. Never set on a ManyToMany join.

indexed: bool

Whether a sink indexes the folded-in rows. false still builds them into the stored document, but maps the whole subtree as one disabled object: nothing under it is searchable, filterable or sortable, and it costs one mapping field.

Trait Implementations

impl Clone for Join

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Join

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Join

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Join

Hashes indexed only when turned off and on only when non-empty, so a schema that never opts in keeps the content hash (and so the physical index) it had before the fields existed.

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Serialize for Join

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.