Skip to content

[3.10] bpo-45608: Document missing sqlite3 DB-API attributes and methods (GH-29219) #29281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 28, 2021
Merged

[3.10] bpo-45608: Document missing sqlite3 DB-API attributes and methods (GH-29219) #29281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,24 @@ Module functions and constants
------------------------------


.. data:: apilevel

String constant stating the supported DB-API level. Required by the DB-API.
Hard-coded to ``"2.0"``.

.. data:: paramstyle

String constant stating the type of parameter marker formatting expected by
the :mod:`sqlite3` module. Required by the DB-API. Hard-coded to
``"qmark"``.

.. note::

The :mod:`sqlite3` module supports both ``qmark`` and ``numeric`` DB-API
parameter styles, because that is what the underlying SQLite library
supports. However, the DB-API does not allow multiple values for
the ``paramstyle`` attribute.

.. data:: version

The version number of this module, as a string. This is not the version of
Expand All @@ -139,6 +157,26 @@ Module functions and constants
The version number of the run-time SQLite library, as a tuple of integers.


.. data:: threadsafety

Integer constant required by the DB-API, stating the level of thread safety
the :mod:`sqlite3` module supports. Currently hard-coded to ``1``, meaning
*"Threads may share the module, but not connections."* However, this may not
always be true. You can check the underlying SQLite library's compile-time
threaded mode using the following query::

import sqlite3
con = sqlite3.connect(":memory:")
con.execute("""
select * from pragma_compile_options
where compile_options like 'THREADSAFE=%'
""").fetchall()

Note that the `SQLITE_THREADSAFE levels
<https://sqlite.org/compile.html#threadsafe>`_ do not match the DB-API 2.0
``threadsafety`` levels.


.. data:: PARSE_DECLTYPES

This constant is meant to be used with the *detect_types* parameter of the
Expand Down Expand Up @@ -701,6 +739,14 @@ Cursor Objects
The cursor will be unusable from this point forward; a :exc:`ProgrammingError`
exception will be raised if any operation is attempted with the cursor.

.. method:: setinputsizes(sizes)

Required by the DB-API. Is a no-op in :mod:`sqlite3`.

.. method:: setoutputsize(size [, column])

Required by the DB-API. Is a no-op in :mod:`sqlite3`.

.. attribute:: rowcount

Although the :class:`Cursor` class of the :mod:`sqlite3` module implements this
Expand Down