sqlite3_db_status(3) - NetBSD Manual Pages

SQLITE3_DB_STATUS(3)    NetBSD Library Functions Manual   SQLITE3_DB_STATUS(3)


NAME

     sqlite3_db_status, sqlite3_db_status64 -- database connection status


SYNOPSIS

     #include <sqlite3.h>

     int
     sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr,
         int resetFlg);

     int
     sqlite3_db_status64(sqlite3*, int, sqlite3_int64*, sqlite3_int64*, int);


DESCRIPTION

     This interface is used to retrieve runtime status information about a
     single database connection.  The first argument is the database connec-
     tion object to be interrogated.  The second argument is an integer con-
     stant, taken from the set of SQLITE_DBSTATUS options, that determines the
     parameter to interrogate.  The set of SQLITE_DBSTATUS options is likely
     to grow in future releases of SQLite.

     The current value of the requested parameter is written into *pCur and
     the highest instantaneous value is written into *pHiwtr.  If the resetFlg
     is true, then the highest instantaneous value is reset back down to the
     current value.

     The sqlite3_db_status() routine returns SQLITE_OK on success and a non-
     zero error code on failure.

     The sqlite3_db_status64(D,O,C,H,R) routine works exactly the same way as
     sqlite3_db_status(D,O,C,H,R) routine except that the C and H parameters
     are pointer to 64-bit integers (type: sqlite3_int64) instead of pointers
     to 32-bit integers, which allows larger status values to be returned.  If
     a status value exceeds 2,147,483,647 then sqlite3_db_status() will trun-
     cate the value whereas sqlite3_db_status64() will return the full value.


IMPLEMENTATION NOTES

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

     SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
     SQLITE_API int sqlite3_db_status64(sqlite3*,int,sqlite3_int64*,sqlite3_int64*,int);


SEE ALSO

     sqlite3(3), sqlite3_status(3), sqlite3_stmt_status(3),
     SQLITE_DBSTATUS_LOOKASIDE_USED(3)

NetBSD 11.99                    April 29, 2026                    NetBSD 11.99