xref: /netbsd-src/external/public-domain/sqlite/man/SQLITE_CHECKPOINT_PASSIVE.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE_CHECKPOINT_PASSIVE 3
3.Os
4.Sh NAME
5.Nm SQLITE_CHECKPOINT_PASSIVE ,
6.Nm SQLITE_CHECKPOINT_FULL ,
7.Nm SQLITE_CHECKPOINT_RESTART ,
8.Nm SQLITE_CHECKPOINT_TRUNCATE
9.Nd checkpoint mode values
10.Sh SYNOPSIS
11.In sqlite3.h
12.Fd #define SQLITE_CHECKPOINT_PASSIVE
13.Fd #define SQLITE_CHECKPOINT_FULL
14.Fd #define SQLITE_CHECKPOINT_RESTART
15.Fd #define SQLITE_CHECKPOINT_TRUNCATE
16.Sh DESCRIPTION
17These constants define all valid values for the "checkpoint mode" passed
18as the third parameter to the
19.Fn sqlite3_wal_checkpoint_v2
20interface.
21See the
22.Fn sqlite3_wal_checkpoint_v2
23documentation for details on the meaning of each of these checkpoint
24modes.
25.Sh IMPLEMENTATION NOTES
26These declarations were extracted from the
27interface documentation at line 9706.
28.Bd -literal
29#define SQLITE_CHECKPOINT_PASSIVE  0  /* Do as much as possible w/o blocking */
30#define SQLITE_CHECKPOINT_FULL     1  /* Wait for writers, then checkpoint */
31#define SQLITE_CHECKPOINT_RESTART  2  /* Like FULL but wait for readers */
32#define SQLITE_CHECKPOINT_TRUNCATE 3  /* Like RESTART but also truncate WAL */
33.Ed
34.Sh SEE ALSO
35.Xr sqlite3_wal_checkpoint_v2 3
36