Updated: 2025/Nov/16

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

SQLITE3_TRACE(3)           Library Functions Manual           SQLITE3_TRACE(3)

NAME
     sqlite3_trace, sqlite3_profile - tracing and profiling functions

SYNOPSIS
     #include <sqlite3.h>

     void *
     sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);

     void *
     sqlite3_profile(sqlite3*,
         void(*xProfile)(void*,const char*,sqlite3_uint64), void*);

DESCRIPTION
     These routines are deprecated.  Use the sqlite3_trace_v2() interface
     instead of the routines described here.

     These routines register callback functions that can be used for tracing
     and profiling the execution of SQL statements.

     The callback function registered by sqlite3_trace() is invoked at various
     times when an SQL statement is being run by sqlite3_step().  The
     sqlite3_trace() callback is invoked with a UTF-8 rendering of the SQL
     statement text as the statement first begins executing.  Additional
     sqlite3_trace() callbacks might occur as each triggered subprogram is
     entered.  The callbacks for triggers contain a UTF-8 SQL comment that
     identifies the trigger.

     The SQLITE_TRACE_SIZE_LIMIT compile-time option can be used to limit the
     length of bound parameter expansion in the output of sqlite3_trace().

     The callback function registered by sqlite3_profile() is invoked as each
     SQL statement finishes.  The profile callback contains the original
     statement text and an estimate of wall-clock time of how long that
     statement took to run.  The profile callback time is in units of
     nanoseconds, however the current implementation is only capable of
     millisecond resolution so the six least significant digits in the time
     are meaningless.  Future versions of SQLite might provide greater
     resolution on the profiler callback.  Invoking either sqlite3_trace() or
     sqlite3_trace_v2() will cancel the profile callback.

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

     SQLITE_API SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*,
        void(*xTrace)(void*,const char*), void*);
     SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*,
        void(*xProfile)(void*,const char*,sqlite3_uint64), void*);

SEE ALSO
     sqlite3_step(3), sqlite3_trace_v2(3)

NetBSD 11.99                   January 24, 2024                   NetBSD 11.99