diff options
author | Erlend Egeberg Aasland <erlend.aasland@innova.no> | 2021-09-15 18:39:05 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-09-15 18:39:05 (GMT) |
commit | 51056b40e711d84692d099ac8970077b33c7fafd (patch) | |
tree | 024dd061fb53925a4d623e29aae807d6487aec9d | |
parent | ff6d2cc55aac5cc53e331cae145d0cf35ec647b0 (diff) | |
download | cpython-51056b40e711d84692d099ac8970077b33c7fafd.zip cpython-51056b40e711d84692d099ac8970077b33c7fafd.tar.gz cpython-51056b40e711d84692d099ac8970077b33c7fafd.tar.bz2 |
bpo-45089: Improve sqlite3 trace callback docs (GH-28238)
- Add link to str object and sqlite3 transaction control
- Mention that exceptions are not propagated
-rw-r--r-- | Doc/library/sqlite3.rst | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index 7c60188..9c9c7f1 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -460,14 +460,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 |