xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_release_memory.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_RELEASE_MEMORY 3
3.Os
4.Sh NAME
5.Nm sqlite3_release_memory
6.Nd attempt to free heap memory
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3_release_memory
11.Fa "int"
12.Fc
13.Sh DESCRIPTION
14The sqlite3_release_memory() interface attempts to free N bytes of
15heap memory by deallocating non-essential memory allocations held by
16the database library.
17Memory used to cache database pages to improve performance is an example
18of non-essential memory.
19sqlite3_release_memory() returns the number of bytes actually freed,
20which might be more or less than the amount requested.
21The sqlite3_release_memory() routine is a no-op returning zero if SQLite
22is not compiled with SQLITE_ENABLE_MEMORY_MANAGEMENT.
23.Pp
24.Sh IMPLEMENTATION NOTES
25These declarations were extracted from the
26interface documentation at line 6939.
27.Bd -literal
28SQLITE_API int sqlite3_release_memory(int);
29.Ed
30.Sh SEE ALSO
31.Xr sqlite3_db_release_memory 3
32