Struct Relationship 

pub struct Relationship {
    pub name: String,
    pub target_type: String,
    pub cardinality: Cardinality,
    pub foreign_key: String,
    pub referenced_key: String,
}

A relationship between two schema types for REST resource embedding.

Fields

name: String

Relationship name (used in ?select=posts embedding syntax).

target_type: String

Target GraphQL type name (e.g., “Post”).

cardinality: Cardinality

Cardinality of the relationship.

foreign_key: String

Foreign key column on the child table (e.g., fk_author).

referenced_key: String

Referenced key column on the parent table (e.g., id).

Implementations

impl Relationship

pub const fn parent_join_column(&self) -> &String

The column an embed of this relationship reads off the declaring type’s row.

OneToMany hangs the foreign key on the child, so the declaring side is its referenced_key — conventionally id, which a client selects anyway, which is why #1230 hid here for so long. ManyToOne/OneToOne hold the key themselves, so the declaring side is the foreign_key — the one column a client asking for author has no reason to select.

Stated here rather than in the REST executor because the compile-time and load-time checks that a join key names a declared field (#1266) have to ask the same question the executor asks; a check with its own copy of this table would accept exactly the schemas the executor cannot follow.

pub const fn target_join_column(&self) -> &String

The column the join predicate filters on the target row — the mirror of parent_join_column, stated once so the two can never drift apart.

Trait Implementations

impl Clone for Relationship

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 Relationship

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Relationship

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Relationship

impl PartialEq for Relationship

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Relationship

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Relationship