Updated: 2022/Sep/29

Please read Privacy Policy. It's for your privacy.

SQLITE_TRACE_STMT(3)       Library Functions Manual       SQLITE_TRACE_STMT(3)

NAME
     SQLITE_TRACE_STMT, SQLITE_TRACE_PROFILE, SQLITE_TRACE_ROW,
     SQLITE_TRACE_CLOSE - SQL trace event codes

SYNOPSIS
     #include <sqlite3.h>

     #define SQLITE_TRACE_STMT
     #define SQLITE_TRACE_PROFILE
     #define SQLITE_TRACE_ROW
     #define SQLITE_TRACE_CLOSE

DESCRIPTION
     These constants identify classes of events that can be monitored using
     the sqlite3_trace_v2() tracing logic.  The M argument to
     sqlite3_trace_v2(D,M,X,P) is an OR-ed combination of one or more of the
     following constants.  The first argument to the trace callback is one of
     the following constants.

     New tracing constants may be added in future releases.

     A trace callback has four arguments: xCallback(T,C,P,X).  The T argument
     is one of the integer type codes above.  The C argument is a copy of the
     context pointer passed in as the fourth argument to sqlite3_trace_v2().
     The P and X arguments are pointers whose meanings depend on T.

     SQLITE_TRACE_STMT
             An SQLITE_TRACE_STMT callback is invoked when a prepared
             statement first begins running and possibly at other times during
             the execution of the prepared statement, such as at the start of
             each trigger subprogram.  The P argument is a pointer to the
             prepared statement.  The X argument is a pointer to a string
             which is the unexpanded SQL text of the prepared statement or an
             SQL comment that indicates the invocation of a trigger.  The
             callback can compute the same text that would have been returned
             by the legacy sqlite3_trace() interface by using the X argument
             when X begins with "--" and invoking sqlite3_expanded_sql(P)
             otherwise.

     SQLITE_TRACE_PROFILE
             An SQLITE_TRACE_PROFILE callback provides approximately the same
             information as is provided by the sqlite3_profile() callback.
             The P argument is a pointer to the prepared statement and the X
             argument points to a 64-bit integer which is approximately the
             number of nanoseconds that the prepared statement took to run.
             The SQLITE_TRACE_PROFILE callback is invoked when the statement
             finishes.

     SQLITE_TRACE_ROW
             An SQLITE_TRACE_ROW callback is invoked whenever a prepared
             statement generates a single row of result.  The P argument is a
             pointer to the prepared statement and the X argument is unused.

     SQLITE_TRACE_CLOSE
             An SQLITE_TRACE_CLOSE callback is invoked when a database
             connection closes.  The P argument is a pointer to the database
             connection object and the X argument is unused.

IMPLEMENTATION NOTES
     These declarations were extracted from the interface documentation at
     line 3326.

     #define SQLITE_TRACE_STMT       0x01
     #define SQLITE_TRACE_PROFILE    0x02
     #define SQLITE_TRACE_ROW        0x04
     #define SQLITE_TRACE_CLOSE      0x08

SEE ALSO
     sqlite3(3), sqlite3_stmt(3), sqlite3_trace(3), sqlite3_trace_v2(3)

NetBSD 10.99                    August 24, 2023                   NetBSD 10.99