xref: /netbsd-src/external/public-domain/sqlite/man/SQLITE_ERROR_MISSING_COLLSEQ.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE_ERROR_MISSING_COLLSEQ 3
3.Os
4.Sh NAME
5.Nm SQLITE_ERROR_MISSING_COLLSEQ ,
6.Nm SQLITE_ERROR_RETRY ,
7.Nm SQLITE_ERROR_SNAPSHOT ,
8.Nm SQLITE_IOERR_READ ,
9.Nm SQLITE_IOERR_SHORT_READ ,
10.Nm SQLITE_IOERR_WRITE ,
11.Nm SQLITE_IOERR_FSYNC ,
12.Nm SQLITE_IOERR_DIR_FSYNC ,
13.Nm SQLITE_IOERR_TRUNCATE ,
14.Nm SQLITE_IOERR_FSTAT ,
15.Nm SQLITE_IOERR_UNLOCK ,
16.Nm SQLITE_IOERR_RDLOCK ,
17.Nm SQLITE_IOERR_DELETE ,
18.Nm SQLITE_IOERR_BLOCKED ,
19.Nm SQLITE_IOERR_NOMEM ,
20.Nm SQLITE_IOERR_ACCESS ,
21.Nm SQLITE_IOERR_CHECKRESERVEDLOCK ,
22.Nm SQLITE_IOERR_LOCK ,
23.Nm SQLITE_IOERR_CLOSE ,
24.Nm SQLITE_IOERR_DIR_CLOSE ,
25.Nm SQLITE_IOERR_SHMOPEN ,
26.Nm SQLITE_IOERR_SHMSIZE ,
27.Nm SQLITE_IOERR_SHMLOCK ,
28.Nm SQLITE_IOERR_SHMMAP ,
29.Nm SQLITE_IOERR_SEEK ,
30.Nm SQLITE_IOERR_DELETE_NOENT ,
31.Nm SQLITE_IOERR_MMAP ,
32.Nm SQLITE_IOERR_GETTEMPPATH ,
33.Nm SQLITE_IOERR_CONVPATH ,
34.Nm SQLITE_IOERR_VNODE ,
35.Nm SQLITE_IOERR_AUTH ,
36.Nm SQLITE_IOERR_BEGIN_ATOMIC ,
37.Nm SQLITE_IOERR_COMMIT_ATOMIC ,
38.Nm SQLITE_IOERR_ROLLBACK_ATOMIC ,
39.Nm SQLITE_IOERR_DATA ,
40.Nm SQLITE_IOERR_CORRUPTFS ,
41.Nm SQLITE_IOERR_IN_PAGE ,
42.Nm SQLITE_LOCKED_SHAREDCACHE ,
43.Nm SQLITE_LOCKED_VTAB ,
44.Nm SQLITE_BUSY_RECOVERY ,
45.Nm SQLITE_BUSY_SNAPSHOT ,
46.Nm SQLITE_BUSY_TIMEOUT ,
47.Nm SQLITE_CANTOPEN_NOTEMPDIR ,
48.Nm SQLITE_CANTOPEN_ISDIR ,
49.Nm SQLITE_CANTOPEN_FULLPATH ,
50.Nm SQLITE_CANTOPEN_CONVPATH ,
51.Nm SQLITE_CANTOPEN_DIRTYWAL ,
52.Nm SQLITE_CANTOPEN_SYMLINK ,
53.Nm SQLITE_CORRUPT_VTAB ,
54.Nm SQLITE_CORRUPT_SEQUENCE ,
55.Nm SQLITE_CORRUPT_INDEX ,
56.Nm SQLITE_READONLY_RECOVERY ,
57.Nm SQLITE_READONLY_CANTLOCK ,
58.Nm SQLITE_READONLY_ROLLBACK ,
59.Nm SQLITE_READONLY_DBMOVED ,
60.Nm SQLITE_READONLY_CANTINIT ,
61.Nm SQLITE_READONLY_DIRECTORY ,
62.Nm SQLITE_ABORT_ROLLBACK ,
63.Nm SQLITE_CONSTRAINT_CHECK ,
64.Nm SQLITE_CONSTRAINT_COMMITHOOK ,
65.Nm SQLITE_CONSTRAINT_FOREIGNKEY ,
66.Nm SQLITE_CONSTRAINT_FUNCTION ,
67.Nm SQLITE_CONSTRAINT_NOTNULL ,
68.Nm SQLITE_CONSTRAINT_PRIMARYKEY ,
69.Nm SQLITE_CONSTRAINT_TRIGGER ,
70.Nm SQLITE_CONSTRAINT_UNIQUE ,
71.Nm SQLITE_CONSTRAINT_VTAB ,
72.Nm SQLITE_CONSTRAINT_ROWID ,
73.Nm SQLITE_CONSTRAINT_PINNED ,
74.Nm SQLITE_CONSTRAINT_DATATYPE ,
75.Nm SQLITE_NOTICE_RECOVER_WAL ,
76.Nm SQLITE_NOTICE_RECOVER_ROLLBACK ,
77.Nm SQLITE_NOTICE_RBU ,
78.Nm SQLITE_WARNING_AUTOINDEX ,
79.Nm SQLITE_AUTH_USER ,
80.Nm SQLITE_OK_LOAD_PERMANENTLY ,
81.Nm SQLITE_OK_SYMLINK
82.Nd extended result codes
83.Sh SYNOPSIS
84.In sqlite3.h
85.Fd #define SQLITE_ERROR_MISSING_COLLSEQ
86.Fd #define SQLITE_ERROR_RETRY
87.Fd #define SQLITE_ERROR_SNAPSHOT
88.Fd #define SQLITE_IOERR_READ
89.Fd #define SQLITE_IOERR_SHORT_READ
90.Fd #define SQLITE_IOERR_WRITE
91.Fd #define SQLITE_IOERR_FSYNC
92.Fd #define SQLITE_IOERR_DIR_FSYNC
93.Fd #define SQLITE_IOERR_TRUNCATE
94.Fd #define SQLITE_IOERR_FSTAT
95.Fd #define SQLITE_IOERR_UNLOCK
96.Fd #define SQLITE_IOERR_RDLOCK
97.Fd #define SQLITE_IOERR_DELETE
98.Fd #define SQLITE_IOERR_BLOCKED
99.Fd #define SQLITE_IOERR_NOMEM
100.Fd #define SQLITE_IOERR_ACCESS
101.Fd #define SQLITE_IOERR_CHECKRESERVEDLOCK
102.Fd #define SQLITE_IOERR_LOCK
103.Fd #define SQLITE_IOERR_CLOSE
104.Fd #define SQLITE_IOERR_DIR_CLOSE
105.Fd #define SQLITE_IOERR_SHMOPEN
106.Fd #define SQLITE_IOERR_SHMSIZE
107.Fd #define SQLITE_IOERR_SHMLOCK
108.Fd #define SQLITE_IOERR_SHMMAP
109.Fd #define SQLITE_IOERR_SEEK
110.Fd #define SQLITE_IOERR_DELETE_NOENT
111.Fd #define SQLITE_IOERR_MMAP
112.Fd #define SQLITE_IOERR_GETTEMPPATH
113.Fd #define SQLITE_IOERR_CONVPATH
114.Fd #define SQLITE_IOERR_VNODE
115.Fd #define SQLITE_IOERR_AUTH
116.Fd #define SQLITE_IOERR_BEGIN_ATOMIC
117.Fd #define SQLITE_IOERR_COMMIT_ATOMIC
118.Fd #define SQLITE_IOERR_ROLLBACK_ATOMIC
119.Fd #define SQLITE_IOERR_DATA
120.Fd #define SQLITE_IOERR_CORRUPTFS
121.Fd #define SQLITE_IOERR_IN_PAGE
122.Fd #define SQLITE_LOCKED_SHAREDCACHE
123.Fd #define SQLITE_LOCKED_VTAB
124.Fd #define SQLITE_BUSY_RECOVERY
125.Fd #define SQLITE_BUSY_SNAPSHOT
126.Fd #define SQLITE_BUSY_TIMEOUT
127.Fd #define SQLITE_CANTOPEN_NOTEMPDIR
128.Fd #define SQLITE_CANTOPEN_ISDIR
129.Fd #define SQLITE_CANTOPEN_FULLPATH
130.Fd #define SQLITE_CANTOPEN_CONVPATH
131.Fd #define SQLITE_CANTOPEN_DIRTYWAL
132.Fd #define SQLITE_CANTOPEN_SYMLINK
133.Fd #define SQLITE_CORRUPT_VTAB
134.Fd #define SQLITE_CORRUPT_SEQUENCE
135.Fd #define SQLITE_CORRUPT_INDEX
136.Fd #define SQLITE_READONLY_RECOVERY
137.Fd #define SQLITE_READONLY_CANTLOCK
138.Fd #define SQLITE_READONLY_ROLLBACK
139.Fd #define SQLITE_READONLY_DBMOVED
140.Fd #define SQLITE_READONLY_CANTINIT
141.Fd #define SQLITE_READONLY_DIRECTORY
142.Fd #define SQLITE_ABORT_ROLLBACK
143.Fd #define SQLITE_CONSTRAINT_CHECK
144.Fd #define SQLITE_CONSTRAINT_COMMITHOOK
145.Fd #define SQLITE_CONSTRAINT_FOREIGNKEY
146.Fd #define SQLITE_CONSTRAINT_FUNCTION
147.Fd #define SQLITE_CONSTRAINT_NOTNULL
148.Fd #define SQLITE_CONSTRAINT_PRIMARYKEY
149.Fd #define SQLITE_CONSTRAINT_TRIGGER
150.Fd #define SQLITE_CONSTRAINT_UNIQUE
151.Fd #define SQLITE_CONSTRAINT_VTAB
152.Fd #define SQLITE_CONSTRAINT_ROWID
153.Fd #define SQLITE_CONSTRAINT_PINNED
154.Fd #define SQLITE_CONSTRAINT_DATATYPE
155.Fd #define SQLITE_NOTICE_RECOVER_WAL
156.Fd #define SQLITE_NOTICE_RECOVER_ROLLBACK
157.Fd #define SQLITE_NOTICE_RBU
158.Fd #define SQLITE_WARNING_AUTOINDEX
159.Fd #define SQLITE_AUTH_USER
160.Fd #define SQLITE_OK_LOAD_PERMANENTLY
161.Fd #define SQLITE_OK_SYMLINK
162.Sh DESCRIPTION
163In its default configuration, SQLite API routines return one of 30
164integer result codes.
165However, experience has shown that many of these result codes are too
166coarse-grained.
167They do not provide as much information about problems as programmers
168might like.
169In an effort to address this, newer versions of SQLite (version 3.3.8
170dateof:3.3.8 and later) include support for additional
171result codes that provide more detailed information about errors.
172These extended result codes are enabled or disabled
173on a per database connection basis using the
174.Fn sqlite3_extended_result_codes
175API.
176Or, the extended code for the most recent error can be obtained using
177.Fn sqlite3_extended_errcode .
178.Sh IMPLEMENTATION NOTES
179These declarations were extracted from the
180interface documentation at line 479.
181.Bd -literal
182#define SQLITE_ERROR_MISSING_COLLSEQ   (SQLITE_ERROR | (1<<8))
183#define SQLITE_ERROR_RETRY             (SQLITE_ERROR | (2<<8))
184#define SQLITE_ERROR_SNAPSHOT          (SQLITE_ERROR | (3<<8))
185#define SQLITE_IOERR_READ              (SQLITE_IOERR | (1<<8))
186#define SQLITE_IOERR_SHORT_READ        (SQLITE_IOERR | (2<<8))
187#define SQLITE_IOERR_WRITE             (SQLITE_IOERR | (3<<8))
188#define SQLITE_IOERR_FSYNC             (SQLITE_IOERR | (4<<8))
189#define SQLITE_IOERR_DIR_FSYNC         (SQLITE_IOERR | (5<<8))
190#define SQLITE_IOERR_TRUNCATE          (SQLITE_IOERR | (6<<8))
191#define SQLITE_IOERR_FSTAT             (SQLITE_IOERR | (7<<8))
192#define SQLITE_IOERR_UNLOCK            (SQLITE_IOERR | (8<<8))
193#define SQLITE_IOERR_RDLOCK            (SQLITE_IOERR | (9<<8))
194#define SQLITE_IOERR_DELETE            (SQLITE_IOERR | (10<<8))
195#define SQLITE_IOERR_BLOCKED           (SQLITE_IOERR | (11<<8))
196#define SQLITE_IOERR_NOMEM             (SQLITE_IOERR | (12<<8))
197#define SQLITE_IOERR_ACCESS            (SQLITE_IOERR | (13<<8))
198#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
199#define SQLITE_IOERR_LOCK              (SQLITE_IOERR | (15<<8))
200#define SQLITE_IOERR_CLOSE             (SQLITE_IOERR | (16<<8))
201#define SQLITE_IOERR_DIR_CLOSE         (SQLITE_IOERR | (17<<8))
202#define SQLITE_IOERR_SHMOPEN           (SQLITE_IOERR | (18<<8))
203#define SQLITE_IOERR_SHMSIZE           (SQLITE_IOERR | (19<<8))
204#define SQLITE_IOERR_SHMLOCK           (SQLITE_IOERR | (20<<8))
205#define SQLITE_IOERR_SHMMAP            (SQLITE_IOERR | (21<<8))
206#define SQLITE_IOERR_SEEK              (SQLITE_IOERR | (22<<8))
207#define SQLITE_IOERR_DELETE_NOENT      (SQLITE_IOERR | (23<<8))
208#define SQLITE_IOERR_MMAP              (SQLITE_IOERR | (24<<8))
209#define SQLITE_IOERR_GETTEMPPATH       (SQLITE_IOERR | (25<<8))
210#define SQLITE_IOERR_CONVPATH          (SQLITE_IOERR | (26<<8))
211#define SQLITE_IOERR_VNODE             (SQLITE_IOERR | (27<<8))
212#define SQLITE_IOERR_AUTH              (SQLITE_IOERR | (28<<8))
213#define SQLITE_IOERR_BEGIN_ATOMIC      (SQLITE_IOERR | (29<<8))
214#define SQLITE_IOERR_COMMIT_ATOMIC     (SQLITE_IOERR | (30<<8))
215#define SQLITE_IOERR_ROLLBACK_ATOMIC   (SQLITE_IOERR | (31<<8))
216#define SQLITE_IOERR_DATA              (SQLITE_IOERR | (32<<8))
217#define SQLITE_IOERR_CORRUPTFS         (SQLITE_IOERR | (33<<8))
218#define SQLITE_IOERR_IN_PAGE           (SQLITE_IOERR | (34<<8))
219#define SQLITE_LOCKED_SHAREDCACHE      (SQLITE_LOCKED |  (1<<8))
220#define SQLITE_LOCKED_VTAB             (SQLITE_LOCKED |  (2<<8))
221#define SQLITE_BUSY_RECOVERY           (SQLITE_BUSY   |  (1<<8))
222#define SQLITE_BUSY_SNAPSHOT           (SQLITE_BUSY   |  (2<<8))
223#define SQLITE_BUSY_TIMEOUT            (SQLITE_BUSY   |  (3<<8))
224#define SQLITE_CANTOPEN_NOTEMPDIR      (SQLITE_CANTOPEN | (1<<8))
225#define SQLITE_CANTOPEN_ISDIR          (SQLITE_CANTOPEN | (2<<8))
226#define SQLITE_CANTOPEN_FULLPATH       (SQLITE_CANTOPEN | (3<<8))
227#define SQLITE_CANTOPEN_CONVPATH       (SQLITE_CANTOPEN | (4<<8))
228#define SQLITE_CANTOPEN_DIRTYWAL       (SQLITE_CANTOPEN | (5<<8)) /* Not Used */
229#define SQLITE_CANTOPEN_SYMLINK        (SQLITE_CANTOPEN | (6<<8))
230#define SQLITE_CORRUPT_VTAB            (SQLITE_CORRUPT | (1<<8))
231#define SQLITE_CORRUPT_SEQUENCE        (SQLITE_CORRUPT | (2<<8))
232#define SQLITE_CORRUPT_INDEX           (SQLITE_CORRUPT | (3<<8))
233#define SQLITE_READONLY_RECOVERY       (SQLITE_READONLY | (1<<8))
234#define SQLITE_READONLY_CANTLOCK       (SQLITE_READONLY | (2<<8))
235#define SQLITE_READONLY_ROLLBACK       (SQLITE_READONLY | (3<<8))
236#define SQLITE_READONLY_DBMOVED        (SQLITE_READONLY | (4<<8))
237#define SQLITE_READONLY_CANTINIT       (SQLITE_READONLY | (5<<8))
238#define SQLITE_READONLY_DIRECTORY      (SQLITE_READONLY | (6<<8))
239#define SQLITE_ABORT_ROLLBACK          (SQLITE_ABORT | (2<<8))
240#define SQLITE_CONSTRAINT_CHECK        (SQLITE_CONSTRAINT | (1<<8))
241#define SQLITE_CONSTRAINT_COMMITHOOK   (SQLITE_CONSTRAINT | (2<<8))
242#define SQLITE_CONSTRAINT_FOREIGNKEY   (SQLITE_CONSTRAINT | (3<<8))
243#define SQLITE_CONSTRAINT_FUNCTION     (SQLITE_CONSTRAINT | (4<<8))
244#define SQLITE_CONSTRAINT_NOTNULL      (SQLITE_CONSTRAINT | (5<<8))
245#define SQLITE_CONSTRAINT_PRIMARYKEY   (SQLITE_CONSTRAINT | (6<<8))
246#define SQLITE_CONSTRAINT_TRIGGER      (SQLITE_CONSTRAINT | (7<<8))
247#define SQLITE_CONSTRAINT_UNIQUE       (SQLITE_CONSTRAINT | (8<<8))
248#define SQLITE_CONSTRAINT_VTAB         (SQLITE_CONSTRAINT | (9<<8))
249#define SQLITE_CONSTRAINT_ROWID        (SQLITE_CONSTRAINT |(10<<8))
250#define SQLITE_CONSTRAINT_PINNED       (SQLITE_CONSTRAINT |(11<<8))
251#define SQLITE_CONSTRAINT_DATATYPE     (SQLITE_CONSTRAINT |(12<<8))
252#define SQLITE_NOTICE_RECOVER_WAL      (SQLITE_NOTICE | (1<<8))
253#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
254#define SQLITE_NOTICE_RBU              (SQLITE_NOTICE | (3<<8))
255#define SQLITE_WARNING_AUTOINDEX       (SQLITE_WARNING | (1<<8))
256#define SQLITE_AUTH_USER               (SQLITE_AUTH | (1<<8))
257#define SQLITE_OK_LOAD_PERMANENTLY     (SQLITE_OK | (1<<8))
258#define SQLITE_OK_SYMLINK              (SQLITE_OK | (2<<8)) /* internal use only */
259.Ed
260.Sh SEE ALSO
261.Xr sqlite3_errcode 3 ,
262.Xr sqlite3_extended_result_codes 3
263