Struct DiffSetBuilder 

pub struct DiffSetBuilder<F: Format<S, B>, T: SchemaWithPK, S, B> { /* private fields */ }

Builder for constructing changeset or patchset binary data.

DiffSetBuilder tracks rows in DML insertion order. When build is called, it simulates SQLite’s session-extension hash table to produce byte-identical output.

For parsed (frozen) data that should be emitted in its original order, see DiffSet.

Generic over the format F (Changeset or Patchset), table schema T, and value types S, B.

Implementations

impl<F: Format<S, B>, T: SchemaWithPK, S: AsRef<str> + Hash + Eq, B: AsRef<[u8]> + Hash + Eq> DiffSetBuilder<F, T, S, B>

pub fn new() -> Self

Create a new builder.

pub fn add_table(&mut self, table: &T) -> &mut Self

Register a table schema without adding any operations.

This is useful when you need the table present (e.g. before calling DiffSetBuilder::digest_sql) but don’t have operations yet. If the table is already registered, this is a no-op.

pub fn is_empty(&self) -> bool

Returns true if the builder has no operations.

pub fn len(&self) -> usize

Returns the number of operations across all tables.

impl<F, T, S, B> DiffSetBuilder<F, T, S, B>

where F: Format<S, B>, T: NamedColumns, S: Clone + Debug + Hash + Eq + AsRef<str> + Default, B: Clone + Debug + Hash + Eq + AsRef<[u8]> + Default,

pub fn digest<E, Sch, A>( self, event: &E, schema: &Sch, adapter: &A, ) -> Result<Self, E::Error>

where E: Digestable<F, T, S, B>, Sch: WireSchema<Table = T>, A: WireAdapter<E::Src, S, B>, T: WireColumnTypes,

Digest one CDC wire event, resolving each affected table via schema and decoding column payloads via adapter.

Errors

Whatever E::Error reports (per-source ConversionError).

impl<T: NamedColumns, S: Clone + Hash + Eq + AsRef<str> + for<'a> From<&'a str>> DiffSetBuilder<PatchsetFormat, T, S, Vec<u8>>

pub fn digest_sql<'input>( &mut self, input: &'input str, ) -> Result<&mut Self, ParseError<'input>>

Digest a SQL string containing INSERT, UPDATE, and DELETE statements into this patchset builder.

The entire input is parsed before any change is applied. A parse error on any statement leaves the builder exactly as it was before this call.

Supported subset

Each statement must be one of these forms:

INSERT INTO table (col1, col2, ...) VALUES (v1, v2, ...)
UPDATE table SET col1 = v1, ... WHERE pk1 = v1 AND pk2 = v2 ...
DELETE FROM table WHERE pk1 = v1 AND pk2 = v2 ...

A WHERE clause is not a filter over stored rows. It is the only way the parser can identify which row is targeted, because no table data is available. Every WHERE must therefore name every primary key column with equality predicates joined by AND. OR, >, LIKE, subqueries, and IN are not supported.

Multiple statements can be separated by semicolons.

Errors

Returns a crate::builders::sql::ParseError if any statement cannot be parsed. The builder is left untouched in that case.

impl<T: SchemaWithPK, S: Clone + Debug + Hash + Eq + AsRef<str>, B: Clone + Debug + Hash + Eq + AsRef<[u8]>> DiffSetBuilder<ChangesetFormat, T, S, B>

pub fn build(&self) -> Vec<u8>

Build the changeset binary data.

Returns the binary representation compatible with SQLite’s session extension.

Panics

This function does not panic under normal usage. Internal indexing is guaranteed to be within bounds.

impl<T: SchemaWithPK, S: Clone + Debug + AsRef<str>, B: Clone + Debug + AsRef<[u8]>> DiffSetBuilder<ChangesetFormat, T, S, B>

pub fn iter(&self) -> impl Iterator<Item = ChangesetOp<'_, T, S, B>>

Walk operations grouped by table in DML insertion order.

Mirrors DiffSet::iter but keeps insertion order; the session-extension hash ordering only applies at build time.

impl<T: SchemaWithPK, S: Clone + Hash + Eq + AsRef<str>, B: Clone + Hash + Eq + AsRef<[u8]>> DiffSetBuilder<PatchsetFormat, T, S, B>

pub fn build(&self) -> Vec<u8>

Build the patchset binary data.

Returns the binary representation compatible with SQLite’s session extension.

Panics

This function does not panic under normal usage. Internal indexing is guaranteed to be within bounds.

impl<T: SchemaWithPK, S: Clone + AsRef<str>, B: Clone + AsRef<[u8]>> DiffSetBuilder<PatchsetFormat, T, S, B>

pub fn iter(&self) -> impl Iterator<Item = PatchsetOp<'_, T, S, B>>

Walk operations grouped by table in DML insertion order.

Mirrors DiffSet::iter but keeps insertion order; the session-extension hash ordering only applies at build time. With the diesel feature enabled, each item implements QueryFragment and executes via RunQueryDsl.

impl<T: ColumnNames, S: AsRef<str> + Clone + Debug + Hash + Eq, B: AsRef<[u8]> + Clone + Debug + Hash + Eq> DiffSetBuilder<ChangesetFormat, T, S, B>

pub fn sql_statements(&self) -> impl Iterator<Item = String> + '_

Iterate over operations as SQL statements.

Each operation is converted to an INSERT, UPDATE, or DELETE statement. Identifiers (table and column names) are quoted with double quotes. Statements do not include trailing semicolons.

Example

use sqlite_diff_rs::{SimpleTable, ChangeSet, DiffOps, Insert};

let table = SimpleTable::new("users", &["id", "name"], &[0]);
let insert = Insert::from(table.clone())
    .set(0, 1i64).unwrap()
    .set(1, "Alice").unwrap();

let changeset = ChangeSet::<SimpleTable, String, Vec<u8>>::new().insert(insert);

for sql in changeset.sql_statements() {
    assert_eq!(sql, r#"INSERT INTO "users" ("id", "name") VALUES (1, 'Alice')"#);
}

impl<T: ColumnNames, S: AsRef<str> + Clone + Hash + Eq, B: AsRef<[u8]> + Clone + Hash + Eq> DiffSetBuilder<PatchsetFormat, T, S, B>

pub fn sql_statements(&self) -> impl Iterator<Item = String> + '_

Iterate over operations as SQL statements.

Each operation is converted to an INSERT, UPDATE, or DELETE statement. Identifiers (table and column names) are quoted with double quotes. Statements do not include trailing semicolons.

Example

use sqlite_diff_rs::{SimpleTable, PatchSet, DiffOps, Insert};

let table = SimpleTable::new("users", &["id", "name"], &[0]);
let insert = Insert::from(table.clone())
    .set(0, 1i64).unwrap()
    .set(1, "Alice").unwrap();

let patchset = PatchSet::<SimpleTable, String, Vec<u8>>::new().insert(insert);

for sql in patchset.sql_statements() {
    assert_eq!(sql, r#"INSERT INTO "users" ("id", "name") VALUES (1, 'Alice')"#);
}

Trait Implementations

impl<F: Format<S, B>, T: SchemaWithPK, S: Clone + Hash + Eq + AsRef<str>, B: Clone + Hash + Eq + AsRef<[u8]>> BitOr for DiffSetBuilder<F, T, S, B>

where Operation<F, S, B>: Add<Output = Option<Operation<F, S, B>>>,

fn bitor(self, rhs: Self) -> Self::Output

Merge two diff sets, consolidating operations on the same row.

type Output = DiffSetBuilder<F, T, S, B>

The resulting type after applying the | operator.

impl<F: Format<S, B>, T: SchemaWithPK, S: Clone + Hash + Eq + AsRef<str>, B: Clone + Hash + Eq + AsRef<[u8]>> BitOrAssign for DiffSetBuilder<F, T, S, B>

where Operation<F, S, B>: Add<Output = Option<Operation<F, S, B>>>,

fn bitor_assign(&mut self, rhs: Self)

Merge another diff set into this one, consolidating operations on the same row.

impl<F: Clone + Format<S, B>, T: Clone + SchemaWithPK, S: Clone, B: Clone> Clone for DiffSetBuilder<F, T, S, B>

fn clone(&self) -> DiffSetBuilder<F, T, S, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Format<S, B>, T: Debug + SchemaWithPK, S: Debug, B: Debug> Debug for DiffSetBuilder<F, T, S, B>

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

Formats the value using the given formatter.

impl<F: Format<S, B>, T: SchemaWithPK, S: AsRef<str> + Hash + Eq, B: AsRef<[u8]> + Hash + Eq> Default for DiffSetBuilder<F, T, S, B>

fn default() -> Self

Returns the “default value” for a type.

impl<T: SchemaWithPK, S: Clone + Debug + Hash + Eq + AsRef<str>, B: Clone + Debug + Hash + Eq + AsRef<[u8]>> DiffOps<T, S, B> for DiffSetBuilder<ChangesetFormat, T, S, B>

type Format = ChangesetFormat

The format (changeset or patchset) of the diff set.

type DeleteArg = ChangeDelete<T, S, B>

The argument type for the delete operation.

fn insert(self, insert: Insert<T, S, B>) -> Self

Add an INSERT operation.

fn delete(self, delete: ChangeDelete<T, S, B>) -> Self

Add a DELETE operation.

fn update(self, update: Update<T, ChangesetFormat, S, B>) -> Self

Add an UPDATE operation.

impl<T: SchemaWithPK, S: Clone + Hash + Eq + AsRef<str>, B: Clone + Hash + Eq + AsRef<[u8]>> DiffOps<T, S, B> for DiffSetBuilder<PatchsetFormat, T, S, B>

fn delete(self, delete: PatchDelete<T, S, B>) -> Self

Delete by primary key.

Example

use sqlite_diff_rs::{DiffOps, PatchDelete, PatchSet, SchemaWithPK, TableSchema};

// CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)
let schema: TableSchema<String> = TableSchema::new("users".into(), 2, vec![1, 0]);

// Delete row where id = 1
let patchset = PatchSet::<_, String, Vec<u8>>::new()
    .delete(PatchDelete::new(schema, vec![1i64.into()]));

fn update(self, update: Update<T, PatchsetFormat, S, B>) -> Self

Update by primary key.

Example

use sqlite_diff_rs::{DiffOps, PatchSet, PatchsetFormat, Update, TableSchema};

// CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)
let schema: TableSchema<String> = TableSchema::new("users".into(), 2, vec![1, 0]);

// UPDATE users SET name = 'Bob' WHERE id = 1
let update = Update::<_, PatchsetFormat, String, Vec<u8>>::from(schema)
    .set(0, 1i64).unwrap()  // PK value
    .set(1, "Bob").unwrap();

let patchset = PatchSet::<_, String, Vec<u8>>::new()
    .update(update);

type Format = PatchsetFormat

The format (changeset or patchset) of the diff set.

type DeleteArg = PatchDelete<T, S, B>

The argument type for the delete operation.

fn insert(self, insert: Insert<T, S, B>) -> Self

Add an INSERT operation.

impl<F: Format<S, B>, T: SchemaWithPK, S, B> Eq for DiffSetBuilder<F, T, S, B>

where S: Eq + Hash + AsRef<str>, B: Eq + Hash + AsRef<[u8]>, F::Old: Eq, F::DeleteData: Eq,

impl<T: SchemaWithPK, S: Clone + Debug + Hash + Eq + AsRef<str>, B: Clone + Debug + Hash + Eq + AsRef<[u8]>> From<&DiffSetBuilder<ChangesetFormat, T, S, B>> for Vec<u8>

fn from(builder: &DiffSetBuilder<ChangesetFormat, T, S, B>) -> Self

Converts to this type from the input type.

impl<T: SchemaWithPK, S: AsRef<str> + Clone + Hash + Eq, B: AsRef<[u8]> + Clone + Hash + Eq> From<&DiffSetBuilder<PatchsetFormat, T, S, B>> for Vec<u8>

fn from(builder: &DiffSetBuilder<PatchsetFormat, T, S, B>) -> Self

Converts to this type from the input type.

impl<F: Format<S, B>, T: SchemaWithPK, S: Hash + Eq + AsRef<str>, B: Hash + Eq + AsRef<[u8]>> From<DiffSet<F, T, S, B>> for DiffSetBuilder<F, T, S, B>

fn from(diffset: DiffSet<F, T, S, B>) -> Self

Converts to this type from the input type.

impl<T: SchemaWithPK, S: Clone + Debug + Hash + Eq + AsRef<str>, B: Clone + Debug + Hash + Eq + AsRef<[u8]>> From<DiffSetBuilder<ChangesetFormat, T, S, B>> for Vec<u8>

fn from(builder: DiffSetBuilder<ChangesetFormat, T, S, B>) -> Self

Converts to this type from the input type.

impl<F: Format<S, B>, T: SchemaWithPK, S: Hash + Eq + AsRef<str>, B: Hash + Eq + AsRef<[u8]>> From<DiffSetBuilder<F, T, S, B>> for DiffSet<F, T, S, B>

fn from(builder: DiffSetBuilder<F, T, S, B>) -> Self

Converts to this type from the input type.

impl<T: SchemaWithPK, S: AsRef<str> + Clone + Hash + Eq, B: AsRef<[u8]> + Clone + Hash + Eq> From<DiffSetBuilder<PatchsetFormat, T, S, B>> for Vec<u8>

fn from(builder: DiffSetBuilder<PatchsetFormat, T, S, B>) -> Self

Converts to this type from the input type.

impl<F: Format<S, B>, T: SchemaWithPK, S, B> PartialEq for DiffSetBuilder<F, T, S, B>

where S: PartialEq + Eq + Hash + AsRef<str>, B: PartialEq + Eq + Hash + AsRef<[u8]>, F::Old: PartialEq, F::DeleteData: PartialEq,

Custom PartialEq that ignores tables with empty operations.

Tables with no operations are not serialized (skipped in build()), so after roundtrip they won’t exist. This makes empty tables semantically equivalent to non-existent tables for comparison purposes.

Verified: SQLite’s session extension does NOT include empty table entries in changesets/patchsets when all operations cancel out. Our builder keeps them in memory to preserve table ordering, but they are correctly excluded here and in build().

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: SchemaWithPK, S: Clone + Debug + Hash + Eq + AsRef<str>, B: Clone + Debug + Hash + Eq + AsRef<[u8]>> Reverse for DiffSetBuilder<ChangesetFormat, T, S, B>

type Output = DiffSetBuilder<ChangesetFormat, T, S, B>

The reverse of this operation.

fn reverse(self) -> Self::Output

Returns the reverse of this operation.