Skip to content
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

gh-131002: clarify how to enforce sqlite3 column types for generated fields #131006

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+19 −18
Open

gh-131002: clarify how to enforce sqlite3 column types for generated fields #131006

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1885626
gh-131002: clarify how to enforce sqlite3 column types for generated …
erlend-aasland Mar 9, 2025
4d14744
wrapped in
erlend-aasland Mar 9, 2025
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
37 changes: 19 additions & 18 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,9 +290,6 @@ Module functions
:const:`PARSE_DECLTYPES` and :const:`PARSE_COLNAMES`
to enable this.
Column names takes precedence over declared types if both flags are set.
Types cannot be detected for generated fields (for example ``max(data)``),
even when the *detect_types* parameter is set; :class:`str` will be
returned instead.
By default (``0``), type detection is disabled.

:param isolation_level:
Expand Down Expand Up @@ -436,21 +433,6 @@ Module constants
old style (pre-Python 3.12) transaction control behaviour.
See :ref:`sqlite3-transaction-control-isolation-level` for more information.

.. data:: PARSE_COLNAMES

Pass this flag value to the *detect_types* parameter of
:func:`connect` to look up a converter function by
using the type name, parsed from the query column name,
as the converter dictionary key.
The type name must be wrapped in square brackets (``[]``).

.. code-block:: sql

SELECT p as "p [point]" FROM test; ! will look up converter "point"

This flag may be combined with :const:`PARSE_DECLTYPES` using the ``|``
(bitwise or) operator.

.. data:: PARSE_DECLTYPES

Pass this flag value to the *detect_types* parameter of
Expand All @@ -472,6 +454,25 @@ Module constants
This flag may be combined with :const:`PARSE_COLNAMES` using the ``|``
(bitwise or) operator.

Generated fields (for example ``MAX(data)``) are returned as :class:`str`;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about the semi-colon here. @AA-Turner, does this read slightly off-kilter?

use :const:`!PARSE_COLNAMES` to enforce types for such queries.

.. data:: PARSE_COLNAMES

Pass this flag value to the *detect_types* parameter of
:func:`connect` to look up a converter function by
using the type name, parsed from the query column name,
as the converter dictionary key.
The query column name must be wrapped in double quotes (``"``),
and the type name must be wrapped in square brackets (``[]``),

.. code-block:: sql

SELECT MAX(p) as "p [point]" FROM test; ! will look up converter "point"

This flag may be combined with :const:`PARSE_DECLTYPES` using the ``|``
(bitwise or) operator.

.. data:: SQLITE_OK
SQLITE_DENY
SQLITE_IGNORE
Expand Down
Loading