Skip to content

SQLITE_OK, SQLITE_DENY and SQLITE_IGNORE not explicitly documented #96096

Closed
@CAM-Gerlach

Description

@CAM-Gerlach

After #96095 is merged, the only remaining broken references/warnings in the sqlite3 library documentation are for the SQLITE_OK, SQLITE_DENY and SQLITE_IGNORE module-level constants that are referenced with :const: under Connection.set_authorizer, but not explicitly documented anywhere (as with the similar reference to sqlite.PrepareProtocol fixed in #94321). Should we at least add brief mentions of them to module constants, e.g.

.. data:: SQLITE_OK
          SQLITE_DENY
          SQLITE_IGNORE

   Flag that *authorizer_callback* of :meth:`Connection.set_authorizer`
   should return 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`)

Also, maybe Connection.set_authorizer()'s docs should be updated to say something like "The callback should return :const:SQLITE_OK. :const:SQLITE_DENY. or :const:SQLITE_IGNORE to control the resulting behavior for the column" rather than repeating ourselves.

@erlend-aasland what do you think?

Metadata

Metadata

Labels

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions