3 # The author disclaims copyright to this source code. In place of
4 # a legal notice, here is a blessing:
6 # May you do good and not evil.
7 # May you find forgiveness for yourself and forgive others.
8 # May you share freely, never taking more than you give.
10 #***********************************************************************
13 source [file join [file dirname [info script]] rbu_common.tcl]
20 # Create a simple RBU database. That expects to write to a table:
22 # CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
24 proc create_rbu1 {filename} {
26 sqlite3 rbu1 $filename
28 CREATE TABLE data_t1(a, b, c, rbu_control);
29 INSERT INTO data_t1 VALUES(1, 2, 3, 0);
30 INSERT INTO data_t1 VALUES(2, 'two', 'three', 0);
31 INSERT INTO data_t1 VALUES(3, NULL, 8.2, 0);
37 # Create a simple RBU database. That expects to write to a table:
39 # CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
41 # This RBU includes both insert and delete operations.
43 proc create_rbu4 {filename} {
45 sqlite3 rbu1 $filename
47 CREATE TABLE data_t1(a, b, c, rbu_control);
48 INSERT INTO data_t1 VALUES(1, 2, 3, 0);
49 INSERT INTO data_t1 VALUES(2, NULL, 5, 1);
50 INSERT INTO data_t1 VALUES(3, 8, 9, 0);
51 INSERT INTO data_t1 VALUES(4, NULL, 11, 1);
57 # Create a simple RBU database. That expects to write to a table:
59 # CREATE TABLE t1(c, b, '(a)' INTEGER PRIMARY KEY);
61 # This RBU includes both insert and delete operations.
63 proc create_rbu4b {filename} {
65 sqlite3 rbu1 $filename
67 CREATE TABLE data_t1(c, b, '(a)', rbu_control);
68 INSERT INTO data_t1 VALUES(3, 2, 1, 0);
69 INSERT INTO data_t1 VALUES(5, NULL, 2, 1);
70 INSERT INTO data_t1 VALUES(9, 8, 3, 0);
71 INSERT INTO data_t1 VALUES(11, NULL, 4, 1);
77 # Create a simple RBU database. That expects to write to a table:
79 # CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c, d);
81 # This RBU includes update statements.
83 proc create_rbu5 {filename} {
85 sqlite3 rbu5 $filename
87 CREATE TABLE data_t1(a, b, c, d, rbu_control);
88 INSERT INTO data_t1 VALUES(1, NULL, NULL, 5, '...x'); -- SET d = 5
89 INSERT INTO data_t1 VALUES(2, NULL, 10, 5, '..xx'); -- SET c=10, d = 5
90 INSERT INTO data_t1 VALUES(3, 11, NULL, NULL, '.x..'); -- SET b=11
97 # Same as [step_rbu], except using a URI to open the target db.
99 proc step_rbu_uri {target rbu} {
101 sqlite3rbu rbu file:$target?xyz=&abc=123 $rbu
104 if {$rc != "SQLITE_OK"} break
109 # Same as [step_rbu], except using an external state database - "state.db"
111 proc step_rbu_state {target rbu} {
113 sqlite3rbu rbu $target $rbu state.db
116 if {$rc != "SQLITE_OK"} break
121 proc dbfilecksum {file} {
123 set cksum [dbcksum ck main]
128 foreach {tn3 create_vfs destroy_vfs} {
131 sqlite3rbu_create_vfs -default myrbu ""
133 sqlite3rbu_destroy_vfs myrbu
136 sqlite3_register_cksumvfs
138 sqlite3_unregister_cksumvfs
146 2 step_rbu 3 step_rbu_uri 4 step_rbu_state
149 foreach {tn schema} {
151 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
154 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
155 CREATE INDEX i1 ON t1(b);
158 CREATE TABLE t1(a PRIMARY KEY, b, c) WITHOUT ROWID;
161 CREATE TABLE t1(a PRIMARY KEY, b, c) WITHOUT ROWID;
162 CREATE INDEX i1 ON t1(b);
165 CREATE TABLE t1(a, b, c, PRIMARY KEY(a, c)) WITHOUT ROWID;
166 CREATE INDEX i1 ON t1(b);
169 CREATE TABLE t1(a, b, c, PRIMARY KEY(c)) WITHOUT ROWID;
170 CREATE INDEX i1 ON t1(b, a);
173 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
174 CREATE INDEX i1 ON t1(b, c);
175 CREATE INDEX i2 ON t1(c, b);
176 CREATE INDEX i3 ON t1(a, b, c, a, b, c);
180 CREATE TABLE t1(a PRIMARY KEY, b, c);
181 CREATE INDEX i1 ON t1(b, c);
182 CREATE INDEX i2 ON t1(c, b);
183 CREATE INDEX i3 ON t1(a, b, c, a, b, c);
187 CREATE TABLE t1(a, b, c, PRIMARY KEY(a, c));
188 CREATE INDEX i1 ON t1(b);
192 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
193 CREATE INDEX i1 ON t1(b DESC);
197 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
198 CREATE INDEX i1 ON t1(b DESC, a ASC, c DESC);
202 CREATE TABLE t1(a INT PRIMARY KEY DESC, b, c) WITHOUT ROWID;
206 CREATE TABLE t1(a INT, b, c, PRIMARY KEY(a DESC)) WITHOUT ROWID;
210 CREATE TABLE t1(a, b, c, PRIMARY KEY(a DESC, c)) WITHOUT ROWID;
211 CREATE INDEX i1 ON t1(b);
215 CREATE TABLE t1(a, b, c, PRIMARY KEY(a, c DESC)) WITHOUT ROWID;
216 CREATE INDEX i1 ON t1(b);
220 CREATE TABLE t1(a, b, c, PRIMARY KEY(c DESC, a)) WITHOUT ROWID;
221 CREATE INDEX i1 ON t1(b DESC, c, a);
227 set check [dbfilecksum rbu.db]
230 do_test $tn3.1.$tn2.$tn.1 {
234 do_execsql_test $tn3.1.$tn2.$tn.2 { SELECT * FROM t1 ORDER BY a ASC } {
239 do_execsql_test $tn3.1.$tn2.$tn.3 { SELECT * FROM t1 ORDER BY b ASC } {
244 do_execsql_test $tn3.1.$tn2.$tn.4 { SELECT * FROM t1 ORDER BY c ASC } {
250 do_execsql_test $tn3.1.$tn2.$tn.5 { PRAGMA integrity_check } ok
252 if {$cmd=="step_rbu_state"} {
253 do_test $tn3.1.$tn2.$tn.6 { file exists state.db } 1
254 do_test $tn3.1.$tn2.$tn.7 { expr {$check == [dbfilecksum rbu.db]} } 1
256 do_test $tn3.1.$tn2.$tn.8 { file exists state.db } 0
257 do_test $tn3.1.$tn2.$tn.9 { expr {$check == [dbfilecksum rbu.db]} } 0
262 #-------------------------------------------------------------------------
263 # Check that an RBU cannot be applied to a table that has no PK.
265 # UPDATE: At one point RBU required that all tables featured either
266 # explicit IPK columns or were declared WITHOUT ROWID. This has been
267 # relaxed so that external PRIMARY KEYs on tables with automatic rowids
270 # UPDATE 2: Tables without any PRIMARY KEY declaration are now allowed.
271 # However the input table must feature an "rbu_rowid" column.
275 do_execsql_test $tn3.2.1 { CREATE TABLE t1(a, b, c) }
277 sqlite3rbu rbu test.db rbu.db
281 list [catch { rbu close } msg] $msg
282 } {1 {SQLITE_ERROR - table data_t1 requires rbu_rowid column}}
284 do_execsql_test $tn3.2.4 { CREATE TABLE t1(a PRIMARY KEY, b, c) }
286 sqlite3rbu rbu test.db rbu.db
290 list [catch { rbu close } msg] $msg
293 #-------------------------------------------------------------------------
294 # Check that if a UNIQUE constraint is violated the current and all
295 # subsequent [rbu step] calls return SQLITE_CONSTRAINT. And that the RBU
296 # transaction is rolled back by the [rbu close] that deletes the rbu
299 foreach {tn errcode errmsg schema} {
300 1 SQLITE_CONSTRAINT "UNIQUE constraint failed: t1.a" {
301 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
302 INSERT INTO t1 VALUES(3, 2, 1);
305 2 SQLITE_CONSTRAINT "UNIQUE constraint failed: t1.c" {
306 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c UNIQUE);
307 INSERT INTO t1 VALUES(4, 2, 'three');
310 3 SQLITE_CONSTRAINT "UNIQUE constraint failed: t1.a" {
311 CREATE TABLE t1(a PRIMARY KEY, b, c);
312 INSERT INTO t1 VALUES(3, 2, 1);
315 4 SQLITE_CONSTRAINT "UNIQUE constraint failed: t1.c" {
316 CREATE TABLE t1(a PRIMARY KEY, b, c UNIQUE);
317 INSERT INTO t1 VALUES(4, 2, 'three');
323 set cksum [dbcksum db main]
325 do_test $tn3.3.$tn.1 {
327 sqlite3rbu rbu test.db rbu.db
328 while {[set res [rbu step]]=="SQLITE_OK"} {}
332 do_test $tn3.3.$tn.2 { rbu step } $errcode
334 do_test $tn3.3.$tn.3 {
335 list [catch { rbu close } msg] $msg
336 } [list 1 "$errcode - $errmsg"]
338 do_test $tn3.3.$tn.4 { dbcksum db main } $cksum
341 #-------------------------------------------------------------------------
343 foreach {tn2 cmd} {1 run_rbu 2 step_rbu 3 step_rbu_state } {
344 foreach {tn schema} {
346 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
349 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
350 CREATE INDEX i1 ON t1(b);
353 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
354 CREATE INDEX i1 ON t1(b);
355 CREATE INDEX i2 ON t1(c, b);
356 CREATE INDEX i3 ON t1(c, b, c);
359 CREATE TABLE t1(a INT PRIMARY KEY, b, c) WITHOUT ROWID;
360 CREATE INDEX i1 ON t1(b);
361 CREATE INDEX i2 ON t1(c, b);
362 CREATE INDEX i3 ON t1(c, b, c);
365 CREATE TABLE t1(a INT PRIMARY KEY, b, c);
366 CREATE INDEX i1 ON t1(b);
367 CREATE INDEX i2 ON t1(c, b);
368 CREATE INDEX i3 ON t1(c, b, c);
372 CREATE TABLE t1(a INT PRIMARY KEY DESC, b, c);
373 CREATE INDEX i1 ON t1(b DESC);
374 CREATE INDEX i2 ON t1(c, b);
375 CREATE INDEX i3 ON t1(c DESC, b, c);
378 CREATE TABLE t1(a INT PRIMARY KEY DESC, b, c) WITHOUT ROWID;
379 CREATE INDEX i1 ON t1(b);
380 CREATE INDEX i2 ON t1(c, b);
381 CREATE INDEX i3 ON t1(c, b, c);
387 INSERT INTO t1 VALUES(2, 'hello', 'world');
388 INSERT INTO t1 VALUES(4, 'hello', 'planet');
389 INSERT INTO t1 VALUES(6, 'hello', 'xyz');
393 set check [dbfilecksum rbu.db]
396 do_test $tn3.4.$tn2.$tn.1 {
400 do_execsql_test $tn3.4.$tn2.$tn.2 {
401 SELECT * FROM t1 ORDER BY a ASC;
408 do_execsql_test $tn3.4.$tn2.$tn.3 { PRAGMA integrity_check } ok
410 if {$cmd=="step_rbu_state"} {
411 do_test $tn3.4.$tn2.$tn.4 { file exists state.db } 1
412 do_test $tn3.4.$tn2.$tn.5 { expr {$check == [dbfilecksum rbu.db]} } 1
414 do_test $tn3.4.$tn2.$tn.6 { file exists state.db } 0
415 do_test $tn3.4.$tn2.$tn.7 { expr {$check == [dbfilecksum rbu.db]} } 0
420 foreach {tn2 cmd} {1 run_rbu 2 step_rbu 3 step_rbu_state} {
421 foreach {tn schema} {
423 CREATE TABLE t1(c, b, '(a)' INTEGER PRIMARY KEY);
424 CREATE INDEX i1 ON t1(c, b);
427 CREATE TABLE t1(c, b, '(a)' PRIMARY KEY);
430 CREATE TABLE t1(c, b, '(a)' PRIMARY KEY) WITHOUT ROWID;
436 INSERT INTO t1('(a)', b, c) VALUES(2, 'hello', 'world');
437 INSERT INTO t1('(a)', b, c) VALUES(4, 'hello', 'planet');
438 INSERT INTO t1('(a)', b, c) VALUES(6, 'hello', 'xyz');
442 set check [dbfilecksum rbu.db]
445 do_test $tn3.5.$tn2.$tn.1 {
449 do_execsql_test $tn3.5.$tn2.$tn.2 {
450 SELECT * FROM t1 ORDER BY "(a)" ASC;
457 do_execsql_test $tn3.4.$tn2.$tn.3 { PRAGMA integrity_check } ok
459 if {$cmd=="step_rbu_state"} {
460 do_test $tn3.5.$tn2.$tn.4 { file exists state.db } 1
461 do_test $tn3.5.$tn2.$tn.5 { expr {$check == [dbfilecksum rbu.db]} } 1
463 do_test $tn3.5.$tn2.$tn.6 { file exists state.db } 0
464 do_test $tn3.5.$tn2.$tn.7 { expr {$check == [dbfilecksum rbu.db]} } 0
469 #-------------------------------------------------------------------------
471 foreach {tn2 cmd} {1 run_rbu 2 step_rbu 3 step_rbu_state} {
472 foreach {tn schema} {
474 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c, d);
477 CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c, d);
478 CREATE INDEX i1 ON t1(d);
479 CREATE INDEX i2 ON t1(d, c);
480 CREATE INDEX i3 ON t1(d, c, b);
481 CREATE INDEX i4 ON t1(b);
482 CREATE INDEX i5 ON t1(c);
483 CREATE INDEX i6 ON t1(c, b);
486 CREATE TABLE t1(a PRIMARY KEY, b, c, d) WITHOUT ROWID;
487 CREATE INDEX i1 ON t1(d);
488 CREATE INDEX i2 ON t1(d, c);
489 CREATE INDEX i3 ON t1(d, c, b);
490 CREATE INDEX i4 ON t1(b);
491 CREATE INDEX i5 ON t1(c);
492 CREATE INDEX i6 ON t1(c, b);
495 CREATE TABLE t1(a PRIMARY KEY, b, c, d);
496 CREATE INDEX i1 ON t1(d);
497 CREATE INDEX i2 ON t1(d, c);
498 CREATE INDEX i3 ON t1(d, c, b);
499 CREATE INDEX i4 ON t1(b);
500 CREATE INDEX i5 ON t1(c);
501 CREATE INDEX i6 ON t1(c, b);
507 INSERT INTO t1 VALUES(1, 2, 3, 4);
508 INSERT INTO t1 VALUES(2, 5, 6, 7);
509 INSERT INTO t1 VALUES(3, 8, 9, 10);
513 set check [dbfilecksum rbu.db]
516 do_test $tn3.5.$tn2.$tn.1 {
520 do_execsql_test $tn3.5.$tn2.$tn.2 {
521 SELECT * FROM t1 ORDER BY a ASC;
528 do_execsql_test $tn3.6.$tn2.$tn.3 { PRAGMA integrity_check } ok
530 if {$cmd=="step_rbu_state"} {
531 do_test $tn3.6.$tn2.$tn.4 { file exists state.db } 1
532 do_test $tn3.6.$tn2.$tn.5 { expr {$check == [dbfilecksum rbu.db]} } 1
534 do_test $tn3.6.$tn2.$tn.6 { file exists state.db } 0
535 do_test $tn3.6.$tn2.$tn.7 { expr {$check == [dbfilecksum rbu.db]} } 0
540 #-------------------------------------------------------------------------
541 # Test some error cases:
543 # * A virtual table with no rbu_rowid column.
544 # * A no-PK table with no rbu_rowid column.
545 # * A PK table with an rbu_rowid column.
547 # 6: An update string of the wrong length
550 foreach {tn schema error} {
552 CREATE TABLE t1(a, b);
553 CREATE TABLE rbu.data_t1(a, b, rbu_control);
554 } {SQLITE_ERROR - table data_t1 requires rbu_rowid column}
557 CREATE VIRTUAL TABLE t1 USING fts4(a, b);
558 CREATE TABLE rbu.data_t1(a, b, rbu_control);
559 } {SQLITE_ERROR - table data_t1 requires rbu_rowid column}
562 CREATE TABLE t1(a PRIMARY KEY, b);
563 CREATE TABLE rbu.data_t1(a, b, rbu_rowid, rbu_control);
564 } {SQLITE_ERROR - table data_t1 may not have rbu_rowid column}
567 CREATE TABLE t1(a INTEGER PRIMARY KEY, b);
568 CREATE TABLE rbu.data_t1(a, b, rbu_rowid, rbu_control);
569 } {SQLITE_ERROR - table data_t1 may not have rbu_rowid column}
572 CREATE TABLE t1(a, b PRIMARY KEY) WITHOUT ROWID;
573 CREATE TABLE rbu.data_t1(a, b, rbu_rowid, rbu_control);
574 } {SQLITE_ERROR - table data_t1 may not have rbu_rowid column}
577 CREATE TABLE t1(a, b PRIMARY KEY) WITHOUT ROWID;
578 CREATE TABLE rbu.data_t1(a, b, rbu_control);
579 INSERT INTO rbu.data_t1 VALUES(1, 2, 'x.x');
580 } {SQLITE_ERROR - invalid rbu_control value}
583 CREATE TABLE t1(a, b PRIMARY KEY) WITHOUT ROWID;
584 CREATE TABLE rbu.data_t1(a, b, rbu_control);
585 INSERT INTO rbu.data_t1 VALUES(1, 2, NULL);
586 } {SQLITE_ERROR - invalid rbu_control value}
589 CREATE TABLE t1(a, b PRIMARY KEY) WITHOUT ROWID;
590 CREATE TABLE rbu.data_t1(a, b, rbu_control);
591 INSERT INTO rbu.data_t1 VALUES(1, 2, 4);
592 } {SQLITE_ERROR - invalid rbu_control value}
595 CREATE TABLE t1(a, b PRIMARY KEY) WITHOUT ROWID;
596 CREATE TABLE rbu.data_t1(a, b, rbu_control);
597 INSERT INTO rbu.data_t1 VALUES(1, 2, 3);
598 } {SQLITE_ERROR - invalid rbu_control value}
601 CREATE TABLE t2(a, b);
602 CREATE TABLE rbu.data_t1(a, b, rbu_control);
603 INSERT INTO rbu.data_t1 VALUES(1, 2, 2);
604 } {SQLITE_ERROR - no such table: t1}
607 CREATE TABLE rbu.data_t2(a, b, rbu_control);
608 INSERT INTO rbu.data_t2 VALUES(1, 2, 2);
609 } {SQLITE_ERROR - no such table: t2}
614 execsql { ATTACH 'rbu.db' AS rbu }
618 list [catch { run_rbu test.db rbu.db } msg] $msg
623 # Test that an RBU database containing no input tables is handled
628 list [catch { run_rbu test.db rbu.db } msg] $msg
631 # Test that an RBU database containing only empty data_xxx tables is
632 # also handled correctly.
635 do_execsql_test $tn3.8.2.1 {
636 CREATE TABLE t1(a PRIMARY KEY, b);
637 INSERT INTO t1 VALUES(1, 2);
638 ATTACH 'rbu.db' AS rbu;
639 CREATE TABLE data_t1(a, b, rbu_control);
643 list [catch { run_rbu test.db rbu.db } msg] $msg
646 # Test that RBU can update indexes containing NULL values.
650 do_execsql_test $tn3.9.1 {
651 CREATE TABLE t1(a PRIMARY KEY, b, c);
652 CREATE INDEX i1 ON t1(b, c);
653 INSERT INTO t1 VALUES(1, 1, NULL);
654 INSERT INTO t1 VALUES(2, NULL, 2);
655 INSERT INTO t1 VALUES(3, NULL, NULL);
657 ATTACH 'rbu.db' AS rbu;
658 CREATE TABLE rbu.data_t1(a, b, c, rbu_control);
659 INSERT INTO data_t1 VALUES(1, NULL, NULL, 1);
660 INSERT INTO data_t1 VALUES(3, NULL, NULL, 1);
664 list [catch { run_rbu test.db rbu.db } msg] $msg
667 do_execsql_test $tn3.9.3 {
670 do_execsql_test $tn3.9.4 { PRAGMA integrity_check } {ok}