xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_status.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.Dd December 19, 2018
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.Ft int
10.Fo sqlite3_status
11.Fa "int op"
12.Fa "int *pCurrent"
13.Fa "int *pHighwater"
14.Fa "int resetFlag"
15.Fc
16.Ft int
17.Fo sqlite3_status64
18.Fa "int op"
19.Fa "sqlite3_int64 *pCurrent"
20.Fa "sqlite3_int64 *pHighwater"
21.Fa "int resetFlag "
22.Fc
23.Sh DESCRIPTION
24These interfaces are used to retrieve runtime status information about
25the performance of SQLite, and optionally to reset various highwater
26marks.
27The first argument is an integer code for the specific parameter to
28measure.
29Recognized integer codes are of the form  SQLITE_STATUS_....
30The current value of the parameter is returned into *pCurrent.
31The highest recorded value is returned in *pHighwater.
32If the resetFlag is true, then the highest record value is reset after
33*pHighwater is written.
34Some parameters do not record the highest value.
35For those parameters nothing is written into *pHighwater and the resetFlag
36is ignored.
37Other parameters record only the highwater mark and not the current
38value.
39For these latter parameters nothing is written into *pCurrent.
40.Pp
41The sqlite3_status() and sqlite3_status64() routines return SQLITE_OK
42on success and a non-zero error code on failure.
43.Pp
44If either the current value or the highwater mark is too large to be
45represented by a 32-bit integer, then the values returned by sqlite3_status()
46are undefined.
47.Pp
48.Sh SEE ALSO
49.Xr sqlite3_db_status 3 ,
50.Xr SQLITE_STATUS_MEMORY_USED 3
51