summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorSimon Willison <simonw@eventbrite.com>2017-11-02 14:34:12 (GMT)
committerBerker Peksag <berker.peksag@gmail.com>2017-11-02 14:34:11 (GMT)
commitac03c03b305273f39d5374e2826526d4ab6bb415 (patch)
tree5a790a1fccb2da80e9fdec7c6526a80891813f01 /Doc
parentc29b585fd4b5a91d17fc5dd41d86edff28a30da3 (diff)
downloadcpython-ac03c03b305273f39d5374e2826526d4ab6bb415.zip
cpython-ac03c03b305273f39d5374e2826526d4ab6bb415.tar.gz
cpython-ac03c03b305273f39d5374e2826526d4ab6bb415.tar.bz2
Returning 1 from the set_progress_handler handler cancels query (GH-4120)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/sqlite3.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 9fef7d7..ef0c0bf 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)