summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/sqlite3_wal_checkpoint.3
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
commit253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch)
treeadf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man3/sqlite3_wal_checkpoint.3
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/sqlite3_wal_checkpoint.3')
-rw-r--r--static/netbsd/man3/sqlite3_wal_checkpoint.339
1 files changed, 39 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3_wal_checkpoint.3 b/static/netbsd/man3/sqlite3_wal_checkpoint.3
new file mode 100644
index 00000000..904a085d
--- /dev/null
+++ b/static/netbsd/man3/sqlite3_wal_checkpoint.3
@@ -0,0 +1,39 @@
+.Dd January 24, 2024
+.Dt SQLITE3_WAL_CHECKPOINT 3
+.Os
+.Sh NAME
+.Nm sqlite3_wal_checkpoint
+.Nd checkpoint a database
+.Sh SYNOPSIS
+.In sqlite3.h
+.Ft int
+.Fo sqlite3_wal_checkpoint
+.Fa "sqlite3 *db"
+.Fa "const char *zDb"
+.Fc
+.Sh DESCRIPTION
+The sqlite3_wal_checkpoint(D,X) is equivalent to sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0).
+.Pp
+In brief, sqlite3_wal_checkpoint(D,X) causes the content in the write-ahead log
+for database X on database connection D to be transferred
+into the database file and for the write-ahead log to be reset.
+See the checkpointing documentation for addition information.
+.Pp
+This interface used to be the only way to cause a checkpoint to occur.
+But then the newer and more powerful
+.Fn sqlite3_wal_checkpoint_v2
+interface was added.
+This interface is retained for backwards compatibility and as a convenience
+for applications that need to manually start a callback but which do
+not need the full power (and corresponding complication) of
+.Fn sqlite3_wal_checkpoint_v2 .
+.Sh IMPLEMENTATION NOTES
+These declarations were extracted from the
+interface documentation at line 9584.
+.Bd -literal
+SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
+.Ed
+.Sh SEE ALSO
+.Xr sqlite3 3 ,
+.Xr sqlite3_wal_checkpoint_v2 3 ,
+.Xr SQLITE_CHECKPOINT_PASSIVE 3