SQLITE_PREPARE_PERSISTENT(3) - NetBSD Manual Pages

SQLITE_PREPARE_PERSI... NetBSD Library Functions ManualSQLITE_PREPARE_PERSI...


NAME

     SQLITE_PREPARE_PERSISTENT, SQLITE_PREPARE_NORMALIZE,
     SQLITE_PREPARE_NO_VTAB, SQLITE_PREPARE_DONT_LOG, SQLITE_PREPARE_FROM_DDL
     -- prepare flags


SYNOPSIS

     #include <sqlite3.h>
     #define SQLITE_PREPARE_PERSISTENT
     #define SQLITE_PREPARE_NORMALIZE
     #define SQLITE_PREPARE_NO_VTAB
     #define SQLITE_PREPARE_DONT_LOG
     #define SQLITE_PREPARE_FROM_DDL


DESCRIPTION

     These constants define various flags that can be passed into the
     "prepFlags" parameter of the sqlite3_prepare_v3() and
     sqlite3_prepare16_v3() interfaces.

     New flags may be added in future releases of SQLite.

     SQLITE_PREPARE_PERSISTENT
             The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner
             that the prepared statement will be retained for a long time and
             probably reused many times.  Without this flag,
             sqlite3_prepare_v3() and sqlite3_prepare16_v3() assume that the
             prepared statement will be used just once or at most a few times
             and then destroyed using sqlite3_finalize() relatively soon.  The
             current implementation acts on this hint by avoiding the use of
             lookaside memory so as not to deplete the limited store of looka-
             side memory.  Future versions of SQLite may act on this hint dif-
             ferently.

     SQLITE_PREPARE_NORMALIZE
             The SQLITE_PREPARE_NORMALIZE flag is a no-op.  This flag used to
             be required for any prepared statement that wanted to use the
             sqlite3_normalized_sql() interface.  However, the
             sqlite3_normalized_sql() interface is now available to all pre-
             pared statements, regardless of whether or not they use this
             flag.

     SQLITE_PREPARE_NO_VTAB
             The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler to return
             an error (error code SQLITE_ERROR) if the statement uses any vir-
             tual tables.

     SQLITE_PREPARE_DONT_LOG
             The SQLITE_PREPARE_DONT_LOG flag prevents SQL compiler errors
             from being sent to the error log defined by SQLITE_CONFIG_LOG.
             This can be used, for example, to do test compiles to see if some
             SQL syntax is well-formed, without generating messages on the
             global error log when it is not.  If the test compile fails, the
             sqlite3_prepare_v3() call returns the same error indications with
             or without this flag; it just omits the call to sqlite3_log()
             that logs the error.

     SQLITE_PREPARE_FROM_DDL
             The SQLITE_PREPARE_FROM_DDL flag causes the SQL compiler to
             enforce security constraints that would otherwise only be
             enforced when parsing the database schema.  In other words, the
             SQLITE_PREPARE_FROM_DDL flag causes the SQL compiler to treat the
             SQL statement being prepared as if it had come from an attacker.
             When SQLITE_PREPARE_FROM_DDL is used and SQLITE_DBCON-
             FIG_TRUSTED_SCHEMA is off, SQL functions may only be called if
             they are tagged with SQLITE_INNOCUOUS and virtual tables may only
             be used if they are tagged with SQLITE_VTAB_INNOCUOUS.  Best
             practice is to use the SQLITE_PREPARE_FROM_DDL option when pre-
             paring any SQL that is derived from parts of the database schema.
             In particular, virtual table implementations that run SQL state-
             ments that are derived from arguments to their CREATE VIRTUAL TA-
             BLE statement should always use sqlite3_prepare_v3() and set the
             SQLITE_PREPARE_FROM_DDL flag to prevent bypass of the
             SQLITE_DBCONFIG_TRUSTED_SCHEMA security checks.


IMPLEMENTATION NOTES

     These declarations were extracted from the interface documentation at
     line 4422.

     #define SQLITE_PREPARE_PERSISTENT              0x01
     #define SQLITE_PREPARE_NORMALIZE               0x02
     #define SQLITE_PREPARE_NO_VTAB                 0x04
     #define SQLITE_PREPARE_DONT_LOG                0x10
     #define SQLITE_PREPARE_FROM_DDL                0x20


SEE ALSO

     sqlite3_finalize(3), sqlite3_log(3), sqlite3_prepare(3), sqlite3_sql(3),
     SQLITE_CONFIG_SINGLETHREAD(3), SQLITE_DBCONFIG_MAINDBNAME(3),
     SQLITE_DETERMINISTIC(3), SQLITE_VTAB_CONSTRAINT_SUPPORT(3)

NetBSD 11.99                    April 29, 2026                    NetBSD 11.99