summaryrefslogtreecommitdiffstats
path: root/Doc/library/sqlite3.rst
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-09-15 19:00:02 (GMT)
committerGitHub <noreply@github.com>2021-09-15 19:00:02 (GMT)
commit87f0ac8c1de83ac63447b9fe799dfb1657a5a9db (patch)
treef7d558c5f1b1948e2908c3acd14631988f12bca4 /Doc/library/sqlite3.rst
parent0e4f913da88791644150282e38ba21d1fca5fd91 (diff)
downloadcpython-87f0ac8c1de83ac63447b9fe799dfb1657a5a9db.zip
cpython-87f0ac8c1de83ac63447b9fe799dfb1657a5a9db.tar.gz
cpython-87f0ac8c1de83ac63447b9fe799dfb1657a5a9db.tar.bz2
bpo-45089: Improve sqlite3 trace callback docs (GH-28238) (GH-28371)
- Add link to str object and sqlite3 transaction control - Mention that exceptions are not propagated (cherry picked from commit 51056b40e711d84692d099ac8970077b33c7fafd) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Diffstat (limited to 'Doc/library/sqlite3.rst')
-rw-r--r--Doc/library/sqlite3.rst18
1 files changed, 13 insertions, 5 deletions
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 58545a6..172c5b7 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -451,14 +451,22 @@ Connection Objects
Registers *trace_callback* to be called for each SQL statement that is
actually executed by the SQLite backend.
- The only argument passed to the callback is the statement (as string) that
- is being executed. The return value of the callback is ignored. Note that
- the backend does not only run statements passed to the :meth:`Cursor.execute`
- methods. Other sources include the transaction management of the Python
- module and the execution of triggers defined in the current database.
+ The only argument passed to the callback is the statement (as
+ :class:`str`) that is being executed. The return value of the callback is
+ ignored. Note that the backend does not only run statements passed to the
+ :meth:`Cursor.execute` methods. Other sources include the
+ :ref:`transaction management <sqlite3-controlling-transactions>` of the
+ sqlite3 module and the execution of triggers defined in the current
+ database.
Passing :const:`None` as *trace_callback* will disable the trace callback.
+ .. note::
+ Exceptions raised in the trace callback are not propagated. As a
+ development and debugging aid, use
+ :meth:`~sqlite3.enable_callback_tracebacks` to enable printing
+ tracebacks from exceptions raised in the trace callback.
+
.. versionadded:: 3.3