You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Improve clarity of sqlite3 transaction handling docs #94017
The current docs start out by describing the SQLite autocommit mode. This can be confusing to new users, especially since the DB API (PEP-249) describes its own autocommit behaviour. Suggesting to tone down the SQLite autocommit mode and instead focus on what the sqlite3 module does.
The docs say that implicit BEGIN statements are issues before DML statements. This is partly true. Implicit BEGIN statements are issued before INSERT, UPDATE, DELETE, and REPLACE statements when executed by execute or executemany, but not by executescript. Other DML statements do not receive such treatment.
We should update the docs of the execute, executemany, and executescript cursor methods to briefly mention their transaction control peculiarities.
Since SQLite autocommit mode is mentioned, we should note that it is in fact possible to query this (low-level) mode using the in_transaction connection attribute. Such information can help developers debug transaction control problems.
Possibly augment the docs of the isolation_level attribute. Currently, the isolation_levelproperty of connection refer to the docs of the isolation_levelattribute, which again refer to the Controlling Transactions section. The isolation_level property should have a concise description (reference), and link to the isolation_level attribute. The isolation_level attribute should provide a reference for what it does, and briefly mention expected behaviour. The Controlling Transactions section should provide more background (explanation) to what is happening, and it should briefly mention PEP 249, and the SQLite autocommit mode.
Revisit any transaction control examples and possibly turn them into clearer how-to's, or guides.
Just to note, this confused me greatly at first, since I thought it was referring to an isolation_levelproperty (@property) of the Connectionclass, but what it appears to mean is the isolation_levelparameter of the connectionfunction.
Just to note, this confused me greatly at first, since I thought it was referring to an isolation_level property (@Property) of the Connection class, but what it appears to mean is the isolation_level parameter of the connection function.
Activity
pythongh-94017: Improve clarity of sqlite3 transaction handling docs
CAM-Gerlach commentedon Jun 29, 2022
Just to note, this confused me greatly at first, since I thought it was referring to an
isolation_levelproperty (@property) of theConnectionclass, but what it appears to mean is theisolation_levelparameter of theconnectionfunction.erlend-aasland commentedon Jul 1, 2022
Sorry 'bout that! I was in a hurry :)
gh-94017: Improve clarity of sqlite3 transaction handling docs (#94320)
pythongh-94017: Improve clarity of sqlite3 transaction handling docs (p…
pythongh-94017: Improve clarity of sqlite3 transaction handling docs (p…
erlend-aasland commentedon Jul 6, 2022
Fixed in:
gh-94017: Improve clarity of sqlite3 transaction handling docs (GH-94320
gh-94017: Improve clarity of sqlite3 transaction handling docs (GH-94320