sqlite3-rdiff

compute and apply signature-based row differences for SQLite3 databases

Depends

Tcl (and lang/tcl-wrapper for FreeBSD)
SQLite extension for Tcl
SQLite3
sqlite-md5 extension library for SQLite

Description

Signatures are computed using md5 algorithm for each full row. Hash collisions are resolved by using different --rows-per-hash for some replication session.

Synopsis

sqlite3-rdiff [--table-name expression] [--rows-per-hash N] signature old-database signature-file

sqlite3-rdiff [--table-name expression] delta signature-file new-database delta-file

sqlite3-rdiff [--table-name expression] [--multimaster] patch old-database delta-file result-database

sqlite3-rdiff [--table-name expression] analyze old-database new-database

In patch mode the same database can be specified as old-database and result-database (in-place patching).

Options

--table-name    regular expression for table names, use ? for any single symbol
                and % for any set of symbols.

--rows-per-hash how much rows are hashed at once. The default value is 1.
                Increase it for small signature and decrease for small delta.
                Use analyze mode to determine the best value of this parameter.
                For master-slave replication any value will be safe.
                This option is used only in signature building mode.

--multimaster   only insert nonexisting records. May produce duplicates when
                a table has no unique column or indices with "replace" or
               "ignore" conflict resolution algorithm and --rows-per-hash
                option is greater than 1.
                Useful for master-master replication on the inserts-only
                populated databases.

Usage

The slave.db is an outdated version of the master.db database. The commands below synchronize the slave.db with actual version of the master.db.

./sqlite3-rdiff --rows-per-hash 10 signature slave.db slave.db.sign
./sqlite3-rdiff delta slave.db.sign master.db slave.db.delta
./sqlite3-rdiff patch slave.db slave.db.delta slave.db

Note: we can patch slave.db in place by setting the last parameter of sqlite3-rdiff patch to the slave.db or create a new database by specifying different file name.

Calculating optimal `--rows-per-hash` value

The analyze command can be used to calculate optimal --rows-per-hash value:

$ ./sqlite3-rdiff analyze slave.db master.db
analyze slave.db master.db --table-name %
52774   old-database size (kB)
53919   new-database size (kB)
Calculating optimal --rows-per-hash value ...................
18      optimal --rows-per-hash option value
2936    signature+delta size (kB)

Practical example

sqlite3-sync - live SQLite3 database master-slave replication with sqlite3-rdiff using rsync over SSH.

_{Rsync in conjunction with signature and delta files caching further reduces the transferring data volume. Total data amount transferred on the wire in both directions is about 0.6% of the slave database size.}

License

This code in Public Domain.

Acknowledgments

The code is based heavily on the now deprecated MBG SQLite's sqlite3-rdiff utility by Alexey Pechnikov pechnikov@mobigroup.ru.

dejanstrbac / sqlite3-rdiff