Struct SchemaDiff 

pub struct SchemaDiff {
    pub operation: DiffOperation,
    pub table: String,
    pub field: Option<String>,
    pub index: Option<String>,
    pub event: Option<String>,
    pub description: String,
    pub forward_sql: String,
    pub backward_sql: String,
    pub details: BTreeMap<String, Value>,
}

Represents a difference between two schema versions.

Examples

use surql::migration::{DiffOperation, SchemaDiff};

let diff = SchemaDiff {
    operation: DiffOperation::AddTable,
    table: "user".into(),
    field: None,
    index: None,
    event: None,
    description: "Add user table".into(),
    forward_sql: "DEFINE TABLE user SCHEMAFULL;".into(),
    backward_sql: "REMOVE TABLE user;".into(),
    details: Default::default(),
};
assert_eq!(diff.operation, DiffOperation::AddTable);

Fields

operation: DiffOperation

The kind of schema change.

table: String

Table name affected by the change.

field: Option<String>

Field name, if the change targets a field.

index: Option<String>

Index name, if the change targets an index.

event: Option<String>

Event name, if the change targets an event.

description: String

Human-readable description.

forward_sql: String

SurrealQL that applies the change (forward).

backward_sql: String

SurrealQL that reverts the change (backward).

details: BTreeMap<String, Value>

Extra operation-specific details.

Trait Implementations

impl Clone for SchemaDiff

fn clone(&self) -> SchemaDiff

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaDiff

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SchemaDiff

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SchemaDiff

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SchemaDiff

impl StructuralPartialEq for SchemaDiff