From: drh Date: Tue, 3 Feb 2009 18:25:13 +0000 (+0000) Subject: Tweaks to the backup API documentation contained in comments. No changes X-Git-Tag: version-3.6.15~508 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=27b3b84796eaea357ba2106183ceea5a06751663;p=thirdparty%2Fsqlite.git Tweaks to the backup API documentation contained in comments. No changes to code. (CVS 6242) FossilOrigin-Name: 6298bcca14bc0dd447198430af4147a3673963fc --- diff --git a/manifest b/manifest index 5d41cc6fe5..4fa3e11969 100644 --- a/manifest +++ b/manifest @@ -1,5 +1,5 @@ -C Commit\sfirst\sversion\sof\sthe\s'backup'\sfeature.\s(CVS\s6241) -D 2009-02-03T16:51:25 +C Tweaks\sto\sthe\sbackup\sAPI\sdocumentation\scontained\sin\scomments.\sNo\schanges\nto\scode.\s(CVS\s6242) +D 2009-02-03T18:25:13 F Makefile.arm-wince-mingw32ce-gcc fcd5e9cd67fe88836360bb4f9ef4cb7f8e2fb5a0 F Makefile.in c7a5a30fb6852bd7839b1024e1661da8549878ee F Makefile.linux-gcc d53183f4aa6a9192d249731c90dbdffbd2c68654 @@ -157,7 +157,7 @@ F src/resolve.c 18dc9f0df1d60048e012ce6632251063e0dd356a F src/rowset.c ba9375f37053d422dd76965a9c370a13b6e1aac4 F src/select.c ae72b604e47092521c4d9ae54e1b1cbeb872a747 F src/shell.c 8965cf0cd7a7dac39d586a43c97adb00930e025d -F src/sqlite.h.in e0d54b3a93489154151f49007a2f1219171945fa +F src/sqlite.h.in 48e40b4115396ff7eaa1ade9fd90a59e1d8353a0 F src/sqlite3ext.h 1db7d63ab5de4b3e6b83dd03d1a4e64fef6d2a17 F src/sqliteInt.h 73c1d4f9716fe21f202f9d05c4fd9e6281f2636f F src/sqliteLimit.h ffe93f5a0c4e7bd13e70cd7bf84cfb5c3465f45d @@ -700,7 +700,7 @@ F tool/speedtest16.c c8a9c793df96db7e4933f0852abb7a03d48f2e81 F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff F tool/speedtest8.c 2902c46588c40b55661e471d7a86e4dd71a18224 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e -P 2e45c2a85183f7430225aa8dd89ee05028afecf2 -R 4e142df07079d9b7b2e171c0f7313ba2 -U danielk1977 -Z aac63fa067e376f14e29eb95cbe2ffd4 +P 663479b417fc06ba1790a544f28694f8797cee57 +R 149ec6ea1b4cdb18000a87226a3bf85e +U drh +Z 1039ac561b4a6768bed916b37674a8c8 diff --git a/manifest.uuid b/manifest.uuid index 2cae1aff8a..6fb37888f5 100644 --- a/manifest.uuid +++ b/manifest.uuid @@ -1 +1 @@ -663479b417fc06ba1790a544f28694f8797cee57 \ No newline at end of file +6298bcca14bc0dd447198430af4147a3673963fc \ No newline at end of file diff --git a/src/sqlite.h.in b/src/sqlite.h.in index 0d23bf213a..e884eff1fd 100644 --- a/src/sqlite.h.in +++ b/src/sqlite.h.in @@ -30,7 +30,7 @@ ** the version number) and changes its name to "sqlite3.h" as ** part of the build process. ** -** @(#) $Id: sqlite.h.in,v 1.423 2009/02/03 16:51:25 danielk1977 Exp $ +** @(#) $Id: sqlite.h.in,v 1.424 2009/02/03 18:25:13 drh Exp $ */ #ifndef _SQLITE3_H_ #define _SQLITE3_H_ @@ -6722,6 +6722,17 @@ struct sqlite3_pcache_methods { void (*xDestroy)(sqlite3_pcache*); }; +/* +** CAPI3REF: Online Backup Object +** EXPERIMENTAL +** +** The sqlite3_backup object records state information about an ongoing +** online backup operation. The sqlite3_backup object is created by +** a call to [sqlite3_backup_init()] and is destroyed by a call to +** [sqlite3_backup_finish()]. +*/ +typedef struct sqlite3_backup sqlite3_backup; + /* ** CAPI3REF: Online Backup API. ** EXPERIMENTAL @@ -6764,8 +6775,8 @@ struct sqlite3_pcache_methods { ** and an error code and error message written into the database handle ** passed as the first argument. They may be retrieved using the ** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16() functions. -** Otherwise, if successful, an opaque handle of type sqlite3_backup* is -** returned. This handle may be used with the sqlite3_backup_step() and +** Otherwise, if successful, a pointer to an [sqlite3_backup] object is +** returned. This pointer may be used with the sqlite3_backup_step() and ** sqlite3_backup_finish() functions to perform the specified backup ** operation. ** @@ -6819,11 +6830,11 @@ struct sqlite3_pcache_methods { ** sqlite3_backup_finish() ** ** Once sqlite3_backup_step() has returned SQLITE_DONE, or when the -** application wishes to abandon the backup operation, the sqlite3_backup* -** handle should be passed to sqlite3_backup_finish(). This releases all +** application wishes to abandon the backup operation, the [sqlite3_backup] +** object should be passed to sqlite3_backup_finish(). This releases all ** resources associated with the backup operation. If sqlite3_backup_step() ** has not yet returned SQLITE_DONE, then any active write-transaction on the -** destination database is rolled back. The sqlite3_backup* handle is invalid +** destination database is rolled back. The [sqlite3_backup] object is invalid ** and may not be used following a call to sqlite3_backup_finish(). ** ** The value returned by sqlite3_backup_finish is SQLITE_OK if no error @@ -6841,7 +6852,7 @@ struct sqlite3_pcache_methods { ** sqlite3_backup_remaining(), sqlite3_backup_pagecount() ** ** Each call to sqlite3_backup_step() sets two values stored internally -** by an sqlite3_backup* handle. The number of pages still to be backed +** by an [sqlite3_backup] object. The number of pages still to be backed ** up, which may be queried by sqlite3_backup_remaining(), and the total ** number of pages in the source database file, which may be queried by ** sqlite3_backup_pagecount(). @@ -6875,14 +6886,13 @@ struct sqlite3_pcache_methods { ** backed up to is not accessed by any connection within the process, ** not just the specific connection that was passed to sqlite3_backup_init(). ** -** The sqlite3_backup handle itself is partially threadsafe. Multiple +** The [sqlite3_backup] object itself is partially threadsafe. Multiple ** threads may safely make multiple concurrent calls to sqlite3_backup_step(). ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() ** APIs are not strictly speaking threadsafe. If they are invoked at the ** same time as another thread is invoking sqlite3_backup_step() it is ** possible that they return invalid values. */ -typedef struct sqlite3_backup sqlite3_backup; sqlite3_backup *sqlite3_backup_init( sqlite3 *pDest, /* Destination database handle */ const char *zDestName, /* Destination database name */