Struct MigrateOptions 

#[non_exhaustive]
pub struct MigrateOptions<'a> {
    pub schema: &'a str,
}

Where migrate creates Reliar’s schema and its bookkeeping table.

use reliar_store_postgres::MigrateOptions;

let options = MigrateOptions::default().schema("orders");
assert_eq!(options.schema, "orders");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schema: &'a str

The schema to create (CREATE SCHEMA IF NOT EXISTS) and use for both the data tables and the _migrations bookkeeping table. Put this same value first on the connection’s search_path — in the connection URL (options=-c search_path=<schema>,public) or with ALTER ROLE <role> SET search_path = <schema>, public — so every unqualified reference resolves here; Reliar does not verify this for you (ADR 0047). Lowercase only ([a-z_][a-z0-9_$]*, at most 63 bytes) — an uppercase name is rejected with MigrateError::InvalidSchema rather than silently folded, since PostgreSQL itself would fold it inconsistently across an unquoted reference (ADR 0040 §5).

Implementations

impl<'a> MigrateOptions<'a>

pub const fn schema(self, schema: &'a str) -> Self

Sets Self::schema. #[non_exhaustive] forbids struct-literal construction outside this crate, so this is the only way to migrate into a non-default schema.

use reliar_store_postgres::MigrateOptions;
let options = MigrateOptions::default().schema("orders");
assert_eq!(options.schema, "orders");

Trait Implementations

impl<'a> Clone for MigrateOptions<'a>

fn clone(&self) -> MigrateOptions<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for MigrateOptions<'a>

impl<'a> Debug for MigrateOptions<'a>

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

Formats the value using the given formatter.

impl Default for MigrateOptions<'_>

fn default() -> Self

Returns the “default value” for a type.