database/sqlite
1
0
Fork 0
mirror of https://github.com/sqlite/sqlite.git synced 2025-11-12 13:01:09 +03:00
Code Activity

Reworking the documentation on integer result codes. This is a comment

Browse Source 
and documentation change only.  There are no changes to code.

FossilOrigin-Name: 54f1df7b63166f14b2f0d5955c546820e5cbdec9
This commit is contained in:
drh
2014-08-08 12:51:42 +00:00
parent b562f63c1b
commit 1d8ba02445
3 changed files with 21 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
manifest
View File

@@ -1,5 +1,5 @@
C When\sthe\sestimated\ssorting\scost\soverwhelms\sthe\sestimated\slookup\scost,\sensure\nthat\slookup\scosts\sare\sstill\staken\sinto\saccount\swhen\sselecting\sa\slookup\nalgorithm. C Reworking\sthe\sdocumentation\son\sinteger\sresult\scodes.\s\sThis\sis\sa\scomment\nand\sdocumentation\schange\sonly.\s\sThere\sare\sno\schanges\sto\scode.
D 2014-08-07T20:42:33.655 D 2014-08-08T12:51:42.280
F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
F Makefile.in 5eb79e334a5de69c87740edd56af6527dd219308 F Makefile.in 5eb79e334a5de69c87740edd56af6527dd219308
F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23 F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
@@ -224,7 +224,7 @@ F src/resolve.c 5fc110baeacf120a73fe34e103f052632ff11a02
F src/rowset.c a9c9aae3234b44a6d7c6f5a3cadf90dce1e627be F src/rowset.c a9c9aae3234b44a6d7c6f5a3cadf90dce1e627be
F src/select.c 1529c49075464c5a95fde77314073612b1b8d595 F src/select.c 1529c49075464c5a95fde77314073612b1b8d595
F src/shell.c 4af71e7f25af6da6debda87dcbd6be37da710916 F src/shell.c 4af71e7f25af6da6debda87dcbd6be37da710916
F src/sqlite.h.in 9bbc5815c73b0e77e68b5275481a5e3e7814a804 F src/sqlite.h.in c9c7328b51a94633c229b435eda8092fcd4e1ea3
F src/sqlite3.rc 11094cc6a157a028b301a9f06b3d03089ea37c3e F src/sqlite3.rc 11094cc6a157a028b301a9f06b3d03089ea37c3e
F src/sqlite3ext.h 886f5a34de171002ad46fae8c36a7d8051c190fc F src/sqlite3ext.h 886f5a34de171002ad46fae8c36a7d8051c190fc
F src/sqliteInt.h 641f8fbb65ca2084c8df95b525f6f82c7a1e91ae F src/sqliteInt.h 641f8fbb65ca2084c8df95b525f6f82c7a1e91ae
@@ -1185,8 +1185,7 @@ F tool/vdbe_profile.tcl 67746953071a9f8f2f668b73fe899074e2c6d8c1
F tool/warnings-clang.sh f6aa929dc20ef1f856af04a730772f59283631d4 F tool/warnings-clang.sh f6aa929dc20ef1f856af04a730772f59283631d4
F tool/warnings.sh 0abfd78ceb09b7f7c27c688c8e3fe93268a13b32 F tool/warnings.sh 0abfd78ceb09b7f7c27c688c8e3fe93268a13b32
F tool/win/sqlite.vsix deb315d026cc8400325c5863eef847784a219a2f F tool/win/sqlite.vsix deb315d026cc8400325c5863eef847784a219a2f
P bcf6d775f90f4d1ba018a1b965f2f710df130f01 b5e8fd575a80334160de0aac8084ed5cd28816a5 P 2af630c5720a4d71f22a952af29346a09bd8dfd0
R 444666601d1d38c7f4902aa29891f8d2 R b6800f247d253d726e2d1b70eaab6208
T +closed b5e8fd575a80334160de0aac8084ed5cd28816a5
U drh U drh
Z f100e3a960f67faf0129a27666ad7927 Z 92cc627e0fe24841ecb93d0e5157435c

2
manifest.uuid
View File

@@ -1 +1 @@
2af630c5720a4d71f22a952af29346a09bd8dfd0 54f1df7b63166f14b2f0d5955c546820e5cbdec9

36
src/sqlite.h.in
View File

@@ -264,7 +264,7 @@ typedef sqlite_uint64 sqlite3_uint64;
** **
** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors ** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
** for the [sqlite3] object. ** for the [sqlite3] object.
** ^Calls to sqlite3_close() and sqlite3_close_v2() return SQLITE_OK if ** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
** the [sqlite3] object is successfully destroyed and all associated ** the [sqlite3] object is successfully destroyed and all associated
** resources are deallocated. ** resources are deallocated.
** **
@@ -285,7 +285,7 @@ typedef sqlite_uint64 sqlite3_uint64;
** with the [sqlite3] object prior to attempting to close the object. ^If ** with the [sqlite3] object prior to attempting to close the object. ^If
** sqlite3_close_v2() is called on a [database connection] that still has ** sqlite3_close_v2() is called on a [database connection] that still has
** outstanding [prepared statements], [BLOB handles], and/or ** outstanding [prepared statements], [BLOB handles], and/or
** [sqlite3_backup] objects then it returns SQLITE_OK but the deallocation ** [sqlite3_backup] objects then it returns [SQLITE_OK] but the deallocation
** of resources is deferred until all [prepared statements], [BLOB handles], ** of resources is deferred until all [prepared statements], [BLOB handles],
** and [sqlite3_backup] objects are also destroyed. ** and [sqlite3_backup] objects are also destroyed.
** **
@@ -381,16 +381,14 @@ int sqlite3_exec(
/* /*
** CAPI3REF: Result Codes ** CAPI3REF: Result Codes
** KEYWORDS: SQLITE_OK {error code} {error codes} ** KEYWORDS: {result code definitions}
** KEYWORDS: {result code} {result codes}
** **
** Many SQLite functions return an integer result code from the set shown ** Many SQLite functions return an integer result code from the set shown
** here in order to indicate success or failure. ** here in order to indicate success or failure.
** **
** New error codes may be added in future versions of SQLite. ** New error codes may be added in future versions of SQLite.
** **
** See also: [SQLITE_IOERR_READ | extended result codes], ** See also: [extended result code definitions]
** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes].
*/ */
#define SQLITE_OK 0 /* Successful result */ #define SQLITE_OK 0 /* Successful result */
/* beginning-of-error-codes */ /* beginning-of-error-codes */
@@ -428,26 +426,19 @@ int sqlite3_exec(
/* /*
** CAPI3REF: Extended Result Codes ** CAPI3REF: Extended Result Codes
** KEYWORDS: {extended error code} {extended error codes} ** KEYWORDS: {extended result code definitions}
** KEYWORDS: {extended result code} {extended result codes}
** **
** In its default configuration, SQLite API routines return one of 26 integer ** In its default configuration, SQLite API routines return one of 30 integer
** [SQLITE_OK | result codes]. However, experience has shown that many of ** [result codes]. However, experience has shown that many of
** these result codes are too coarse-grained. They do not provide as ** these result codes are too coarse-grained. They do not provide as
** much information about problems as programmers might like. In an effort to ** much information about problems as programmers might like. In an effort to
** address this, newer versions of SQLite (version 3.3.8 and later) include ** address this, newer versions of SQLite (version 3.3.8 and later) include
** support for additional result codes that provide more detailed information ** support for additional result codes that provide more detailed information
** about errors. The extended result codes are enabled or disabled ** about errors. These [extended result codes] are enabled or disabled
** on a per database connection basis using the ** on a per database connection basis using the
** [sqlite3_extended_result_codes()] API. ** [sqlite3_extended_result_codes()] API. Or, the extended code for
** ** the most recent error can be obtained using
** Some of the available extended result codes are listed here. ** [sqlite3_extended_errcode()].
** One may expect the number of extended result codes will increase
** over time. Software that uses extended result codes should expect
** to see new result codes in future releases of SQLite.
**
** The SQLITE_OK result code will never be extended. It will always
** be exactly zero.
*/ */
#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
@@ -2523,8 +2514,8 @@ int sqlite3_set_authorizer(
** [sqlite3_set_authorizer | authorizer documentation] for additional ** [sqlite3_set_authorizer | authorizer documentation] for additional
** information. ** information.
** **
** Note that SQLITE_IGNORE is also used as a [SQLITE_ROLLBACK | return code] ** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
** from the [sqlite3_vtab_on_conflict()] interface. ** returned from the [sqlite3_vtab_on_conflict()] interface.
*/ */
#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
@@ -7364,6 +7355,7 @@ int sqlite3_vtab_on_conflict(sqlite3 *);
/* /*
** CAPI3REF: Conflict resolution modes ** CAPI3REF: Conflict resolution modes
** KEYWORDS: {conflict resolution mode}
** **
** These constants are returned by [sqlite3_vtab_on_conflict()] to ** These constants are returned by [sqlite3_vtab_on_conflict()] to
** inform a [virtual table] implementation what the [ON CONFLICT] mode ** inform a [virtual table] implementation what the [ON CONFLICT] mode