From: Simon Willison <simonw@eventbrite.com>
Date: Thu, 2 Nov 2017 14:34:12 +0000 (-0700)
Subject: Returning 1 from the set_progress_handler handler cancels query (GH-4120)
X-Git-Tag: v3.7.0a3~260
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ac03c03b305273f39d5374e2826526d4ab6bb415;p=python

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

diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 9fef7d7f03..ef0c0bf64c 100644
--- 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)