Returning 1 from the set_progress_handler handler cancels query (GH-4120)

ac03c03b · Simon Willison · Berker Peksag · c29b585f · ac03c03b
Commit ac03c03b authored Nov 02, 2017 by Simon Willison Committed by Berker Peksag Nov 02, 2017
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 0 deletions

Doc/library/sqlite3.rst Doc/library/sqlite3.rst +4 -0

No files found.
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -421,6 +421,10 @@ Connection Objects
      If you want to clear any previously installed progress handler, call the
      method with :const:`None` for *handler*.

+      Returning a non-zero value from the handler function will terminate the
+      currently executing query and cause it to raise an :exc:`OperationalError`
+      exception.
+

   .. method:: set_trace_callback(trace_callback)