xref: /netbsd-src/external/public-domain/sqlite/man/SQLITE_OK.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE_OK 3
3.Os
4.Sh NAME
5.Nm SQLITE_OK ,
6.Nm SQLITE_ERROR ,
7.Nm SQLITE_INTERNAL ,
8.Nm SQLITE_PERM ,
9.Nm SQLITE_ABORT ,
10.Nm SQLITE_BUSY ,
11.Nm SQLITE_LOCKED ,
12.Nm SQLITE_NOMEM ,
13.Nm SQLITE_READONLY ,
14.Nm SQLITE_INTERRUPT ,
15.Nm SQLITE_IOERR ,
16.Nm SQLITE_CORRUPT ,
17.Nm SQLITE_NOTFOUND ,
18.Nm SQLITE_FULL ,
19.Nm SQLITE_CANTOPEN ,
20.Nm SQLITE_PROTOCOL ,
21.Nm SQLITE_EMPTY ,
22.Nm SQLITE_SCHEMA ,
23.Nm SQLITE_TOOBIG ,
24.Nm SQLITE_CONSTRAINT ,
25.Nm SQLITE_MISMATCH ,
26.Nm SQLITE_MISUSE ,
27.Nm SQLITE_NOLFS ,
28.Nm SQLITE_AUTH ,
29.Nm SQLITE_FORMAT ,
30.Nm SQLITE_RANGE ,
31.Nm SQLITE_NOTADB ,
32.Nm SQLITE_NOTICE ,
33.Nm SQLITE_WARNING ,
34.Nm SQLITE_ROW ,
35.Nm SQLITE_DONE
36.Nd result codes
37.Sh SYNOPSIS
38.In sqlite3.h
39.Fd #define SQLITE_OK
40.Fd #define SQLITE_ERROR
41.Fd #define SQLITE_INTERNAL
42.Fd #define SQLITE_PERM
43.Fd #define SQLITE_ABORT
44.Fd #define SQLITE_BUSY
45.Fd #define SQLITE_LOCKED
46.Fd #define SQLITE_NOMEM
47.Fd #define SQLITE_READONLY
48.Fd #define SQLITE_INTERRUPT
49.Fd #define SQLITE_IOERR
50.Fd #define SQLITE_CORRUPT
51.Fd #define SQLITE_NOTFOUND
52.Fd #define SQLITE_FULL
53.Fd #define SQLITE_CANTOPEN
54.Fd #define SQLITE_PROTOCOL
55.Fd #define SQLITE_EMPTY
56.Fd #define SQLITE_SCHEMA
57.Fd #define SQLITE_TOOBIG
58.Fd #define SQLITE_CONSTRAINT
59.Fd #define SQLITE_MISMATCH
60.Fd #define SQLITE_MISUSE
61.Fd #define SQLITE_NOLFS
62.Fd #define SQLITE_AUTH
63.Fd #define SQLITE_FORMAT
64.Fd #define SQLITE_RANGE
65.Fd #define SQLITE_NOTADB
66.Fd #define SQLITE_NOTICE
67.Fd #define SQLITE_WARNING
68.Fd #define SQLITE_ROW
69.Fd #define SQLITE_DONE
70.Sh DESCRIPTION
71Many SQLite functions return an integer result code from the set shown
72here in order to indicate success or failure.
73.Pp
74New error codes may be added in future versions of SQLite.
75.Pp
76.Sh IMPLEMENTATION NOTES
77These declarations were extracted from the
78interface documentation at line 434.
79.Bd -literal
80#define SQLITE_OK           0   /* Successful result */
81/* beginning-of-error-codes */
82#define SQLITE_ERROR        1   /* Generic error */
83#define SQLITE_INTERNAL     2   /* Internal logic error in SQLite */
84#define SQLITE_PERM         3   /* Access permission denied */
85#define SQLITE_ABORT        4   /* Callback routine requested an abort */
86#define SQLITE_BUSY         5   /* The database file is locked */
87#define SQLITE_LOCKED       6   /* A table in the database is locked */
88#define SQLITE_NOMEM        7   /* A malloc() failed */
89#define SQLITE_READONLY     8   /* Attempt to write a readonly database */
90#define SQLITE_INTERRUPT    9   /* Operation terminated by sqlite3_interrupt()*/
91#define SQLITE_IOERR       10   /* Some kind of disk I/O error occurred */
92#define SQLITE_CORRUPT     11   /* The database disk image is malformed */
93#define SQLITE_NOTFOUND    12   /* Unknown opcode in sqlite3_file_control() */
94#define SQLITE_FULL        13   /* Insertion failed because database is full */
95#define SQLITE_CANTOPEN    14   /* Unable to open the database file */
96#define SQLITE_PROTOCOL    15   /* Database lock protocol error */
97#define SQLITE_EMPTY       16   /* Internal use only */
98#define SQLITE_SCHEMA      17   /* The database schema changed */
99#define SQLITE_TOOBIG      18   /* String or BLOB exceeds size limit */
100#define SQLITE_CONSTRAINT  19   /* Abort due to constraint violation */
101#define SQLITE_MISMATCH    20   /* Data type mismatch */
102#define SQLITE_MISUSE      21   /* Library used incorrectly */
103#define SQLITE_NOLFS       22   /* Uses OS features not supported on host */
104#define SQLITE_AUTH        23   /* Authorization denied */
105#define SQLITE_FORMAT      24   /* Not used */
106#define SQLITE_RANGE       25   /* 2nd parameter to sqlite3_bind out of range */
107#define SQLITE_NOTADB      26   /* File opened that is not a database file */
108#define SQLITE_NOTICE      27   /* Notifications from sqlite3_log() */
109#define SQLITE_WARNING     28   /* Warnings from sqlite3_log() */
110#define SQLITE_ROW         100  /* sqlite3_step() has another row ready */
111#define SQLITE_DONE        101  /* sqlite3_step() has finished executing */
112/* end-of-error-codes */
113.Ed
114.Sh SEE ALSO
115.Xr SQLITE_ERROR_MISSING_COLLSEQ 3
116