summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/sqlite3_interrupt.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_interrupt.3
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/sqlite3_interrupt.3')
-rw-r--r--static/netbsd/man3/sqlite3_interrupt.363
1 files changed, 63 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3_interrupt.3 b/static/netbsd/man3/sqlite3_interrupt.3
new file mode 100644
index 00000000..91c65a45
--- /dev/null
+++ b/static/netbsd/man3/sqlite3_interrupt.3
@@ -0,0 +1,63 @@
+.Dd January 24, 2024
+.Dt SQLITE3_INTERRUPT 3
+.Os
+.Sh NAME
+.Nm sqlite3_interrupt ,
+.Nm sqlite3_is_interrupted
+.Nd interrupt a long-Running query
+.Sh SYNOPSIS
+.In sqlite3.h
+.Ft void
+.Fo sqlite3_interrupt
+.Fa "sqlite3*"
+.Fc
+.Ft int
+.Fo sqlite3_is_interrupted
+.Fa "sqlite3*"
+.Fc
+.Sh DESCRIPTION
+This function causes any pending database operation to abort and return
+at its earliest opportunity.
+This routine is typically called in response to a user action such
+as pressing "Cancel" or Ctrl-C where the user wants a long query operation
+to halt immediately.
+.Pp
+It is safe to call this routine from a thread different from the thread
+that is currently running the database operation.
+But it is not safe to call this routine with a database connection
+that is closed or might close before sqlite3_interrupt() returns.
+.Pp
+If an SQL operation is very nearly finished at the time when sqlite3_interrupt()
+is called, then it might not have an opportunity to be interrupted
+and might continue to completion.
+.Pp
+An SQL operation that is interrupted will return SQLITE_INTERRUPT.
+If the interrupted SQL operation is an INSERT, UPDATE, or DELETE that
+is inside an explicit transaction, then the entire transaction will
+be rolled back automatically.
+.Pp
+The sqlite3_interrupt(D) call is in effect until all currently running
+SQL statements on database connection D complete.
+Any new SQL statements that are started after the sqlite3_interrupt()
+call and before the running statement count reaches zero are interrupted
+as if they had been running prior to the sqlite3_interrupt() call.
+New SQL statements that are started after the running statement count
+reaches zero are not effected by the sqlite3_interrupt().
+A call to sqlite3_interrupt(D) that occurs when there are no running
+SQL statements is a no-op and has no effect on SQL statements that
+are started after the sqlite3_interrupt() call returns.
+.Pp
+The sqlite3_is_interrupted(D) interface can
+be used to determine whether or not an interrupt is currently in effect
+for database connection D.
+It returns 1 if an interrupt is currently in effect, or 0 otherwise.
+.Sh IMPLEMENTATION NOTES
+These declarations were extracted from the
+interface documentation at line 2703.
+.Bd -literal
+SQLITE_API void sqlite3_interrupt(sqlite3*);
+SQLITE_API int sqlite3_is_interrupted(sqlite3*);
+.Ed
+.Sh SEE ALSO
+.Xr sqlite3 3 ,
+.Xr SQLITE_OK 3