xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_stmt_status.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_STMT_STATUS 3
3.Os
4.Sh NAME
5.Nm sqlite3_stmt_status
6.Nd prepared statement status
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3_stmt_status
11.Fa "sqlite3_stmt*"
12.Fa "int op"
13.Fa "int resetFlg"
14.Fc
15.Sh DESCRIPTION
16Each prepared statement maintains various SQLITE_STMTSTATUS counters
17that measure the number of times it has performed specific operations.
18These counters can be used to monitor the performance characteristics
19of the prepared statements.
20For example, if the number of table steps greatly exceeds the number
21of table searches or result rows, that would tend to indicate that
22the prepared statement is using a full table scan rather than an index.
23.Pp
24This interface is used to retrieve and reset counter values from a
25prepared statement.
26The first argument is the prepared statement object to be interrogated.
27The second argument is an integer code for a specific SQLITE_STMTSTATUS counter
28to be interrogated.
29The current value of the requested counter is returned.
30If the resetFlg is true, then the counter is reset to zero after this
31interface call returns.
32.Pp
33.Sh IMPLEMENTATION NOTES
34These declarations were extracted from the
35interface documentation at line 8779.
36.Bd -literal
37SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
38.Ed
39.Sh SEE ALSO
40.Xr sqlite3_db_status 3 ,
41.Xr sqlite3_status 3 ,
42.Xr sqlite3_stmt 3 ,
43.Xr SQLITE_STMTSTATUS_FULLSCAN_STEP 3
44