Skip to content

[3.11] gh-95235: Document undocumented parameters in sqlite3 functions and methods (GH-95236) #95249

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.

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
Jul 25, 2022
Merged
Changes from all commits
Commits
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
30 changes: 17 additions & 13 deletions Doc/library/sqlite3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,7 @@ Connection Objects

.. method:: set_authorizer(authorizer_callback)

This routine registers a callback. The callback is invoked for each attempt to
Register callable *authorizer_callback* to be invoked for each attempt to
access a column of a table in the database. The callback should return
:const:`SQLITE_OK` if access is allowed, :const:`SQLITE_DENY` if the entire SQL
statement should be aborted with an error and :const:`SQLITE_IGNORE` if the
Expand All @@ -599,7 +599,7 @@ Connection Objects

.. method:: set_progress_handler(progress_handler, n)

This routine registers a callback. The callback is invoked for every *n*
Register callable *progress_handler* to be invoked for every *n*
instructions of the SQLite virtual machine. This is useful if you want to
get called from SQLite during long-running operations, for example to update
a GUI.
Expand All @@ -614,8 +614,8 @@ Connection Objects

.. method:: set_trace_callback(trace_callback)

Registers *trace_callback* to be called for each SQL statement that is
actually executed by the SQLite backend.
Register callable *trace_callback* to be invoked for each SQL statement
that is actually executed by the SQLite backend.

The only argument passed to the callback is the statement (as
:class:`str`) that is being executed. The return value of the callback is
Expand All @@ -638,8 +638,10 @@ Connection Objects

.. method:: enable_load_extension(enabled, /)

This routine allows/disallows the SQLite engine to load SQLite extensions
from shared libraries. SQLite extensions can define new functions,
Enable the SQLite engine to load SQLite extensions from shared libraries
if *enabled* is :const:`True`;
else, disallow loading SQLite extensions.
SQLite extensions can define new functions,
aggregates or whole new virtual table implementations. One well-known
extension is the fulltext-search extension distributed with SQLite.

Expand All @@ -656,9 +658,9 @@ Connection Objects

.. method:: load_extension(path, /)

This routine loads an SQLite extension from a shared library. You have to
enable extension loading with :meth:`enable_load_extension` before you can
use this routine.
Load an SQLite extension from a shared library located at *path*.
Enable extension loading with :meth:`enable_load_extension` before
calling this method.

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

Expand Down Expand Up @@ -867,8 +869,10 @@ Cursor Objects

.. method:: execute(sql, parameters=(), /)

Execute an SQL statement. Values may be bound to the statement using
:ref:`placeholders <sqlite3-placeholders>`.
Execute SQL statement *sql*.
Bind values to the statement using :ref:`placeholders
<sqlite3-placeholders>` that map to the :term:`sequence` or :class:`dict`
*parameters*.

:meth:`execute` will only execute a single SQL statement. If you try to execute
more than one statement with it, it will raise a :exc:`ProgrammingError`. Use
Expand All @@ -883,7 +887,7 @@ Cursor Objects

.. method:: executemany(sql, seq_of_parameters, /)

Execute a :ref:`parameterized <sqlite3-placeholders>` SQL command
Execute :ref:`parameterized <sqlite3-placeholders>` SQL statement *sql*
against all parameter sequences or mappings found in the sequence
*seq_of_parameters*. It is also possible to use an
:term:`iterator` yielding parameters instead of a sequence.
Expand All @@ -898,7 +902,7 @@ Cursor Objects

.. method:: executescript(sql_script, /)

Execute multiple SQL statements at once.
Execute the SQL statements in *sql_script*.
If there is a pending transaciton,
an implicit ``COMMIT`` statement is executed first.
No other implicit transaction control is performed;
Expand Down