Skip to content

[3.11] gh-95273: Relocate sqlite3 enable load extension note (GH-95430) #95448

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
miss-islington merged 1 commit into from
Jul 29, 2022
Merged

[3.11] gh-95273: Relocate sqlite3 enable load extension note (GH-95430) #95448

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
gh-95273: Relocate sqlite3 enable load extension note (GH-95430) 
(cherry picked from commit d92b19e)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
  • Loading branch information
@erlend-aasland @miss-islington
erlend-aasland authored and miss-islington committed Jul 29, 2022
commit 3b37028bbabfb608eda0015e5827be457c8b204c
20 changes: 8 additions & 12 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,14 @@ Connection Objects
aggregates or whole new virtual table implementations. One well-known
extension is the fulltext-search extension distributed with SQLite.

Loadable extensions are disabled by default. See [#f1]_.
.. note::

The ``sqlite3`` module is not built with loadable extension support by
default, because some platforms (notably macOS) have SQLite
libraries which are compiled without this feature.
To get loadable extension support,
you must pass the :option:`--enable-loadable-sqlite-extensions` option
to :program:`configure`.

.. audit-event:: sqlite3.enable_load_extension connection,enabled sqlite3.Connection.enable_load_extension

Expand All @@ -760,8 +767,6 @@ Connection Objects
Enable extension loading with :meth:`enable_load_extension` before
calling this method.

Loadable extensions are disabled by default. See [#f1]_.

.. audit-event:: sqlite3.load_extension connection,path sqlite3.Connection.load_extension

.. versionadded:: 3.2
Expand Down Expand Up @@ -1699,12 +1704,3 @@ the context manager is a no-op.
nor closes the connection.

.. literalinclude:: ../includes/sqlite3/ctx_manager.py


.. rubric:: Footnotes

.. [#f1] The sqlite3 module is not built with loadable extension support by
default, because some platforms (notably macOS) have SQLite
libraries which are compiled without this feature. To get loadable
extension support, you must pass the
:option:`--enable-loadable-sqlite-extensions` option to configure.