xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3session_config.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3SESSION_CONFIG 3
3.Os
4.Sh NAME
5.Nm sqlite3session_config
6.Nd configure global parameters
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3session_config
11.Fa "int op"
12.Fa "void *pArg"
13.Fc
14.Sh DESCRIPTION
15The sqlite3session_config() interface is used to make global configuration
16changes to the sessions module in order to tune it to the specific
17needs of the application.
18.Pp
19The sqlite3session_config() interface is not threadsafe.
20If it is invoked while any other thread is inside any other sessions
21method then the results are undefined.
22Furthermore, if it is invoked after any sessions related objects have
23been created, the results are also undefined.
24.Pp
25The first argument to the sqlite3session_config() function must be
26one of the SQLITE_SESSION_CONFIG_XXX constants defined below.
27The interpretation of the (void*) value passed as the second parameter
28and the effect of calling this function depends on the value of the
29first parameter.
30.Bl -tag -width Ds
31.It SQLITE_SESSION_CONFIG_STRMSIZE
32By default, the sessions module streaming interfaces attempt to input
33and output data in approximately 1 KiB chunks.
34This operand may be used to set and query the value of this configuration
35setting.
36The pointer passed as the second argument must point to a value of
37type (int).
38If this value is greater than 0, it is used as the new streaming data
39chunk size for both input and output.
40Before returning, the (int) value pointed to by pArg is set to the
41final value of the streaming interface chunk size.
42.El
43.Pp
44This function returns SQLITE_OK if successful, or an SQLite error code
45otherwise.
46.Sh IMPLEMENTATION NOTES
47These declarations were extracted from the
48interface documentation at line 12680.
49.Bd -literal
50SQLITE_API int sqlite3session_config(int op, void *pArg);
51.Ed
52