aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authordan <Dan Kennedy>2024-10-02 11:11:00 +0000
committerdan <Dan Kennedy>2024-10-02 11:11:00 +0000
commitf9d1141a3b34e36cf26be87dbd199b036985b2d6 (patch)
tree2b0014476cf21499aa35992242dbf28a8f43a883 /src
parentd0720eee5e19d9d6889b275bdb652e5e0160899c (diff)
downloadsqlite-f9d1141a3b34e36cf26be87dbd199b036985b2d6.tar.gz
sqlite-f9d1141a3b34e36cf26be87dbd199b036985b2d6.zip
Update docs for sqlite3_snapshot_get().
FossilOrigin-Name: 78c3892ab777a39406da8a9df84d0634397514e25512b0363a13bff3b8bc8925
Diffstat (limited to 'src')
-rw-r--r--src/sqlite.h.in8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index 5546793c9..013be2037 100644
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -10539,6 +10539,14 @@ typedef struct sqlite3_snapshot {
** If there is not already a read-transaction open on schema S when
** this function is called, one is opened automatically.
**
+** If a read-transaction is opened by this function, then it is guaranteed
+** that the returned snapshot object may not be invalidated by a database
+** writer or checkpointer until after the read-transaction is closed. This
+** is not guaranteed if a read-transaction is already open when this
+** function is called. In that case, any subsequent write or checkpoint
+** operation on the database may invalidate the returned snapshot handle,
+** even while the read-transaction remains open.
+**
** The following must be true for this function to succeed. If any of
** the following statements are false when sqlite3_snapshot_get() is
** called, SQLITE_ERROR is returned. The final value of *P is undefined