0000: 3c 74 69 74 6c 65 3e 53 51 4c 69 74 65 20 42 61 <title>SQLite Ba
0010: 63 6b 75 70 20 41 50 49 3c 2f 74 69 74 6c 65 3e ckup API</title>
0020: 0a 3c 74 63 6c 3e 68 64 5f 6b 65 79 77 6f 72 64 .<tcl>hd_keyword
0030: 73 20 7b 55 73 69 6e 67 20 74 68 65 20 53 51 4c s {Using the SQL
0040: 69 74 65 20 4f 6e 6c 69 6e 65 20 42 61 63 6b 75 ite Online Backu
0050: 70 20 41 50 49 7d 20 7b 62 61 63 6b 75 70 20 41 p API} {backup A
0060: 50 49 7d 3c 2f 74 63 6c 3e 0a 0a 3c 73 74 79 6c PI}</tcl>..<styl
0070: 65 3e 0a 20 20 2f 2a 20 46 6f 72 6d 61 74 74 69 e>. /* Formatti
0080: 6e 67 20 66 6f 72 20 74 68 65 20 62 6c 6f 63 6b ng for the block
0090: 73 20 63 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 s containing the
00a0: 20 65 78 61 6d 70 6c 65 20 63 6f 64 65 20 2a 2f example code */
00b0: 0a 20 20 70 72 65 20 61 3a 76 69 73 69 74 65 64 . pre a:visited
00c0: 2c 20 70 72 65 20 61 3a 6c 69 6e 6b 20 7b 20 74 , pre a:link { t
00d0: 65 78 74 2d 64 65 63 6f 72 61 74 69 6f 6e 3a 20 ext-decoration:
00e0: 6e 6f 6e 65 20 3b 20 63 6f 6c 6f 72 3a 20 23 34 none ; color: #4
00f0: 30 35 33 34 62 20 7d 0a 20 20 70 72 65 20 7b 20 0534b }. pre {
0100: 0a 20 20 20 20 62 61 63 6b 67 72 6f 75 6e 64 3a . background:
0110: 20 23 46 33 46 33 46 33 3b 20 0a 20 20 20 20 66 #F3F3F3; . f
0120: 6c 6f 61 74 3a 20 72 69 67 68 74 3b 20 0a 20 20 loat: right; .
0130: 20 20 70 61 64 64 69 6e 67 3a 20 31 65 78 20 32 padding: 1ex 2
0140: 65 78 3b 20 0a 20 20 20 20 6d 61 72 67 69 6e 2d ex; . margin-
0150: 6c 65 66 74 3a 20 31 65 6d 3b 0a 20 20 20 20 62 left: 1em;. b
0160: 6f 72 64 65 72 3a 20 73 6f 6c 69 64 20 62 6c 61 order: solid bla
0170: 63 6b 20 31 70 78 3b 20 0a 20 20 7d 0a 20 20 68 ck 1px; . }. h
0180: 31 2c 68 32 20 7b 20 63 6c 65 61 72 3a 20 62 6f 1,h2 { clear: bo
0190: 74 68 20 7d 0a 3c 2f 73 74 79 6c 65 3e 0a 0a 3c th }.</style>..<
01a0: 64 69 76 20 63 6c 61 73 73 3d 66 61 6e 63 79 3e div class=fancy>
01b0: 0a 3c 68 31 3e 55 73 69 6e 67 20 74 68 65 20 53 .<h1>Using the S
01c0: 51 4c 69 74 65 20 4f 6e 6c 69 6e 65 20 42 61 63 QLite Online Bac
01d0: 6b 75 70 20 41 50 49 3c 2f 68 31 3e 0a 0a 3c 70 kup API</h1>..<p
01e0: 3e 0a 20 20 48 69 73 74 6f 72 69 63 61 6c 6c 79 >. Historically
01f0: 2c 20 62 61 63 6b 75 70 73 20 28 63 6f 70 69 65 , backups (copie
0200: 73 29 20 6f 66 20 53 51 4c 69 74 65 20 64 61 74 s) of SQLite dat
0210: 61 62 61 73 65 73 20 68 61 76 65 20 62 65 65 6e abases have been
0220: 20 63 72 65 61 74 65 64 0a 20 20 75 73 69 6e 67 created. using
0230: 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 6d the following m
0240: 65 74 68 6f 64 3a 0a 0a 3c 6f 6c 3e 0a 20 20 3c ethod:..<ol>. <
0250: 6c 69 3e 20 45 73 74 61 62 6c 69 73 68 20 61 20 li> Establish a
0260: 73 68 61 72 65 64 20 6c 6f 63 6b 20 6f 6e 20 74 shared lock on t
0270: 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 he database file
0280: 20 75 73 69 6e 67 20 74 68 65 20 53 51 4c 69 74 using the SQLit
0290: 65 20 41 50 49 20 28 69 2e 65 2e 0a 20 20 20 20 e API (i.e..
02a0: 20 20 20 74 68 65 20 73 68 65 6c 6c 20 74 6f 6f the shell too
02b0: 6c 29 2e 0a 20 20 3c 6c 69 3e 20 43 6f 70 79 20 l).. <li> Copy
02c0: 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c the database fil
02d0: 65 20 75 73 69 6e 67 20 61 6e 20 65 78 74 65 72 e using an exter
02e0: 6e 61 6c 20 74 6f 6f 6c 20 28 66 6f 72 20 65 78 nal tool (for ex
02f0: 61 6d 70 6c 65 20 74 68 65 20 75 6e 69 78 20 27 ample the unix '
0300: 63 70 27 0a 20 20 20 20 20 20 20 75 74 69 6c 69 cp'. utili
0310: 74 79 20 6f 72 20 74 68 65 20 44 4f 53 20 27 63 ty or the DOS 'c
0320: 6f 70 79 27 20 63 6f 6d 6d 61 6e 64 29 2e 0a 20 opy' command)..
0330: 20 3c 6c 69 3e 20 52 65 6c 69 6e 71 75 69 73 68 <li> Relinquish
0340: 20 74 68 65 20 73 68 61 72 65 64 20 6c 6f 63 6b the shared lock
0350: 20 6f 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 on the database
0360: 20 66 69 6c 65 20 6f 62 74 61 69 6e 65 64 20 69 file obtained i
0370: 6e 20 73 74 65 70 20 31 2e 0a 3c 2f 6f 6c 3e 0a n step 1..</ol>.
0380: 0a 3c 70 3e 0a 20 20 54 68 69 73 20 70 72 6f 63 .<p>. This proc
0390: 65 64 75 72 65 20 77 6f 72 6b 73 20 77 65 6c 6c edure works well
03a0: 20 69 6e 20 6d 61 6e 79 20 73 63 65 6e 61 72 69 in many scenari
03b0: 6f 73 20 61 6e 64 20 69 73 20 75 73 75 61 6c 6c os and is usuall
03c0: 79 20 76 65 72 79 0a 20 20 66 61 73 74 2e 20 48 y very. fast. H
03d0: 6f 77 65 76 65 72 2c 20 74 68 69 73 20 74 65 63 owever, this tec
03e0: 68 6e 69 71 75 65 20 68 61 73 20 74 68 65 20 66 hnique has the f
03f0: 6f 6c 6c 6f 77 69 6e 67 20 73 68 6f 72 74 63 6f ollowing shortco
0400: 6d 69 6e 67 73 3a 0a 0a 3c 75 6c 3e 0a 20 20 3c mings:..<ul>. <
0410: 6c 69 3e 20 41 6e 79 20 64 61 74 61 62 61 73 65 li> Any database
0420: 20 63 6c 69 65 6e 74 73 20 77 69 73 68 69 6e 67 clients wishing
0430: 20 74 6f 20 77 72 69 74 65 20 74 6f 20 74 68 65 to write to the
0440: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 77 database file w
0450: 68 69 6c 65 20 61 0a 20 20 20 20 20 20 20 62 61 hile a. ba
0460: 63 6b 75 70 20 69 73 20 62 65 69 6e 67 20 63 72 ckup is being cr
0470: 65 61 74 65 64 20 6d 75 73 74 20 77 61 69 74 20 eated must wait
0480: 75 6e 74 69 6c 20 74 68 65 20 73 68 61 72 65 64 until the shared
0490: 20 6c 6f 63 6b 20 69 73 0a 20 20 20 20 20 20 20 lock is.
04a0: 72 65 6c 69 6e 71 75 69 73 68 65 64 2e 0a 0a 20 relinquished...
04b0: 20 3c 6c 69 3e 20 49 74 20 63 61 6e 6e 6f 74 20 <li> It cannot
04c0: 62 65 20 75 73 65 64 20 74 6f 20 63 6f 70 79 20 be used to copy
04d0: 64 61 74 61 20 74 6f 20 6f 72 20 66 72 6f 6d 20 data to or from
04e0: 69 6e 2d 6d 65 6d 6f 72 79 20 64 61 74 61 62 61 in-memory databa
04f0: 73 65 73 2e 0a 0a 20 20 3c 6c 69 3e 20 49 66 20 ses... <li> If
0500: 61 20 70 6f 77 65 72 20 66 61 69 6c 75 72 65 20 a power failure
0510: 6f 72 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 or operating sys
0520: 74 65 6d 20 66 61 69 6c 75 72 65 20 6f 63 63 75 tem failure occu
0530: 72 73 20 77 68 69 6c 65 20 63 6f 70 79 69 6e 67 rs while copying
0540: 0a 20 20 20 20 20 20 20 74 68 65 20 64 61 74 61 . the data
0550: 62 61 73 65 20 66 69 6c 65 20 74 68 65 20 62 61 base file the ba
0560: 63 6b 75 70 20 64 61 74 61 62 61 73 65 20 6d 61 ckup database ma
0570: 79 20 62 65 20 63 6f 72 72 75 70 74 65 64 20 66 y be corrupted f
0580: 6f 6c 6c 6f 77 69 6e 67 0a 20 20 20 20 20 20 20 ollowing.
0590: 73 79 73 74 65 6d 20 72 65 63 6f 76 65 72 79 2e system recovery.
05a0: 0a 3c 2f 75 6c 3e 0a 0a 3c 70 3e 0a 20 20 54 68 .</ul>..<p>. Th
05b0: 65 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 e [sqlite3_backu
05c0: 70 5f 69 6e 69 74 20 7c 20 4f 6e 6c 69 6e 65 20 p_init | Online
05d0: 42 61 63 6b 75 70 20 41 50 49 5d 20 77 61 73 20 Backup API] was
05e0: 63 72 65 61 74 65 64 20 74 6f 20 0a 20 20 61 64 created to . ad
05f0: 64 72 65 73 73 20 74 68 65 73 65 20 63 6f 6e 63 dress these conc
0600: 65 72 6e 73 2e 20 54 68 65 20 6f 6e 6c 69 6e 65 erns. The online
0610: 20 62 61 63 6b 75 70 20 41 50 49 20 61 6c 6c 6f backup API allo
0620: 77 73 20 74 68 65 20 63 6f 6e 74 65 6e 74 73 20 ws the contents
0630: 6f 66 0a 20 20 6f 6e 65 20 64 61 74 61 62 61 73 of. one databas
0640: 65 20 74 6f 20 62 65 20 63 6f 70 69 65 64 20 69 e to be copied i
0650: 6e 74 6f 20 61 6e 6f 74 68 65 72 20 64 61 74 61 nto another data
0660: 62 61 73 65 2c 20 6f 76 65 72 77 72 69 74 69 6e base, overwritin
0670: 67 20 74 68 65 20 0a 20 20 6f 72 69 67 69 6e 61 g the . origina
0680: 6c 20 63 6f 6e 74 65 6e 74 73 20 6f 66 20 74 68 l contents of th
0690: 65 20 74 61 72 67 65 74 20 64 61 74 61 62 61 73 e target databas
06a0: 65 2e 20 54 68 65 20 63 6f 70 79 20 6f 70 65 72 e. The copy oper
06b0: 61 74 69 6f 6e 20 6d 61 79 20 62 65 20 0a 20 20 ation may be .
06c0: 64 6f 6e 65 20 69 6e 63 72 65 6d 65 6e 74 61 6c done incremental
06d0: 6c 79 2c 20 69 6e 20 77 68 69 63 68 20 63 61 73 ly, in which cas
06e0: 65 20 74 68 65 20 73 6f 75 72 63 65 20 64 61 74 e the source dat
06f0: 61 62 61 73 65 20 64 6f 65 73 20 6e 6f 74 20 6e abase does not n
0700: 65 65 64 0a 20 20 74 6f 20 62 65 20 6c 6f 63 6b eed. to be lock
0710: 65 64 20 66 6f 72 20 74 68 65 20 64 75 72 61 74 ed for the durat
0720: 69 6f 6e 20 6f 66 20 74 68 65 20 63 6f 70 79 2c ion of the copy,
0730: 20 6f 6e 6c 79 20 66 6f 72 20 74 68 65 20 62 72 only for the br
0740: 69 65 66 20 70 65 72 69 6f 64 73 0a 20 20 6f 66 ief periods. of
0750: 20 74 69 6d 65 20 77 68 65 6e 20 69 74 20 69 73 time when it is
0760: 20 61 63 74 75 61 6c 6c 79 20 62 65 69 6e 67 20 actually being
0770: 72 65 61 64 20 66 72 6f 6d 2e 20 54 68 69 73 20 read from. This
0780: 61 6c 6c 6f 77 73 20 6f 74 68 65 72 20 64 61 74 allows other dat
0790: 61 62 61 73 65 0a 20 20 75 73 65 72 73 20 74 6f abase. users to
07a0: 20 63 6f 6e 74 69 6e 75 65 20 75 6e 69 6e 74 65 continue uninte
07b0: 72 72 75 70 74 65 64 20 77 68 69 6c 65 20 61 20 rrupted while a
07c0: 62 61 63 6b 75 70 20 6f 66 20 61 6e 20 6f 6e 6c backup of an onl
07d0: 69 6e 65 20 64 61 74 61 62 61 73 65 20 69 73 0a ine database is.
07e0: 20 20 6d 61 64 65 2e 0a 0a 3c 70 3e 0a 20 20 54 made...<p>. T
07f0: 68 65 20 6f 6e 6c 69 6e 65 20 62 61 63 6b 75 70 he online backup
0800: 20 41 50 49 20 69 73 20 5b 73 71 6c 69 74 65 33 API is [sqlite3
0810: 5f 62 61 63 6b 75 70 5f 69 6e 69 74 20 7c 20 64 _backup_init | d
0820: 6f 63 75 6d 65 6e 74 65 64 20 68 65 72 65 5d 2e ocumented here].
0830: 0a 20 20 54 68 65 20 72 65 6d 61 69 6e 64 65 72 . The remainder
0840: 20 6f 66 20 74 68 69 73 20 70 61 67 65 20 63 6f of this page co
0850: 6e 74 61 69 6e 73 20 74 77 6f 20 43 20 6c 61 6e ntains two C lan
0860: 67 75 61 67 65 20 65 78 61 6d 70 6c 65 73 20 69 guage examples i
0870: 6c 6c 75 73 74 72 61 74 69 6e 67 20 0a 20 20 63 llustrating . c
0880: 6f 6d 6d 6f 6e 20 75 73 65 73 20 6f 66 20 74 68 ommon uses of th
0890: 65 20 41 50 49 20 61 6e 64 20 64 69 73 63 75 73 e API and discus
08a0: 73 69 6f 6e 73 20 74 68 65 72 65 6f 66 2e 20 52 sions thereof. R
08b0: 65 61 64 69 6e 67 20 74 68 65 73 65 20 65 78 61 eading these exa
08c0: 6d 70 6c 65 73 0a 20 20 69 73 20 6e 6f 20 73 75 mples. is no su
08d0: 62 73 74 69 74 75 74 65 20 66 6f 72 20 72 65 61 bstitute for rea
08e0: 64 69 6e 67 20 74 68 65 20 41 50 49 20 64 6f 63 ding the API doc
08f0: 75 6d 65 6e 74 61 74 69 6f 6e 21 0a 0a 3c 70 3e umentation!..<p>
0900: 0a 20 20 55 70 64 61 74 65 3a 20 54 68 65 20 5b . Update: The [
0910: 56 41 43 55 55 4d 20 49 4e 54 4f 5d 20 63 6f 6d VACUUM INTO] com
0920: 6d 61 6e 64 20 69 6e 74 72 6f 64 75 63 65 64 20 mand introduced
0930: 69 6e 20 0a 20 20 53 51 4c 69 74 65 20 76 65 72 in . SQLite ver
0940: 73 69 6f 6e 20 33 2e 32 37 2e 30 20 28 5b 64 61 sion 3.27.0 ([da
0950: 74 65 6f 66 3a 33 2e 32 37 2e 30 5d 29 20 63 61 teof:3.27.0]) ca
0960: 6e 20 73 65 72 76 65 20 61 73 20 61 6e 0a 20 20 n serve as an.
0970: 61 6c 74 65 72 6e 61 74 69 76 65 20 74 6f 20 74 alternative to t
0980: 68 65 20 62 61 63 6b 75 70 20 41 50 49 2e 0a 0a he backup API...
0990: 3c 68 32 3e 45 78 61 6d 70 6c 65 20 31 3a 20 4c <h2>Example 1: L
09a0: 6f 61 64 69 6e 67 20 61 6e 64 20 53 61 76 69 6e oading and Savin
09b0: 67 20 49 6e 2d 4d 65 6d 6f 72 79 20 44 61 74 61 g In-Memory Data
09c0: 62 61 73 65 73 3c 2f 68 32 3e 0a 0a 3c 74 63 6c bases</h2>..<tcl
09d0: 3e 0a 0a 70 72 6f 63 20 43 5f 43 6f 64 65 20 7b >..proc C_Code {
09e0: 74 65 78 74 7d 20 7b 0a 20 20 68 64 5f 70 75 74 text} {. hd_put
09f0: 73 20 22 3c 70 72 65 3e 5c 6e 22 0a 20 20 73 65 s "<pre>\n". se
0a00: 74 20 69 4c 69 6e 65 20 30 0a 20 20 66 6f 72 65 t iLine 0. fore
0a10: 61 63 68 20 7a 4c 69 6e 65 20 5b 73 70 6c 69 74 ach zLine [split
0a20: 20 5b 73 74 72 69 6e 67 20 74 72 69 6d 20 24 74 [string trim $t
0a30: 65 78 74 20 22 5c 6e 22 5d 20 22 5c 6e 22 5d 20 ext "\n"] "\n"]
0a40: 7b 0a 20 20 20 20 72 65 67 73 75 62 20 7b 5e 20 {. regsub {^
0a50: 20 7d 20 24 7a 4c 69 6e 65 20 7b 7d 20 7a 4c 69 } $zLine {} zLi
0a60: 6e 65 20 0a 20 20 20 20 73 65 74 20 7a 53 75 62 ne . set zSub
0a70: 73 70 65 63 20 7b 3c 73 70 61 6e 20 73 74 79 6c spec {<span styl
0a80: 65 3d 22 63 6f 6c 6f 72 3a 62 6c 75 65 3b 66 6f e="color:blue;fo
0a90: 6e 74 2d 73 74 79 6c 65 3a 69 74 61 6c 69 63 22 nt-style:italic"
0aa0: 3e 26 3c 2f 73 70 61 6e 3e 7d 0a 20 20 20 20 72 >&</span>}. r
0ab0: 65 67 73 75 62 20 7b 28 2f 5c 2a 7c 5c 2a 5c 2a egsub {(/\*|\*\*
0ac0: 7c 5c 2a 2f 29 2e 2a 7d 20 24 7a 4c 69 6e 65 20 |\*/).*} $zLine
0ad0: 24 7a 53 75 62 73 70 65 63 20 7a 4c 69 6e 65 20 $zSubspec zLine
0ae0: 0a 20 20 20 20 69 66 20 7b 5b 72 65 67 65 78 70 . if {[regexp
0af0: 20 7b 28 2e 2a 29 28 73 71 6c 69 74 65 33 5b 61 {(.*)(sqlite3[a
0b00: 2d 7a 30 2d 39 5f 5d 2a 29 28 2e 2a 29 7d 20 24 -z0-9_]*)(.*)} $
0b10: 7a 4c 69 6e 65 20 2d 3e 20 6f 6e 65 20 74 77 6f zLine -> one two
0b20: 20 74 68 72 65 65 5d 7d 20 7b 0a 20 20 20 20 20 three]} {.
0b30: 20 68 64 5f 70 75 74 73 20 24 6f 6e 65 0a 20 20 hd_puts $one.
0b40: 20 20 20 20 68 64 5f 72 65 73 6f 6c 76 65 20 22 hd_resolve "
0b50: 5c 5b 24 74 77 6f 5c 5d 22 0a 20 20 20 20 20 20 \[$two\]".
0b60: 68 64 5f 70 75 74 73 20 24 74 68 72 65 65 0a 20 hd_puts $three.
0b70: 20 20 20 7d 20 65 6c 73 65 20 7b 0a 20 20 20 20 } else {.
0b80: 20 20 68 64 5f 70 75 74 73 20 24 7a 4c 69 6e 65 hd_puts $zLine
0b90: 0a 20 20 20 20 7d 0a 20 20 20 20 68 64 5f 70 75 . }. hd_pu
0ba0: 74 73 20 22 5c 6e 22 0a 20 20 7d 0a 20 20 68 64 ts "\n". }. hd
0bb0: 5f 70 75 74 73 20 22 3c 2f 70 72 65 3e 5c 6e 22 _puts "</pre>\n"
0bc0: 0a 7d 0a 0a 43 5f 43 6f 64 65 20 7b 0a 20 20 2f .}..C_Code {. /
0bd0: 2a 0a 20 20 2a 2a 20 54 68 69 73 20 66 75 6e 63 *. ** This func
0be0: 74 69 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 20 tion is used to
0bf0: 6c 6f 61 64 20 74 68 65 20 63 6f 6e 74 65 6e 74 load the content
0c00: 73 20 6f 66 20 61 20 64 61 74 61 62 61 73 65 20 s of a database
0c10: 66 69 6c 65 20 6f 6e 20 64 69 73 6b 20 0a 20 20 file on disk .
0c20: 2a 2a 20 69 6e 74 6f 20 74 68 65 20 22 6d 61 69 ** into the "mai
0c30: 6e 22 20 64 61 74 61 62 61 73 65 20 6f 66 20 6f n" database of o
0c40: 70 65 6e 20 64 61 74 61 62 61 73 65 20 63 6f 6e pen database con
0c50: 6e 65 63 74 69 6f 6e 20 70 49 6e 4d 65 6d 6f 72 nection pInMemor
0c60: 79 2c 20 6f 72 0a 20 20 2a 2a 20 74 6f 20 73 61 y, or. ** to sa
0c70: 76 65 20 74 68 65 20 63 75 72 72 65 6e 74 20 63 ve the current c
0c80: 6f 6e 74 65 6e 74 73 20 6f 66 20 74 68 65 20 64 ontents of the d
0c90: 61 74 61 62 61 73 65 20 6f 70 65 6e 65 64 20 62 atabase opened b
0ca0: 79 20 70 49 6e 4d 65 6d 6f 72 79 20 69 6e 74 6f y pInMemory into
0cb0: 0a 20 20 2a 2a 20 61 20 64 61 74 61 62 61 73 65 . ** a database
0cc0: 20 66 69 6c 65 20 6f 6e 20 64 69 73 6b 2e 20 70 file on disk. p
0cd0: 49 6e 4d 65 6d 6f 72 79 20 69 73 20 70 72 6f 62 InMemory is prob
0ce0: 61 62 6c 79 20 61 6e 20 69 6e 2d 6d 65 6d 6f 72 ably an in-memor
0cf0: 79 20 64 61 74 61 62 61 73 65 2c 20 0a 20 20 2a y database, . *
0d00: 2a 20 62 75 74 20 74 68 69 73 20 66 75 6e 63 74 * but this funct
0d10: 69 6f 6e 20 77 69 6c 6c 20 61 6c 73 6f 20 77 6f ion will also wo
0d20: 72 6b 20 66 69 6e 65 20 69 66 20 69 74 20 69 73 rk fine if it is
0d30: 20 6e 6f 74 2e 0a 20 20 2a 2a 0a 20 20 2a 2a 20 not.. **. **
0d40: 50 61 72 61 6d 65 74 65 72 20 7a 46 69 6c 65 6e Parameter zFilen
0d50: 61 6d 65 20 70 6f 69 6e 74 73 20 74 6f 20 61 20 ame points to a
0d60: 6e 75 6c 2d 74 65 72 6d 69 6e 61 74 65 64 20 73 nul-terminated s
0d70: 74 72 69 6e 67 20 63 6f 6e 74 61 69 6e 69 6e 67 tring containing
0d80: 20 74 68 65 0a 20 20 2a 2a 20 6e 61 6d 65 20 6f the. ** name o
0d90: 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 f the database f
0da0: 69 6c 65 20 6f 6e 20 64 69 73 6b 20 74 6f 20 6c ile on disk to l
0db0: 6f 61 64 20 66 72 6f 6d 20 6f 72 20 73 61 76 65 oad from or save
0dc0: 20 74 6f 2e 20 49 66 20 70 61 72 61 6d 65 74 65 to. If paramete
0dd0: 72 0a 20 20 2a 2a 20 69 73 53 61 76 65 20 69 73 r. ** isSave is
0de0: 20 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65 6e 20 non-zero, then
0df0: 74 68 65 20 63 6f 6e 74 65 6e 74 73 20 6f 66 20 the contents of
0e00: 74 68 65 20 66 69 6c 65 20 7a 46 69 6c 65 6e 61 the file zFilena
0e10: 6d 65 20 61 72 65 20 0a 20 20 2a 2a 20 6f 76 65 me are . ** ove
0e20: 72 77 72 69 74 74 65 6e 20 77 69 74 68 20 74 68 rwritten with th
0e30: 65 20 63 6f 6e 74 65 6e 74 73 20 6f 66 20 74 68 e contents of th
0e40: 65 20 64 61 74 61 62 61 73 65 20 6f 70 65 6e 65 e database opene
0e50: 64 20 62 79 20 70 49 6e 4d 65 6d 6f 72 79 2e 20 d by pInMemory.
0e60: 49 66 0a 20 20 2a 2a 20 70 61 72 61 6d 65 74 65 If. ** paramete
0e70: 72 20 69 73 53 61 76 65 20 69 73 20 7a 65 72 6f r isSave is zero
0e80: 2c 20 74 68 65 6e 20 74 68 65 20 63 6f 6e 74 65 , then the conte
0e90: 6e 74 73 20 6f 66 20 74 68 65 20 64 61 74 61 62 nts of the datab
0ea0: 61 73 65 20 6f 70 65 6e 65 64 20 62 79 0a 20 20 ase opened by.
0eb0: 2a 2a 20 70 49 6e 4d 65 6d 6f 72 79 20 61 72 65 ** pInMemory are
0ec0: 20 72 65 70 6c 61 63 65 64 20 62 79 20 64 61 74 replaced by dat
0ed0: 61 20 6c 6f 61 64 65 64 20 66 72 6f 6d 20 74 68 a loaded from th
0ee0: 65 20 66 69 6c 65 20 7a 46 69 6c 65 6e 61 6d 65 e file zFilename
0ef0: 2e 0a 20 20 2a 2a 0a 20 20 2a 2a 20 49 66 20 74 .. **. ** If t
0f00: 68 65 20 6f 70 65 72 61 74 69 6f 6e 20 69 73 20 he operation is
0f10: 73 75 63 63 65 73 73 66 75 6c 2c 20 53 51 4c 49 successful, SQLI
0f20: 54 45 5f 4f 4b 20 69 73 20 72 65 74 75 72 6e 65 TE_OK is returne
0f30: 64 2e 20 4f 74 68 65 72 77 69 73 65 2c 20 69 66 d. Otherwise, if
0f40: 0a 20 20 2a 2a 20 61 6e 20 65 72 72 6f 72 20 6f . ** an error o
0f50: 63 63 75 72 73 2c 20 61 6e 20 53 51 4c 69 74 65 ccurs, an SQLite
0f60: 20 65 72 72 6f 72 20 63 6f 64 65 20 69 73 20 72 error code is r
0f70: 65 74 75 72 6e 65 64 2e 0a 20 20 2a 2f 0a 20 20 eturned.. */.
0f80: 69 6e 74 20 6c 6f 61 64 4f 72 53 61 76 65 44 62 int loadOrSaveDb
0f90: 28 73 71 6c 69 74 65 33 20 2a 70 49 6e 4d 65 6d (sqlite3 *pInMem
0fa0: 6f 72 79 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 ory, const char
0fb0: 2a 7a 46 69 6c 65 6e 61 6d 65 2c 20 69 6e 74 20 *zFilename, int
0fc0: 69 73 53 61 76 65 29 7b 0a 20 20 20 20 69 6e 74 isSave){. int
0fd0: 20 72 63 3b 20 20 20 20 20 20 20 20 20 20 20 20 rc;
0fe0: 20 20 20 20 20 20 20 2f 2a 20 46 75 6e 63 74 69 /* Functi
0ff0: 6f 6e 20 72 65 74 75 72 6e 20 63 6f 64 65 20 2a on return code *
1000: 2f 0a 20 20 20 20 73 71 6c 69 74 65 33 20 2a 70 /. sqlite3 *p
1010: 46 69 6c 65 3b 20 20 20 20 20 20 20 20 20 20 20 File;
1020: 2f 2a 20 44 61 74 61 62 61 73 65 20 63 6f 6e 6e /* Database conn
1030: 65 63 74 69 6f 6e 20 6f 70 65 6e 65 64 20 6f 6e ection opened on
1040: 20 7a 46 69 6c 65 6e 61 6d 65 20 2a 2f 0a 20 20 zFilename */.
1050: 20 20 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 sqlite3_backup
1060: 20 2a 70 42 61 63 6b 75 70 3b 20 20 2f 2a 20 42 *pBackup; /* B
1070: 61 63 6b 75 70 20 6f 62 6a 65 63 74 20 75 73 65 ackup object use
1080: 64 20 74 6f 20 63 6f 70 79 20 64 61 74 61 20 2a d to copy data *
1090: 2f 0a 20 20 20 20 73 71 6c 69 74 65 33 20 2a 70 /. sqlite3 *p
10a0: 54 6f 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 To;
10b0: 2f 2a 20 44 61 74 61 62 61 73 65 20 74 6f 20 63 /* Database to c
10c0: 6f 70 79 20 74 6f 20 28 70 46 69 6c 65 20 6f 72 opy to (pFile or
10d0: 20 70 49 6e 4d 65 6d 6f 72 79 29 20 2a 2f 0a 20 pInMemory) */.
10e0: 20 20 20 73 71 6c 69 74 65 33 20 2a 70 46 72 6f sqlite3 *pFro
10f0: 6d 3b 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 m; /*
1100: 44 61 74 61 62 61 73 65 20 74 6f 20 63 6f 70 79 Database to copy
1110: 20 66 72 6f 6d 20 28 70 46 69 6c 65 20 6f 72 20 from (pFile or
1120: 70 49 6e 4d 65 6d 6f 72 79 29 20 2a 2f 0a 0a 20 pInMemory) */..
1130: 20 20 20 2f 2a 20 4f 70 65 6e 20 74 68 65 20 64 /* Open the d
1140: 61 74 61 62 61 73 65 20 66 69 6c 65 20 69 64 65 atabase file ide
1150: 6e 74 69 66 69 65 64 20 62 79 20 7a 46 69 6c 65 ntified by zFile
1160: 6e 61 6d 65 2e 20 45 78 69 74 20 65 61 72 6c 79 name. Exit early
1170: 20 69 66 20 74 68 69 73 20 66 61 69 6c 73 0a 20 if this fails.
1180: 20 20 20 2a 2a 20 66 6f 72 20 61 6e 79 20 72 65 ** for any re
1190: 61 73 6f 6e 2e 20 2a 2f 0a 20 20 20 20 72 63 20 ason. */. rc
11a0: 3d 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 7a = sqlite3_open(z
11b0: 46 69 6c 65 6e 61 6d 65 2c 20 26 70 46 69 6c 65 Filename, &pFile
11c0: 29 3b 0a 20 20 20 20 69 66 28 20 72 63 3d 3d 53 );. if( rc==S
11d0: 51 4c 49 54 45 5f 4f 4b 20 29 7b 0a 20 20 0a 20 QLITE_OK ){. .
11e0: 20 20 20 20 20 2f 2a 20 49 66 20 74 68 69 73 20 /* If this
11f0: 69 73 20 61 20 27 6c 6f 61 64 27 20 6f 70 65 72 is a 'load' oper
1200: 61 74 69 6f 6e 20 28 69 73 53 61 76 65 3d 3d 30 ation (isSave==0
1210: 29 2c 20 74 68 65 6e 20 64 61 74 61 20 69 73 20 ), then data is
1220: 63 6f 70 69 65 64 0a 20 20 20 20 20 20 2a 2a 20 copied. **
1230: 66 72 6f 6d 20 74 68 65 20 64 61 74 61 62 61 73 from the databas
1240: 65 20 66 69 6c 65 20 6a 75 73 74 20 6f 70 65 6e e file just open
1250: 65 64 20 74 6f 20 64 61 74 61 62 61 73 65 20 70 ed to database p
1260: 49 6e 4d 65 6d 6f 72 79 2e 20 0a 20 20 20 20 20 InMemory. .
1270: 20 2a 2a 20 4f 74 68 65 72 77 69 73 65 2c 20 69 ** Otherwise, i
1280: 66 20 74 68 69 73 20 69 73 20 61 20 27 73 61 76 f this is a 'sav
1290: 65 27 20 6f 70 65 72 61 74 69 6f 6e 20 28 69 73 e' operation (is
12a0: 53 61 76 65 3d 3d 31 29 2c 20 74 68 65 6e 20 64 Save==1), then d
12b0: 61 74 61 0a 20 20 20 20 20 20 2a 2a 20 69 73 20 ata. ** is
12c0: 63 6f 70 69 65 64 20 66 72 6f 6d 20 70 49 6e 4d copied from pInM
12d0: 65 6d 6f 72 79 20 74 6f 20 70 46 69 6c 65 2e 20 emory to pFile.
12e0: 20 53 65 74 20 74 68 65 20 76 61 72 69 61 62 6c Set the variabl
12f0: 65 73 20 70 46 72 6f 6d 20 61 6e 64 0a 20 20 20 es pFrom and.
1300: 20 20 20 2a 2a 20 70 54 6f 20 61 63 63 6f 72 64 ** pTo accord
1310: 69 6e 67 6c 79 2e 20 2a 2f 0a 20 20 20 20 20 20 ingly. */.
1320: 70 46 72 6f 6d 20 3d 20 28 69 73 53 61 76 65 20 pFrom = (isSave
1330: 3f 20 70 49 6e 4d 65 6d 6f 72 79 20 3a 20 70 46 ? pInMemory : pF
1340: 69 6c 65 29 3b 0a 20 20 20 20 20 20 70 54 6f 20 ile);. pTo
1350: 20 20 3d 20 28 69 73 53 61 76 65 20 3f 20 70 46 = (isSave ? pF
1360: 69 6c 65 20 20 20 20 20 3a 20 70 49 6e 4d 65 6d ile : pInMem
1370: 6f 72 79 29 3b 0a 20 20 0a 20 20 20 20 20 20 2f ory);. . /
1380: 2a 20 53 65 74 20 75 70 20 74 68 65 20 62 61 63 * Set up the bac
1390: 6b 75 70 20 70 72 6f 63 65 64 75 72 65 20 74 6f kup procedure to
13a0: 20 63 6f 70 79 20 66 72 6f 6d 20 74 68 65 20 22 copy from the "
13b0: 6d 61 69 6e 22 20 64 61 74 61 62 61 73 65 20 6f main" database o
13c0: 66 20 0a 20 20 20 20 20 20 2a 2a 20 63 6f 6e 6e f . ** conn
13d0: 65 63 74 69 6f 6e 20 70 46 69 6c 65 20 74 6f 20 ection pFile to
13e0: 74 68 65 20 6d 61 69 6e 20 64 61 74 61 62 61 73 the main databas
13f0: 65 20 6f 66 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 e of connection
1400: 70 49 6e 4d 65 6d 6f 72 79 2e 0a 20 20 20 20 20 pInMemory..
1410: 20 2a 2a 20 49 66 20 73 6f 6d 65 74 68 69 6e 67 ** If something
1420: 20 67 6f 65 73 20 77 72 6f 6e 67 2c 20 70 42 61 goes wrong, pBa
1430: 63 6b 75 70 20 77 69 6c 6c 20 62 65 20 73 65 74 ckup will be set
1440: 20 74 6f 20 4e 55 4c 4c 20 61 6e 64 20 61 6e 20 to NULL and an
1450: 65 72 72 6f 72 0a 20 20 20 20 20 20 2a 2a 20 63 error. ** c
1460: 6f 64 65 20 61 6e 64 20 6d 65 73 73 61 67 65 20 ode and message
1470: 6c 65 66 74 20 69 6e 20 63 6f 6e 6e 65 63 74 69 left in connecti
1480: 6f 6e 20 70 54 6f 2e 0a 20 20 20 20 20 20 2a 2a on pTo.. **
1490: 0a 20 20 20 20 20 20 2a 2a 20 49 66 20 74 68 65 . ** If the
14a0: 20 62 61 63 6b 75 70 20 6f 62 6a 65 63 74 20 69 backup object i
14b0: 73 20 73 75 63 63 65 73 73 66 75 6c 6c 79 20 63 s successfully c
14c0: 72 65 61 74 65 64 2c 20 63 61 6c 6c 20 62 61 63 reated, call bac
14d0: 6b 75 70 5f 73 74 65 70 28 29 0a 20 20 20 20 20 kup_step().
14e0: 20 2a 2a 20 74 6f 20 63 6f 70 79 20 64 61 74 61 ** to copy data
14f0: 20 66 72 6f 6d 20 70 46 69 6c 65 20 74 6f 20 70 from pFile to p
1500: 49 6e 4d 65 6d 6f 72 79 2e 20 54 68 65 6e 20 63 InMemory. Then c
1510: 61 6c 6c 20 62 61 63 6b 75 70 5f 66 69 6e 69 73 all backup_finis
1520: 68 28 29 0a 20 20 20 20 20 20 2a 2a 20 74 6f 20 h(). ** to
1530: 72 65 6c 65 61 73 65 20 72 65 73 6f 75 72 63 65 release resource
1540: 73 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 s associated wit
1550: 68 20 74 68 65 20 70 42 61 63 6b 75 70 20 6f 62 h the pBackup ob
1560: 6a 65 63 74 2e 20 20 49 66 20 61 6e 0a 20 20 20 ject. If an.
1570: 20 20 20 2a 2a 20 65 72 72 6f 72 20 6f 63 63 75 ** error occu
1580: 72 72 65 64 2c 20 74 68 65 6e 20 61 6e 20 65 72 rred, then an er
1590: 72 6f 72 20 63 6f 64 65 20 61 6e 64 20 6d 65 73 ror code and mes
15a0: 73 61 67 65 20 77 69 6c 6c 20 62 65 20 6c 65 66 sage will be lef
15b0: 74 20 69 6e 0a 20 20 20 20 20 20 2a 2a 20 63 6f t in. ** co
15c0: 6e 6e 65 63 74 69 6f 6e 20 70 54 6f 2e 20 49 66 nnection pTo. If
15d0: 20 6e 6f 20 65 72 72 6f 72 20 6f 63 63 75 72 72 no error occurr
15e0: 65 64 2c 20 74 68 65 6e 20 74 68 65 20 65 72 72 ed, then the err
15f0: 6f 72 20 63 6f 64 65 20 62 65 6c 6f 6e 67 69 6e or code belongin
1600: 67 0a 20 20 20 20 20 20 2a 2a 20 74 6f 20 70 54 g. ** to pT
1610: 6f 20 69 73 20 73 65 74 20 74 6f 20 53 51 4c 49 o is set to SQLI
1620: 54 45 5f 4f 4b 2e 0a 20 20 20 20 20 20 2a 2f 0a TE_OK.. */.
1630: 20 20 20 20 20 20 70 42 61 63 6b 75 70 20 3d 20 pBackup =
1640: 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f 69 sqlite3_backup_i
1650: 6e 69 74 28 70 54 6f 2c 20 22 6d 61 69 6e 22 2c nit(pTo, "main",
1660: 20 70 46 72 6f 6d 2c 20 22 6d 61 69 6e 22 29 3b pFrom, "main");
1670: 0a 20 20 20 20 20 20 69 66 28 20 70 42 61 63 6b . if( pBack
1680: 75 70 20 29 7b 0a 20 20 20 20 20 20 20 20 28 76 up ){. (v
1690: 6f 69 64 29 73 71 6c 69 74 65 33 5f 62 61 63 6b oid)sqlite3_back
16a0: 75 70 5f 73 74 65 70 28 70 42 61 63 6b 75 70 2c up_step(pBackup,
16b0: 20 2d 31 29 3b 0a 20 20 20 20 20 20 20 20 28 76 -1);. (v
16c0: 6f 69 64 29 73 71 6c 69 74 65 33 5f 62 61 63 6b oid)sqlite3_back
16d0: 75 70 5f 66 69 6e 69 73 68 28 70 42 61 63 6b 75 up_finish(pBacku
16e0: 70 29 3b 0a 20 20 20 20 20 20 7d 0a 20 20 20 20 p);. }.
16f0: 20 20 72 63 20 3d 20 73 71 6c 69 74 65 33 5f 65 rc = sqlite3_e
1700: 72 72 63 6f 64 65 28 70 54 6f 29 3b 0a 20 20 20 rrcode(pTo);.
1710: 20 7d 0a 0a 20 20 20 20 2f 2a 20 43 6c 6f 73 65 }.. /* Close
1720: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f the database co
1730: 6e 6e 65 63 74 69 6f 6e 20 6f 70 65 6e 65 64 20 nnection opened
1740: 6f 6e 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 on database file
1750: 20 7a 46 69 6c 65 6e 61 6d 65 0a 20 20 20 20 2a zFilename. *
1760: 2a 20 61 6e 64 20 72 65 74 75 72 6e 20 74 68 65 * and return the
1770: 20 72 65 73 75 6c 74 20 6f 66 20 74 68 69 73 20 result of this
1780: 66 75 6e 63 74 69 6f 6e 2e 20 2a 2f 0a 20 20 20 function. */.
1790: 20 28 76 6f 69 64 29 73 71 6c 69 74 65 33 5f 63 (void)sqlite3_c
17a0: 6c 6f 73 65 28 70 46 69 6c 65 29 3b 0a 20 20 20 lose(pFile);.
17b0: 20 72 65 74 75 72 6e 20 72 63 3b 0a 20 20 7d 0a return rc;. }.
17c0: 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 0a 20 20 }.</tcl>..<p>.
17d0: 54 68 65 20 43 20 66 75 6e 63 74 69 6f 6e 20 74 The C function t
17e0: 6f 20 74 68 65 20 72 69 67 68 74 20 64 65 6d 6f o the right demo
17f0: 6e 73 74 72 61 74 65 73 20 6f 6e 65 20 6f 66 20 nstrates one of
1800: 74 68 65 20 73 69 6d 70 6c 65 73 74 2c 0a 20 20 the simplest,.
1810: 61 6e 64 20 6d 6f 73 74 20 63 6f 6d 6d 6f 6e 2c and most common,
1820: 20 75 73 65 73 20 6f 66 20 74 68 65 20 62 61 63 uses of the bac
1830: 6b 75 70 20 41 50 49 3a 20 6c 6f 61 64 69 6e 67 kup API: loading
1840: 20 61 6e 64 20 73 61 76 69 6e 67 20 74 68 65 20 and saving the
1850: 63 6f 6e 74 65 6e 74 73 0a 20 20 6f 66 20 61 6e contents. of an
1860: 20 69 6e 2d 6d 65 6d 6f 72 79 20 64 61 74 61 62 in-memory datab
1870: 61 73 65 20 74 6f 20 61 20 66 69 6c 65 20 6f 6e ase to a file on
1880: 20 64 69 73 6b 2e 20 54 68 65 20 62 61 63 6b 75 disk. The backu
1890: 70 20 41 50 49 20 69 73 20 75 73 65 64 20 61 73 p API is used as
18a0: 0a 20 20 66 6f 6c 6c 6f 77 73 20 69 6e 20 74 68 . follows in th
18b0: 69 73 20 65 78 61 6d 70 6c 65 3a 0a 0a 20 20 3c is example:.. <
18c0: 6f 6c 3e 0a 20 20 20 20 3c 6c 69 3e 46 75 6e 63 ol>. <li>Func
18d0: 74 69 6f 6e 20 5b 73 71 6c 69 74 65 33 5f 62 61 tion [sqlite3_ba
18e0: 63 6b 75 70 5f 69 6e 69 74 28 29 5d 20 69 73 20 ckup_init()] is
18f0: 63 61 6c 6c 65 64 20 74 6f 20 63 72 65 61 74 65 called to create
1900: 20 61 6e 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 an [sqlite3_bac
1910: 6b 75 70 5d 0a 20 20 20 20 20 20 20 20 6f 62 6a kup]. obj
1920: 65 63 74 20 74 6f 20 63 6f 70 79 20 64 61 74 61 ect to copy data
1930: 20 62 65 74 77 65 65 6e 20 74 68 65 20 74 77 6f between the two
1940: 20 64 61 74 61 62 61 73 65 73 20 28 65 69 74 68 databases (eith
1950: 65 72 20 66 72 6f 6d 20 61 20 66 69 6c 65 20 61 er from a file a
1960: 6e 64 0a 20 20 20 20 20 20 20 20 69 6e 74 6f 20 nd. into
1970: 74 68 65 20 69 6e 2d 6d 65 6d 6f 72 79 20 64 61 the in-memory da
1980: 74 61 62 61 73 65 2c 20 6f 72 20 76 69 63 65 2d tabase, or vice-
1990: 76 65 72 73 61 29 2e 0a 20 20 20 20 3c 6c 69 3e versa).. <li>
19a0: 46 75 6e 63 74 69 6f 6e 20 5b 73 71 6c 69 74 65 Function [sqlite
19b0: 33 5f 62 61 63 6b 75 70 5f 73 74 65 70 28 29 5d 3_backup_step()]
19c0: 20 69 73 20 63 61 6c 6c 65 64 20 77 69 74 68 20 is called with
19d0: 61 20 70 61 72 61 6d 65 74 65 72 20 6f 66 20 0a a parameter of .
19e0: 20 20 20 20 20 20 20 20 3c 74 74 3e 2d 31 3c 2f <tt>-1</
19f0: 74 74 3e 20 74 6f 20 63 6f 70 79 20 74 68 65 20 tt> to copy the
1a00: 65 6e 74 69 72 65 20 73 6f 75 72 63 65 20 64 61 entire source da
1a10: 74 61 62 61 73 65 20 74 6f 20 74 68 65 20 64 65 tabase to the de
1a20: 73 74 69 6e 61 74 69 6f 6e 2e 0a 20 20 20 20 3c stination.. <
1a30: 6c 69 3e 46 75 6e 63 74 69 6f 6e 20 5b 73 71 6c li>Function [sql
1a40: 69 74 65 33 5f 62 61 63 6b 75 70 5f 66 69 6e 69 ite3_backup_fini
1a50: 73 68 28 29 5d 20 69 73 20 63 61 6c 6c 65 64 20 sh()] is called
1a60: 74 6f 20 63 6c 65 61 6e 20 75 70 20 72 65 73 6f to clean up reso
1a70: 75 72 63 65 73 0a 20 20 20 20 20 20 20 20 61 6c urces. al
1a80: 6c 6f 63 61 74 65 64 20 62 79 20 5b 73 71 6c 69 located by [sqli
1a90: 74 65 33 5f 62 61 63 6b 75 70 5f 69 6e 69 74 28 te3_backup_init(
1aa0: 29 5d 2e 0a 20 20 3c 2f 6f 6c 3e 0a 0a 3c 70 3e )].. </ol>..<p>
1ab0: 3c 62 3e 45 72 72 6f 72 20 68 61 6e 64 6c 69 6e <b>Error handlin
1ac0: 67 3c 2f 62 3e 0a 0a 3c 70 3e 0a 20 20 49 66 20 g</b>..<p>. If
1ad0: 61 6e 20 65 72 72 6f 72 20 6f 63 63 75 72 73 20 an error occurs
1ae0: 69 6e 20 61 6e 79 20 6f 66 20 74 68 65 20 74 68 in any of the th
1af0: 72 65 65 20 6d 61 69 6e 20 62 61 63 6b 75 70 20 ree main backup
1b00: 41 50 49 20 72 6f 75 74 69 6e 65 73 0a 20 20 74 API routines. t
1b10: 68 65 6e 20 74 68 65 20 5b 65 72 72 6f 72 20 63 hen the [error c
1b20: 6f 64 65 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 ode] and [sqlite
1b30: 33 5f 65 72 72 6d 73 67 20 7c 20 6d 65 73 73 61 3_errmsg | messa
1b40: 67 65 5d 20 61 72 65 20 61 74 74 61 63 68 65 64 ge] are attached
1b50: 20 74 6f 0a 20 20 74 68 65 20 64 65 73 74 69 6e to. the destin
1b60: 61 74 69 6f 6e 20 5b 64 61 74 61 62 61 73 65 20 ation [database
1b70: 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 0a 20 20 41 connection].. A
1b80: 64 64 69 74 69 6f 6e 61 6c 6c 79 2c 20 69 66 0a dditionally, if.
1b90: 20 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 [sqlite3_backu
1ba0: 70 5f 73 74 65 70 28 29 5d 20 65 6e 63 6f 75 6e p_step()] encoun
1bb0: 74 65 72 73 20 61 6e 20 65 72 72 6f 72 2c 20 74 ters an error, t
1bc0: 68 65 6e 20 74 68 65 20 5b 65 72 72 6f 72 20 63 hen the [error c
1bd0: 6f 64 65 5d 20 69 73 20 72 65 74 75 72 6e 65 64 ode] is returned
1be0: 0a 20 20 62 79 20 62 6f 74 68 20 74 68 65 20 5b . by both the [
1bf0: 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f 73 sqlite3_backup_s
1c00: 74 65 70 28 29 5d 20 63 61 6c 6c 20 69 74 73 65 tep()] call itse
1c10: 6c 66 2c 20 61 6e 64 20 62 79 20 74 68 65 20 73 lf, and by the s
1c20: 75 62 73 65 71 75 65 6e 74 20 63 61 6c 6c 0a 20 ubsequent call.
1c30: 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 to [sqlite3_bac
1c40: 6b 75 70 5f 66 69 6e 69 73 68 28 29 5d 2e 20 53 kup_finish()]. S
1c50: 6f 20 61 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c o a call to [sql
1c60: 69 74 65 33 5f 62 61 63 6b 75 70 5f 66 69 6e 69 ite3_backup_fini
1c70: 73 68 28 29 5d 0a 20 20 64 6f 65 73 20 6e 6f 74 sh()]. does not
1c80: 20 6f 76 65 72 77 72 69 74 65 20 61 6e 20 5b 65 overwrite an [e
1c90: 72 72 6f 72 20 63 6f 64 65 5d 20 73 74 6f 72 65 rror code] store
1ca0: 64 20 69 6e 20 74 68 65 20 64 65 73 74 69 6e 61 d in the destina
1cb0: 74 69 6f 6e 0a 20 20 5b 64 61 74 61 62 61 73 65 tion. [database
1cc0: 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 62 79 20 connection] by
1cd0: 5b 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f [sqlite3_backup_
1ce0: 73 74 65 70 28 29 5d 2e 20 20 54 68 69 73 20 66 step()]. This f
1cf0: 65 61 74 75 72 65 0a 20 20 69 73 20 75 73 65 64 eature. is used
1d00: 20 69 6e 20 74 68 65 20 65 78 61 6d 70 6c 65 20 in the example
1d10: 63 6f 64 65 20 74 6f 20 72 65 64 75 63 65 20 61 code to reduce a
1d20: 6d 6f 75 6e 74 20 6f 66 20 65 72 72 6f 72 20 68 mount of error h
1d30: 61 6e 64 6c 69 6e 67 20 72 65 71 75 69 72 65 64 andling required
1d40: 2e 0a 20 20 54 68 65 20 72 65 74 75 72 6e 20 76 .. The return v
1d50: 61 6c 75 65 73 20 6f 66 20 74 68 65 20 5b 73 71 alues of the [sq
1d60: 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f 73 74 65 lite3_backup_ste
1d70: 70 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 p()] and [sqlite
1d80: 33 5f 62 61 63 6b 75 70 5f 66 69 6e 69 73 68 28 3_backup_finish(
1d90: 29 5d 0a 20 20 63 61 6c 6c 73 20 61 72 65 20 69 )]. calls are i
1da0: 67 6e 6f 72 65 64 20 61 6e 64 20 74 68 65 20 65 gnored and the e
1db0: 72 72 6f 72 20 63 6f 64 65 20 69 6e 64 69 63 61 rror code indica
1dc0: 74 69 6e 67 20 74 68 65 20 73 75 63 63 65 73 73 ting the success
1dd0: 20 6f 72 20 66 61 69 6c 75 72 65 20 6f 66 0a 20 or failure of.
1de0: 20 74 68 65 20 63 6f 70 79 20 6f 70 65 72 61 74 the copy operat
1df0: 69 6f 6e 20 63 6f 6c 6c 65 63 74 65 64 20 66 72 ion collected fr
1e00: 6f 6d 20 74 68 65 20 64 65 73 74 69 6e 61 74 69 om the destinati
1e10: 6f 6e 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e on [database con
1e20: 6e 65 63 74 69 6f 6e 5d 0a 20 20 61 66 74 65 72 nection]. after
1e30: 77 61 72 64 2e 0a 0a 3c 70 3e 3c 62 3e 50 6f 73 ward...<p><b>Pos
1e40: 73 69 62 6c 65 20 45 6e 68 61 6e 63 65 6d 65 6e sible Enhancemen
1e50: 74 73 3c 2f 62 3e 0a 0a 3c 70 3e 0a 20 20 54 68 ts</b>..<p>. Th
1e60: 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e e implementation
1e70: 20 6f 66 20 74 68 69 73 20 66 75 6e 63 74 69 6f of this functio
1e80: 6e 20 63 6f 75 6c 64 20 62 65 20 65 6e 68 61 6e n could be enhan
1e90: 63 65 64 20 69 6e 20 61 74 20 6c 65 61 73 74 20 ced in at least
1ea0: 74 77 6f 20 77 61 79 73 3a 0a 0a 20 20 3c 6f 6c two ways:.. <ol
1eb0: 3e 0a 20 20 20 20 3c 6c 69 3e 20 46 61 69 6c 69 >. <li> Faili
1ec0: 6e 67 20 74 6f 20 6f 62 74 61 69 6e 20 74 68 65 ng to obtain the
1ed0: 20 6c 6f 63 6b 20 6f 6e 20 64 61 74 61 62 61 73 lock on databas
1ee0: 65 20 66 69 6c 65 20 7a 46 69 6c 65 6e 61 6d 65 e file zFilename
1ef0: 20 28 61 6e 20 5b 53 51 4c 49 54 45 5f 42 55 53 (an [SQLITE_BUS
1f00: 59 5d 0a 20 20 20 20 20 20 20 20 20 65 72 72 6f Y]. erro
1f10: 72 29 20 63 6f 75 6c 64 20 62 65 20 68 61 6e 64 r) could be hand
1f20: 6c 65 64 2c 20 61 6e 64 0a 20 20 20 20 3c 6c 69 led, and. <li
1f30: 3e 20 43 61 73 65 73 20 77 68 65 72 65 20 74 68 > Cases where th
1f40: 65 20 70 61 67 65 2d 73 69 7a 65 73 20 6f 66 20 e page-sizes of
1f50: 64 61 74 61 62 61 73 65 20 70 49 6e 4d 65 6d 6f database pInMemo
1f60: 72 79 20 61 6e 64 20 7a 46 69 6c 65 6e 61 6d 65 ry and zFilename
1f70: 20 61 72 65 0a 20 20 20 20 20 20 20 20 20 64 69 are. di
1f80: 66 66 65 72 65 6e 74 20 63 6f 75 6c 64 20 62 65 fferent could be
1f90: 20 68 61 6e 64 6c 65 64 20 62 65 74 74 65 72 2e handled better.
1fa0: 0a 20 20 3c 2f 6f 6c 3e 0a 0a 3c 70 3e 0a 20 20 . </ol>..<p>.
1fb0: 53 69 6e 63 65 20 64 61 74 61 62 61 73 65 20 7a Since database z
1fc0: 46 69 6c 65 6e 61 6d 65 20 69 73 20 61 20 66 69 Filename is a fi
1fd0: 6c 65 20 6f 6e 20 64 69 73 6b 2c 20 74 68 65 6e le on disk, then
1fe0: 20 69 74 20 6d 61 79 20 62 65 20 61 63 63 65 73 it may be acces
1ff0: 73 65 64 20 0a 20 20 65 78 74 65 72 6e 61 6c 6c sed . externall
2000: 79 20 62 79 20 61 6e 6f 74 68 65 72 20 70 72 6f y by another pro
2010: 63 65 73 73 2e 20 54 68 69 73 20 6d 65 61 6e 73 cess. This means
2020: 20 74 68 61 74 20 77 68 65 6e 20 74 68 65 20 63 that when the c
2030: 61 6c 6c 20 74 6f 0a 20 20 73 71 6c 69 74 65 33 all to. sqlite3
2040: 5f 62 61 63 6b 75 70 5f 73 74 65 70 28 29 20 61 _backup_step() a
2050: 74 74 65 6d 70 74 73 20 74 6f 20 72 65 61 64 20 ttempts to read
2060: 66 72 6f 6d 20 6f 72 20 77 72 69 74 65 20 64 61 from or write da
2070: 74 61 20 74 6f 20 69 74 2c 20 69 74 20 6d 61 79 ta to it, it may
2080: 0a 20 20 66 61 69 6c 20 74 6f 20 6f 62 74 61 69 . fail to obtai
2090: 6e 20 74 68 65 20 72 65 71 75 69 72 65 64 20 66 n the required f
20a0: 69 6c 65 20 6c 6f 63 6b 2e 20 49 66 20 74 68 69 ile lock. If thi
20b0: 73 20 68 61 70 70 65 6e 73 2c 20 74 68 69 73 20 s happens, this
20c0: 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 0a 20 implementation.
20d0: 20 77 69 6c 6c 20 66 61 69 6c 2c 20 72 65 74 75 will fail, retu
20e0: 72 6e 69 6e 67 20 53 51 4c 49 54 45 5f 42 55 53 rning SQLITE_BUS
20f0: 59 20 69 6d 6d 65 64 69 61 74 65 6c 79 2e 20 54 Y immediately. T
2100: 68 65 20 73 6f 6c 75 74 69 6f 6e 20 77 6f 75 6c he solution woul
2110: 64 20 62 65 20 74 6f 0a 20 20 72 65 67 69 73 74 d be to. regist
2120: 65 72 20 61 20 62 75 73 79 2d 68 61 6e 64 6c 65 er a busy-handle
2130: 72 20 63 61 6c 6c 62 61 63 6b 20 6f 72 20 0a 20 r callback or .
2140: 20 74 69 6d 65 6f 75 74 20 77 69 74 68 20 5b 64 timeout with [d
2150: 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 atabase connecti
2160: 6f 6e 5d 20 70 46 69 6c 65 20 0a 20 20 75 73 69 on] pFile . usi
2170: 6e 67 20 5b 73 71 6c 69 74 65 33 5f 62 75 73 79 ng [sqlite3_busy
2180: 5f 68 61 6e 64 6c 65 72 28 29 5d 20 6f 72 20 5b _handler()] or [
2190: 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 74 69 6d sqlite3_busy_tim
21a0: 65 6f 75 74 28 29 5d 0a 20 20 61 73 20 73 6f 6f eout()]. as soo
21b0: 6e 20 61 73 20 69 74 20 69 73 20 6f 70 65 6e 65 n as it is opene
21c0: 64 2e 20 49 66 20 69 74 20 66 61 69 6c 73 20 74 d. If it fails t
21d0: 6f 20 6f 62 74 61 69 6e 20 61 20 72 65 71 75 69 o obtain a requi
21e0: 72 65 64 20 6c 6f 63 6b 20 69 6d 6d 65 64 69 61 red lock immedia
21f0: 74 65 6c 79 2c 0a 20 20 5b 73 71 6c 69 74 65 33 tely,. [sqlite3
2200: 5f 62 61 63 6b 75 70 5f 73 74 65 70 28 29 5d 20 _backup_step()]
2210: 75 73 65 73 20 61 6e 79 20 72 65 67 69 73 74 65 uses any registe
2220: 72 65 64 20 62 75 73 79 2d 68 61 6e 64 6c 65 72 red busy-handler
2230: 20 63 61 6c 6c 62 61 63 6b 20 6f 72 20 74 69 6d callback or tim
2240: 65 6f 75 74 0a 20 20 69 6e 20 74 68 65 20 73 61 eout. in the sa
2250: 6d 65 20 77 61 79 20 61 73 20 5b 73 71 6c 69 74 me way as [sqlit
2260: 65 33 5f 73 74 65 70 28 29 5d 20 6f 72 20 5b 73 e3_step()] or [s
2270: 71 6c 69 74 65 33 5f 65 78 65 63 28 29 5d 20 64 qlite3_exec()] d
2280: 6f 65 73 2e 0a 0a 3c 70 3e 0a 20 20 55 73 75 61 oes...<p>. Usua
2290: 6c 6c 79 2c 20 69 74 20 64 6f 65 73 20 6e 6f 74 lly, it does not
22a0: 20 6d 61 74 74 65 72 20 69 66 20 74 68 65 20 70 matter if the p
22b0: 61 67 65 2d 73 69 7a 65 73 20 6f 66 20 74 68 65 age-sizes of the
22c0: 20 73 6f 75 72 63 65 20 64 61 74 61 62 61 73 65 source database
22d0: 20 61 6e 64 20 74 68 65 0a 20 20 64 65 73 74 69 and the. desti
22e0: 6e 61 74 69 6f 6e 20 64 61 74 61 62 61 73 65 20 nation database
22f0: 61 72 65 20 64 69 66 66 65 72 65 6e 74 20 62 65 are different be
2300: 66 6f 72 65 20 74 68 65 20 63 6f 6e 74 65 6e 74 fore the content
2310: 73 20 6f 66 20 74 68 65 20 64 65 73 74 69 6e 61 s of the destina
2320: 74 69 6f 6e 0a 20 20 61 72 65 20 6f 76 65 72 77 tion. are overw
2330: 72 69 74 74 65 6e 2e 20 54 68 65 20 70 61 67 65 ritten. The page
2340: 2d 73 69 7a 65 20 6f 66 20 74 68 65 20 64 65 73 -size of the des
2350: 74 69 6e 61 74 69 6f 6e 20 64 61 74 61 62 61 73 tination databas
2360: 65 20 69 73 20 73 69 6d 70 6c 79 20 63 68 61 6e e is simply chan
2370: 67 65 64 0a 20 20 61 73 20 70 61 72 74 20 6f 66 ged. as part of
2380: 20 74 68 65 20 62 61 63 6b 75 70 20 6f 70 65 72 the backup oper
2390: 61 74 69 6f 6e 2e 20 54 68 65 20 65 78 63 65 70 ation. The excep
23a0: 74 69 6f 6e 20 69 73 20 69 66 20 74 68 65 20 64 tion is if the d
23b0: 65 73 74 69 6e 61 74 69 6f 6e 20 64 61 74 61 62 estination datab
23c0: 61 73 65 0a 20 20 68 61 70 70 65 6e 73 20 74 6f ase. happens to
23d0: 20 62 65 20 61 6e 20 69 6e 2d 6d 65 6d 6f 72 79 be an in-memory
23e0: 20 64 61 74 61 62 61 73 65 2e 20 49 6e 20 74 68 database. In th
23f0: 69 73 20 63 61 73 65 2c 20 69 66 20 74 68 65 20 is case, if the
2400: 70 61 67 65 20 73 69 7a 65 73 0a 20 20 61 72 65 page sizes. are
2410: 20 6e 6f 74 20 74 68 65 20 73 61 6d 65 20 61 74 not the same at
2420: 20 74 68 65 20 73 74 61 72 74 20 6f 66 20 74 68 the start of th
2430: 65 20 62 61 63 6b 75 70 20 6f 70 65 72 61 74 69 e backup operati
2440: 6f 6e 2c 20 74 68 65 6e 20 74 68 65 20 6f 70 65 on, then the ope
2450: 72 61 74 69 6f 6e 0a 20 20 66 61 69 6c 73 20 77 ration. fails w
2460: 69 74 68 20 61 6e 20 53 51 4c 49 54 45 5f 52 45 ith an SQLITE_RE
2470: 41 44 4f 4e 4c 59 20 65 72 72 6f 72 2e 20 55 6e ADONLY error. Un
2480: 66 6f 72 74 75 6e 61 74 65 6c 79 2c 20 74 68 69 fortunately, thi
2490: 73 20 63 6f 75 6c 64 20 6f 63 63 75 72 20 77 68 s could occur wh
24a0: 65 6e 0a 20 20 6c 6f 61 64 69 6e 67 20 61 20 64 en. loading a d
24b0: 61 74 61 62 61 73 65 20 69 6d 61 67 65 20 66 72 atabase image fr
24c0: 6f 6d 20 61 20 66 69 6c 65 20 69 6e 74 6f 20 61 om a file into a
24d0: 6e 20 69 6e 2d 6d 65 6d 6f 72 79 20 64 61 74 61 n in-memory data
24e0: 62 61 73 65 20 75 73 69 6e 67 0a 20 20 66 75 6e base using. fun
24f0: 63 74 69 6f 6e 20 6c 6f 61 64 4f 72 53 61 76 65 ction loadOrSave
2500: 44 62 28 29 2e 0a 0a 3c 70 3e 0a 20 20 48 6f 77 Db()...<p>. How
2510: 65 76 65 72 2c 20 69 66 20 69 6e 2d 6d 65 6d 6f ever, if in-memo
2520: 72 79 20 64 61 74 61 62 61 73 65 20 70 49 6e 4d ry database pInM
2530: 65 6d 6f 72 79 20 68 61 73 20 6a 75 73 74 20 62 emory has just b
2540: 65 65 6e 20 6f 70 65 6e 65 64 20 28 61 6e 64 20 een opened (and
2550: 69 73 20 0a 20 20 74 68 65 72 65 66 6f 72 65 20 is . therefore
2560: 63 6f 6d 70 6c 65 74 65 6c 79 20 65 6d 70 74 79 completely empty
2570: 29 20 62 65 66 6f 72 65 20 62 65 69 6e 67 20 70 ) before being p
2580: 61 73 73 65 64 20 74 6f 20 66 75 6e 63 74 69 6f assed to functio
2590: 6e 20 6c 6f 61 64 4f 72 53 61 76 65 44 62 28 29 n loadOrSaveDb()
25a0: 2c 20 0a 20 20 74 68 65 6e 20 69 74 20 69 73 20 , . then it is
25b0: 73 74 69 6c 6c 20 70 6f 73 73 69 62 6c 65 20 74 still possible t
25c0: 6f 20 63 68 61 6e 67 65 20 69 74 73 20 70 61 67 o change its pag
25d0: 65 20 73 69 7a 65 20 75 73 69 6e 67 20 61 6e 20 e size using an
25e0: 53 51 4c 69 74 65 20 22 50 52 41 47 4d 41 0a 20 SQLite "PRAGMA.
25f0: 20 70 61 67 65 5f 73 69 7a 65 22 20 63 6f 6d 6d page_size" comm
2600: 61 6e 64 2e 20 46 75 6e 63 74 69 6f 6e 20 6c 6f and. Function lo
2610: 61 64 4f 72 53 61 76 65 44 62 28 29 20 63 6f 75 adOrSaveDb() cou
2620: 6c 64 20 64 65 74 65 63 74 20 74 68 69 73 20 63 ld detect this c
2630: 61 73 65 2c 20 61 6e 64 0a 20 20 61 74 74 65 6d ase, and. attem
2640: 70 74 20 74 6f 20 73 65 74 20 74 68 65 20 70 61 pt to set the pa
2650: 67 65 2d 73 69 7a 65 20 6f 66 20 74 68 65 20 69 ge-size of the i
2660: 6e 2d 6d 65 6d 6f 72 79 20 64 61 74 61 62 61 73 n-memory databas
2670: 65 20 74 6f 20 74 68 65 20 70 61 67 65 2d 73 69 e to the page-si
2680: 7a 65 0a 20 20 6f 66 20 64 61 74 61 62 61 73 65 ze. of database
2690: 20 7a 46 69 6c 65 6e 61 6d 65 20 62 65 66 6f 72 zFilename befor
26a0: 65 20 69 6e 76 6f 6b 69 6e 67 20 74 68 65 20 6f e invoking the o
26b0: 6e 6c 69 6e 65 20 62 61 63 6b 75 70 20 41 50 49 nline backup API
26c0: 20 66 75 6e 63 74 69 6f 6e 73 2e 0a 20 20 0a 3c functions.. .<
26d0: 68 32 3e 45 78 61 6d 70 6c 65 20 32 3a 20 4f 6e h2>Example 2: On
26e0: 6c 69 6e 65 20 42 61 63 6b 75 70 20 6f 66 20 61 line Backup of a
26f0: 20 52 75 6e 6e 69 6e 67 20 44 61 74 61 62 61 73 Running Databas
2700: 65 3c 2f 68 32 3e 0a 0a 3c 74 63 6c 3e 0a 43 5f e</h2>..<tcl>.C_
2710: 43 6f 64 65 20 7b 0a 20 20 2f 2a 0a 20 20 2a 2a Code {. /*. **
2720: 20 50 65 72 66 6f 72 6d 20 61 6e 20 6f 6e 6c 69 Perform an onli
2730: 6e 65 20 62 61 63 6b 75 70 20 6f 66 20 64 61 74 ne backup of dat
2740: 61 62 61 73 65 20 70 44 62 20 74 6f 20 74 68 65 abase pDb to the
2750: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 6e database file n
2760: 61 6d 65 64 0a 20 20 2a 2a 20 62 79 20 7a 46 69 amed. ** by zFi
2770: 6c 65 6e 61 6d 65 2e 20 54 68 69 73 20 66 75 6e lename. This fun
2780: 63 74 69 6f 6e 20 63 6f 70 69 65 73 20 35 20 64 ction copies 5 d
2790: 61 74 61 62 61 73 65 20 70 61 67 65 73 20 66 72 atabase pages fr
27a0: 6f 6d 20 70 44 62 20 74 6f 0a 20 20 2a 2a 20 7a om pDb to. ** z
27b0: 46 69 6c 65 6e 61 6d 65 2c 20 74 68 65 6e 20 75 Filename, then u
27c0: 6e 6c 6f 63 6b 73 20 70 44 62 20 61 6e 64 20 73 nlocks pDb and s
27d0: 6c 65 65 70 73 20 66 6f 72 20 32 35 30 20 6d 73 leeps for 250 ms
27e0: 2c 20 74 68 65 6e 20 72 65 70 65 61 74 73 20 74 , then repeats t
27f0: 68 65 0a 20 20 2a 2a 20 70 72 6f 63 65 73 73 20 he. ** process
2800: 75 6e 74 69 6c 20 74 68 65 20 65 6e 74 69 72 65 until the entire
2810: 20 64 61 74 61 62 61 73 65 20 69 73 20 62 61 63 database is bac
2820: 6b 65 64 20 75 70 2e 0a 20 20 2a 2a 20 0a 20 20 ked up.. ** .
2830: 2a 2a 20 54 68 65 20 74 68 69 72 64 20 61 72 67 ** The third arg
2840: 75 6d 65 6e 74 20 70 61 73 73 65 64 20 74 6f 20 ument passed to
2850: 74 68 69 73 20 66 75 6e 63 74 69 6f 6e 20 6d 75 this function mu
2860: 73 74 20 62 65 20 61 20 70 6f 69 6e 74 65 72 20 st be a pointer
2870: 74 6f 20 61 20 70 72 6f 67 72 65 73 73 0a 20 20 to a progress.
2880: 2a 2a 20 66 75 6e 63 74 69 6f 6e 2e 20 41 66 74 ** function. Aft
2890: 65 72 20 65 61 63 68 20 73 65 74 20 6f 66 20 35 er each set of 5
28a0: 20 70 61 67 65 73 20 69 73 20 62 61 63 6b 65 64 pages is backed
28b0: 20 75 70 2c 20 74 68 65 20 70 72 6f 67 72 65 73 up, the progres
28c0: 73 20 66 75 6e 63 74 69 6f 6e 0a 20 20 2a 2a 20 s function. **
28d0: 69 73 20 69 6e 76 6f 6b 65 64 20 77 69 74 68 20 is invoked with
28e0: 74 77 6f 20 69 6e 74 65 67 65 72 20 70 61 72 61 two integer para
28f0: 6d 65 74 65 72 73 3a 20 74 68 65 20 6e 75 6d 62 meters: the numb
2900: 65 72 20 6f 66 20 70 61 67 65 73 20 6c 65 66 74 er of pages left
2910: 20 74 6f 0a 20 20 2a 2a 20 63 6f 70 79 2c 20 61 to. ** copy, a
2920: 6e 64 20 74 68 65 20 74 6f 74 61 6c 20 6e 75 6d nd the total num
2930: 62 65 72 20 6f 66 20 70 61 67 65 73 20 69 6e 20 ber of pages in
2940: 74 68 65 20 73 6f 75 72 63 65 20 66 69 6c 65 2e the source file.
2950: 20 54 68 69 73 20 69 6e 66 6f 72 6d 61 74 69 6f This informatio
2960: 6e 0a 20 20 2a 2a 20 6d 61 79 20 62 65 20 75 73 n. ** may be us
2970: 65 64 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65 2c ed, for example,
2980: 20 74 6f 20 75 70 64 61 74 65 20 61 20 47 55 49 to update a GUI
2990: 20 70 72 6f 67 72 65 73 73 20 62 61 72 2e 0a 20 progress bar..
29a0: 20 2a 2a 0a 20 20 2a 2a 20 57 68 69 6c 65 20 74 **. ** While t
29b0: 68 69 73 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 his function is
29c0: 72 75 6e 6e 69 6e 67 2c 20 61 6e 6f 74 68 65 72 running, another
29d0: 20 74 68 72 65 61 64 20 6d 61 79 20 75 73 65 20 thread may use
29e0: 74 68 65 20 64 61 74 61 62 61 73 65 20 70 44 62 the database pDb
29f0: 2c 20 6f 72 0a 20 20 2a 2a 20 61 6e 6f 74 68 65 , or. ** anothe
2a00: 72 20 70 72 6f 63 65 73 73 20 6d 61 79 20 61 63 r process may ac
2a10: 63 65 73 73 20 74 68 65 20 75 6e 64 65 72 6c 79 cess the underly
2a20: 69 6e 67 20 64 61 74 61 62 61 73 65 20 66 69 6c ing database fil
2a30: 65 20 76 69 61 20 61 20 73 65 70 61 72 61 74 65 e via a separate
2a40: 20 0a 20 20 2a 2a 20 63 6f 6e 6e 65 63 74 69 6f . ** connectio
2a50: 6e 2e 0a 20 20 2a 2a 0a 20 20 2a 2a 20 49 66 20 n.. **. ** If
2a60: 74 68 65 20 62 61 63 6b 75 70 20 70 72 6f 63 65 the backup proce
2a70: 73 73 20 69 73 20 73 75 63 63 65 73 73 66 75 6c ss is successful
2a80: 6c 79 20 63 6f 6d 70 6c 65 74 65 64 2c 20 53 51 ly completed, SQ
2a90: 4c 49 54 45 5f 4f 4b 20 69 73 20 72 65 74 75 72 LITE_OK is retur
2aa0: 6e 65 64 2e 0a 20 20 2a 2a 20 4f 74 68 65 72 77 ned.. ** Otherw
2ab0: 69 73 65 2c 20 69 66 20 61 6e 20 65 72 72 6f 72 ise, if an error
2ac0: 20 6f 63 63 75 72 73 2c 20 61 6e 20 53 51 4c 69 occurs, an SQLi
2ad0: 74 65 20 65 72 72 6f 72 20 63 6f 64 65 20 69 73 te error code is
2ae0: 20 72 65 74 75 72 6e 65 64 2e 0a 20 20 2a 2f 0a returned.. */.
2af0: 20 20 69 6e 74 20 62 61 63 6b 75 70 44 62 28 0a int backupDb(.
2b00: 20 20 20 20 73 71 6c 69 74 65 33 20 2a 70 44 62 sqlite3 *pDb
2b10: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 ,
2b20: 2f 2a 20 44 61 74 61 62 61 73 65 20 74 6f 20 62 /* Database to b
2b30: 61 63 6b 20 75 70 20 2a 2f 0a 20 20 20 20 63 6f ack up */. co
2b40: 6e 73 74 20 63 68 61 72 20 2a 7a 46 69 6c 65 6e nst char *zFilen
2b50: 61 6d 65 2c 20 20 20 20 20 20 2f 2a 20 4e 61 6d ame, /* Nam
2b60: 65 20 6f 66 20 66 69 6c 65 20 74 6f 20 62 61 63 e of file to bac
2b70: 6b 20 75 70 20 74 6f 20 2a 2f 0a 20 20 20 20 76 k up to */. v
2b80: 6f 69 64 28 2a 78 50 72 6f 67 72 65 73 73 29 28 oid(*xProgress)(
2b90: 69 6e 74 2c 20 69 6e 74 29 20 20 2f 2a 20 50 72 int, int) /* Pr
2ba0: 6f 67 72 65 73 73 20 66 75 6e 63 74 69 6f 6e 20 ogress function
2bb0: 74 6f 20 69 6e 76 6f 6b 65 20 2a 2f 20 20 20 20 to invoke */
2bc0: 20 0a 20 20 29 7b 0a 20 20 20 20 69 6e 74 20 72 . ){. int r
2bd0: 63 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 20 c;
2be0: 20 20 20 20 20 20 20 2f 2a 20 46 75 6e 63 74 69 /* Functi
2bf0: 6f 6e 20 72 65 74 75 72 6e 20 63 6f 64 65 20 2a on return code *
2c00: 2f 0a 20 20 20 20 73 71 6c 69 74 65 33 20 2a 70 /. sqlite3 *p
2c10: 46 69 6c 65 3b 20 20 20 20 20 20 20 20 20 20 20 File;
2c20: 20 20 2f 2a 20 44 61 74 61 62 61 73 65 20 63 6f /* Database co
2c30: 6e 6e 65 63 74 69 6f 6e 20 6f 70 65 6e 65 64 20 nnection opened
2c40: 6f 6e 20 7a 46 69 6c 65 6e 61 6d 65 20 2a 2f 0a on zFilename */.
2c50: 20 20 20 20 73 71 6c 69 74 65 33 5f 62 61 63 6b sqlite3_back
2c60: 75 70 20 2a 70 42 61 63 6b 75 70 3b 20 20 20 20 up *pBackup;
2c70: 2f 2a 20 42 61 63 6b 75 70 20 68 61 6e 64 6c 65 /* Backup handle
2c80: 20 75 73 65 64 20 74 6f 20 63 6f 70 79 20 64 61 used to copy da
2c90: 74 61 20 2a 2f 0a 0a 20 20 20 20 2f 2a 20 4f 70 ta */.. /* Op
2ca0: 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20 en the database
2cb0: 66 69 6c 65 20 69 64 65 6e 74 69 66 69 65 64 20 file identified
2cc0: 62 79 20 7a 46 69 6c 65 6e 61 6d 65 2e 20 2a 2f by zFilename. */
2cd0: 0a 20 20 20 20 72 63 20 3d 20 73 71 6c 69 74 65 . rc = sqlite
2ce0: 33 5f 6f 70 65 6e 28 7a 46 69 6c 65 6e 61 6d 65 3_open(zFilename
2cf0: 2c 20 26 70 46 69 6c 65 29 3b 0a 20 20 20 20 69 , &pFile);. i
2d00: 66 28 20 72 63 3d 3d 53 51 4c 49 54 45 5f 4f 4b f( rc==SQLITE_OK
2d10: 20 29 7b 0a 0a 20 20 20 20 20 20 2f 2a 20 4f 70 ){.. /* Op
2d20: 65 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f 62 en the sqlite3_b
2d30: 61 63 6b 75 70 20 6f 62 6a 65 63 74 20 75 73 65 ackup object use
2d40: 64 20 74 6f 20 61 63 63 6f 6d 70 6c 69 73 68 20 d to accomplish
2d50: 74 68 65 20 74 72 61 6e 73 66 65 72 20 2a 2f 0a the transfer */.
2d60: 20 20 20 20 20 20 70 42 61 63 6b 75 70 20 3d 20 pBackup =
2d70: 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f 69 sqlite3_backup_i
2d80: 6e 69 74 28 70 46 69 6c 65 2c 20 22 6d 61 69 6e nit(pFile, "main
2d90: 22 2c 20 70 44 62 2c 20 22 6d 61 69 6e 22 29 3b ", pDb, "main");
2da0: 0a 20 20 20 20 20 20 69 66 28 20 70 42 61 63 6b . if( pBack
2db0: 75 70 20 29 7b 0a 20 20 0a 20 20 20 20 20 20 20 up ){. .
2dc0: 20 2f 2a 20 45 61 63 68 20 69 74 65 72 61 74 69 /* Each iterati
2dd0: 6f 6e 20 6f 66 20 74 68 69 73 20 6c 6f 6f 70 20 on of this loop
2de0: 63 6f 70 69 65 73 20 35 20 64 61 74 61 62 61 73 copies 5 databas
2df0: 65 20 70 61 67 65 73 20 66 72 6f 6d 20 64 61 74 e pages from dat
2e00: 61 62 61 73 65 0a 20 20 20 20 20 20 20 20 2a 2a abase. **
2e10: 20 70 44 62 20 74 6f 20 74 68 65 20 62 61 63 6b pDb to the back
2e20: 75 70 20 64 61 74 61 62 61 73 65 2e 20 49 66 20 up database. If
2e30: 74 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 the return value
2e40: 20 6f 66 20 62 61 63 6b 75 70 5f 73 74 65 70 28 of backup_step(
2e50: 29 0a 20 20 20 20 20 20 20 20 2a 2a 20 69 6e 64 ). ** ind
2e60: 69 63 61 74 65 73 20 74 68 61 74 20 74 68 65 72 icates that ther
2e70: 65 20 61 72 65 20 73 74 69 6c 6c 20 66 75 72 74 e are still furt
2e80: 68 65 72 20 70 61 67 65 73 20 74 6f 20 63 6f 70 her pages to cop
2e90: 79 2c 20 73 6c 65 65 70 20 66 6f 72 0a 20 20 20 y, sleep for.
2ea0: 20 20 20 20 20 2a 2a 20 32 35 30 20 6d 73 20 62 ** 250 ms b
2eb0: 65 66 6f 72 65 20 72 65 70 65 61 74 69 6e 67 2e efore repeating.
2ec0: 20 2a 2f 0a 20 20 20 20 20 20 20 20 64 6f 20 7b */. do {
2ed0: 0a 20 20 20 20 20 20 20 20 20 20 72 63 20 3d 20 . rc =
2ee0: 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f 73 sqlite3_backup_s
2ef0: 74 65 70 28 70 42 61 63 6b 75 70 2c 20 35 29 3b tep(pBackup, 5);
2f00: 0a 20 20 20 20 20 20 20 20 20 20 78 50 72 6f 67 . xProg
2f10: 72 65 73 73 28 0a 20 20 20 20 20 20 20 20 20 20 ress(.
2f20: 20 20 20 20 73 71 6c 69 74 65 33 5f 62 61 63 6b sqlite3_back
2f30: 75 70 5f 72 65 6d 61 69 6e 69 6e 67 28 70 42 61 up_remaining(pBa
2f40: 63 6b 75 70 29 2c 0a 20 20 20 20 20 20 20 20 20 ckup),.
2f50: 20 20 20 20 20 73 71 6c 69 74 65 33 5f 62 61 63 sqlite3_bac
2f60: 6b 75 70 5f 70 61 67 65 63 6f 75 6e 74 28 70 42 kup_pagecount(pB
2f70: 61 63 6b 75 70 29 0a 20 20 20 20 20 20 20 20 20 ackup).
2f80: 20 29 3b 0a 20 20 20 20 20 20 20 20 20 20 69 66 );. if
2f90: 28 20 72 63 3d 3d 53 51 4c 49 54 45 5f 4f 4b 20 ( rc==SQLITE_OK
2fa0: 7c 7c 20 72 63 3d 3d 53 51 4c 49 54 45 5f 42 55 || rc==SQLITE_BU
2fb0: 53 59 20 7c 7c 20 72 63 3d 3d 53 51 4c 49 54 45 SY || rc==SQLITE
2fc0: 5f 4c 4f 43 4b 45 44 20 29 7b 0a 20 20 20 20 20 _LOCKED ){.
2fd0: 20 20 20 20 20 20 20 73 71 6c 69 74 65 33 5f 73 sqlite3_s
2fe0: 6c 65 65 70 28 32 35 30 29 3b 0a 20 20 20 20 20 leep(250);.
2ff0: 20 20 20 20 20 7d 0a 20 20 20 20 20 20 20 20 7d }. }
3000: 20 77 68 69 6c 65 28 20 72 63 3d 3d 53 51 4c 49 while( rc==SQLI
3010: 54 45 5f 4f 4b 20 7c 7c 20 72 63 3d 3d 53 51 4c TE_OK || rc==SQL
3020: 49 54 45 5f 42 55 53 59 20 7c 7c 20 72 63 3d 3d ITE_BUSY || rc==
3030: 53 51 4c 49 54 45 5f 4c 4f 43 4b 45 44 20 29 3b SQLITE_LOCKED );
3040: 0a 20 20 0a 20 20 20 20 20 20 20 20 2f 2a 20 52 . . /* R
3050: 65 6c 65 61 73 65 20 72 65 73 6f 75 72 63 65 73 elease resources
3060: 20 61 6c 6c 6f 63 61 74 65 64 20 62 79 20 62 61 allocated by ba
3070: 63 6b 75 70 5f 69 6e 69 74 28 29 2e 20 2a 2f 0a ckup_init(). */.
3080: 20 20 20 20 20 20 20 20 28 76 6f 69 64 29 73 71 (void)sq
3090: 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f 66 69 6e lite3_backup_fin
30a0: 69 73 68 28 70 42 61 63 6b 75 70 29 3b 0a 20 20 ish(pBackup);.
30b0: 20 20 20 20 7d 0a 20 20 20 20 20 20 72 63 20 3d }. rc =
30c0: 20 73 71 6c 69 74 65 33 5f 65 72 72 63 6f 64 65 sqlite3_errcode
30d0: 28 70 46 69 6c 65 29 3b 0a 20 20 20 20 7d 0a 20 (pFile);. }.
30e0: 20 20 20 0a 20 20 20 20 2f 2a 20 43 6c 6f 73 65 . /* Close
30f0: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f the database co
3100: 6e 6e 65 63 74 69 6f 6e 20 6f 70 65 6e 65 64 20 nnection opened
3110: 6f 6e 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 on database file
3120: 20 7a 46 69 6c 65 6e 61 6d 65 0a 20 20 20 20 2a zFilename. *
3130: 2a 20 61 6e 64 20 72 65 74 75 72 6e 20 74 68 65 * and return the
3140: 20 72 65 73 75 6c 74 20 6f 66 20 74 68 69 73 20 result of this
3150: 66 75 6e 63 74 69 6f 6e 2e 20 2a 2f 0a 20 20 20 function. */.
3160: 20 28 76 6f 69 64 29 73 71 6c 69 74 65 33 5f 63 (void)sqlite3_c
3170: 6c 6f 73 65 28 70 46 69 6c 65 29 3b 0a 20 20 20 lose(pFile);.
3180: 20 72 65 74 75 72 6e 20 72 63 3b 0a 20 20 7d 0a return rc;. }.
3190: 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 0a 20 20 }.</tcl>..<p>.
31a0: 54 68 65 20 66 75 6e 63 74 69 6f 6e 20 70 72 65 The function pre
31b0: 73 65 6e 74 65 64 20 69 6e 20 74 68 65 20 70 72 sented in the pr
31c0: 65 76 69 6f 75 73 20 65 78 61 6d 70 6c 65 20 63 evious example c
31d0: 6f 70 69 65 73 20 74 68 65 20 65 6e 74 69 72 65 opies the entire
31e0: 20 73 6f 75 72 63 65 0a 20 20 64 61 74 61 62 61 source. databa
31f0: 73 65 20 69 6e 20 6f 6e 65 20 63 61 6c 6c 20 74 se in one call t
3200: 6f 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 o [sqlite3_backu
3210: 70 5f 73 74 65 70 28 29 5d 2e 20 54 68 69 73 20 p_step()]. This
3220: 72 65 71 75 69 72 65 73 20 68 6f 6c 64 69 6e 67 requires holding
3230: 20 61 20 0a 20 20 72 65 61 64 2d 6c 6f 63 6b 20 a . read-lock
3240: 6f 6e 20 74 68 65 20 73 6f 75 72 63 65 20 64 61 on the source da
3250: 74 61 62 61 73 65 20 66 69 6c 65 20 66 6f 72 20 tabase file for
3260: 74 68 65 20 64 75 72 61 74 69 6f 6e 20 6f 66 20 the duration of
3270: 74 68 65 20 6f 70 65 72 61 74 69 6f 6e 2c 0a 20 the operation,.
3280: 20 70 72 65 76 65 6e 74 69 6e 67 20 61 6e 79 20 preventing any
3290: 6f 74 68 65 72 20 64 61 74 61 62 61 73 65 20 75 other database u
32a0: 73 65 72 20 66 72 6f 6d 20 77 72 69 74 69 6e 67 ser from writing
32b0: 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73 65 to the database
32c0: 2e 20 49 74 20 61 6c 73 6f 0a 20 20 68 6f 6c 64 . It also. hold
32d0: 73 20 74 68 65 20 6d 75 74 65 78 20 61 73 73 6f s the mutex asso
32e0: 63 69 61 74 65 64 20 77 69 74 68 20 64 61 74 61 ciated with data
32f0: 62 61 73 65 20 70 49 6e 4d 65 6d 6f 72 79 20 74 base pInMemory t
3300: 68 72 6f 75 67 68 6f 75 74 20 74 68 65 20 63 6f hroughout the co
3310: 70 79 2c 0a 20 20 70 72 65 76 65 6e 74 69 6e 67 py,. preventing
3320: 20 61 6e 79 20 6f 74 68 65 72 20 74 68 72 65 61 any other threa
3330: 64 20 66 72 6f 6d 20 75 73 69 6e 67 20 69 74 2e d from using it.
3340: 20 54 68 65 20 43 20 66 75 6e 63 74 69 6f 6e 20 The C function
3350: 69 6e 20 74 68 69 73 20 73 65 63 74 69 6f 6e 2c in this section,
3360: 0a 20 20 64 65 73 69 67 6e 65 64 20 74 6f 20 62 . designed to b
3370: 65 20 63 61 6c 6c 65 64 20 62 79 20 61 20 62 61 e called by a ba
3380: 63 6b 67 72 6f 75 6e 64 20 74 68 72 65 61 64 20 ckground thread
3390: 6f 72 20 70 72 6f 63 65 73 73 20 66 6f 72 20 63 or process for c
33a0: 72 65 61 74 69 6e 67 20 61 20 0a 20 20 62 61 63 reating a . bac
33b0: 6b 75 70 20 6f 66 20 61 6e 20 6f 6e 6c 69 6e 65 kup of an online
33c0: 20 64 61 74 61 62 61 73 65 2c 20 61 76 6f 69 64 database, avoid
33d0: 73 20 74 68 65 73 65 20 70 72 6f 62 6c 65 6d 73 s these problems
33e0: 20 75 73 69 6e 67 20 74 68 65 20 66 6f 6c 6c 6f using the follo
33f0: 77 69 6e 67 20 0a 20 20 61 70 70 72 6f 61 63 68 wing . approach
3400: 3a 0a 0a 20 20 3c 6f 6c 3e 0a 20 20 20 20 3c 6c :.. <ol>. <l
3410: 69 3e 46 75 6e 63 74 69 6f 6e 20 5b 73 71 6c 69 i>Function [sqli
3420: 74 65 33 5f 62 61 63 6b 75 70 5f 69 6e 69 74 28 te3_backup_init(
3430: 29 5d 20 69 73 20 63 61 6c 6c 65 64 20 74 6f 20 )] is called to
3440: 63 72 65 61 74 65 20 61 6e 20 5b 73 71 6c 69 74 create an [sqlit
3450: 65 33 5f 62 61 63 6b 75 70 5d 0a 20 20 20 20 20 e3_backup].
3460: 20 20 20 6f 62 6a 65 63 74 20 74 6f 20 63 6f 70 object to cop
3470: 79 20 64 61 74 61 20 66 72 6f 6d 20 64 61 74 61 y data from data
3480: 62 61 73 65 20 70 44 62 20 74 6f 20 74 68 65 20 base pDb to the
3490: 62 61 63 6b 75 70 20 64 61 74 61 62 61 73 65 20 backup database
34a0: 66 69 6c 65 20 0a 20 20 20 20 20 20 20 20 69 64 file . id
34b0: 65 6e 74 69 66 69 65 64 20 62 79 20 7a 46 69 6c entified by zFil
34c0: 65 6e 61 6d 65 2e 0a 20 20 20 20 3c 6c 69 3e 46 ename.. <li>F
34d0: 75 6e 63 74 69 6f 6e 20 5b 73 71 6c 69 74 65 33 unction [sqlite3
34e0: 5f 62 61 63 6b 75 70 5f 73 74 65 70 28 29 5d 20 _backup_step()]
34f0: 69 73 20 63 61 6c 6c 65 64 20 77 69 74 68 20 61 is called with a
3500: 20 70 61 72 61 6d 65 74 65 72 20 6f 66 20 35 20 parameter of 5
3510: 74 6f 0a 20 20 20 20 20 20 20 20 63 6f 70 79 20 to. copy
3520: 35 20 70 61 67 65 73 20 6f 66 20 64 61 74 61 62 5 pages of datab
3530: 61 73 65 20 70 44 62 20 74 6f 20 74 68 65 20 62 ase pDb to the b
3540: 61 63 6b 75 70 20 64 61 74 61 62 61 73 65 20 28 ackup database (
3550: 66 69 6c 65 20 7a 46 69 6c 65 6e 61 6d 65 29 2e file zFilename).
3560: 0a 20 20 20 20 3c 6c 69 3e 49 66 20 74 68 65 72 . <li>If ther
3570: 65 20 61 72 65 20 73 74 69 6c 6c 20 6d 6f 72 65 e are still more
3580: 20 70 61 67 65 73 20 74 6f 20 63 6f 70 79 20 66 pages to copy f
3590: 72 6f 6d 20 64 61 74 61 62 61 73 65 20 70 44 62 rom database pDb
35a0: 2c 20 74 68 65 6e 20 74 68 65 0a 20 20 20 20 20 , then the.
35b0: 20 20 20 66 75 6e 63 74 69 6f 6e 20 73 6c 65 65 function slee
35c0: 70 73 20 66 6f 72 20 32 35 30 20 6d 69 6c 6c 69 ps for 250 milli
35d0: 73 65 63 6f 6e 64 73 20 28 75 73 69 6e 67 20 74 seconds (using t
35e0: 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 6c 65 65 he [sqlite3_slee
35f0: 70 28 29 5d 0a 20 20 20 20 20 20 20 20 75 74 69 p()]. uti
3600: 6c 69 74 79 29 20 61 6e 64 20 74 68 65 6e 20 72 lity) and then r
3610: 65 74 75 72 6e 73 20 74 6f 20 73 74 65 70 20 32 eturns to step 2
3620: 2e 0a 20 20 20 20 3c 6c 69 3e 46 75 6e 63 74 69 .. <li>Functi
3630: 6f 6e 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 6b on [sqlite3_back
3640: 75 70 5f 66 69 6e 69 73 68 28 29 5d 20 69 73 20 up_finish()] is
3650: 63 61 6c 6c 65 64 20 74 6f 20 63 6c 65 61 6e 20 called to clean
3660: 75 70 20 72 65 73 6f 75 72 63 65 73 0a 20 20 20 up resources.
3670: 20 20 20 20 20 61 6c 6c 6f 63 61 74 65 64 20 62 allocated b
3680: 79 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 y [sqlite3_backu
3690: 70 5f 69 6e 69 74 28 29 5d 2e 0a 20 20 3c 2f 6f p_init()].. </o
36a0: 6c 3e 0a 0a 3c 70 3e 3c 62 3e 46 69 6c 65 20 61 l>..<p><b>File a
36b0: 6e 64 20 44 61 74 61 62 61 73 65 20 43 6f 6e 6e nd Database Conn
36c0: 65 63 74 69 6f 6e 20 4c 6f 63 6b 69 6e 67 3c 2f ection Locking</
36d0: 62 3e 0a 0a 3c 70 3e 0a 20 20 44 75 72 69 6e 67 b>..<p>. During
36e0: 20 74 68 65 20 32 35 30 20 6d 73 20 73 6c 65 65 the 250 ms slee
36f0: 70 20 69 6e 20 73 74 65 70 20 33 20 61 62 6f 76 p in step 3 abov
3700: 65 2c 20 6e 6f 20 72 65 61 64 2d 6c 6f 63 6b 20 e, no read-lock
3710: 69 73 20 68 65 6c 64 20 6f 6e 20 74 68 65 20 64 is held on the d
3720: 61 74 61 62 61 73 65 0a 20 20 66 69 6c 65 20 61 atabase. file a
3730: 6e 64 20 74 68 65 20 6d 75 74 65 78 20 61 73 73 nd the mutex ass
3740: 6f 63 69 61 74 65 64 20 77 69 74 68 20 70 44 62 ociated with pDb
3750: 20 69 73 20 6e 6f 74 20 68 65 6c 64 2e 20 54 68 is not held. Th
3760: 69 73 20 61 6c 6c 6f 77 73 20 6f 74 68 65 72 20 is allows other
3770: 74 68 72 65 61 64 73 0a 20 20 74 6f 20 75 73 65 threads. to use
3780: 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 [database conne
3790: 63 74 69 6f 6e 5d 20 70 44 62 20 61 6e 64 20 6f ction] pDb and o
37a0: 74 68 65 72 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 ther connections
37b0: 20 74 6f 20 77 72 69 74 65 20 74 6f 20 74 68 65 to write to the
37c0: 0a 20 20 75 6e 64 65 72 6c 79 69 6e 67 20 64 61 . underlying da
37d0: 74 61 62 61 73 65 20 66 69 6c 65 2e 20 0a 0a 3c tabase file. ..<
37e0: 70 3e 0a 20 20 49 66 20 61 6e 6f 74 68 65 72 20 p>. If another
37f0: 74 68 72 65 61 64 20 6f 72 20 70 72 6f 63 65 73 thread or proces
3800: 73 20 77 72 69 74 65 73 20 74 6f 20 74 68 65 20 s writes to the
3810: 73 6f 75 72 63 65 20 64 61 74 61 62 61 73 65 20 source database
3820: 77 68 69 6c 65 20 74 68 69 73 20 0a 20 20 66 75 while this . fu
3830: 6e 63 74 69 6f 6e 20 69 73 20 73 6c 65 65 70 69 nction is sleepi
3840: 6e 67 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 20 ng, then SQLite
3850: 64 65 74 65 63 74 73 20 74 68 69 73 20 61 6e 64 detects this and
3860: 20 75 73 75 61 6c 6c 79 20 72 65 73 74 61 72 74 usually restart
3870: 73 20 74 68 65 20 0a 20 20 62 61 63 6b 75 70 20 s the . backup
3880: 70 72 6f 63 65 73 73 20 77 68 65 6e 20 73 71 6c process when sql
3890: 69 74 65 33 5f 62 61 63 6b 75 70 5f 73 74 65 70 ite3_backup_step
38a0: 28 29 20 69 73 20 6e 65 78 74 20 63 61 6c 6c 65 () is next calle
38b0: 64 2e 20 54 68 65 72 65 20 69 73 20 6f 6e 65 20 d. There is one
38c0: 0a 20 20 65 78 63 65 70 74 69 6f 6e 20 74 6f 20 . exception to
38d0: 74 68 69 73 20 72 75 6c 65 3a 20 49 66 20 74 68 this rule: If th
38e0: 65 20 73 6f 75 72 63 65 20 64 61 74 61 62 61 73 e source databas
38f0: 65 20 69 73 20 6e 6f 74 20 61 6e 20 69 6e 2d 6d e is not an in-m
3900: 65 6d 6f 72 79 20 64 61 74 61 62 61 73 65 2c 0a emory database,.
3910: 20 20 61 6e 64 20 74 68 65 20 77 72 69 74 65 20 and the write
3920: 69 73 20 70 65 72 66 6f 72 6d 65 64 20 66 72 6f is performed fro
3930: 6d 20 77 69 74 68 69 6e 20 74 68 65 20 73 61 6d m within the sam
3940: 65 20 70 72 6f 63 65 73 73 20 61 73 20 74 68 65 e process as the
3950: 20 62 61 63 6b 75 70 0a 20 20 6f 70 65 72 61 74 backup. operat
3960: 69 6f 6e 20 61 6e 64 20 75 73 65 73 20 74 68 65 ion and uses the
3970: 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 20 68 same database h
3980: 61 6e 64 6c 65 20 28 70 44 62 29 2c 20 74 68 65 andle (pDb), the
3990: 6e 20 74 68 65 20 64 65 73 74 69 6e 61 74 69 6f n the destinatio
39a0: 6e 0a 20 20 64 61 74 61 62 61 73 65 20 28 74 68 n. database (th
39b0: 65 20 6f 6e 65 20 6f 70 65 6e 65 64 20 75 73 69 e one opened usi
39c0: 6e 67 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 70 46 ng connection pF
39d0: 69 6c 65 29 20 69 73 20 61 75 74 6f 6d 61 74 69 ile) is automati
39e0: 63 61 6c 6c 79 20 75 70 64 61 74 65 64 0a 20 20 cally updated.
39f0: 61 6c 6f 6e 67 20 77 69 74 68 20 74 68 65 20 73 along with the s
3a00: 6f 75 72 63 65 2e 20 54 68 65 20 62 61 63 6b 75 ource. The backu
3a10: 70 20 70 72 6f 63 65 73 73 20 6d 61 79 20 74 68 p process may th
3a20: 65 6e 20 62 65 20 63 6f 6e 74 69 6e 75 65 64 20 en be continued
3a30: 61 66 74 65 72 20 74 68 65 20 0a 20 20 73 71 6c after the . sql
3a40: 69 74 65 33 5f 73 6c 65 65 70 28 29 20 63 61 6c ite3_sleep() cal
3a50: 6c 20 72 65 74 75 72 6e 73 20 61 73 20 69 66 20 l returns as if
3a60: 6e 6f 74 68 69 6e 67 20 68 61 64 20 68 61 70 70 nothing had happ
3a70: 65 6e 65 64 2e 20 0a 0a 3c 70 3e 0a 20 20 57 68 ened. ..<p>. Wh
3a80: 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68 65 ether or not the
3a90: 20 62 61 63 6b 75 70 20 70 72 6f 63 65 73 73 20 backup process
3aa0: 69 73 20 72 65 73 74 61 72 74 65 64 20 61 73 20 is restarted as
3ab0: 61 20 72 65 73 75 6c 74 20 6f 66 20 77 72 69 74 a result of writ
3ac0: 65 73 20 74 6f 0a 20 20 74 68 65 20 73 6f 75 72 es to. the sour
3ad0: 63 65 20 64 61 74 61 62 61 73 65 20 6d 69 64 2d ce database mid-
3ae0: 62 61 63 6b 75 70 2c 20 74 68 65 20 75 73 65 72 backup, the user
3af0: 20 63 61 6e 20 62 65 20 73 75 72 65 20 74 68 61 can be sure tha
3b00: 74 20 77 68 65 6e 20 74 68 65 20 62 61 63 6b 75 t when the backu
3b10: 70 0a 20 20 6f 70 65 72 61 74 69 6f 6e 20 69 73 p. operation is
3b20: 20 63 6f 6d 70 6c 65 74 65 64 20 74 68 65 20 62 completed the b
3b30: 61 63 6b 75 70 20 64 61 74 61 62 61 73 65 20 63 ackup database c
3b40: 6f 6e 74 61 69 6e 73 20 61 20 63 6f 6e 73 69 73 ontains a consis
3b50: 74 65 6e 74 20 61 6e 64 20 0a 20 20 75 70 2d 74 tent and . up-t
3b60: 6f 2d 64 61 74 65 20 73 6e 61 70 73 68 6f 74 20 o-date snapshot
3b70: 6f 66 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 2e of the original.
3b80: 20 48 6f 77 65 76 65 72 3a 0a 0a 20 20 3c 75 6c However:.. <ul
3b90: 3e 0a 20 20 20 20 3c 6c 69 3e 20 57 72 69 74 65 >. <li> Write
3ba0: 73 20 74 6f 20 61 6e 20 69 6e 2d 6d 65 6d 6f 72 s to an in-memor
3bb0: 79 20 73 6f 75 72 63 65 20 64 61 74 61 62 61 73 y source databas
3bc0: 65 2c 20 6f 72 20 77 72 69 74 65 73 20 74 6f 20 e, or writes to
3bd0: 61 20 66 69 6c 65 2d 62 61 73 65 64 20 0a 20 20 a file-based .
3be0: 20 20 20 20 20 20 20 73 6f 75 72 63 65 20 64 61 source da
3bf0: 74 61 62 61 73 65 20 62 79 20 61 6e 20 65 78 74 tabase by an ext
3c00: 65 72 6e 61 6c 20 70 72 6f 63 65 73 73 20 6f 72 ernal process or
3c10: 20 74 68 72 65 61 64 20 75 73 69 6e 67 20 61 20 thread using a
3c20: 0a 20 20 20 20 20 20 20 20 20 64 61 74 61 62 61 . databa
3c30: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 6f 74 se connection ot
3c40: 68 65 72 20 74 68 61 6e 20 70 44 62 20 61 72 65 her than pDb are
3c50: 20 73 69 67 6e 69 66 69 63 61 6e 74 6c 79 20 6d significantly m
3c60: 6f 72 65 20 65 78 70 65 6e 73 69 76 65 20 0a 20 ore expensive .
3c70: 20 20 20 20 20 20 20 20 74 68 61 6e 20 77 72 69 than wri
3c80: 74 65 73 20 6d 61 64 65 20 74 6f 20 61 20 66 69 tes made to a fi
3c90: 6c 65 2d 62 61 73 65 64 20 73 6f 75 72 63 65 20 le-based source
3ca0: 64 61 74 61 62 61 73 65 20 75 73 69 6e 67 20 70 database using p
3cb0: 44 62 20 28 61 73 20 74 68 65 0a 20 20 20 20 20 Db (as the.
3cc0: 20 20 20 20 65 6e 74 69 72 65 20 62 61 63 6b 75 entire backu
3cd0: 70 20 6f 70 65 72 61 74 69 6f 6e 20 6d 75 73 74 p operation must
3ce0: 20 62 65 20 72 65 73 74 61 72 74 65 64 20 69 6e be restarted in
3cf0: 20 74 68 65 20 66 6f 72 6d 65 72 20 74 77 6f 20 the former two
3d00: 63 61 73 65 73 29 2e 0a 0a 20 20 20 20 3c 6c 69 cases)... <li
3d10: 3e 20 49 66 20 74 68 65 20 62 61 63 6b 75 70 20 > If the backup
3d20: 70 72 6f 63 65 73 73 20 69 73 20 72 65 73 74 61 process is resta
3d30: 72 74 65 64 20 66 72 65 71 75 65 6e 74 6c 79 20 rted frequently
3d40: 65 6e 6f 75 67 68 20 69 74 20 6d 61 79 20 6e 65 enough it may ne
3d50: 76 65 72 0a 20 20 20 20 20 20 20 20 20 72 75 6e ver. run
3d60: 20 74 6f 20 63 6f 6d 70 6c 65 74 69 6f 6e 20 61 to completion a
3d70: 6e 64 20 74 68 65 20 62 61 63 6b 75 70 44 62 28 nd the backupDb(
3d80: 29 20 66 75 6e 63 74 69 6f 6e 20 6d 61 79 20 6e ) function may n
3d90: 65 76 65 72 20 72 65 74 75 72 6e 2e 0a 20 20 3c ever return.. <
3da0: 2f 75 6c 3e 0a 20 0a 3c 70 3e 3c 62 3e 62 61 63 /ul>. .<p><b>bac
3db0: 6b 75 70 5f 72 65 6d 61 69 6e 69 6e 67 28 29 20 kup_remaining()
3dc0: 61 6e 64 20 62 61 63 6b 75 70 5f 70 61 67 65 63 and backup_pagec
3dd0: 6f 75 6e 74 28 29 3c 2f 62 3e 0a 0a 3c 70 3e 0a ount()</b>..<p>.
3de0: 20 20 54 68 65 20 62 61 63 6b 75 70 44 62 28 29 The backupDb()
3df0: 20 66 75 6e 63 74 69 6f 6e 20 75 73 65 73 20 74 function uses t
3e00: 68 65 20 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 he sqlite3_backu
3e10: 70 5f 72 65 6d 61 69 6e 69 6e 67 28 29 20 61 6e p_remaining() an
3e20: 64 0a 20 20 73 71 6c 69 74 65 33 5f 62 61 63 6b d. sqlite3_back
3e30: 75 70 5f 70 61 67 65 63 6f 75 6e 74 28 29 20 66 up_pagecount() f
3e40: 75 6e 63 74 69 6f 6e 73 20 74 6f 20 72 65 70 6f unctions to repo
3e50: 72 74 20 69 74 73 20 70 72 6f 67 72 65 73 73 20 rt its progress
3e60: 76 69 61 20 74 68 65 0a 20 20 75 73 65 72 2d 73 via the. user-s
3e70: 75 70 70 6c 69 65 64 20 78 50 72 6f 67 72 65 73 upplied xProgres
3e80: 73 28 29 20 63 61 6c 6c 62 61 63 6b 2e 20 46 75 s() callback. Fu
3e90: 6e 63 74 69 6f 6e 20 73 71 6c 69 74 65 33 5f 62 nction sqlite3_b
3ea0: 61 63 6b 75 70 5f 72 65 6d 61 69 6e 69 6e 67 28 ackup_remaining(
3eb0: 29 0a 20 20 72 65 74 75 72 6e 73 20 74 68 65 20 ). returns the
3ec0: 6e 75 6d 62 65 72 20 6f 66 20 70 61 67 65 73 20 number of pages
3ed0: 6c 65 66 74 20 74 6f 20 63 6f 70 79 20 61 6e 64 left to copy and
3ee0: 20 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f sqlite3_backup_
3ef0: 70 61 67 65 63 6f 75 6e 74 28 29 0a 20 20 72 65 pagecount(). re
3f00: 74 75 72 6e 73 20 74 68 65 20 74 6f 74 61 6c 20 turns the total
3f10: 6e 75 6d 62 65 72 20 6f 66 20 70 61 67 65 73 20 number of pages
3f20: 69 6e 20 74 68 65 20 73 6f 75 72 63 65 20 64 61 in the source da
3f30: 74 61 62 61 73 65 20 28 69 6e 20 74 68 69 73 20 tabase (in this
3f40: 63 61 73 65 20 0a 20 20 74 68 65 20 64 61 74 61 case . the data
3f50: 62 61 73 65 20 6f 70 65 6e 65 64 20 62 79 20 70 base opened by p
3f60: 44 62 29 2e 20 53 6f 20 74 68 65 20 70 65 72 63 Db). So the perc
3f70: 65 6e 74 61 67 65 20 63 6f 6d 70 6c 65 74 69 6f entage completio
3f80: 6e 20 6f 66 20 74 68 65 20 70 72 6f 63 65 73 73 n of the process
3f90: 0a 20 20 6d 61 79 20 62 65 20 63 61 6c 63 75 6c . may be calcul
3fa0: 61 74 65 64 20 61 73 3a 0a 0a 3c 70 20 73 74 79 ated as:..<p sty
3fb0: 6c 65 3d 22 66 6f 6e 74 2d 66 61 6d 69 6c 79 3a le="font-family:
3fc0: 66 69 78 65 64 3b 6d 61 72 67 69 6e 2d 6c 65 66 fixed;margin-lef
3fd0: 74 3a 35 65 6d 22 3e 0a 20 20 43 6f 6d 70 6c 65 t:5em">. Comple
3fe0: 74 69 6f 6e 20 3d 20 31 30 30 25 20 2a 20 28 70 tion = 100% * (p
3ff0: 61 67 65 63 6f 75 6e 74 28 29 20 2d 20 72 65 6d agecount() - rem
4000: 61 69 6e 69 6e 67 28 29 29 20 2f 20 70 61 67 65 aining()) / page
4010: 63 6f 75 6e 74 28 29 0a 0a 3c 70 3e 0a 20 20 54 count()..<p>. T
4020: 68 65 20 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 he sqlite3_backu
4030: 70 5f 72 65 6d 61 69 6e 69 6e 67 28 29 20 61 6e p_remaining() an
4040: 64 20 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 d sqlite3_backup
4050: 5f 70 61 67 65 63 6f 75 6e 74 28 29 20 41 50 49 _pagecount() API
4060: 73 20 72 65 70 6f 72 74 0a 20 20 76 61 6c 75 65 s report. value
4070: 73 20 73 74 6f 72 65 64 20 62 79 20 74 68 65 20 s stored by the
4080: 70 72 65 76 69 6f 75 73 20 63 61 6c 6c 20 74 6f previous call to
4090: 20 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f sqlite3_backup_
40a0: 73 74 65 70 28 29 2c 20 74 68 65 79 20 64 6f 20 step(), they do
40b0: 6e 6f 74 0a 20 20 61 63 74 75 61 6c 6c 79 20 69 not. actually i
40c0: 6e 73 70 65 63 74 20 74 68 65 20 73 6f 75 72 63 nspect the sourc
40d0: 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 2e e database file.
40e0: 20 54 68 69 73 20 6d 65 61 6e 73 20 74 68 61 74 This means that
40f0: 20 69 66 20 74 68 65 20 73 6f 75 72 63 65 0a 20 if the source.
4100: 20 64 61 74 61 62 61 73 65 20 69 73 20 77 72 69 database is wri
4110: 74 74 65 6e 20 74 6f 20 62 79 20 61 6e 6f 74 68 tten to by anoth
4120: 65 72 20 74 68 72 65 61 64 20 6f 72 20 70 72 6f er thread or pro
4130: 63 65 73 73 20 61 66 74 65 72 20 74 68 65 20 63 cess after the c
4140: 61 6c 6c 20 74 6f 0a 20 20 73 71 6c 69 74 65 33 all to. sqlite3
4150: 5f 62 61 63 6b 75 70 5f 73 74 65 70 28 29 20 72 _backup_step() r
4160: 65 74 75 72 6e 73 20 62 75 74 20 62 65 66 6f 72 eturns but befor
4170: 65 20 74 68 65 20 76 61 6c 75 65 73 20 72 65 74 e the values ret
4180: 75 72 6e 65 64 20 62 79 0a 20 20 73 71 6c 69 74 urned by. sqlit
4190: 65 33 5f 62 61 63 6b 75 70 5f 72 65 6d 61 69 6e e3_backup_remain
41a0: 69 6e 67 28 29 20 61 6e 64 20 73 71 6c 69 74 65 ing() and sqlite
41b0: 33 5f 62 61 63 6b 75 70 5f 70 61 67 65 63 6f 75 3_backup_pagecou
41c0: 6e 74 28 29 20 61 72 65 20 75 73 65 64 2c 20 74 nt() are used, t
41d0: 68 65 20 0a 20 20 76 61 6c 75 65 73 20 6d 61 79 he . values may
41e0: 20 62 65 20 74 65 63 68 6e 69 63 61 6c 6c 79 20 be technically
41f0: 69 6e 63 6f 72 72 65 63 74 2e 20 54 68 69 73 20 incorrect. This
4200: 69 73 20 6e 6f 74 20 75 73 75 61 6c 6c 79 20 61 is not usually a
4210: 20 70 72 6f 62 6c 65 6d 2e 0a 0a 0a 3c 64 69 76 problem....<div
4220: 20 73 74 79 6c 65 3d 22 63 6c 65 61 72 3a 62 6f style="clear:bo
4230: 74 68 22 3e 3c 2f 64 69 76 3e 0a th"></div>.