Enum ReferenceAction 

#[non_exhaustive]
pub enum ReferenceAction {
    Cascade,
    Restrict,
    SetNull,
    SetDefault,
    NoAction,
}

The referential action taken on child rows when the referenced parent row changes.

Used in ForeignKeyDef::on_delete and ForeignKeyDef::on_update to control cascading behaviour. In JSON model files these are written in snake_case (e.g. "on_delete": "cascade").

This enum is #[non_exhaustive]: new variants may be added in future releases. Downstream match expressions should include a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Cascade

Automatically delete or update child rows when the parent row is deleted or updated (CASCADE).

Restrict

Prevent the parent row from being deleted or updated if child rows exist (RESTRICT).

SetNull

Set the foreign key column(s) in child rows to NULL when the parent changes (SET NULL). The column must be nullable.

SetDefault

Set the foreign key column(s) in child rows to their column default when the parent changes (SET DEFAULT).

NoAction

Do nothing to child rows; the database defers enforcement or raises an error (NO ACTION).

Implementations

impl ReferenceAction

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

SQL keyword representation as written in ALTER TABLE ... ADD CONSTRAINT ... FOREIGN KEY ... ON DELETE <keyword> etc. Used by vespertide-query when emitting raw SQL (e.g. the F11 NOT VALID + VALIDATE PG path, which bypasses the sea-query ForeignKey builder).

Trait Implementations

impl Clone for ReferenceAction

fn clone(&self) -> ReferenceAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReferenceAction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReferenceAction

impl JsonSchema for ReferenceAction

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 Ord for ReferenceAction

fn cmp(&self, other: &ReferenceAction) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ReferenceAction

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

fn partial_cmp(&self, other: &ReferenceAction) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ReferenceAction

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 ReferenceAction