Home | History | Annotate | Line # | Download | only in man
      1 .Dd April 29, 2026
      2 .Dt SQLITE_CHECKPOINT_NOOP 3
      3 .Os
      4 .Sh NAME
      5 .Nm SQLITE_CHECKPOINT_NOOP ,
      6 .Nm SQLITE_CHECKPOINT_PASSIVE ,
      7 .Nm SQLITE_CHECKPOINT_FULL ,
      8 .Nm SQLITE_CHECKPOINT_RESTART ,
      9 .Nm SQLITE_CHECKPOINT_TRUNCATE
     10 .Nd checkpoint mode values
     11 .Sh SYNOPSIS
     12 .In sqlite3.h
     13 .Fd #define SQLITE_CHECKPOINT_NOOP
     14 .Fd #define SQLITE_CHECKPOINT_PASSIVE
     15 .Fd #define SQLITE_CHECKPOINT_FULL
     16 .Fd #define SQLITE_CHECKPOINT_RESTART
     17 .Fd #define SQLITE_CHECKPOINT_TRUNCATE
     18 .Sh DESCRIPTION
     19 These constants define all valid values for the "checkpoint mode" passed
     20 as the third parameter to the
     21 .Fn sqlite3_wal_checkpoint_v2
     22 interface.
     23 See the
     24 .Fn sqlite3_wal_checkpoint_v2
     25 documentation for details on the meaning of each of these checkpoint
     26 modes.
     27 .Sh IMPLEMENTATION NOTES
     28 These declarations were extracted from the
     29 interface documentation at line 10168.
     30 .Bd -literal
     31 #define SQLITE_CHECKPOINT_NOOP    -1  /* Do no work at all */
     32 #define SQLITE_CHECKPOINT_PASSIVE  0  /* Do as much as possible w/o blocking */
     33 #define SQLITE_CHECKPOINT_FULL     1  /* Wait for writers, then checkpoint */
     34 #define SQLITE_CHECKPOINT_RESTART  2  /* Like FULL but wait for readers */
     35 #define SQLITE_CHECKPOINT_TRUNCATE 3  /* Like RESTART but also truncate WAL */
     36 .Ed
     37 .Sh SEE ALSO
     38 .Xr sqlite3_wal_checkpoint_v2 3
     39