xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_test_control.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_TEST_CONTROL 3
3.Os
4.Sh NAME
5.Nm sqlite3_test_control
6.Nd testing interface
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3_test_control
11.Fa "int op"
12.Fa "..."
13.Fc
14.Sh DESCRIPTION
15The sqlite3_test_control() interface is used to read out internal state
16of SQLite and to inject faults into SQLite for testing purposes.
17The first parameter is an operation code that determines the number,
18meaning, and operation of all subsequent parameters.
19.Pp
20This interface is not for use by applications.
21It exists solely for verifying the correct operation of the SQLite
22library.
23Depending on how the SQLite library is compiled, this interface might
24not exist.
25.Pp
26The details of the operation codes, their meanings, the parameters
27they take, and what they do are all subject to change without notice.
28Unlike most of the SQLite API, this function is not guaranteed to operate
29consistently from one release to the next.
30.Sh IMPLEMENTATION NOTES
31These declarations were extracted from the
32interface documentation at line 8264.
33.Bd -literal
34SQLITE_API int sqlite3_test_control(int op, ...);
35.Ed
36