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