Struct SqliteUpdateRouter 

pub struct SqliteUpdateRouter { /* private fields */ }

Available on crate feature __sqlite-shared only.

Routes SQLite row-change events to per-table callbacks, selected by typed table! markers.

SQLite allows only one update hook per connection. This router is a single value the caller composes and installs into that one slot with on_update, so the dispatch table is explicit rather than hidden connection state. Build it with on and on_any, then install it:

use diesel::prelude::*;
use diesel::sqlite::{SqliteConnection, SqliteChangeOps, SqliteUpdateRouter};
use std::sync::{Arc, Mutex};

diesel::table! { users (id) { id -> Integer, name -> Text, } }

let inserted = Arc::new(Mutex::new(Vec::new()));
let captured = inserted.clone();

conn.on_update(
    SqliteUpdateRouter::new()
        .on(users::table, SqliteChangeOps::INSERT, move |change| {
            captured.lock().unwrap().push(change.rowid);
        }),
);

diesel::insert_into(users::table)
    .values(users::name.eq("Alice"))
    .execute(conn)
    .unwrap();

assert_eq!(*inserted.lock().unwrap(), vec![1]);

Every matching route fires for a given event, so overlapping routes (for example an on_any audit log alongside table-specific handlers) all run. There are no per-route handles: to change the routes, install a different router or call remove_update_hook.

Implementations

impl SqliteUpdateRouter

pub fn new() -> Self

Creates an empty router that matches nothing until routes are added.

pub fn on<T, F>(self, table: T, ops: SqliteChangeOps, callback: F) -> Self

where T: NamedTable + Send + 'static, F: FnMut(SqliteChangeEvent<'_>) + Send + 'static,

Routes changes on table matching ops to callback.

table is a table type, either generated by table! or a diesel-dynamic-schema table. The schema name is treated as database name An unqualified table matches by table name in any database, so a same-named table in an ATTACH-ed database also matches. A schema-qualified table! type additionally matches the database name, so it fires only for that attached database.

pub fn on_any<F>(self, ops: SqliteChangeOps, callback: F) -> Self

where F: FnMut(SqliteChangeEvent<'_>) + Send + 'static,

Routes changes on any table matching ops to callback.

Trait Implementations

impl Default for SqliteUpdateRouter

fn default() -> Self

Returns the “default value” for a type.