Struct sql_migration_tests::test_api::DiffParams

pub struct DiffParams {
    pub exit_code: Option<bool>,
    pub from: DiffTarget,
    pub script: bool,
    pub shadow_database_url: Option<String>,
    pub to: DiffTarget,
}

The type of params for the diff method.

Example

{
    "from": {
        "tag": "migrations",
        "path": "./prisma/migrations"
    },
    "to": {
        "tag": "schemaDatamodel",
        "schema": "./prisma/schema.prisma",
    }
    "shadowDatabaseUrl": "mysql://test/test"
}

Fields

exit_code: Option<bool>

Whether the –exit-code param was passed.

If this is set, the engine will return exitCode = 2 in the diffResult in case the diff is non-empty. Other than this, it does not change the behaviour of the command.

JSON name: exitCode

from: DiffTarget

The source of the schema to consider as a starting point.

script: bool

By default, the response will contain a human-readable diff. If you want an executable script, pass the "script": true param.

shadow_database_url: Option<String>

The URL to a live database to use as a shadow database. The schema and data on that database will be wiped during diffing.

This is only necessary when one of from or to is referencing a migrations directory as a source for the schema.

JSON name: shadowDatabaseUrl

to: DiffTarget

The source of the schema to consider as a destination, or the desired end-state.

Trait Implementations

impl Debug for DiffParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DiffParams

fn deserialize<__D>( __deserializer: __D ) -> Result<DiffParams, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DiffParams

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

Serialize this value into the given Serde serializer.