Enum Relationship 

pub enum Relationship {
    ForeignKey {
        table: QualifiedIdentifier,
        foreign_table: QualifiedIdentifier,
        is_self: bool,
        cardinality: Cardinality,
        table_is_view: bool,
        foreign_table_is_view: bool,
        constraint_name: String,
    },
    Computed {
        function: QualifiedIdentifier,
        table: QualifiedIdentifier,
        foreign_table: QualifiedIdentifier,
        table_alias: QualifiedIdentifier,
        to_one: bool,
        is_self: bool,
        row_argument: Option<String>,
    },
}

A relationship between tables.

Variants

ForeignKey

Foreign key relationship

Fields

table: QualifiedIdentifier

Source table

foreign_table: QualifiedIdentifier

Target table

is_self: bool

Whether this is a self-referential relationship

cardinality: Cardinality

Relationship cardinality

table_is_view: bool

Whether the source is a view

foreign_table_is_view: bool

Whether the target is a view

constraint_name: String

FK constraint name

Computed

Computed relationship (from a function)

Fields

function: QualifiedIdentifier

Function that computes the relationship

table: QualifiedIdentifier

Source table

foreign_table: QualifiedIdentifier

Target table

table_alias: QualifiedIdentifier

Alias for the relationship

to_one: bool

Whether this returns a single row

is_self: bool

Whether this is self-referential

row_argument: Option<String>

The name of the parameter that takes the parent’s row.

Usually the only one, and then the call is positional. A function that also takes a search term or the caller’s session has the row somewhere among its parameters and is called by name, which is why the name is kept rather than the position.

Implementations

impl Relationship

pub fn foreign_table(&self) -> &QualifiedIdentifier

Get the foreign table for this relationship.

pub fn is_to_one(&self) -> bool

Check if this relationship returns a single row.

pub fn constraint_name(&self) -> &str

The name of the foreign key constraint behind this relationship.

Empty for a many-to-many, which is two constraints rather than one, and for a computed relationship, which has none.

pub fn cardinality_name(&self) -> &'static str

How PostgREST names this relationship’s cardinality.

pub fn describe(&self) -> String

How this relationship reads when several of them cannot be told apart.

message_sender_fkey using message(sender) and person_detail(id) – the constraint, then each side with the columns it joins on, which is what a client needs to write the hint that disambiguates it.

pub fn disambiguator(&self) -> String

The !hint that picks this relationship out from its rivals.

The constraint for a foreign key, the junction table for a many-to-many: whichever name is the one a client would have to write to mean this relationship and no other.

pub fn matches_hint(&self, hint: &str) -> bool

Whether a hint names this relationship.

A hint may be the constraint, the column that joins them, or the table on the far side – whichever the client found unambiguous.

pub fn is_self_referential(&self) -> bool

Whether this is a self-referential foreign key.

pub fn is_one_to_many(&self) -> bool

Whether this relationship yields many rows per row of its own table.

pub fn single_local_column(&self) -> Option<&str>

The single column this side joins on, where it joins on exactly one.

pub fn single_foreign_column(&self) -> Option<&str>

The single column the other side joins on, where there is exactly one.

pub fn join_columns(&self) -> Vec<(String, String)>

Get the join columns for this relationship.

Trait Implementations

impl Clone for Relationship

fn clone(&self) -> Relationship

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 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.