xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_vtab_config.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_VTAB_CONFIG 3
3.Os
4.Sh NAME
5.Nm sqlite3_vtab_config
6.Nd virtual table interface configuration
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3_vtab_config
11.Fa "sqlite3*"
12.Fa "int op"
13.Fa "..."
14.Fc
15.Sh DESCRIPTION
16This function may be called by either the xConnect or xCreate
17method of a virtual table implementation to configure
18various facets of the virtual table interface.
19.Pp
20If this interface is invoked outside the context of an xConnect or
21xCreate virtual table method then the behavior is undefined.
22.Pp
23In the call sqlite3_vtab_config(D,C,...) the D parameter is the database connection
24in which the virtual table is being created and which is passed in
25as the first argument to the xConnect or xCreate method
26that is invoking sqlite3_vtab_config().
27The C parameter is one of the virtual table configuration options.
28The presence and meaning of parameters after C depend on which virtual table configuration option
29is used.
30.Sh IMPLEMENTATION NOTES
31These declarations were extracted from the
32interface documentation at line 9720.
33.Bd -literal
34SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
35.Ed
36.Sh SEE ALSO
37.Xr sqlite3 3 ,
38.Xr SQLITE_VTAB_CONSTRAINT_SUPPORT 3
39