xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3 3
3.Os
4.Sh NAME
5.Nm sqlite3
6.Nd database connection handle
7.Sh SYNOPSIS
8.In sqlite3.h
9.Vt typedef struct sqlite3 sqlite3;
10.Sh DESCRIPTION
11Each open SQLite database is represented by a pointer to an instance
12of the opaque structure named "sqlite3".
13It is useful to think of an sqlite3 pointer as an object.
14The
15.Fn sqlite3_open ,
16.Fn sqlite3_open16 ,
17and
18.Fn sqlite3_open_v2
19interfaces are its constructors, and
20.Fn sqlite3_close
21and
22.Fn sqlite3_close_v2
23are its destructors.
24There are many other interfaces (such as
25.Fn sqlite3_prepare_v2 ,
26.Fn sqlite3_create_function ,
27and
28.Fn sqlite3_busy_timeout
29to name but three) that are methods on an sqlite3 object.
30.Sh IMPLEMENTATION NOTES
31These declarations were extracted from the
32interface documentation at line 259.
33.Bd -literal
34typedef struct sqlite3 sqlite3;
35.Ed
36.Sh SEE ALSO
37.Xr sqlite3_busy_timeout 3 ,
38.Xr sqlite3_close 3 ,
39.Xr sqlite3_create_function 3 ,
40.Xr sqlite3_open 3 ,
41.Xr sqlite3_prepare 3
42