Struct Migrator

Source

pub struct Migrator<E, S>where
    E: Event + Clone,
    S: Serde<E> + Send + Sync,
{ /* private fields */ }

Expand description

Helper for initializing and migrating the PgEventStore database schema.

Migrator encapsulates the logic required to:

initialize the database for a fresh deployment
apply schema migrations when upgrading between versions

It is intended to be used during application startup or in dedicated maintenance / administration workflows.

Implementations§

Source §

impl<E, S> Migrator<E, S>
where E: Event + Clone, S: Serde<E> + Send + Sync,

Source

pub fn new(event_store: PgEventStore<E, S>) -> Self

Source

pub async fn init_event_store(&self) -> Result<(), Error>

Init PgEventStore database

Source

pub async fn init_listener(&self) -> Result<(), Error>

Init PgEventListener database

Source

pub async fn migrate_v2_1_0_to_v3_0_0(&self) -> Result<(), Error>

Migrate the database from version 2.1.0 to version 3.0.0

Backward compatible migration replacing HASH indexes with BTREE indexes to improve performance.

Auto Trait Implementations§

§

impl<E, S> !UnwindSafe for Migrator<E, S>

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §