Skip to main content

Replication

Struct Replication 

Source
pub struct Replication { /* private fields */ }
Expand description

Replicates the configured sources and delivers committed changes to handlers.

There is no default handler. Register at least one before starting, to avoid advancing checkpoints without a consumer. Use with_runtime to register custom source plugins or version adapters.

Implementations§

Source§

impl Replication

Source

pub fn new(config: AppConfig) -> Result<Self>

Examples found in repository?
examples/listen.rs (line 10)
5fn main() -> Result<()> {
6    let Some(path) = std::env::args().nth(1) else {
7        eprintln!("usage: cargo run -p mysql-replication --example listen -- CONFIG.toml");
8        return Ok(());
9    };
10    let mut replication = Replication::new(AppConfig::read(Path::new(&path))?)?;
11    replication.add_handle(|event: Event<'_>| {
12        for change in event.changes {
13            println!(
14                "{} {}.{} {:?} {:?} {:?}",
15                event.source_id,
16                change.table.schema,
17                change.table.table,
18                change.operation,
19                change.pk,
20                change.changed_names().collect::<Vec<_>>()
21            );
22        }
23        Ok(())
24    });
25    replication.run()
26}
Source

pub fn with_runtime(config: AppConfig, runtime: Runtime) -> Result<Self>

Examples found in repository?
examples/custom_version.rs (line 45)
38fn main() -> Result<()> {
39    let Some(path) = std::env::args().nth(1) else {
40        eprintln!("usage: cargo run -p mysql-replication --example custom_version -- CONFIG.toml");
41        return Ok(());
42    };
43    let mut runtime = Runtime::default();
44    runtime.versions.register(Arc::new(CustomMysql))?;
45    let mut replication = Replication::with_runtime(AppConfig::read(Path::new(&path))?, runtime)?;
46    let output = JsonLinesSink::new(BufWriter::new(std::io::stdout()));
47    replication.add_handle(move |event: Event<'_>| {
48        output.commit(event.source_id, event.checkpoint, event.changes)
49    });
50    replication.run()
51}
Source

pub fn add_handle(&mut self, handler: impl EventHandler + 'static) -> &mut Self

Registers a handler or a Fn(Event<'_>) -> Result<()> closure.

Examples found in repository?
examples/custom_version.rs (lines 47-49)
38fn main() -> Result<()> {
39    let Some(path) = std::env::args().nth(1) else {
40        eprintln!("usage: cargo run -p mysql-replication --example custom_version -- CONFIG.toml");
41        return Ok(());
42    };
43    let mut runtime = Runtime::default();
44    runtime.versions.register(Arc::new(CustomMysql))?;
45    let mut replication = Replication::with_runtime(AppConfig::read(Path::new(&path))?, runtime)?;
46    let output = JsonLinesSink::new(BufWriter::new(std::io::stdout()));
47    replication.add_handle(move |event: Event<'_>| {
48        output.commit(event.source_id, event.checkpoint, event.changes)
49    });
50    replication.run()
51}
More examples
Hide additional examples
examples/listen.rs (lines 11-24)
5fn main() -> Result<()> {
6    let Some(path) = std::env::args().nth(1) else {
7        eprintln!("usage: cargo run -p mysql-replication --example listen -- CONFIG.toml");
8        return Ok(());
9    };
10    let mut replication = Replication::new(AppConfig::read(Path::new(&path))?)?;
11    replication.add_handle(|event: Event<'_>| {
12        for change in event.changes {
13            println!(
14                "{} {}.{} {:?} {:?} {:?}",
15                event.source_id,
16                change.table.schema,
17                change.table.table,
18                change.operation,
19                change.pk,
20                change.changed_names().collect::<Vec<_>>()
21            );
22        }
23        Ok(())
24    });
25    replication.run()
26}
Source

pub fn check(&self) -> Result<()>

Validates the upstream settings and whitelist without consuming events.

Source

pub fn initialize(self) -> Result<()>

Creates initial checkpoints without consuming events.

Source

pub fn run(self) -> Result<()>

Consumes continuously until a source or handler fails.

Examples found in repository?
examples/custom_version.rs (line 50)
38fn main() -> Result<()> {
39    let Some(path) = std::env::args().nth(1) else {
40        eprintln!("usage: cargo run -p mysql-replication --example custom_version -- CONFIG.toml");
41        return Ok(());
42    };
43    let mut runtime = Runtime::default();
44    runtime.versions.register(Arc::new(CustomMysql))?;
45    let mut replication = Replication::with_runtime(AppConfig::read(Path::new(&path))?, runtime)?;
46    let output = JsonLinesSink::new(BufWriter::new(std::io::stdout()));
47    replication.add_handle(move |event: Event<'_>| {
48        output.commit(event.source_id, event.checkpoint, event.changes)
49    });
50    replication.run()
51}
More examples
Hide additional examples
examples/listen.rs (line 25)
5fn main() -> Result<()> {
6    let Some(path) = std::env::args().nth(1) else {
7        eprintln!("usage: cargo run -p mysql-replication --example listen -- CONFIG.toml");
8        return Ok(());
9    };
10    let mut replication = Replication::new(AppConfig::read(Path::new(&path))?)?;
11    replication.add_handle(|event: Event<'_>| {
12        for change in event.changes {
13            println!(
14                "{} {}.{} {:?} {:?} {:?}",
15                event.source_id,
16                change.table.schema,
17                change.table.table,
18                change.operation,
19                change.pk,
20                change.changed_names().collect::<Vec<_>>()
21            );
22        }
23        Ok(())
24    });
25    replication.run()
26}
Source

pub fn run_once(self) -> Result<()>

Consumes the currently available binlog and returns at its end.

Auto Trait Implementations§

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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.