Struct MigrateParams 

pub struct MigrateParams {
    pub migrations_path: String,
    pub pool_var: String,
}

Parameters for a sqlx::migrate!() macro invocation.

Emits sqlx::migrate!("migrations/").run(&pool).await?.

Build-time constraint: DATABASE_URL must be set at compile time of the emitted binary. The migrations path is relative to the emitted source file.

Fields

migrations_path: String

Path to the migrations directory, relative to the emitted file (e.g. "migrations").

Defaults to "migrations" if omitted.

pool_var: String

Name of the pool variable at the call site (e.g. "pool").

The emitted code calls .run(&pool_var).await?.

Trait Implementations

impl Clone for MigrateParams

fn clone(&self) -> MigrateParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MigrateParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MigrateParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EmitCode for MigrateParams

fn emit_code(&self) -> TokenStream

Emit the Rust token stream for this item.

fn crate_deps(&self) -> Vec<CrateDep>

Crate dependencies required by the emitted code.

fn shared_scope(&self) -> bool

Whether this step’s emitted code shares the outer function scope with adjacent steps.

impl JsonSchema for MigrateParams

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 Serialize for MigrateParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.