xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_db_status.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.Dd December 19, 2018
2.Dt SQLITE3_DB_STATUS 3
3.Os
4.Sh NAME
5.Nm sqlite3_db_status
6.Nd Database Connection Status
7.Sh SYNOPSIS
8.Ft int
9.Fo sqlite3_db_status
10.Fa "sqlite3*"
11.Fa "int op"
12.Fa "int *pCur"
13.Fa "int *pHiwtr"
14.Fa "int resetFlg"
15.Fc
16.Sh DESCRIPTION
17This interface is used to retrieve runtime status information about
18a single database connection.
19The first argument is the database connection object to be interrogated.
20The second argument is an integer constant, taken from the set of SQLITE_DBSTATUS options,
21that determines the parameter to interrogate.
22The set of SQLITE_DBSTATUS options is likely
23to grow in future releases of SQLite.
24.Pp
25The current value of the requested parameter is written into *pCur
26and the highest instantaneous value is written into *pHiwtr.
27If the resetFlg is true, then the highest instantaneous value is reset
28back down to the current value.
29.Pp
30The sqlite3_db_status() routine returns SQLITE_OK on success and a
31non-zero error code on failure.
32.Pp
33.Sh SEE ALSO
34.Xr sqlite3 3 ,
35.Xr sqlite3_status 3 ,
36.Xr sqlite3_stmt_status 3 ,
37.Xr SQLITE_DBSTATUS_LOOKASIDE_USED 3
38