From: Berker Peksag <berker.peksag@gmail.com>
Date: Thu, 2 Nov 2017 18:08:04 +0000 (+0300)
Subject: Returning 1 from the set_progress_handler handler cancels query (GH-4120)
X-Git-Tag: v3.6.4rc1~109
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7891556b5cc98e546f905b4a5778e7cd7d9a0c7c;p=thirdparty%2FPython%2Fcpython.git

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

(cherry picked from commit ac03c03b305273f39d5374e2826526d4ab6bb415)
---

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