/ Check-in [0ef8ffd1]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Split the documentation for sqlite3_wal_checkpoint_v2() and its constants onto separate pages. No changes to code.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:0ef8ffd12fce47c3c89e851e5116e2777ea9f435
User & Date: drh 2011-02-10 18:56:09
Context
2011-02-10
21:08
Add .testctrl option to CLI. check-in: f85afa0e user: shaneh tags: trunk
18:56
Split the documentation for sqlite3_wal_checkpoint_v2() and its constants onto separate pages. No changes to code. check-in: 0ef8ffd1 user: drh tags: trunk
17:46
Prevent a segfault when automatic indices try to use a column with an unknown collating function. Ticket [77aa3b1e6592582e38605d36]. This check-in also removes some stray \r characters unrelated to the problem. check-in: f01030a0 user: drh tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to src/sqlite.h.in.

  6243   6243   ** connection D.  ^If the database connection D is not in
  6244   6244   ** [WAL | write-ahead log mode] then this interface is a harmless no-op.
  6245   6245   **
  6246   6246   ** ^The [wal_checkpoint pragma] can be used to invoke this interface
  6247   6247   ** from SQL.  ^The [sqlite3_wal_autocheckpoint()] interface and the
  6248   6248   ** [wal_autocheckpoint pragma] can be used to cause this interface to be
  6249   6249   ** run whenever the WAL reaches a certain size threshold.
         6250  +**
         6251  +** See also: [sqlite3_wal_checkpoint_v2()]
  6250   6252   */
  6251   6253   int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
  6252   6254   
  6253   6255   /*
  6254         -**
  6255   6256   ** CAPI3REF: Checkpoint a database
  6256   6257   **
  6257   6258   ** Run a checkpoint operation on WAL database zDb attached to database 
  6258   6259   ** handle db. The specific operation is determined by the value of the 
  6259   6260   ** eMode parameter:
  6260   6261   **
  6261   6262   ** <dl>
................................................................................
  6324   6325   int sqlite3_wal_checkpoint_v2(
  6325   6326     sqlite3 *db,                    /* Database handle */
  6326   6327     const char *zDb,                /* Name of attached database (or NULL) */
  6327   6328     int eMode,                      /* SQLITE_CHECKPOINT_* value */
  6328   6329     int *pnLog,                     /* OUT: Size of WAL log in frames */
  6329   6330     int *pnCkpt                     /* OUT: Total number of frames checkpointed */
  6330   6331   );
         6332  +
         6333  +/*
         6334  +** CAPI3REF: Checkpoint operation parameters
         6335  +**
         6336  +** These constants can be used as the 3rd parameter to
         6337  +** [sqlite3_wal_checkpoint_v2()].  See the [sqlite3_wal_checkpoint_v2()]
         6338  +** documentation for additional information about the meaning and use of
         6339  +** each of these values.
         6340  +*/
  6331   6341   #define SQLITE_CHECKPOINT_PASSIVE 0
  6332   6342   #define SQLITE_CHECKPOINT_FULL    1
  6333   6343   #define SQLITE_CHECKPOINT_RESTART 2
  6334   6344   
  6335   6345   
  6336   6346   /*
  6337   6347   ** Undo the hack that converts floating point types to integer for