1.Dd January 24, 2024 2.Dt SQLITE3_STATUS 3 3.Os 4.Sh NAME 5.Nm sqlite3_status , 6.Nm sqlite3_status64 7.Nd SQLite runtime status 8.Sh SYNOPSIS 9.In sqlite3.h 10.Ft int 11.Fo sqlite3_status 12.Fa "int op" 13.Fa "int *pCurrent" 14.Fa "int *pHighwater" 15.Fa "int resetFlag" 16.Fc 17.Ft int 18.Fo sqlite3_status64 19.Fa "int op" 20.Fa "sqlite3_int64 *pCurrent" 21.Fa "sqlite3_int64 *pHighwater" 22.Fa "int resetFlag" 23.Fc 24.Sh DESCRIPTION 25These interfaces are used to retrieve runtime status information about 26the performance of SQLite, and optionally to reset various highwater 27marks. 28The first argument is an integer code for the specific parameter to 29measure. 30Recognized integer codes are of the form SQLITE_STATUS_.... 31The current value of the parameter is returned into *pCurrent. 32The highest recorded value is returned in *pHighwater. 33If the resetFlag is true, then the highest record value is reset after 34*pHighwater is written. 35Some parameters do not record the highest value. 36For those parameters nothing is written into *pHighwater and the resetFlag 37is ignored. 38Other parameters record only the highwater mark and not the current 39value. 40For these latter parameters nothing is written into *pCurrent. 41.Pp 42The sqlite3_status() and sqlite3_status64() routines return SQLITE_OK 43on success and a non-zero error code on failure. 44.Pp 45If either the current value or the highwater mark is too large to be 46represented by a 32-bit integer, then the values returned by sqlite3_status() 47are undefined. 48.Pp 49.Sh IMPLEMENTATION NOTES 50These declarations were extracted from the 51interface documentation at line 8514. 52.Bd -literal 53SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); 54SQLITE_API int sqlite3_status64( 55 int op, 56 sqlite3_int64 *pCurrent, 57 sqlite3_int64 *pHighwater, 58 int resetFlag 59); 60.Ed 61.Sh SEE ALSO 62.Xr sqlite3_db_status 3 , 63.Xr SQLITE_STATUS_MEMORY_USED 3 64