Struct ForeignKeyRef 

pub struct ForeignKeyRef {
    pub table: ObjectName,
    pub columns: ThinVec<Ident>,
    pub match_type: Option<ForeignKeyMatch>,
    pub on_delete: Option<Box<ReferentialAction>>,
    pub on_update: Option<Box<ReferentialAction>>,
    pub update_before_delete: bool,
    pub meta: Meta,
}

A foreign-key reference: REFERENCES <table> [(<column>, ...)] plus the optional <referential triggered action> clauses.

match_type, on_delete, and on_update stay None when their clause is unwritten — the canonical shape keeps one node for both the column-level REFERENCES form and the table-level FOREIGN KEY form. The clauses are order-independent in the standard, so the parser accepts them in any order and renders them in a fixed canonical order (ON DELETE before ON UPDATE); the update_before_delete tag records the one bit of order the two separate fields otherwise lose, so a source-fidelity render replays the written order. PostgreSQL always materializes these (defaulting MATCH SIMPLE / NO ACTION), so an unwritten clause and the explicit default are representation-equivalent.

Fields

table: ObjectName

Table referenced by this syntax.

columns: ThinVec<Ident>

Columns in source order.

match_type: Option<ForeignKeyMatch>

Optional match type for this syntax.

on_delete: Option<Box<ReferentialAction>>

The referential actions are boxed because they are usually absent and a ReferentialAction is comparatively large: a bare REFERENCES then pays only a null pointer, keeping the inline node small where this type is embedded in ColumnOption/TableConstraint (the same reason those enums box their generated-column and identity payloads).

on_update: Option<Box<ReferentialAction>>

Optional on update for this syntax.

update_before_delete: bool

Whether the source wrote ON UPDATE before ON DELETE. Meaningful only when both actions are present; the canonical render emits ON DELETE first, and a source-fidelity render swaps to the written order. Exact-order fidelity — the clauses are order-independent, so a target re-spell and the redacted fingerprint keep the canonical order.

meta: Meta

Source location and node identity.

Trait Implementations

impl Clone for ForeignKeyRef

fn clone(&self) -> ForeignKeyRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForeignKeyRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ForeignKeyRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ForeignKeyRef

impl Hash for ForeignKeyRef

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 PartialEq for ForeignKeyRef

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

Equality operator ==.

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

Inequality operator !=.

impl Render for ForeignKeyRef

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

Return the render for this value.

fn operand_binding_power(&self) -> Option<BindingPower>

The binding power this node contributes when it appears as an operand, or None (the default) for a self-delimiting node — an atom, call, or constructor — that never needs parentheses.

impl Serialize for ForeignKeyRef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Spanned for ForeignKeyRef

fn span(&self) -> Span

Return the span for this value.

impl StructuralPartialEq for ForeignKeyRef