Skip to content

Commit

Permalink
gh-96096: Add undocumented SQLITE_OK/DENY/IGNORE sqlite3 constants (G…
Browse files Browse the repository at this point in the history
…H-96134)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit d6259c5)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
  • Loading branch information
miss-islington and CAM-Gerlach committed Aug 23, 2022
1 parent 88a559f commit dc63917
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions Doc/library/sqlite3.rst
Expand Up @@ -444,6 +444,17 @@ Module constants
This flag may be combined with :const:`PARSE_COLNAMES` using the ``|``
(bitwise or) operator.

.. data:: SQLITE_OK
SQLITE_DENY
SQLITE_IGNORE

Flags that should be returned by the *authorizer_callback* callable
passed to :meth:`Connection.set_authorizer`, to indicate whether:

* Access is allowed (:const:`!SQLITE_OK`),
* The SQL statement should be aborted with an error (:const:`!SQLITE_DENY`)
* The column should be treated as a ``NULL`` value (:const:`!SQLITE_IGNORE`)

.. data:: apilevel

String constant stating the supported DB-API level. Required by the DB-API.
Expand Down Expand Up @@ -809,10 +820,9 @@ Connection objects

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
column should be treated as a NULL value. These constants are available in the
:mod:`!sqlite3` module.
one of :const:`SQLITE_OK`, :const:`SQLITE_DENY`, or :const:`SQLITE_IGNORE`
to signal how access to the column should be handled
by the underlying SQLite library.

The first argument to the callback signifies what kind of operation is to be
authorized. The second and third argument will be arguments or ``None``
Expand Down

0 comments on commit dc63917

Please sign in to comment.