xref: /netbsd-src/external/public-domain/sqlite/man/SQLITE_STMTSTATUS_FULLSCAN_STEP.3 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.Dd March 11, 2017
2.Dt SQLITE_STMTSTATUS_FULLSCAN_STEP 3
3.Os
4.Sh NAME
5.Nm SQLITE_STMTSTATUS_FULLSCAN_STEP ,
6.Nm SQLITE_STMTSTATUS_SORT ,
7.Nm SQLITE_STMTSTATUS_AUTOINDEX ,
8.Nm SQLITE_STMTSTATUS_VM_STEP
9.Nd Status Parameters for prepared statements
10.Sh SYNOPSIS
11.Fd #define SQLITE_STMTSTATUS_FULLSCAN_STEP
12.Fd #define SQLITE_STMTSTATUS_SORT
13.Fd #define SQLITE_STMTSTATUS_AUTOINDEX
14.Fd #define SQLITE_STMTSTATUS_VM_STEP
15.Sh DESCRIPTION
16These preprocessor macros define integer codes that name counter values
17associated with the sqlite3_stmt_status() interface.
18The meanings of the various counters are as follows:
19.Bl -tag -width Ds
20.It SQLITE_STMTSTATUS_FULLSCAN_STEP
21This is the number of times that SQLite has stepped forward in a table
22as part of a full table scan.
23Large numbers for this counter may indicate opportunities for performance
24improvement through careful use of indices.
25.It SQLITE_STMTSTATUS_SORT
26This is the number of sort operations that have occurred.
27A non-zero value in this counter may indicate an opportunity to improvement
28performance through careful use of indices.
29.It SQLITE_STMTSTATUS_AUTOINDEX
30This is the number of rows inserted into transient indices that were
31created automatically in order to help joins run faster.
32A non-zero value in this counter may indicate an opportunity to improvement
33performance by adding permanent indices that do not need to be reinitialized
34each time the statement is run.
35.It SQLITE_STMTSTATUS_VM_STEP
36This is the number of virtual machine operations executed by the prepared
37statement if that number is less than or equal to 2147483647.
38The number of virtual machine operations can be used as a proxy for
39the total work done by the prepared statement.
40If the number of virtual machine operations exceeds 2147483647 then
41the value returned by this statement status code is undefined.
42.El
43.Pp
44.Sh SEE ALSO
45.Xr sqlite3_stmt_status 3
46