xref: /netbsd-src/external/public-domain/sqlite/man/SQLITE_ACCESS_EXISTS.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE_ACCESS_EXISTS 3
3.Os
4.Sh NAME
5.Nm SQLITE_ACCESS_EXISTS ,
6.Nm SQLITE_ACCESS_READWRITE ,
7.Nm SQLITE_ACCESS_READ
8.Nd flags for the xAccess VFS method
9.Sh SYNOPSIS
10.In sqlite3.h
11.Fd #define SQLITE_ACCESS_EXISTS
12.Fd #define SQLITE_ACCESS_READWRITE
13.Fd #define SQLITE_ACCESS_READ
14.Sh DESCRIPTION
15These integer constants can be used as the third parameter to the xAccess
16method of an sqlite3_vfs object.
17They determine what kind of permissions the xAccess method is looking
18for.
19With SQLITE_ACCESS_EXISTS, the xAccess method simply checks whether
20the file exists.
21With SQLITE_ACCESS_READWRITE, the xAccess method checks whether the
22named directory is both readable and writable (in other words, if files
23can be added, removed, and renamed within the directory).
24The SQLITE_ACCESS_READWRITE constant is currently used only by the
25temp_store_directory pragma, though this
26could change in a future release of SQLite.
27With SQLITE_ACCESS_READ, the xAccess method checks whether the file
28is readable.
29The SQLITE_ACCESS_READ constant is currently unused, though it might
30be used in a future release of SQLite.
31.Sh IMPLEMENTATION NOTES
32These declarations were extracted from the
33interface documentation at line 1505.
34.Bd -literal
35#define SQLITE_ACCESS_EXISTS    0
36#define SQLITE_ACCESS_READWRITE 1   /* Used by PRAGMA temp_store_directory */
37#define SQLITE_ACCESS_READ      2   /* Unused */
38.Ed
39.Sh SEE ALSO
40.Xr sqlite3_vfs 3
41