blob: 88a004ee562419989d89b2535e79146b376011c6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
.Dd January 24, 2024
.Dt SQLITE3_DB_STATUS 3
.Os
.Sh NAME
.Nm sqlite3_db_status
.Nd database connection status
.Sh SYNOPSIS
.In sqlite3.h
.Ft int
.Fo sqlite3_db_status
.Fa "sqlite3*"
.Fa "int op"
.Fa "int *pCur"
.Fa "int *pHiwtr"
.Fa "int resetFlg"
.Fc
.Sh DESCRIPTION
This interface is used to retrieve runtime status information about
a single database connection.
The first argument is the database connection object to be interrogated.
The second argument is an integer constant, 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.
.Pp
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.
.Pp
The sqlite3_db_status() routine returns SQLITE_OK on success and a
non-zero error code on failure.
.Pp
.Sh IMPLEMENTATION NOTES
These declarations were extracted from the
interface documentation at line 8627.
.Bd -literal
SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
.Ed
.Sh SEE ALSO
.Xr sqlite3 3 ,
.Xr sqlite3_status 3 ,
.Xr sqlite3_stmt_status 3 ,
.Xr SQLITE_DBSTATUS_LOOKASIDE_USED 3
|
