xref: /netbsd-src/external/public-domain/sqlite/man/SQLITE_IOERR_READ.3 (revision a24efa7dea9f1f56c3bdb15a927d3516792ace1c)
1.Dd $Mdocdate$
2.Dt SQLITE_IOERR_READ 3
3.Os
4.Sh NAME
5.Nm SQLITE_IOERR_READ ,
6.Nm SQLITE_IOERR_SHORT_READ ,
7.Nm SQLITE_IOERR_WRITE ,
8.Nm SQLITE_IOERR_FSYNC ,
9.Nm SQLITE_IOERR_DIR_FSYNC ,
10.Nm SQLITE_IOERR_TRUNCATE ,
11.Nm SQLITE_IOERR_FSTAT ,
12.Nm SQLITE_IOERR_UNLOCK ,
13.Nm SQLITE_IOERR_RDLOCK ,
14.Nm SQLITE_IOERR_DELETE ,
15.Nm SQLITE_IOERR_BLOCKED ,
16.Nm SQLITE_IOERR_NOMEM ,
17.Nm SQLITE_IOERR_ACCESS ,
18.Nm SQLITE_IOERR_CHECKRESERVEDLOCK ,
19.Nm SQLITE_IOERR_LOCK ,
20.Nm SQLITE_IOERR_CLOSE ,
21.Nm SQLITE_IOERR_DIR_CLOSE ,
22.Nm SQLITE_IOERR_SHMOPEN ,
23.Nm SQLITE_IOERR_SHMSIZE ,
24.Nm SQLITE_IOERR_SHMLOCK ,
25.Nm SQLITE_IOERR_SHMMAP ,
26.Nm SQLITE_IOERR_SEEK ,
27.Nm SQLITE_IOERR_DELETE_NOENT ,
28.Nm SQLITE_IOERR_MMAP ,
29.Nm SQLITE_IOERR_GETTEMPPATH ,
30.Nm SQLITE_IOERR_CONVPATH ,
31.Nm SQLITE_LOCKED_SHAREDCACHE ,
32.Nm SQLITE_BUSY_RECOVERY ,
33.Nm SQLITE_BUSY_SNAPSHOT ,
34.Nm SQLITE_CANTOPEN_NOTEMPDIR ,
35.Nm SQLITE_CANTOPEN_ISDIR ,
36.Nm SQLITE_CANTOPEN_FULLPATH ,
37.Nm SQLITE_CANTOPEN_CONVPATH ,
38.Nm SQLITE_CORRUPT_VTAB ,
39.Nm SQLITE_READONLY_RECOVERY ,
40.Nm SQLITE_READONLY_CANTLOCK ,
41.Nm SQLITE_READONLY_ROLLBACK ,
42.Nm SQLITE_READONLY_DBMOVED ,
43.Nm SQLITE_ABORT_ROLLBACK ,
44.Nm SQLITE_CONSTRAINT_CHECK ,
45.Nm SQLITE_CONSTRAINT_COMMITHOOK ,
46.Nm SQLITE_CONSTRAINT_FOREIGNKEY ,
47.Nm SQLITE_CONSTRAINT_FUNCTION ,
48.Nm SQLITE_CONSTRAINT_NOTNULL ,
49.Nm SQLITE_CONSTRAINT_PRIMARYKEY ,
50.Nm SQLITE_CONSTRAINT_TRIGGER ,
51.Nm SQLITE_CONSTRAINT_UNIQUE ,
52.Nm SQLITE_CONSTRAINT_VTAB ,
53.Nm SQLITE_CONSTRAINT_ROWID ,
54.Nm SQLITE_NOTICE_RECOVER_WAL ,
55.Nm SQLITE_NOTICE_RECOVER_ROLLBACK ,
56.Nm SQLITE_WARNING_AUTOINDEX
57.Nd Extended Result Codes
58.Sh SYNOPSIS
59.Fd #define SQLITE_IOERR_READ
60.Fd #define SQLITE_IOERR_SHORT_READ
61.Fd #define SQLITE_IOERR_WRITE
62.Fd #define SQLITE_IOERR_FSYNC
63.Fd #define SQLITE_IOERR_DIR_FSYNC
64.Fd #define SQLITE_IOERR_TRUNCATE
65.Fd #define SQLITE_IOERR_FSTAT
66.Fd #define SQLITE_IOERR_UNLOCK
67.Fd #define SQLITE_IOERR_RDLOCK
68.Fd #define SQLITE_IOERR_DELETE
69.Fd #define SQLITE_IOERR_BLOCKED
70.Fd #define SQLITE_IOERR_NOMEM
71.Fd #define SQLITE_IOERR_ACCESS
72.Fd #define SQLITE_IOERR_CHECKRESERVEDLOCK
73.Fd #define SQLITE_IOERR_LOCK
74.Fd #define SQLITE_IOERR_CLOSE
75.Fd #define SQLITE_IOERR_DIR_CLOSE
76.Fd #define SQLITE_IOERR_SHMOPEN
77.Fd #define SQLITE_IOERR_SHMSIZE
78.Fd #define SQLITE_IOERR_SHMLOCK
79.Fd #define SQLITE_IOERR_SHMMAP
80.Fd #define SQLITE_IOERR_SEEK
81.Fd #define SQLITE_IOERR_DELETE_NOENT
82.Fd #define SQLITE_IOERR_MMAP
83.Fd #define SQLITE_IOERR_GETTEMPPATH
84.Fd #define SQLITE_IOERR_CONVPATH
85.Fd #define SQLITE_LOCKED_SHAREDCACHE
86.Fd #define SQLITE_BUSY_RECOVERY
87.Fd #define SQLITE_BUSY_SNAPSHOT
88.Fd #define SQLITE_CANTOPEN_NOTEMPDIR
89.Fd #define SQLITE_CANTOPEN_ISDIR
90.Fd #define SQLITE_CANTOPEN_FULLPATH
91.Fd #define SQLITE_CANTOPEN_CONVPATH
92.Fd #define SQLITE_CORRUPT_VTAB
93.Fd #define SQLITE_READONLY_RECOVERY
94.Fd #define SQLITE_READONLY_CANTLOCK
95.Fd #define SQLITE_READONLY_ROLLBACK
96.Fd #define SQLITE_READONLY_DBMOVED
97.Fd #define SQLITE_ABORT_ROLLBACK
98.Fd #define SQLITE_CONSTRAINT_CHECK
99.Fd #define SQLITE_CONSTRAINT_COMMITHOOK
100.Fd #define SQLITE_CONSTRAINT_FOREIGNKEY
101.Fd #define SQLITE_CONSTRAINT_FUNCTION
102.Fd #define SQLITE_CONSTRAINT_NOTNULL
103.Fd #define SQLITE_CONSTRAINT_PRIMARYKEY
104.Fd #define SQLITE_CONSTRAINT_TRIGGER
105.Fd #define SQLITE_CONSTRAINT_UNIQUE
106.Fd #define SQLITE_CONSTRAINT_VTAB
107.Fd #define SQLITE_CONSTRAINT_ROWID
108.Fd #define SQLITE_NOTICE_RECOVER_WAL
109.Fd #define SQLITE_NOTICE_RECOVER_ROLLBACK
110.Fd #define SQLITE_WARNING_AUTOINDEX
111.Sh DESCRIPTION
112In its default configuration, SQLite API routines return one of 26
113integer  result codes.
114However, experience has shown that many of these result codes are too
115coarse-grained.
116They do not provide as much information about problems as programmers
117might like.
118In an effort to address this, newer versions of SQLite (version 3.3.8
119and later) include support for additional result codes that provide
120more detailed information about errors.
121The extended result codes are enabled or disabled on a per database
122connection basis using the sqlite3_extended_result_codes()
123API.
124.Pp
125Some of the available extended result codes are listed here.
126One may expect the number of extended result codes will increase over
127time.
128Software that uses extended result codes should expect to see new result
129codes in future releases of SQLite.
130.Pp
131The SQLITE_OK result code will never be extended.
132It will always be exactly zero.
133.Sh SEE ALSO
134.Xr sqlite3_extended_result_codes 3 ,
135.Xr SQLITE_OK 3
136