Enum ForeignKeySyntax 

pub enum ForeignKeySyntax {
    String(String),
    Reference(ReferenceSyntaxDef),
    Object(ForeignKeyDef),
}

Inline foreign key declaration on a ColumnDef, supporting three levels of verbosity.

In JSON model files you can write:

• "foreign_key": "user.id" (string shorthand)
• "foreign_key": {"references": "user.id", "on_delete": "cascade"} (reference object)
• "foreign_key": {"ref_table": "user", "ref_columns": ["id"], "on_delete": "cascade"} (full object)

All three forms are normalized into a ForeignKeyDef by the planner.

Variants

String(String)

Shorthand string in "table.column" format, e.g. "user.id".

Reference(ReferenceSyntaxDef)

Object with a "references" key in "table.column" format plus optional actions.

Object(ForeignKeyDef)

Full object with explicit ref_table, ref_columns, and optional actions.

Trait Implementations

impl Clone for ForeignKeySyntax

fn clone(&self) -> ForeignKeySyntax

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForeignKeySyntax

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ForeignKeySyntax

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ForeignKeySyntax

impl JsonSchema for ForeignKeySyntax

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ForeignKeySyntax

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

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 ForeignKeySyntax