Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(46)

Side by Side Diff: third_party/sqlite/preprocessed/sqlite3.h

Issue 5626002: Update sqlite to 3.7.3. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/third_party/sqlite/src
Patch Set: Remove misc change. Created 10 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « third_party/sqlite/preprocessed/parse.c ('k') | third_party/sqlite/safe-tolower.patch » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 /* 1 /*
2 ** 2001 September 15 2 ** 2001 September 15
3 ** 3 **
4 ** The author disclaims copyright to this source code. In place of 4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing: 5 ** a legal notice, here is a blessing:
6 ** 6 **
7 ** May you do good and not evil. 7 ** May you do good and not evil.
8 ** May you find forgiveness for yourself and forgive others. 8 ** May you find forgiveness for yourself and forgive others.
9 ** May you share freely, never taking more than you give. 9 ** May you share freely, never taking more than you give.
10 ** 10 **
(...skipping 63 matching lines...) Expand 10 before | Expand all | Expand 10 after
74 ** Ensure these symbols were not defined by some previous header file. 74 ** Ensure these symbols were not defined by some previous header file.
75 */ 75 */
76 #ifdef SQLITE_VERSION 76 #ifdef SQLITE_VERSION
77 # undef SQLITE_VERSION 77 # undef SQLITE_VERSION
78 #endif 78 #endif
79 #ifdef SQLITE_VERSION_NUMBER 79 #ifdef SQLITE_VERSION_NUMBER
80 # undef SQLITE_VERSION_NUMBER 80 # undef SQLITE_VERSION_NUMBER
81 #endif 81 #endif
82 82
83 /* 83 /*
84 ** CAPI3REF: Compile-Time Library Version Numbers {H10010} <S60100> 84 ** CAPI3REF: Compile-Time Library Version Numbers
85 ** 85 **
86 ** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in 86 ** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
87 ** the sqlite3.h file specify the version of SQLite with which 87 ** evaluates to a string literal that is the SQLite version in the
88 ** that header file is associated. 88 ** format "X.Y.Z" where X is the major version number (always 3 for
89 ** 89 ** SQLite3) and Y is the minor version number and Z is the release number.)^
90 ** The "version" of SQLite is a string of the form "W.X.Y" or "W.X.Y.Z". 90 ** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
91 ** The W value is major version number and is always 3 in SQLite3. 91 ** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
92 ** The W value only changes when backwards compatibility is 92 ** numbers used in [SQLITE_VERSION].)^
93 ** broken and we intend to never break backwards compatibility. 93 ** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
94 ** The X value is the minor version number and only changes when 94 ** be larger than the release from which it is derived. Either Y will
95 ** there are major feature enhancements that are forwards compatible 95 ** be held constant and Z will be incremented or else Y will be incremented
96 ** but not backwards compatible. 96 ** and Z will be reset to zero.
97 ** The Y value is the release number and is incremented with
98 ** each release but resets back to 0 whenever X is incremented.
99 ** The Z value only appears on branch releases.
100 **
101 ** The SQLITE_VERSION_NUMBER is an integer that is computed as
102 ** follows:
103 **
104 ** <blockquote><pre>
105 ** SQLITE_VERSION_NUMBER = W*1000000 + X*1000 + Y
106 ** </pre></blockquote>
107 ** 97 **
108 ** Since version 3.6.18, SQLite source code has been stored in the 98 ** Since version 3.6.18, SQLite source code has been stored in the
109 ** <a href="http://www.fossil-scm.org/">fossil configuration management 99 ** <a href="http://www.fossil-scm.org/">Fossil configuration management
110 ** system</a>. The SQLITE_SOURCE_ID 100 ** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
111 ** macro is a string which identifies a particular check-in of SQLite 101 ** a string which identifies a particular check-in of SQLite
112 ** within its configuration management system. The string contains the 102 ** within its configuration management system. ^The SQLITE_SOURCE_ID
113 ** date and time of the check-in (UTC) and an SHA1 hash of the entire 103 ** string contains the date and time of the check-in (UTC) and an SHA1
114 ** source tree. 104 ** hash of the entire source tree.
115 ** 105 **
116 ** See also: [sqlite3_libversion()], 106 ** See also: [sqlite3_libversion()],
117 ** [sqlite3_libversion_number()], [sqlite3_sourceid()], 107 ** [sqlite3_libversion_number()], [sqlite3_sourceid()],
118 ** [sqlite_version()] and [sqlite_source_id()]. 108 ** [sqlite_version()] and [sqlite_source_id()].
119 **
120 ** Requirements: [H10011] [H10014]
121 */ 109 */
122 #define SQLITE_VERSION "3.6.18" 110 #define SQLITE_VERSION "3.7.3"
123 #define SQLITE_VERSION_NUMBER 3006018 111 #define SQLITE_VERSION_NUMBER 3007003
124 #define SQLITE_SOURCE_ID "2009-09-11 14:05:07 b084828a771ec40be85f07c590ca9 9de4f6c24ee" 112 #define SQLITE_SOURCE_ID "2010-10-08 02:34:02 2677848087c9c090efb17c1893e77 d6136a9111d"
125 113
126 /* 114 /*
127 ** CAPI3REF: Run-Time Library Version Numbers {H10020} <S60100> 115 ** CAPI3REF: Run-Time Library Version Numbers
128 ** KEYWORDS: sqlite3_version 116 ** KEYWORDS: sqlite3_version, sqlite3_sourceid
129 ** 117 **
130 ** These interfaces provide the same information as the [SQLITE_VERSION], 118 ** These interfaces provide the same information as the [SQLITE_VERSION],
131 ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] #defines in the header, 119 ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
132 ** but are associated with the library instead of the header file. Cautious 120 ** but are associated with the library instead of the header file. ^(Cautious
133 ** programmers might include assert() statements in their application to 121 ** programmers might include assert() statements in their application to
134 ** verify that values returned by these interfaces match the macros in 122 ** verify that values returned by these interfaces match the macros in
135 ** the header, and thus insure that the application is 123 ** the header, and thus insure that the application is
136 ** compiled with matching library and header files. 124 ** compiled with matching library and header files.
137 ** 125 **
138 ** <blockquote><pre> 126 ** <blockquote><pre>
139 ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); 127 ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
140 ** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 ); 128 ** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
141 ** assert( strcmp(sqlite3_libversion,SQLITE_VERSION)==0 ); 129 ** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
142 ** </pre></blockquote> 130 ** </pre></blockquote>)^
143 ** 131 **
144 ** The sqlite3_libversion() function returns the same information as is 132 ** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
145 ** in the sqlite3_version[] string constant. The function is provided 133 ** macro. ^The sqlite3_libversion() function returns a pointer to the
146 ** for use in DLLs since DLL users usually do not have direct access to string 134 ** to the sqlite3_version[] string constant. The sqlite3_libversion()
147 ** constants within the DLL. Similarly, the sqlite3_sourceid() function 135 ** function is provided for use in DLLs since DLL users usually do not have
148 ** returns the same information as is in the [SQLITE_SOURCE_ID] #define of 136 ** direct access to string constants within the DLL. ^The
149 ** the header file. 137 ** sqlite3_libversion_number() function returns an integer equal to
138 ** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns
139 ** a pointer to a string constant whose value is the same as the
140 ** [SQLITE_SOURCE_ID] C preprocessor macro.
150 ** 141 **
151 ** See also: [sqlite_version()] and [sqlite_source_id()]. 142 ** See also: [sqlite_version()] and [sqlite_source_id()].
152 **
153 ** Requirements: [H10021] [H10022] [H10023]
154 */ 143 */
155 SQLITE_API SQLITE_EXTERN const char sqlite3_version[]; 144 SQLITE_API SQLITE_EXTERN const char sqlite3_version[];
156 SQLITE_API const char *sqlite3_libversion(void); 145 SQLITE_API const char *sqlite3_libversion(void);
157 SQLITE_API const char *sqlite3_sourceid(void); 146 SQLITE_API const char *sqlite3_sourceid(void);
158 SQLITE_API int sqlite3_libversion_number(void); 147 SQLITE_API int sqlite3_libversion_number(void);
159 148
160 /* 149 /*
161 ** CAPI3REF: Test To See If The Library Is Threadsafe {H10100} <S60100> 150 ** CAPI3REF: Run-Time Library Compilation Options Diagnostics
151 **
152 ** ^The sqlite3_compileoption_used() function returns 0 or 1
153 ** indicating whether the specified option was defined at
154 ** compile time. ^The SQLITE_ prefix may be omitted from the
155 ** option name passed to sqlite3_compileoption_used().
156 **
157 ** ^The sqlite3_compileoption_get() function allows iterating
158 ** over the list of options that were defined at compile time by
159 ** returning the N-th compile time option string. ^If N is out of range,
160 ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
161 ** prefix is omitted from any strings returned by
162 ** sqlite3_compileoption_get().
163 **
164 ** ^Support for the diagnostic functions sqlite3_compileoption_used()
165 ** and sqlite3_compileoption_get() may be omitted by specifying the
166 ** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
167 **
168 ** See also: SQL functions [sqlite_compileoption_used()] and
169 ** [sqlite_compileoption_get()] and the [compile_options pragma].
170 */
171 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
172 SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
173 SQLITE_API const char *sqlite3_compileoption_get(int N);
174 #endif
175
176 /*
177 ** CAPI3REF: Test To See If The Library Is Threadsafe
178 **
179 ** ^The sqlite3_threadsafe() function returns zero if and only if
180 ** SQLite was compiled mutexing code omitted due to the
181 ** [SQLITE_THREADSAFE] compile-time option being set to 0.
162 ** 182 **
163 ** SQLite can be compiled with or without mutexes. When 183 ** SQLite can be compiled with or without mutexes. When
164 ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes 184 ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
165 ** are enabled and SQLite is threadsafe. When the 185 ** are enabled and SQLite is threadsafe. When the
166 ** [SQLITE_THREADSAFE] macro is 0, 186 ** [SQLITE_THREADSAFE] macro is 0,
167 ** the mutexes are omitted. Without the mutexes, it is not safe 187 ** the mutexes are omitted. Without the mutexes, it is not safe
168 ** to use SQLite concurrently from more than one thread. 188 ** to use SQLite concurrently from more than one thread.
169 ** 189 **
170 ** Enabling mutexes incurs a measurable performance penalty. 190 ** Enabling mutexes incurs a measurable performance penalty.
171 ** So if speed is of utmost importance, it makes sense to disable 191 ** So if speed is of utmost importance, it makes sense to disable
172 ** the mutexes. But for maximum safety, mutexes should be enabled. 192 ** the mutexes. But for maximum safety, mutexes should be enabled.
173 ** The default behavior is for mutexes to be enabled. 193 ** ^The default behavior is for mutexes to be enabled.
174 ** 194 **
175 ** This interface can be used by an application to make sure that the 195 ** This interface can be used by an application to make sure that the
176 ** version of SQLite that it is linking against was compiled with 196 ** version of SQLite that it is linking against was compiled with
177 ** the desired setting of the [SQLITE_THREADSAFE] macro. 197 ** the desired setting of the [SQLITE_THREADSAFE] macro.
178 ** 198 **
179 ** This interface only reports on the compile-time mutex setting 199 ** This interface only reports on the compile-time mutex setting
180 ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with 200 ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
181 ** SQLITE_THREADSAFE=1 then mutexes are enabled by default but 201 ** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
182 ** can be fully or partially disabled using a call to [sqlite3_config()] 202 ** can be fully or partially disabled using a call to [sqlite3_config()]
183 ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], 203 ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
184 ** or [SQLITE_CONFIG_MUTEX]. The return value of this function shows 204 ** or [SQLITE_CONFIG_MUTEX]. ^(The return value of the
185 ** only the default compile-time setting, not any run-time changes 205 ** sqlite3_threadsafe() function shows only the compile-time setting of
186 ** to that setting. 206 ** thread safety, not any run-time changes to that setting made by
207 ** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
208 ** is unchanged by calls to sqlite3_config().)^
187 ** 209 **
188 ** See the [threading mode] documentation for additional information. 210 ** See the [threading mode] documentation for additional information.
189 **
190 ** Requirements: [H10101] [H10102]
191 */ 211 */
192 SQLITE_API int sqlite3_threadsafe(void); 212 SQLITE_API int sqlite3_threadsafe(void);
193 213
194 /* 214 /*
195 ** CAPI3REF: Database Connection Handle {H12000} <S40200> 215 ** CAPI3REF: Database Connection Handle
196 ** KEYWORDS: {database connection} {database connections} 216 ** KEYWORDS: {database connection} {database connections}
197 ** 217 **
198 ** Each open SQLite database is represented by a pointer to an instance of 218 ** Each open SQLite database is represented by a pointer to an instance of
199 ** the opaque structure named "sqlite3". It is useful to think of an sqlite3 219 ** the opaque structure named "sqlite3". It is useful to think of an sqlite3
200 ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and 220 ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
201 ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] 221 ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
202 ** is its destructor. There are many other interfaces (such as 222 ** is its destructor. There are many other interfaces (such as
203 ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and 223 ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
204 ** [sqlite3_busy_timeout()] to name but three) that are methods on an 224 ** [sqlite3_busy_timeout()] to name but three) that are methods on an
205 ** sqlite3 object. 225 ** sqlite3 object.
206 */ 226 */
207 typedef struct sqlite3 sqlite3; 227 typedef struct sqlite3 sqlite3;
208 228
209 /* 229 /*
210 ** CAPI3REF: 64-Bit Integer Types {H10200} <S10110> 230 ** CAPI3REF: 64-Bit Integer Types
211 ** KEYWORDS: sqlite_int64 sqlite_uint64 231 ** KEYWORDS: sqlite_int64 sqlite_uint64
212 ** 232 **
213 ** Because there is no cross-platform way to specify 64-bit integer types 233 ** Because there is no cross-platform way to specify 64-bit integer types
214 ** SQLite includes typedefs for 64-bit signed and unsigned integers. 234 ** SQLite includes typedefs for 64-bit signed and unsigned integers.
215 ** 235 **
216 ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. 236 ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
217 ** The sqlite_int64 and sqlite_uint64 types are supported for backwards 237 ** The sqlite_int64 and sqlite_uint64 types are supported for backwards
218 ** compatibility only. 238 ** compatibility only.
219 ** 239 **
220 ** Requirements: [H10201] [H10202] 240 ** ^The sqlite3_int64 and sqlite_int64 types can store integer values
241 ** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
242 ** sqlite3_uint64 and sqlite_uint64 types can store integer values
243 ** between 0 and +18446744073709551615 inclusive.
221 */ 244 */
222 #ifdef SQLITE_INT64_TYPE 245 #ifdef SQLITE_INT64_TYPE
223 typedef SQLITE_INT64_TYPE sqlite_int64; 246 typedef SQLITE_INT64_TYPE sqlite_int64;
224 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; 247 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
225 #elif defined(_MSC_VER) || defined(__BORLANDC__) 248 #elif defined(_MSC_VER) || defined(__BORLANDC__)
226 typedef __int64 sqlite_int64; 249 typedef __int64 sqlite_int64;
227 typedef unsigned __int64 sqlite_uint64; 250 typedef unsigned __int64 sqlite_uint64;
228 #else 251 #else
229 typedef long long int sqlite_int64; 252 typedef long long int sqlite_int64;
230 typedef unsigned long long int sqlite_uint64; 253 typedef unsigned long long int sqlite_uint64;
231 #endif 254 #endif
232 typedef sqlite_int64 sqlite3_int64; 255 typedef sqlite_int64 sqlite3_int64;
233 typedef sqlite_uint64 sqlite3_uint64; 256 typedef sqlite_uint64 sqlite3_uint64;
234 257
235 /* 258 /*
236 ** If compiling for a processor that lacks floating point support, 259 ** If compiling for a processor that lacks floating point support,
237 ** substitute integer for floating-point. 260 ** substitute integer for floating-point.
238 */ 261 */
239 #ifdef SQLITE_OMIT_FLOATING_POINT 262 #ifdef SQLITE_OMIT_FLOATING_POINT
240 # define double sqlite3_int64 263 # define double sqlite3_int64
241 #endif 264 #endif
242 265
243 /* 266 /*
244 ** CAPI3REF: Closing A Database Connection {H12010} <S30100><S40200> 267 ** CAPI3REF: Closing A Database Connection
245 ** 268 **
246 ** This routine is the destructor for the [sqlite3] object. 269 ** ^The sqlite3_close() routine is the destructor for the [sqlite3] object.
270 ** ^Calls to sqlite3_close() return SQLITE_OK if the [sqlite3] object is
271 ** successfully destroyed and all associated resources are deallocated.
247 ** 272 **
248 ** Applications should [sqlite3_finalize | finalize] all [prepared statements] 273 ** Applications must [sqlite3_finalize | finalize] all [prepared statements]
249 ** and [sqlite3_blob_close | close] all [BLOB handles] associated with 274 ** and [sqlite3_blob_close | close] all [BLOB handles] associated with
250 ** the [sqlite3] object prior to attempting to close the object. 275 ** the [sqlite3] object prior to attempting to close the object. ^If
251 ** The [sqlite3_next_stmt()] interface can be used to locate all 276 ** sqlite3_close() is called on a [database connection] that still has
252 ** [prepared statements] associated with a [database connection] if desired. 277 ** outstanding [prepared statements] or [BLOB handles], then it returns
253 ** Typical code might look like this: 278 ** SQLITE_BUSY.
254 ** 279 **
255 ** <blockquote><pre> 280 ** ^If [sqlite3_close()] is invoked while a transaction is open,
256 ** sqlite3_stmt *pStmt;
257 ** while( (pStmt = sqlite3_next_stmt(db, 0))!=0 ){
258 ** &nbsp; sqlite3_finalize(pStmt);
259 ** }
260 ** </pre></blockquote>
261 **
262 ** If [sqlite3_close()] is invoked while a transaction is open,
263 ** the transaction is automatically rolled back. 281 ** the transaction is automatically rolled back.
264 ** 282 **
265 ** The C parameter to [sqlite3_close(C)] must be either a NULL 283 ** The C parameter to [sqlite3_close(C)] must be either a NULL
266 ** pointer or an [sqlite3] object pointer obtained 284 ** pointer or an [sqlite3] object pointer obtained
267 ** from [sqlite3_open()], [sqlite3_open16()], or 285 ** from [sqlite3_open()], [sqlite3_open16()], or
268 ** [sqlite3_open_v2()], and not previously closed. 286 ** [sqlite3_open_v2()], and not previously closed.
269 ** 287 ** ^Calling sqlite3_close() with a NULL pointer argument is a
270 ** Requirements: 288 ** harmless no-op.
271 ** [H12011] [H12012] [H12013] [H12014] [H12015] [H12019]
272 */ 289 */
273 SQLITE_API int sqlite3_close(sqlite3 *); 290 SQLITE_API int sqlite3_close(sqlite3 *);
274 291
275 /* 292 /*
276 ** The type for a callback function. 293 ** The type for a callback function.
277 ** This is legacy and deprecated. It is included for historical 294 ** This is legacy and deprecated. It is included for historical
278 ** compatibility and is not documented. 295 ** compatibility and is not documented.
279 */ 296 */
280 typedef int (*sqlite3_callback)(void*,int,char**, char**); 297 typedef int (*sqlite3_callback)(void*,int,char**, char**);
281 298
282 /* 299 /*
283 ** CAPI3REF: One-Step Query Execution Interface {H12100} <S10000> 300 ** CAPI3REF: One-Step Query Execution Interface
284 ** 301 **
285 ** The sqlite3_exec() interface is a convenient way of running one or more 302 ** The sqlite3_exec() interface is a convenience wrapper around
286 ** SQL statements without having to write a lot of C code. The UTF-8 encoded 303 ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
287 ** SQL statements are passed in as the second parameter to sqlite3_exec(). 304 ** that allows an application to run multiple statements of SQL
288 ** The statements are evaluated one by one until either an error or 305 ** without having to use a lot of C code.
289 ** an interrupt is encountered, or until they are all done. The 3rd parameter
290 ** is an optional callback that is invoked once for each row of any query
291 ** results produced by the SQL statements. The 5th parameter tells where
292 ** to write any error messages.
293 ** 306 **
294 ** The error message passed back through the 5th parameter is held 307 ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
295 ** in memory obtained from [sqlite3_malloc()]. To avoid a memory leak, 308 ** semicolon-separate SQL statements passed into its 2nd argument,
296 ** the calling application should call [sqlite3_free()] on any error 309 ** in the context of the [database connection] passed in as its 1st
297 ** message returned through the 5th parameter when it has finished using 310 ** argument. ^If the callback function of the 3rd argument to
298 ** the error message. 311 ** sqlite3_exec() is not NULL, then it is invoked for each result row
312 ** coming out of the evaluated SQL statements. ^The 4th argument to
313 ** to sqlite3_exec() is relayed through to the 1st argument of each
314 ** callback invocation. ^If the callback pointer to sqlite3_exec()
315 ** is NULL, then no callback is ever invoked and result rows are
316 ** ignored.
299 ** 317 **
300 ** If the SQL statement in the 2nd parameter is NULL or an empty string 318 ** ^If an error occurs while evaluating the SQL statements passed into
301 ** or a string containing only whitespace and comments, then no SQL 319 ** sqlite3_exec(), then execution of the current statement stops and
302 ** statements are evaluated and the database is not changed. 320 ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
321 ** is not NULL then any error message is written into memory obtained
322 ** from [sqlite3_malloc()] and passed back through the 5th parameter.
323 ** To avoid memory leaks, the application should invoke [sqlite3_free()]
324 ** on error message strings returned through the 5th parameter of
325 ** of sqlite3_exec() after the error message string is no longer needed.
326 ** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
327 ** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
328 ** NULL before returning.
303 ** 329 **
304 ** The sqlite3_exec() interface is implemented in terms of 330 ** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
305 ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()]. 331 ** routine returns SQLITE_ABORT without invoking the callback again and
306 ** The sqlite3_exec() routine does nothing to the database that cannot be done 332 ** without running any subsequent SQL statements.
307 ** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
308 ** 333 **
309 ** The first parameter to [sqlite3_exec()] must be an valid and open 334 ** ^The 2nd argument to the sqlite3_exec() callback function is the
310 ** [database connection]. 335 ** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
336 ** callback is an array of pointers to strings obtained as if from
337 ** [sqlite3_column_text()], one for each column. ^If an element of a
338 ** result row is NULL then the corresponding string pointer for the
339 ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
340 ** sqlite3_exec() callback is an array of pointers to strings where each
341 ** entry represents the name of corresponding result column as obtained
342 ** from [sqlite3_column_name()].
311 ** 343 **
312 ** The database connection must not be closed while 344 ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
313 ** [sqlite3_exec()] is running. 345 ** to an empty string, or a pointer that contains only whitespace and/or
346 ** SQL comments, then no SQL statements are evaluated and the database
347 ** is not changed.
314 ** 348 **
315 ** The calling function should use [sqlite3_free()] to free 349 ** Restrictions:
316 ** the memory that *errmsg is left pointing at once the error
317 ** message is no longer needed.
318 ** 350 **
319 ** The SQL statement text in the 2nd parameter to [sqlite3_exec()] 351 ** <ul>
320 ** must remain unchanged while [sqlite3_exec()] is running. 352 ** <li> The application must insure that the 1st parameter to sqlite3_exec()
321 ** 353 ** is a valid and open [database connection].
322 ** Requirements: 354 ** <li> The application must not close [database connection] specified by
323 ** [H12101] [H12102] [H12104] [H12105] [H12107] [H12110] [H12113] [H12116] 355 ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
324 ** [H12119] [H12122] [H12125] [H12131] [H12134] [H12137] [H12138] 356 ** <li> The application must not modify the SQL statement text passed into
357 ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
358 ** </ul>
325 */ 359 */
326 SQLITE_API int sqlite3_exec( 360 SQLITE_API int sqlite3_exec(
327 sqlite3*, /* An open database */ 361 sqlite3*, /* An open database */
328 const char *sql, /* SQL to be evaluated */ 362 const char *sql, /* SQL to be evaluated */
329 int (*callback)(void*,int,char**,char**), /* Callback function */ 363 int (*callback)(void*,int,char**,char**), /* Callback function */
330 void *, /* 1st argument to callback */ 364 void *, /* 1st argument to callback */
331 char **errmsg /* Error msg written here */ 365 char **errmsg /* Error msg written here */
332 ); 366 );
333 367
334 /* 368 /*
335 ** CAPI3REF: Result Codes {H10210} <S10700> 369 ** CAPI3REF: Result Codes
336 ** KEYWORDS: SQLITE_OK {error code} {error codes} 370 ** KEYWORDS: SQLITE_OK {error code} {error codes}
337 ** KEYWORDS: {result code} {result codes} 371 ** KEYWORDS: {result code} {result codes}
338 ** 372 **
339 ** Many SQLite functions return an integer result code from the set shown 373 ** Many SQLite functions return an integer result code from the set shown
340 ** here in order to indicates success or failure. 374 ** here in order to indicates success or failure.
341 ** 375 **
342 ** New error codes may be added in future versions of SQLite. 376 ** New error codes may be added in future versions of SQLite.
343 ** 377 **
344 ** See also: [SQLITE_IOERR_READ | extended result codes] 378 ** See also: [SQLITE_IOERR_READ | extended result codes]
345 */ 379 */
346 #define SQLITE_OK 0 /* Successful result */ 380 #define SQLITE_OK 0 /* Successful result */
347 /* beginning-of-error-codes */ 381 /* beginning-of-error-codes */
348 #define SQLITE_ERROR 1 /* SQL error or missing database */ 382 #define SQLITE_ERROR 1 /* SQL error or missing database */
349 #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ 383 #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
350 #define SQLITE_PERM 3 /* Access permission denied */ 384 #define SQLITE_PERM 3 /* Access permission denied */
351 #define SQLITE_ABORT 4 /* Callback routine requested an abort */ 385 #define SQLITE_ABORT 4 /* Callback routine requested an abort */
352 #define SQLITE_BUSY 5 /* The database file is locked */ 386 #define SQLITE_BUSY 5 /* The database file is locked */
353 #define SQLITE_LOCKED 6 /* A table in the database is locked */ 387 #define SQLITE_LOCKED 6 /* A table in the database is locked */
354 #define SQLITE_NOMEM 7 /* A malloc() failed */ 388 #define SQLITE_NOMEM 7 /* A malloc() failed */
355 #define SQLITE_READONLY 8 /* Attempt to write a readonly database */ 389 #define SQLITE_READONLY 8 /* Attempt to write a readonly database */
356 #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ 390 #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
357 #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ 391 #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
358 #define SQLITE_CORRUPT 11 /* The database disk image is malformed */ 392 #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
359 #define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */ 393 #define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */
360 #define SQLITE_FULL 13 /* Insertion failed because database is full */ 394 #define SQLITE_FULL 13 /* Insertion failed because database is full */
361 #define SQLITE_CANTOPEN 14 /* Unable to open the database file */ 395 #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
362 #define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */ 396 #define SQLITE_PROTOCOL 15 /* Database lock protocol error */
363 #define SQLITE_EMPTY 16 /* Database is empty */ 397 #define SQLITE_EMPTY 16 /* Database is empty */
364 #define SQLITE_SCHEMA 17 /* The database schema changed */ 398 #define SQLITE_SCHEMA 17 /* The database schema changed */
365 #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ 399 #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
366 #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ 400 #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
367 #define SQLITE_MISMATCH 20 /* Data type mismatch */ 401 #define SQLITE_MISMATCH 20 /* Data type mismatch */
368 #define SQLITE_MISUSE 21 /* Library used incorrectly */ 402 #define SQLITE_MISUSE 21 /* Library used incorrectly */
369 #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ 403 #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
370 #define SQLITE_AUTH 23 /* Authorization denied */ 404 #define SQLITE_AUTH 23 /* Authorization denied */
371 #define SQLITE_FORMAT 24 /* Auxiliary database format error */ 405 #define SQLITE_FORMAT 24 /* Auxiliary database format error */
372 #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ 406 #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
373 #define SQLITE_NOTADB 26 /* File opened that is not a database file */ 407 #define SQLITE_NOTADB 26 /* File opened that is not a database file */
374 #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ 408 #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
375 #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ 409 #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
376 /* end-of-error-codes */ 410 /* end-of-error-codes */
377 411
378 /* 412 /*
379 ** CAPI3REF: Extended Result Codes {H10220} <S10700> 413 ** CAPI3REF: Extended Result Codes
380 ** KEYWORDS: {extended error code} {extended error codes} 414 ** KEYWORDS: {extended error code} {extended error codes}
381 ** KEYWORDS: {extended result code} {extended result codes} 415 ** KEYWORDS: {extended result code} {extended result codes}
382 ** 416 **
383 ** In its default configuration, SQLite API routines return one of 26 integer 417 ** In its default configuration, SQLite API routines return one of 26 integer
384 ** [SQLITE_OK | result codes]. However, experience has shown that many of 418 ** [SQLITE_OK | result codes]. However, experience has shown that many of
385 ** these result codes are too coarse-grained. They do not provide as 419 ** these result codes are too coarse-grained. They do not provide as
386 ** much information about problems as programmers might like. In an effort to 420 ** much information about problems as programmers might like. In an effort to
387 ** address this, newer versions of SQLite (version 3.3.8 and later) include 421 ** address this, newer versions of SQLite (version 3.3.8 and later) include
388 ** support for additional result codes that provide more detailed information 422 ** support for additional result codes that provide more detailed information
389 ** about errors. The extended result codes are enabled or disabled 423 ** about errors. The extended result codes are enabled or disabled
(...skipping 18 matching lines...) Expand all
408 #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) 442 #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
409 #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) 443 #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
410 #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) 444 #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
411 #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) 445 #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
412 #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) 446 #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
413 #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) 447 #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
414 #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) 448 #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
415 #define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) 449 #define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
416 #define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) 450 #define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
417 #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) 451 #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
418 #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8) ) 452 #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8))
453 #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8))
454 #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8))
455 #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8))
456 #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8))
457 #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8))
419 458
420 /* 459 /*
421 ** CAPI3REF: Flags For File Open Operations {H10230} <H11120> <H12700> 460 ** CAPI3REF: Flags For File Open Operations
422 ** 461 **
423 ** These bit values are intended for use in the 462 ** These bit values are intended for use in the
424 ** 3rd parameter to the [sqlite3_open_v2()] interface and 463 ** 3rd parameter to the [sqlite3_open_v2()] interface and
425 ** in the 4th parameter to the xOpen method of the 464 ** in the 4th parameter to the xOpen method of the
426 ** [sqlite3_vfs] object. 465 ** [sqlite3_vfs] object.
427 */ 466 */
428 #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ 467 #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
429 #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ 468 #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
430 #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ 469 #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
431 #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ 470 #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
432 #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ 471 #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
472 #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
433 #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ 473 #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
434 #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ 474 #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
435 #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ 475 #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
436 #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ 476 #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
437 #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ 477 #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
438 #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ 478 #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
439 #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ 479 #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
440 #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ 480 #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
441 #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ 481 #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
442 #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ 482 #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
443 #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ 483 #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
484 #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
444 485
445 /* 486 /*
446 ** CAPI3REF: Device Characteristics {H10240} <H11120> 487 ** CAPI3REF: Device Characteristics
447 ** 488 **
448 ** The xDeviceCapabilities method of the [sqlite3_io_methods] 489 ** The xDeviceCharacteristics method of the [sqlite3_io_methods]
449 ** object returns an integer which is a vector of the these 490 ** object returns an integer which is a vector of the these
450 ** bit values expressing I/O characteristics of the mass storage 491 ** bit values expressing I/O characteristics of the mass storage
451 ** device that holds the file that the [sqlite3_io_methods] 492 ** device that holds the file that the [sqlite3_io_methods]
452 ** refers to. 493 ** refers to.
453 ** 494 **
454 ** The SQLITE_IOCAP_ATOMIC property means that all writes of 495 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
455 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 496 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
456 ** mean that writes of blocks that are nnn bytes in size and 497 ** mean that writes of blocks that are nnn bytes in size and
457 ** are aligned to an address which is an integer multiple of 498 ** are aligned to an address which is an integer multiple of
458 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 499 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
459 ** that when data is appended to a file, the data is appended 500 ** that when data is appended to a file, the data is appended
460 ** first then the size of the file is extended, never the other 501 ** first then the size of the file is extended, never the other
461 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 502 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
462 ** information is written to disk in the same order as calls 503 ** information is written to disk in the same order as calls
463 ** to xWrite(). 504 ** to xWrite().
464 */ 505 */
465 #define SQLITE_IOCAP_ATOMIC 0x00000001 506 #define SQLITE_IOCAP_ATOMIC 0x00000001
466 #define SQLITE_IOCAP_ATOMIC512 0x00000002 507 #define SQLITE_IOCAP_ATOMIC512 0x00000002
467 #define SQLITE_IOCAP_ATOMIC1K 0x00000004 508 #define SQLITE_IOCAP_ATOMIC1K 0x00000004
468 #define SQLITE_IOCAP_ATOMIC2K 0x00000008 509 #define SQLITE_IOCAP_ATOMIC2K 0x00000008
469 #define SQLITE_IOCAP_ATOMIC4K 0x00000010 510 #define SQLITE_IOCAP_ATOMIC4K 0x00000010
470 #define SQLITE_IOCAP_ATOMIC8K 0x00000020 511 #define SQLITE_IOCAP_ATOMIC8K 0x00000020
471 #define SQLITE_IOCAP_ATOMIC16K 0x00000040 512 #define SQLITE_IOCAP_ATOMIC16K 0x00000040
472 #define SQLITE_IOCAP_ATOMIC32K 0x00000080 513 #define SQLITE_IOCAP_ATOMIC32K 0x00000080
473 #define SQLITE_IOCAP_ATOMIC64K 0x00000100 514 #define SQLITE_IOCAP_ATOMIC64K 0x00000100
474 #define SQLITE_IOCAP_SAFE_APPEND 0x00000200 515 #define SQLITE_IOCAP_SAFE_APPEND 0x00000200
475 #define SQLITE_IOCAP_SEQUENTIAL 0x00000400 516 #define SQLITE_IOCAP_SEQUENTIAL 0x00000400
517 #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
476 518
477 /* 519 /*
478 ** CAPI3REF: File Locking Levels {H10250} <H11120> <H11310> 520 ** CAPI3REF: File Locking Levels
479 ** 521 **
480 ** SQLite uses one of these integer values as the second 522 ** SQLite uses one of these integer values as the second
481 ** argument to calls it makes to the xLock() and xUnlock() methods 523 ** argument to calls it makes to the xLock() and xUnlock() methods
482 ** of an [sqlite3_io_methods] object. 524 ** of an [sqlite3_io_methods] object.
483 */ 525 */
484 #define SQLITE_LOCK_NONE 0 526 #define SQLITE_LOCK_NONE 0
485 #define SQLITE_LOCK_SHARED 1 527 #define SQLITE_LOCK_SHARED 1
486 #define SQLITE_LOCK_RESERVED 2 528 #define SQLITE_LOCK_RESERVED 2
487 #define SQLITE_LOCK_PENDING 3 529 #define SQLITE_LOCK_PENDING 3
488 #define SQLITE_LOCK_EXCLUSIVE 4 530 #define SQLITE_LOCK_EXCLUSIVE 4
489 531
490 /* 532 /*
491 ** CAPI3REF: Synchronization Type Flags {H10260} <H11120> 533 ** CAPI3REF: Synchronization Type Flags
492 ** 534 **
493 ** When SQLite invokes the xSync() method of an 535 ** When SQLite invokes the xSync() method of an
494 ** [sqlite3_io_methods] object it uses a combination of 536 ** [sqlite3_io_methods] object it uses a combination of
495 ** these integer values as the second argument. 537 ** these integer values as the second argument.
496 ** 538 **
497 ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the 539 ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
498 ** sync operation only needs to flush data to mass storage. Inode 540 ** sync operation only needs to flush data to mass storage. Inode
499 ** information need not be flushed. If the lower four bits of the flag 541 ** information need not be flushed. If the lower four bits of the flag
500 ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. 542 ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
501 ** If the lower four bits equal SQLITE_SYNC_FULL, that means 543 ** If the lower four bits equal SQLITE_SYNC_FULL, that means
502 ** to use Mac OS X style fullsync instead of fsync(). 544 ** to use Mac OS X style fullsync instead of fsync().
503 */ 545 */
504 #define SQLITE_SYNC_NORMAL 0x00002 546 #define SQLITE_SYNC_NORMAL 0x00002
505 #define SQLITE_SYNC_FULL 0x00003 547 #define SQLITE_SYNC_FULL 0x00003
506 #define SQLITE_SYNC_DATAONLY 0x00010 548 #define SQLITE_SYNC_DATAONLY 0x00010
507 549
508 /* 550 /*
509 ** CAPI3REF: OS Interface Open File Handle {H11110} <S20110> 551 ** CAPI3REF: OS Interface Open File Handle
510 ** 552 **
511 ** An [sqlite3_file] object represents an open file in the 553 ** An [sqlite3_file] object represents an open file in the
512 ** [sqlite3_vfs | OS interface layer]. Individual OS interface 554 ** [sqlite3_vfs | OS interface layer]. Individual OS interface
513 ** implementations will 555 ** implementations will
514 ** want to subclass this object by appending additional fields 556 ** want to subclass this object by appending additional fields
515 ** for their own use. The pMethods entry is a pointer to an 557 ** for their own use. The pMethods entry is a pointer to an
516 ** [sqlite3_io_methods] object that defines methods for performing 558 ** [sqlite3_io_methods] object that defines methods for performing
517 ** I/O operations on the open file. 559 ** I/O operations on the open file.
518 */ 560 */
519 typedef struct sqlite3_file sqlite3_file; 561 typedef struct sqlite3_file sqlite3_file;
520 struct sqlite3_file { 562 struct sqlite3_file {
521 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ 563 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
522 }; 564 };
523 565
524 /* 566 /*
525 ** CAPI3REF: OS Interface File Virtual Methods Object {H11120} <S20110> 567 ** CAPI3REF: OS Interface File Virtual Methods Object
526 ** 568 **
527 ** Every file opened by the [sqlite3_vfs] xOpen method populates an 569 ** Every file opened by the [sqlite3_vfs] xOpen method populates an
528 ** [sqlite3_file] object (or, more commonly, a subclass of the 570 ** [sqlite3_file] object (or, more commonly, a subclass of the
529 ** [sqlite3_file] object) with a pointer to an instance of this object. 571 ** [sqlite3_file] object) with a pointer to an instance of this object.
530 ** This object defines the methods used to perform various operations 572 ** This object defines the methods used to perform various operations
531 ** against the open file represented by the [sqlite3_file] object. 573 ** against the open file represented by the [sqlite3_file] object.
532 ** 574 **
533 ** If the xOpen method sets the sqlite3_file.pMethods element 575 ** If the xOpen method sets the sqlite3_file.pMethods element
534 ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method 576 ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
535 ** may be invoked even if the xOpen reported that it failed. The 577 ** may be invoked even if the xOpen reported that it failed. The
(...skipping 80 matching lines...) Expand 10 before | Expand all | Expand 10 after
616 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); 658 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
617 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); 659 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
618 int (*xSync)(sqlite3_file*, int flags); 660 int (*xSync)(sqlite3_file*, int flags);
619 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); 661 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
620 int (*xLock)(sqlite3_file*, int); 662 int (*xLock)(sqlite3_file*, int);
621 int (*xUnlock)(sqlite3_file*, int); 663 int (*xUnlock)(sqlite3_file*, int);
622 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); 664 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
623 int (*xFileControl)(sqlite3_file*, int op, void *pArg); 665 int (*xFileControl)(sqlite3_file*, int op, void *pArg);
624 int (*xSectorSize)(sqlite3_file*); 666 int (*xSectorSize)(sqlite3_file*);
625 int (*xDeviceCharacteristics)(sqlite3_file*); 667 int (*xDeviceCharacteristics)(sqlite3_file*);
668 /* Methods above are valid for version 1 */
669 int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
670 int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
671 void (*xShmBarrier)(sqlite3_file*);
672 int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
673 /* Methods above are valid for version 2 */
626 /* Additional methods may be added in future releases */ 674 /* Additional methods may be added in future releases */
627 }; 675 };
628 676
629 /* 677 /*
630 ** CAPI3REF: Standard File Control Opcodes {H11310} <S30800> 678 ** CAPI3REF: Standard File Control Opcodes
631 ** 679 **
632 ** These integer constants are opcodes for the xFileControl method 680 ** These integer constants are opcodes for the xFileControl method
633 ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] 681 ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
634 ** interface. 682 ** interface.
635 ** 683 **
636 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This 684 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
637 ** opcode causes the xFileControl method to write the current state of 685 ** opcode causes the xFileControl method to write the current state of
638 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], 686 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
639 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) 687 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
640 ** into an integer that the pArg argument points to. This capability 688 ** into an integer that the pArg argument points to. This capability
641 ** is used during testing and only needs to be supported when SQLITE_TEST 689 ** is used during testing and only needs to be supported when SQLITE_TEST
642 ** is defined. 690 ** is defined.
691 **
692 ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
693 ** layer a hint of how large the database file will grow to be during the
694 ** current transaction. This hint is not guaranteed to be accurate but it
695 ** is often close. The underlying VFS might choose to preallocate database
696 ** file space based on this hint in order to help writes to the database
697 ** file run faster.
698 **
699 ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
700 ** extends and truncates the database file in chunks of a size specified
701 ** by the user. The fourth argument to [sqlite3_file_control()] should
702 ** point to an integer (type int) containing the new chunk-size to use
703 ** for the nominated database. Allocating database file space in large
704 ** chunks (say 1MB at a time), may reduce file-system fragmentation and
705 ** improve performance on some systems.
643 */ 706 */
644 #define SQLITE_FCNTL_LOCKSTATE 1 707 #define SQLITE_FCNTL_LOCKSTATE 1
645 #define SQLITE_GET_LOCKPROXYFILE 2 708 #define SQLITE_GET_LOCKPROXYFILE 2
646 #define SQLITE_SET_LOCKPROXYFILE 3 709 #define SQLITE_SET_LOCKPROXYFILE 3
647 #define SQLITE_LAST_ERRNO 4 710 #define SQLITE_LAST_ERRNO 4
711 #define SQLITE_FCNTL_SIZE_HINT 5
712 #define SQLITE_FCNTL_CHUNK_SIZE 6
648 713
649 /* 714 /*
650 ** CAPI3REF: Mutex Handle {H17110} <S20130> 715 ** CAPI3REF: Mutex Handle
651 ** 716 **
652 ** The mutex module within SQLite defines [sqlite3_mutex] to be an 717 ** The mutex module within SQLite defines [sqlite3_mutex] to be an
653 ** abstract type for a mutex object. The SQLite core never looks 718 ** abstract type for a mutex object. The SQLite core never looks
654 ** at the internal representation of an [sqlite3_mutex]. It only 719 ** at the internal representation of an [sqlite3_mutex]. It only
655 ** deals with pointers to the [sqlite3_mutex] object. 720 ** deals with pointers to the [sqlite3_mutex] object.
656 ** 721 **
657 ** Mutexes are created using [sqlite3_mutex_alloc()]. 722 ** Mutexes are created using [sqlite3_mutex_alloc()].
658 */ 723 */
659 typedef struct sqlite3_mutex sqlite3_mutex; 724 typedef struct sqlite3_mutex sqlite3_mutex;
660 725
661 /* 726 /*
662 ** CAPI3REF: OS Interface Object {H11140} <S20100> 727 ** CAPI3REF: OS Interface Object
663 ** 728 **
664 ** An instance of the sqlite3_vfs object defines the interface between 729 ** An instance of the sqlite3_vfs object defines the interface between
665 ** the SQLite core and the underlying operating system. The "vfs" 730 ** the SQLite core and the underlying operating system. The "vfs"
666 ** in the name of the object stands for "virtual file system". 731 ** in the name of the object stands for "virtual file system".
667 ** 732 **
668 ** The value of the iVersion field is initially 1 but may be larger in 733 ** The value of the iVersion field is initially 1 but may be larger in
669 ** future versions of SQLite. Additional fields may be appended to this 734 ** future versions of SQLite. Additional fields may be appended to this
670 ** object when the iVersion value is increased. Note that the structure 735 ** object when the iVersion value is increased. Note that the structure
671 ** of the sqlite3_vfs object changes in the transaction between 736 ** of the sqlite3_vfs object changes in the transaction between
672 ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not 737 ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
(...skipping 12 matching lines...) Expand all
685 ** 750 **
686 ** The pNext field is the only field in the sqlite3_vfs 751 ** The pNext field is the only field in the sqlite3_vfs
687 ** structure that SQLite will ever modify. SQLite will only access 752 ** structure that SQLite will ever modify. SQLite will only access
688 ** or modify this field while holding a particular static mutex. 753 ** or modify this field while holding a particular static mutex.
689 ** The application should never modify anything within the sqlite3_vfs 754 ** The application should never modify anything within the sqlite3_vfs
690 ** object once the object has been registered. 755 ** object once the object has been registered.
691 ** 756 **
692 ** The zName field holds the name of the VFS module. The name must 757 ** The zName field holds the name of the VFS module. The name must
693 ** be unique across all VFS modules. 758 ** be unique across all VFS modules.
694 ** 759 **
695 ** SQLite will guarantee that the zFilename parameter to xOpen 760 ** ^SQLite guarantees that the zFilename parameter to xOpen
696 ** is either a NULL pointer or string obtained 761 ** is either a NULL pointer or string obtained
697 ** from xFullPathname(). SQLite further guarantees that 762 ** from xFullPathname() with an optional suffix added.
763 ** ^If a suffix is added to the zFilename parameter, it will
764 ** consist of a single "-" character followed by no more than
765 ** 10 alphanumeric and/or "-" characters.
766 ** ^SQLite further guarantees that
698 ** the string will be valid and unchanged until xClose() is 767 ** the string will be valid and unchanged until xClose() is
699 ** called. Because of the previous sentence, 768 ** called. Because of the previous sentence,
700 ** the [sqlite3_file] can safely store a pointer to the 769 ** the [sqlite3_file] can safely store a pointer to the
701 ** filename if it needs to remember the filename for some reason. 770 ** filename if it needs to remember the filename for some reason.
702 ** If the zFilename parameter is xOpen is a NULL pointer then xOpen 771 ** If the zFilename parameter to xOpen is a NULL pointer then xOpen
703 ** must invent its own temporary name for the file. Whenever the 772 ** must invent its own temporary name for the file. ^Whenever the
704 ** xFilename parameter is NULL it will also be the case that the 773 ** xFilename parameter is NULL it will also be the case that the
705 ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. 774 ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
706 ** 775 **
707 ** The flags argument to xOpen() includes all bits set in 776 ** The flags argument to xOpen() includes all bits set in
708 ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] 777 ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
709 ** or [sqlite3_open16()] is used, then flags includes at least 778 ** or [sqlite3_open16()] is used, then flags includes at least
710 ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 779 ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
711 ** If xOpen() opens a file read-only then it sets *pOutFlags to 780 ** If xOpen() opens a file read-only then it sets *pOutFlags to
712 ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. 781 ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
713 ** 782 **
714 ** SQLite will also add one of the following flags to the xOpen() 783 ** ^(SQLite will also add one of the following flags to the xOpen()
715 ** call, depending on the object being opened: 784 ** call, depending on the object being opened:
716 ** 785 **
717 ** <ul> 786 ** <ul>
718 ** <li> [SQLITE_OPEN_MAIN_DB] 787 ** <li> [SQLITE_OPEN_MAIN_DB]
719 ** <li> [SQLITE_OPEN_MAIN_JOURNAL] 788 ** <li> [SQLITE_OPEN_MAIN_JOURNAL]
720 ** <li> [SQLITE_OPEN_TEMP_DB] 789 ** <li> [SQLITE_OPEN_TEMP_DB]
721 ** <li> [SQLITE_OPEN_TEMP_JOURNAL] 790 ** <li> [SQLITE_OPEN_TEMP_JOURNAL]
722 ** <li> [SQLITE_OPEN_TRANSIENT_DB] 791 ** <li> [SQLITE_OPEN_TRANSIENT_DB]
723 ** <li> [SQLITE_OPEN_SUBJOURNAL] 792 ** <li> [SQLITE_OPEN_SUBJOURNAL]
724 ** <li> [SQLITE_OPEN_MASTER_JOURNAL] 793 ** <li> [SQLITE_OPEN_MASTER_JOURNAL]
725 ** </ul> 794 ** <li> [SQLITE_OPEN_WAL]
795 ** </ul>)^
726 ** 796 **
727 ** The file I/O implementation can use the object type flags to 797 ** The file I/O implementation can use the object type flags to
728 ** change the way it deals with files. For example, an application 798 ** change the way it deals with files. For example, an application
729 ** that does not care about crash recovery or rollback might make 799 ** that does not care about crash recovery or rollback might make
730 ** the open of a journal file a no-op. Writes to this journal would 800 ** the open of a journal file a no-op. Writes to this journal would
731 ** also be no-ops, and any attempt to read the journal would return 801 ** also be no-ops, and any attempt to read the journal would return
732 ** SQLITE_IOERR. Or the implementation might recognize that a database 802 ** SQLITE_IOERR. Or the implementation might recognize that a database
733 ** file will be doing page-aligned sector reads and writes in a random 803 ** file will be doing page-aligned sector reads and writes in a random
734 ** order and set up its I/O subsystem accordingly. 804 ** order and set up its I/O subsystem accordingly.
735 ** 805 **
736 ** SQLite might also add one of the following flags to the xOpen method: 806 ** SQLite might also add one of the following flags to the xOpen method:
737 ** 807 **
738 ** <ul> 808 ** <ul>
739 ** <li> [SQLITE_OPEN_DELETEONCLOSE] 809 ** <li> [SQLITE_OPEN_DELETEONCLOSE]
740 ** <li> [SQLITE_OPEN_EXCLUSIVE] 810 ** <li> [SQLITE_OPEN_EXCLUSIVE]
741 ** </ul> 811 ** </ul>
742 ** 812 **
743 ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be 813 ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
744 ** deleted when it is closed. The [SQLITE_OPEN_DELETEONCLOSE] 814 ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
745 ** will be set for TEMP databases, journals and for subjournals. 815 ** will be set for TEMP databases and their journals, transient
816 ** databases, and subjournals.
746 ** 817 **
747 ** The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction 818 ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
748 ** with the [SQLITE_OPEN_CREATE] flag, which are both directly 819 ** with the [SQLITE_OPEN_CREATE] flag, which are both directly
749 ** analogous to the O_EXCL and O_CREAT flags of the POSIX open() 820 ** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
750 ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the 821 ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
751 ** SQLITE_OPEN_CREATE, is used to indicate that file should always 822 ** SQLITE_OPEN_CREATE, is used to indicate that file should always
752 ** be created, and that it is an error if it already exists. 823 ** be created, and that it is an error if it already exists.
753 ** It is <i>not</i> used to indicate the file should be opened 824 ** It is <i>not</i> used to indicate the file should be opened
754 ** for exclusive access. 825 ** for exclusive access.
755 ** 826 **
756 ** At least szOsFile bytes of memory are allocated by SQLite 827 ** ^At least szOsFile bytes of memory are allocated by SQLite
757 ** to hold the [sqlite3_file] structure passed as the third 828 ** to hold the [sqlite3_file] structure passed as the third
758 ** argument to xOpen. The xOpen method does not have to 829 ** argument to xOpen. The xOpen method does not have to
759 ** allocate the structure; it should just fill it in. Note that 830 ** allocate the structure; it should just fill it in. Note that
760 ** the xOpen method must set the sqlite3_file.pMethods to either 831 ** the xOpen method must set the sqlite3_file.pMethods to either
761 ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do 832 ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
762 ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods 833 ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
763 ** element will be valid after xOpen returns regardless of the success 834 ** element will be valid after xOpen returns regardless of the success
764 ** or failure of the xOpen call. 835 ** or failure of the xOpen call.
765 ** 836 **
766 ** The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 837 ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
767 ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to 838 ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
768 ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] 839 ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
769 ** to test whether a file is at least readable. The file can be a 840 ** to test whether a file is at least readable. The file can be a
770 ** directory. 841 ** directory.
771 ** 842 **
772 ** SQLite will always allocate at least mxPathname+1 bytes for the 843 ** ^SQLite will always allocate at least mxPathname+1 bytes for the
773 ** output buffer xFullPathname. The exact size of the output buffer 844 ** output buffer xFullPathname. The exact size of the output buffer
774 ** is also passed as a parameter to both methods. If the output buffer 845 ** is also passed as a parameter to both methods. If the output buffer
775 ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is 846 ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
776 ** handled as a fatal error by SQLite, vfs implementations should endeavor 847 ** handled as a fatal error by SQLite, vfs implementations should endeavor
777 ** to prevent this by setting mxPathname to a sufficiently large value. 848 ** to prevent this by setting mxPathname to a sufficiently large value.
778 ** 849 **
779 ** The xRandomness(), xSleep(), and xCurrentTime() interfaces 850 ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
780 ** are not strictly a part of the filesystem, but they are 851 ** interfaces are not strictly a part of the filesystem, but they are
781 ** included in the VFS structure for completeness. 852 ** included in the VFS structure for completeness.
782 ** The xRandomness() function attempts to return nBytes bytes 853 ** The xRandomness() function attempts to return nBytes bytes
783 ** of good-quality randomness into zOut. The return value is 854 ** of good-quality randomness into zOut. The return value is
784 ** the actual number of bytes of randomness obtained. 855 ** the actual number of bytes of randomness obtained.
785 ** The xSleep() method causes the calling thread to sleep for at 856 ** The xSleep() method causes the calling thread to sleep for at
786 ** least the number of microseconds given. The xCurrentTime() 857 ** least the number of microseconds given. ^The xCurrentTime()
787 ** method returns a Julian Day Number for the current date and time. 858 ** method returns a Julian Day Number for the current date and time as
788 ** 859 ** a floating point value.
860 ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
861 ** Day Number multipled by 86400000 (the number of milliseconds in
862 ** a 24-hour day).
863 ** ^SQLite will use the xCurrentTimeInt64() method to get the current
864 ** date and time if that method is available (if iVersion is 2 or
865 ** greater and the function pointer is not NULL) and will fall back
866 ** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
789 */ 867 */
790 typedef struct sqlite3_vfs sqlite3_vfs; 868 typedef struct sqlite3_vfs sqlite3_vfs;
791 struct sqlite3_vfs { 869 struct sqlite3_vfs {
792 int iVersion; /* Structure version number */ 870 int iVersion; /* Structure version number (currently 2) */
793 int szOsFile; /* Size of subclassed sqlite3_file */ 871 int szOsFile; /* Size of subclassed sqlite3_file */
794 int mxPathname; /* Maximum file pathname length */ 872 int mxPathname; /* Maximum file pathname length */
795 sqlite3_vfs *pNext; /* Next registered VFS */ 873 sqlite3_vfs *pNext; /* Next registered VFS */
796 const char *zName; /* Name of this virtual file system */ 874 const char *zName; /* Name of this virtual file system */
797 void *pAppData; /* Pointer to application-specific data */ 875 void *pAppData; /* Pointer to application-specific data */
798 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, 876 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
799 int flags, int *pOutFlags); 877 int flags, int *pOutFlags);
800 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); 878 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
801 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); 879 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
802 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); 880 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
803 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); 881 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
804 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); 882 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
805 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); 883 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
806 void (*xDlClose)(sqlite3_vfs*, void*); 884 void (*xDlClose)(sqlite3_vfs*, void*);
807 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); 885 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
808 int (*xSleep)(sqlite3_vfs*, int microseconds); 886 int (*xSleep)(sqlite3_vfs*, int microseconds);
809 int (*xCurrentTime)(sqlite3_vfs*, double*); 887 int (*xCurrentTime)(sqlite3_vfs*, double*);
810 int (*xGetLastError)(sqlite3_vfs*, int, char *); 888 int (*xGetLastError)(sqlite3_vfs*, int, char *);
811 /* New fields may be appended in figure versions. The iVersion 889 /*
812 ** value will increment whenever this happens. */ 890 ** The methods above are in version 1 of the sqlite_vfs object
891 ** definition. Those that follow are added in version 2 or later
892 */
893 int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
894 /*
895 ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
896 ** New fields may be appended in figure versions. The iVersion
897 ** value will increment whenever this happens.
898 */
813 }; 899 };
814 900
815 /* 901 /*
816 ** CAPI3REF: Flags for the xAccess VFS method {H11190} <H11140> 902 ** CAPI3REF: Flags for the xAccess VFS method
817 ** 903 **
818 ** These integer constants can be used as the third parameter to 904 ** These integer constants can be used as the third parameter to
819 ** the xAccess method of an [sqlite3_vfs] object. {END} They determine 905 ** the xAccess method of an [sqlite3_vfs] object. They determine
820 ** what kind of permissions the xAccess method is looking for. 906 ** what kind of permissions the xAccess method is looking for.
821 ** With SQLITE_ACCESS_EXISTS, the xAccess method 907 ** With SQLITE_ACCESS_EXISTS, the xAccess method
822 ** simply checks whether the file exists. 908 ** simply checks whether the file exists.
823 ** With SQLITE_ACCESS_READWRITE, the xAccess method 909 ** With SQLITE_ACCESS_READWRITE, the xAccess method
824 ** checks whether the file is both readable and writable. 910 ** checks whether the named directory is both readable and writable
911 ** (in other words, if files can be added, removed, and renamed within
912 ** the directory).
913 ** The SQLITE_ACCESS_READWRITE constant is currently used only by the
914 ** [temp_store_directory pragma], though this could change in a future
915 ** release of SQLite.
825 ** With SQLITE_ACCESS_READ, the xAccess method 916 ** With SQLITE_ACCESS_READ, the xAccess method
826 ** checks whether the file is readable. 917 ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
918 ** currently unused, though it might be used in a future release of
919 ** SQLite.
827 */ 920 */
828 #define SQLITE_ACCESS_EXISTS 0 921 #define SQLITE_ACCESS_EXISTS 0
829 #define SQLITE_ACCESS_READWRITE 1 922 #define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
830 #define SQLITE_ACCESS_READ 2 923 #define SQLITE_ACCESS_READ 2 /* Unused */
831 924
832 /* 925 /*
833 ** CAPI3REF: Initialize The SQLite Library {H10130} <S20000><S30100> 926 ** CAPI3REF: Flags for the xShmLock VFS method
834 ** 927 **
835 ** The sqlite3_initialize() routine initializes the 928 ** These integer constants define the various locking operations
836 ** SQLite library. The sqlite3_shutdown() routine 929 ** allowed by the xShmLock method of [sqlite3_io_methods]. The
930 ** following are the only legal combinations of flags to the
931 ** xShmLock method:
932 **
933 ** <ul>
934 ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
935 ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
936 ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
937 ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
938 ** </ul>
939 **
940 ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
941 ** was given no the corresponding lock.
942 **
943 ** The xShmLock method can transition between unlocked and SHARED or
944 ** between unlocked and EXCLUSIVE. It cannot transition between SHARED
945 ** and EXCLUSIVE.
946 */
947 #define SQLITE_SHM_UNLOCK 1
948 #define SQLITE_SHM_LOCK 2
949 #define SQLITE_SHM_SHARED 4
950 #define SQLITE_SHM_EXCLUSIVE 8
951
952 /*
953 ** CAPI3REF: Maximum xShmLock index
954 **
955 ** The xShmLock method on [sqlite3_io_methods] may use values
956 ** between 0 and this upper bound as its "offset" argument.
957 ** The SQLite core will never attempt to acquire or release a
958 ** lock outside of this range
959 */
960 #define SQLITE_SHM_NLOCK 8
961
962
963 /*
964 ** CAPI3REF: Initialize The SQLite Library
965 **
966 ** ^The sqlite3_initialize() routine initializes the
967 ** SQLite library. ^The sqlite3_shutdown() routine
837 ** deallocates any resources that were allocated by sqlite3_initialize(). 968 ** deallocates any resources that were allocated by sqlite3_initialize().
969 ** These routines are designed to aid in process initialization and
970 ** shutdown on embedded systems. Workstation applications using
971 ** SQLite normally do not need to invoke either of these routines.
838 ** 972 **
839 ** A call to sqlite3_initialize() is an "effective" call if it is 973 ** A call to sqlite3_initialize() is an "effective" call if it is
840 ** the first time sqlite3_initialize() is invoked during the lifetime of 974 ** the first time sqlite3_initialize() is invoked during the lifetime of
841 ** the process, or if it is the first time sqlite3_initialize() is invoked 975 ** the process, or if it is the first time sqlite3_initialize() is invoked
842 ** following a call to sqlite3_shutdown(). Only an effective call 976 ** following a call to sqlite3_shutdown(). ^(Only an effective call
843 ** of sqlite3_initialize() does any initialization. All other calls 977 ** of sqlite3_initialize() does any initialization. All other calls
844 ** are harmless no-ops. 978 ** are harmless no-ops.)^
845 ** 979 **
846 ** A call to sqlite3_shutdown() is an "effective" call if it is the first 980 ** A call to sqlite3_shutdown() is an "effective" call if it is the first
847 ** call to sqlite3_shutdown() since the last sqlite3_initialize(). Only 981 ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
848 ** an effective call to sqlite3_shutdown() does any deinitialization. 982 ** an effective call to sqlite3_shutdown() does any deinitialization.
849 ** All other calls to sqlite3_shutdown() are harmless no-ops. 983 ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
850 ** 984 **
851 ** Among other things, sqlite3_initialize() shall invoke 985 ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
852 ** sqlite3_os_init(). Similarly, sqlite3_shutdown() 986 ** is not. The sqlite3_shutdown() interface must only be called from a
853 ** shall invoke sqlite3_os_end(). 987 ** single thread. All open [database connections] must be closed and all
988 ** other SQLite resources must be deallocated prior to invoking
989 ** sqlite3_shutdown().
854 ** 990 **
855 ** The sqlite3_initialize() routine returns [SQLITE_OK] on success. 991 ** Among other things, ^sqlite3_initialize() will invoke
856 ** If for some reason, sqlite3_initialize() is unable to initialize 992 ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
993 ** will invoke sqlite3_os_end().
994 **
995 ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
996 ** ^If for some reason, sqlite3_initialize() is unable to initialize
857 ** the library (perhaps it is unable to allocate a needed resource such 997 ** the library (perhaps it is unable to allocate a needed resource such
858 ** as a mutex) it returns an [error code] other than [SQLITE_OK]. 998 ** as a mutex) it returns an [error code] other than [SQLITE_OK].
859 ** 999 **
860 ** The sqlite3_initialize() routine is called internally by many other 1000 ** ^The sqlite3_initialize() routine is called internally by many other
861 ** SQLite interfaces so that an application usually does not need to 1001 ** SQLite interfaces so that an application usually does not need to
862 ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] 1002 ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
863 ** calls sqlite3_initialize() so the SQLite library will be automatically 1003 ** calls sqlite3_initialize() so the SQLite library will be automatically
864 ** initialized when [sqlite3_open()] is called if it has not be initialized 1004 ** initialized when [sqlite3_open()] is called if it has not be initialized
865 ** already. However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] 1005 ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
866 ** compile-time option, then the automatic calls to sqlite3_initialize() 1006 ** compile-time option, then the automatic calls to sqlite3_initialize()
867 ** are omitted and the application must call sqlite3_initialize() directly 1007 ** are omitted and the application must call sqlite3_initialize() directly
868 ** prior to using any other SQLite interface. For maximum portability, 1008 ** prior to using any other SQLite interface. For maximum portability,
869 ** it is recommended that applications always invoke sqlite3_initialize() 1009 ** it is recommended that applications always invoke sqlite3_initialize()
870 ** directly prior to using any other SQLite interface. Future releases 1010 ** directly prior to using any other SQLite interface. Future releases
871 ** of SQLite may require this. In other words, the behavior exhibited 1011 ** of SQLite may require this. In other words, the behavior exhibited
872 ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the 1012 ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
873 ** default behavior in some future release of SQLite. 1013 ** default behavior in some future release of SQLite.
874 ** 1014 **
875 ** The sqlite3_os_init() routine does operating-system specific 1015 ** The sqlite3_os_init() routine does operating-system specific
(...skipping 18 matching lines...) Expand all
894 ** implementation of sqlite3_os_init() or sqlite3_os_end() 1034 ** implementation of sqlite3_os_init() or sqlite3_os_end()
895 ** must return [SQLITE_OK] on success and some other [error code] upon 1035 ** must return [SQLITE_OK] on success and some other [error code] upon
896 ** failure. 1036 ** failure.
897 */ 1037 */
898 SQLITE_API int sqlite3_initialize(void); 1038 SQLITE_API int sqlite3_initialize(void);
899 SQLITE_API int sqlite3_shutdown(void); 1039 SQLITE_API int sqlite3_shutdown(void);
900 SQLITE_API int sqlite3_os_init(void); 1040 SQLITE_API int sqlite3_os_init(void);
901 SQLITE_API int sqlite3_os_end(void); 1041 SQLITE_API int sqlite3_os_end(void);
902 1042
903 /* 1043 /*
904 ** CAPI3REF: Configuring The SQLite Library {H14100} <S20000><S30200> 1044 ** CAPI3REF: Configuring The SQLite Library
905 ** EXPERIMENTAL
906 ** 1045 **
907 ** The sqlite3_config() interface is used to make global configuration 1046 ** The sqlite3_config() interface is used to make global configuration
908 ** changes to SQLite in order to tune SQLite to the specific needs of 1047 ** changes to SQLite in order to tune SQLite to the specific needs of
909 ** the application. The default configuration is recommended for most 1048 ** the application. The default configuration is recommended for most
910 ** applications and so this routine is usually not necessary. It is 1049 ** applications and so this routine is usually not necessary. It is
911 ** provided to support rare applications with unusual needs. 1050 ** provided to support rare applications with unusual needs.
912 ** 1051 **
913 ** The sqlite3_config() interface is not threadsafe. The application 1052 ** The sqlite3_config() interface is not threadsafe. The application
914 ** must insure that no other SQLite interfaces are invoked by other 1053 ** must insure that no other SQLite interfaces are invoked by other
915 ** threads while sqlite3_config() is running. Furthermore, sqlite3_config() 1054 ** threads while sqlite3_config() is running. Furthermore, sqlite3_config()
916 ** may only be invoked prior to library initialization using 1055 ** may only be invoked prior to library initialization using
917 ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. 1056 ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
918 ** Note, however, that sqlite3_config() can be called as part of the 1057 ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
1058 ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
1059 ** Note, however, that ^sqlite3_config() can be called as part of the
919 ** implementation of an application-defined [sqlite3_os_init()]. 1060 ** implementation of an application-defined [sqlite3_os_init()].
920 ** 1061 **
921 ** The first argument to sqlite3_config() is an integer 1062 ** The first argument to sqlite3_config() is an integer
922 ** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines 1063 ** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines
923 ** what property of SQLite is to be configured. Subsequent arguments 1064 ** what property of SQLite is to be configured. Subsequent arguments
924 ** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option] 1065 ** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option]
925 ** in the first argument. 1066 ** in the first argument.
926 ** 1067 **
927 ** When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. 1068 ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
928 ** If the option is unknown or SQLite is unable to set the option 1069 ** ^If the option is unknown or SQLite is unable to set the option
929 ** then this routine returns a non-zero [error code]. 1070 ** then this routine returns a non-zero [error code].
930 **
931 ** Requirements:
932 ** [H14103] [H14106] [H14120] [H14123] [H14126] [H14129] [H14132] [H14135]
933 ** [H14138] [H14141] [H14144] [H14147] [H14150] [H14153] [H14156] [H14159]
934 ** [H14162] [H14165] [H14168]
935 */ 1071 */
936 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_config(int, ...); 1072 SQLITE_API int sqlite3_config(int, ...);
937 1073
938 /* 1074 /*
939 ** CAPI3REF: Configure database connections {H14200} <S20000> 1075 ** CAPI3REF: Configure database connections
940 ** EXPERIMENTAL
941 ** 1076 **
942 ** The sqlite3_db_config() interface is used to make configuration 1077 ** The sqlite3_db_config() interface is used to make configuration
943 ** changes to a [database connection]. The interface is similar to 1078 ** changes to a [database connection]. The interface is similar to
944 ** [sqlite3_config()] except that the changes apply to a single 1079 ** [sqlite3_config()] except that the changes apply to a single
945 ** [database connection] (specified in the first argument). The 1080 ** [database connection] (specified in the first argument). The
946 ** sqlite3_db_config() interface can only be used immediately after 1081 ** sqlite3_db_config() interface should only be used immediately after
947 ** the database connection is created using [sqlite3_open()], 1082 ** the database connection is created using [sqlite3_open()],
948 ** [sqlite3_open16()], or [sqlite3_open_v2()]. 1083 ** [sqlite3_open16()], or [sqlite3_open_v2()].
949 ** 1084 **
950 ** The second argument to sqlite3_db_config(D,V,...) is the 1085 ** The second argument to sqlite3_db_config(D,V,...) is the
951 ** configuration verb - an integer code that indicates what 1086 ** configuration verb - an integer code that indicates what
952 ** aspect of the [database connection] is being configured. 1087 ** aspect of the [database connection] is being configured.
953 ** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE]. 1088 ** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE].
954 ** New verbs are likely to be added in future releases of SQLite. 1089 ** New verbs are likely to be added in future releases of SQLite.
955 ** Additional arguments depend on the verb. 1090 ** Additional arguments depend on the verb.
956 ** 1091 **
957 ** Requirements: 1092 ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
958 ** [H14203] [H14206] [H14209] [H14212] [H14215] 1093 ** the call is considered successful.
959 */ 1094 */
960 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_db_config(sqlite3*, int op, ...); 1095 SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
961 1096
962 /* 1097 /*
963 ** CAPI3REF: Memory Allocation Routines {H10155} <S20120> 1098 ** CAPI3REF: Memory Allocation Routines
964 ** EXPERIMENTAL
965 ** 1099 **
966 ** An instance of this object defines the interface between SQLite 1100 ** An instance of this object defines the interface between SQLite
967 ** and low-level memory allocation routines. 1101 ** and low-level memory allocation routines.
968 ** 1102 **
969 ** This object is used in only one place in the SQLite interface. 1103 ** This object is used in only one place in the SQLite interface.
970 ** A pointer to an instance of this object is the argument to 1104 ** A pointer to an instance of this object is the argument to
971 ** [sqlite3_config()] when the configuration option is 1105 ** [sqlite3_config()] when the configuration option is
972 ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. 1106 ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
973 ** By creating an instance of this object 1107 ** By creating an instance of this object
974 ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) 1108 ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
975 ** during configuration, an application can specify an alternative 1109 ** during configuration, an application can specify an alternative
976 ** memory allocation subsystem for SQLite to use for all of its 1110 ** memory allocation subsystem for SQLite to use for all of its
977 ** dynamic memory needs. 1111 ** dynamic memory needs.
978 ** 1112 **
979 ** Note that SQLite comes with several [built-in memory allocators] 1113 ** Note that SQLite comes with several [built-in memory allocators]
980 ** that are perfectly adequate for the overwhelming majority of applications 1114 ** that are perfectly adequate for the overwhelming majority of applications
981 ** and that this object is only useful to a tiny minority of applications 1115 ** and that this object is only useful to a tiny minority of applications
982 ** with specialized memory allocation requirements. This object is 1116 ** with specialized memory allocation requirements. This object is
983 ** also used during testing of SQLite in order to specify an alternative 1117 ** also used during testing of SQLite in order to specify an alternative
984 ** memory allocator that simulates memory out-of-memory conditions in 1118 ** memory allocator that simulates memory out-of-memory conditions in
985 ** order to verify that SQLite recovers gracefully from such 1119 ** order to verify that SQLite recovers gracefully from such
986 ** conditions. 1120 ** conditions.
987 ** 1121 **
988 ** The xMalloc and xFree methods must work like the 1122 ** The xMalloc and xFree methods must work like the
989 ** malloc() and free() functions from the standard C library. 1123 ** malloc() and free() functions from the standard C library.
990 ** The xRealloc method must work like realloc() from the standard C library 1124 ** The xRealloc method must work like realloc() from the standard C library
991 ** with the exception that if the second argument to xRealloc is zero, 1125 ** with the exception that if the second argument to xRealloc is zero,
992 ** xRealloc must be a no-op - it must not perform any allocation or 1126 ** xRealloc must be a no-op - it must not perform any allocation or
993 ** deallocation. SQLite guaranteeds that the second argument to 1127 ** deallocation. ^SQLite guarantees that the second argument to
994 ** xRealloc is always a value returned by a prior call to xRoundup. 1128 ** xRealloc is always a value returned by a prior call to xRoundup.
995 ** And so in cases where xRoundup always returns a positive number, 1129 ** And so in cases where xRoundup always returns a positive number,
996 ** xRealloc can perform exactly as the standard library realloc() and 1130 ** xRealloc can perform exactly as the standard library realloc() and
997 ** still be in compliance with this specification. 1131 ** still be in compliance with this specification.
998 ** 1132 **
999 ** xSize should return the allocated size of a memory allocation 1133 ** xSize should return the allocated size of a memory allocation
1000 ** previously obtained from xMalloc or xRealloc. The allocated size 1134 ** previously obtained from xMalloc or xRealloc. The allocated size
1001 ** is always at least as big as the requested size but may be larger. 1135 ** is always at least as big as the requested size but may be larger.
1002 ** 1136 **
1003 ** The xRoundup method returns what would be the allocated size of 1137 ** The xRoundup method returns what would be the allocated size of
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
1035 void (*xFree)(void*); /* Free a prior allocation */ 1169 void (*xFree)(void*); /* Free a prior allocation */
1036 void *(*xRealloc)(void*,int); /* Resize an allocation */ 1170 void *(*xRealloc)(void*,int); /* Resize an allocation */
1037 int (*xSize)(void*); /* Return the size of an allocation */ 1171 int (*xSize)(void*); /* Return the size of an allocation */
1038 int (*xRoundup)(int); /* Round up request size to allocation size */ 1172 int (*xRoundup)(int); /* Round up request size to allocation size */
1039 int (*xInit)(void*); /* Initialize the memory allocator */ 1173 int (*xInit)(void*); /* Initialize the memory allocator */
1040 void (*xShutdown)(void*); /* Deinitialize the memory allocator */ 1174 void (*xShutdown)(void*); /* Deinitialize the memory allocator */
1041 void *pAppData; /* Argument to xInit() and xShutdown() */ 1175 void *pAppData; /* Argument to xInit() and xShutdown() */
1042 }; 1176 };
1043 1177
1044 /* 1178 /*
1045 ** CAPI3REF: Configuration Options {H10160} <S20000> 1179 ** CAPI3REF: Configuration Options
1046 ** EXPERIMENTAL
1047 ** 1180 **
1048 ** These constants are the available integer configuration options that 1181 ** These constants are the available integer configuration options that
1049 ** can be passed as the first argument to the [sqlite3_config()] interface. 1182 ** can be passed as the first argument to the [sqlite3_config()] interface.
1050 ** 1183 **
1051 ** New configuration options may be added in future releases of SQLite. 1184 ** New configuration options may be added in future releases of SQLite.
1052 ** Existing configuration options might be discontinued. Applications 1185 ** Existing configuration options might be discontinued. Applications
1053 ** should check the return code from [sqlite3_config()] to make sure that 1186 ** should check the return code from [sqlite3_config()] to make sure that
1054 ** the call worked. The [sqlite3_config()] interface will return a 1187 ** the call worked. The [sqlite3_config()] interface will return a
1055 ** non-zero [error code] if a discontinued or unsupported configuration option 1188 ** non-zero [error code] if a discontinued or unsupported configuration option
1056 ** is invoked. 1189 ** is invoked.
1057 ** 1190 **
1058 ** <dl> 1191 ** <dl>
1059 ** <dt>SQLITE_CONFIG_SINGLETHREAD</dt> 1192 ** <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
1060 ** <dd>There are no arguments to this option. This option disables 1193 ** <dd>There are no arguments to this option. ^This option sets the
1194 ** [threading mode] to Single-thread. In other words, it disables
1061 ** all mutexing and puts SQLite into a mode where it can only be used 1195 ** all mutexing and puts SQLite into a mode where it can only be used
1062 ** by a single thread.</dd> 1196 ** by a single thread. ^If SQLite is compiled with
1197 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1198 ** it is not possible to change the [threading mode] from its default
1199 ** value of Single-thread and so [sqlite3_config()] will return
1200 ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
1201 ** configuration option.</dd>
1063 ** 1202 **
1064 ** <dt>SQLITE_CONFIG_MULTITHREAD</dt> 1203 ** <dt>SQLITE_CONFIG_MULTITHREAD</dt>
1065 ** <dd>There are no arguments to this option. This option disables 1204 ** <dd>There are no arguments to this option. ^This option sets the
1205 ** [threading mode] to Multi-thread. In other words, it disables
1066 ** mutexing on [database connection] and [prepared statement] objects. 1206 ** mutexing on [database connection] and [prepared statement] objects.
1067 ** The application is responsible for serializing access to 1207 ** The application is responsible for serializing access to
1068 ** [database connections] and [prepared statements]. But other mutexes 1208 ** [database connections] and [prepared statements]. But other mutexes
1069 ** are enabled so that SQLite will be safe to use in a multi-threaded 1209 ** are enabled so that SQLite will be safe to use in a multi-threaded
1070 ** environment as long as no two threads attempt to use the same 1210 ** environment as long as no two threads attempt to use the same
1071 ** [database connection] at the same time. See the [threading mode] 1211 ** [database connection] at the same time. ^If SQLite is compiled with
1072 ** documentation for additional information.</dd> 1212 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1213 ** it is not possible to set the Multi-thread [threading mode] and
1214 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1215 ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
1073 ** 1216 **
1074 ** <dt>SQLITE_CONFIG_SERIALIZED</dt> 1217 ** <dt>SQLITE_CONFIG_SERIALIZED</dt>
1075 ** <dd>There are no arguments to this option. This option enables 1218 ** <dd>There are no arguments to this option. ^This option sets the
1219 ** [threading mode] to Serialized. In other words, this option enables
1076 ** all mutexes including the recursive 1220 ** all mutexes including the recursive
1077 ** mutexes on [database connection] and [prepared statement] objects. 1221 ** mutexes on [database connection] and [prepared statement] objects.
1078 ** In this mode (which is the default when SQLite is compiled with 1222 ** In this mode (which is the default when SQLite is compiled with
1079 ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access 1223 ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
1080 ** to [database connections] and [prepared statements] so that the 1224 ** to [database connections] and [prepared statements] so that the
1081 ** application is free to use the same [database connection] or the 1225 ** application is free to use the same [database connection] or the
1082 ** same [prepared statement] in different threads at the same time. 1226 ** same [prepared statement] in different threads at the same time.
1083 ** See the [threading mode] documentation for additional information.</dd> 1227 ** ^If SQLite is compiled with
1228 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1229 ** it is not possible to set the Serialized [threading mode] and
1230 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1231 ** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
1084 ** 1232 **
1085 ** <dt>SQLITE_CONFIG_MALLOC</dt> 1233 ** <dt>SQLITE_CONFIG_MALLOC</dt>
1086 ** <dd>This option takes a single argument which is a pointer to an 1234 ** <dd> ^(This option takes a single argument which is a pointer to an
1087 ** instance of the [sqlite3_mem_methods] structure. The argument specifies 1235 ** instance of the [sqlite3_mem_methods] structure. The argument specifies
1088 ** alternative low-level memory allocation routines to be used in place of 1236 ** alternative low-level memory allocation routines to be used in place of
1089 ** the memory allocation routines built into SQLite.</dd> 1237 ** the memory allocation routines built into SQLite.)^ ^SQLite makes
1238 ** its own private copy of the content of the [sqlite3_mem_methods] structure
1239 ** before the [sqlite3_config()] call returns.</dd>
1090 ** 1240 **
1091 ** <dt>SQLITE_CONFIG_GETMALLOC</dt> 1241 ** <dt>SQLITE_CONFIG_GETMALLOC</dt>
1092 ** <dd>This option takes a single argument which is a pointer to an 1242 ** <dd> ^(This option takes a single argument which is a pointer to an
1093 ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] 1243 ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods]
1094 ** structure is filled with the currently defined memory allocation routines. 1244 ** structure is filled with the currently defined memory allocation routines.)^
1095 ** This option can be used to overload the default memory allocation 1245 ** This option can be used to overload the default memory allocation
1096 ** routines with a wrapper that simulations memory allocation failure or 1246 ** routines with a wrapper that simulations memory allocation failure or
1097 ** tracks memory usage, for example.</dd> 1247 ** tracks memory usage, for example. </dd>
1098 ** 1248 **
1099 ** <dt>SQLITE_CONFIG_MEMSTATUS</dt> 1249 ** <dt>SQLITE_CONFIG_MEMSTATUS</dt>
1100 ** <dd>This option takes single argument of type int, interpreted as a 1250 ** <dd> ^This option takes single argument of type int, interpreted as a
1101 ** boolean, which enables or disables the collection of memory allocation 1251 ** boolean, which enables or disables the collection of memory allocation
1102 ** statistics. When disabled, the following SQLite interfaces become 1252 ** statistics. ^(When memory allocation statistics are disabled, the
1103 ** non-operational: 1253 ** following SQLite interfaces become non-operational:
1104 ** <ul> 1254 ** <ul>
1105 ** <li> [sqlite3_memory_used()] 1255 ** <li> [sqlite3_memory_used()]
1106 ** <li> [sqlite3_memory_highwater()] 1256 ** <li> [sqlite3_memory_highwater()]
1107 ** <li> [sqlite3_soft_heap_limit()] 1257 ** <li> [sqlite3_soft_heap_limit64()]
1108 ** <li> [sqlite3_status()] 1258 ** <li> [sqlite3_status()]
1109 ** </ul> 1259 ** </ul>)^
1260 ** ^Memory allocation statistics are enabled by default unless SQLite is
1261 ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
1262 ** allocation statistics are disabled by default.
1110 ** </dd> 1263 ** </dd>
1111 ** 1264 **
1112 ** <dt>SQLITE_CONFIG_SCRATCH</dt> 1265 ** <dt>SQLITE_CONFIG_SCRATCH</dt>
1113 ** <dd>This option specifies a static memory buffer that SQLite can use for 1266 ** <dd> ^This option specifies a static memory buffer that SQLite can use for
1114 ** scratch memory. There are three arguments: A pointer an 8-byte 1267 ** scratch memory. There are three arguments: A pointer an 8-byte
1115 ** aligned memory buffer from which the scrach allocations will be 1268 ** aligned memory buffer from which the scrach allocations will be
1116 ** drawn, the size of each scratch allocation (sz), 1269 ** drawn, the size of each scratch allocation (sz),
1117 ** and the maximum number of scratch allocations (N). The sz 1270 ** and the maximum number of scratch allocations (N). The sz
1118 ** argument must be a multiple of 16. The sz parameter should be a few bytes 1271 ** argument must be a multiple of 16.
1119 ** larger than the actual scratch space required due to internal overhead. 1272 ** The first argument must be a pointer to an 8-byte aligned buffer
1120 ** The first argument should pointer to an 8-byte aligned buffer
1121 ** of at least sz*N bytes of memory. 1273 ** of at least sz*N bytes of memory.
1122 ** SQLite will use no more than one scratch buffer at once per thread, so 1274 ** ^SQLite will use no more than two scratch buffers per thread. So
1123 ** N should be set to the expected maximum number of threads. The sz 1275 ** N should be set to twice the expected maximum number of threads.
1124 ** parameter should be 6 times the size of the largest database page size. 1276 ** ^SQLite will never require a scratch buffer that is more than 6
1125 ** Scratch buffers are used as part of the btree balance operation. If 1277 ** times the database page size. ^If SQLite needs needs additional
1126 ** The btree balancer needs additional memory beyond what is provided by 1278 ** scratch memory beyond what is provided by this configuration option, then
1127 ** scratch buffers or if no scratch buffer space is specified, then SQLite 1279 ** [sqlite3_malloc()] will be used to obtain the memory needed.</dd>
1128 ** goes to [sqlite3_malloc()] to obtain the memory it needs.</dd>
1129 ** 1280 **
1130 ** <dt>SQLITE_CONFIG_PAGECACHE</dt> 1281 ** <dt>SQLITE_CONFIG_PAGECACHE</dt>
1131 ** <dd>This option specifies a static memory buffer that SQLite can use for 1282 ** <dd> ^This option specifies a static memory buffer that SQLite can use for
1132 ** the database page cache with the default page cache implemenation. 1283 ** the database page cache with the default page cache implemenation.
1133 ** This configuration should not be used if an application-define page 1284 ** This configuration should not be used if an application-define page
1134 ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option. 1285 ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option.
1135 ** There are three arguments to this option: A pointer to 8-byte aligned 1286 ** There are three arguments to this option: A pointer to 8-byte aligned
1136 ** memory, the size of each page buffer (sz), and the number of pages (N). 1287 ** memory, the size of each page buffer (sz), and the number of pages (N).
1137 ** The sz argument should be the size of the largest database page 1288 ** The sz argument should be the size of the largest database page
1138 ** (a power of two between 512 and 32768) plus a little extra for each 1289 ** (a power of two between 512 and 32768) plus a little extra for each
1139 ** page header. The page header size is 20 to 40 bytes depending on 1290 ** page header. ^The page header size is 20 to 40 bytes depending on
1140 ** the host architecture. It is harmless, apart from the wasted memory, 1291 ** the host architecture. ^It is harmless, apart from the wasted memory,
1141 ** to make sz a little too large. The first 1292 ** to make sz a little too large. The first
1142 ** argument should point to an allocation of at least sz*N bytes of memory. 1293 ** argument should point to an allocation of at least sz*N bytes of memory.
1143 ** SQLite will use the memory provided by the first argument to satisfy its 1294 ** ^SQLite will use the memory provided by the first argument to satisfy its
1144 ** memory needs for the first N pages that it adds to cache. If additional 1295 ** memory needs for the first N pages that it adds to cache. ^If additional
1145 ** page cache memory is needed beyond what is provided by this option, then 1296 ** page cache memory is needed beyond what is provided by this option, then
1146 ** SQLite goes to [sqlite3_malloc()] for the additional storage space. 1297 ** SQLite goes to [sqlite3_malloc()] for the additional storage space.
1147 ** The implementation might use one or more of the N buffers to hold 1298 ** The pointer in the first argument must
1148 ** memory accounting information. The pointer in the first argument must
1149 ** be aligned to an 8-byte boundary or subsequent behavior of SQLite 1299 ** be aligned to an 8-byte boundary or subsequent behavior of SQLite
1150 ** will be undefined.</dd> 1300 ** will be undefined.</dd>
1151 ** 1301 **
1152 ** <dt>SQLITE_CONFIG_HEAP</dt> 1302 ** <dt>SQLITE_CONFIG_HEAP</dt>
1153 ** <dd>This option specifies a static memory buffer that SQLite will use 1303 ** <dd> ^This option specifies a static memory buffer that SQLite will use
1154 ** for all of its dynamic memory allocation needs beyond those provided 1304 ** for all of its dynamic memory allocation needs beyond those provided
1155 ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. 1305 ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
1156 ** There are three arguments: An 8-byte aligned pointer to the memory, 1306 ** There are three arguments: An 8-byte aligned pointer to the memory,
1157 ** the number of bytes in the memory buffer, and the minimum allocation size. 1307 ** the number of bytes in the memory buffer, and the minimum allocation size.
1158 ** If the first pointer (the memory pointer) is NULL, then SQLite reverts 1308 ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
1159 ** to using its default memory allocator (the system malloc() implementation), 1309 ** to using its default memory allocator (the system malloc() implementation),
1160 ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. If the 1310 ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
1161 ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or 1311 ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or
1162 ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory 1312 ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory
1163 ** allocator is engaged to handle all of SQLites memory allocation needs. 1313 ** allocator is engaged to handle all of SQLites memory allocation needs.
1164 ** The first pointer (the memory pointer) must be aligned to an 8-byte 1314 ** The first pointer (the memory pointer) must be aligned to an 8-byte
1165 ** boundary or subsequent behavior of SQLite will be undefined.</dd> 1315 ** boundary or subsequent behavior of SQLite will be undefined.</dd>
1166 ** 1316 **
1167 ** <dt>SQLITE_CONFIG_MUTEX</dt> 1317 ** <dt>SQLITE_CONFIG_MUTEX</dt>
1168 ** <dd>This option takes a single argument which is a pointer to an 1318 ** <dd> ^(This option takes a single argument which is a pointer to an
1169 ** instance of the [sqlite3_mutex_methods] structure. The argument specifies 1319 ** instance of the [sqlite3_mutex_methods] structure. The argument specifies
1170 ** alternative low-level mutex routines to be used in place 1320 ** alternative low-level mutex routines to be used in place
1171 ** the mutex routines built into SQLite.</dd> 1321 ** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the
1322 ** content of the [sqlite3_mutex_methods] structure before the call to
1323 ** [sqlite3_config()] returns. ^If SQLite is compiled with
1324 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1325 ** the entire mutexing subsystem is omitted from the build and hence calls to
1326 ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
1327 ** return [SQLITE_ERROR].</dd>
1172 ** 1328 **
1173 ** <dt>SQLITE_CONFIG_GETMUTEX</dt> 1329 ** <dt>SQLITE_CONFIG_GETMUTEX</dt>
1174 ** <dd>This option takes a single argument which is a pointer to an 1330 ** <dd> ^(This option takes a single argument which is a pointer to an
1175 ** instance of the [sqlite3_mutex_methods] structure. The 1331 ** instance of the [sqlite3_mutex_methods] structure. The
1176 ** [sqlite3_mutex_methods] 1332 ** [sqlite3_mutex_methods]
1177 ** structure is filled with the currently defined mutex routines. 1333 ** structure is filled with the currently defined mutex routines.)^
1178 ** This option can be used to overload the default mutex allocation 1334 ** This option can be used to overload the default mutex allocation
1179 ** routines with a wrapper used to track mutex usage for performance 1335 ** routines with a wrapper used to track mutex usage for performance
1180 ** profiling or testing, for example.</dd> 1336 ** profiling or testing, for example. ^If SQLite is compiled with
1337 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1338 ** the entire mutexing subsystem is omitted from the build and hence calls to
1339 ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
1340 ** return [SQLITE_ERROR].</dd>
1181 ** 1341 **
1182 ** <dt>SQLITE_CONFIG_LOOKASIDE</dt> 1342 ** <dt>SQLITE_CONFIG_LOOKASIDE</dt>
1183 ** <dd>This option takes two arguments that determine the default 1343 ** <dd> ^(This option takes two arguments that determine the default
1184 ** memory allocation lookaside optimization. The first argument is the 1344 ** memory allocation for the lookaside memory allocator on each
1345 ** [database connection]. The first argument is the
1185 ** size of each lookaside buffer slot and the second is the number of 1346 ** size of each lookaside buffer slot and the second is the number of
1186 ** slots allocated to each database connection. This option sets the 1347 ** slots allocated to each database connection.)^ ^(This option sets the
1187 ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] 1348 ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
1188 ** verb to [sqlite3_db_config()] can be used to change the lookaside 1349 ** verb to [sqlite3_db_config()] can be used to change the lookaside
1189 ** configuration on individual connections.</dd> 1350 ** configuration on individual connections.)^ </dd>
1190 ** 1351 **
1191 ** <dt>SQLITE_CONFIG_PCACHE</dt> 1352 ** <dt>SQLITE_CONFIG_PCACHE</dt>
1192 ** <dd>This option takes a single argument which is a pointer to 1353 ** <dd> ^(This option takes a single argument which is a pointer to
1193 ** an [sqlite3_pcache_methods] object. This object specifies the interface 1354 ** an [sqlite3_pcache_methods] object. This object specifies the interface
1194 ** to a custom page cache implementation. SQLite makes a copy of the 1355 ** to a custom page cache implementation.)^ ^SQLite makes a copy of the
1195 ** object and uses it for page cache memory allocations.</dd> 1356 ** object and uses it for page cache memory allocations.</dd>
1196 ** 1357 **
1197 ** <dt>SQLITE_CONFIG_GETPCACHE</dt> 1358 ** <dt>SQLITE_CONFIG_GETPCACHE</dt>
1198 ** <dd>This option takes a single argument which is a pointer to an 1359 ** <dd> ^(This option takes a single argument which is a pointer to an
1199 ** [sqlite3_pcache_methods] object. SQLite copies of the current 1360 ** [sqlite3_pcache_methods] object. SQLite copies of the current
1200 ** page cache implementation into that object.</dd> 1361 ** page cache implementation into that object.)^ </dd>
1362 **
1363 ** <dt>SQLITE_CONFIG_LOG</dt>
1364 ** <dd> ^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
1365 ** function with a call signature of void(*)(void*,int,const char*),
1366 ** and a pointer to void. ^If the function pointer is not NULL, it is
1367 ** invoked by [sqlite3_log()] to process each logging event. ^If the
1368 ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
1369 ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
1370 ** passed through as the first parameter to the application-defined logger
1371 ** function whenever that function is invoked. ^The second parameter to
1372 ** the logger function is a copy of the first parameter to the corresponding
1373 ** [sqlite3_log()] call and is intended to be a [result code] or an
1374 ** [extended result code]. ^The third parameter passed to the logger is
1375 ** log message after formatting via [sqlite3_snprintf()].
1376 ** The SQLite logging interface is not reentrant; the logger function
1377 ** supplied by the application must not invoke any SQLite interface.
1378 ** In a multi-threaded application, the application-defined logger
1379 ** function must be threadsafe. </dd>
1201 ** 1380 **
1202 ** </dl> 1381 ** </dl>
1203 */ 1382 */
1204 #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ 1383 #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
1205 #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ 1384 #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
1206 #define SQLITE_CONFIG_SERIALIZED 3 /* nil */ 1385 #define SQLITE_CONFIG_SERIALIZED 3 /* nil */
1207 #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ 1386 #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
1208 #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ 1387 #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
1209 #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ 1388 #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
1210 #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ 1389 #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
1211 #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ 1390 #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
1212 #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ 1391 #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
1213 #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ 1392 #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
1214 #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ 1393 #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
1215 /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 1394 /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
1216 #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ 1395 #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
1217 #define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */ 1396 #define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */
1218 #define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */ 1397 #define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */
1398 #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
1219 1399
1220 /* 1400 /*
1221 ** CAPI3REF: Configuration Options {H10170} <S20000> 1401 ** CAPI3REF: Database Connection Configuration Options
1222 ** EXPERIMENTAL
1223 ** 1402 **
1224 ** These constants are the available integer configuration options that 1403 ** These constants are the available integer configuration options that
1225 ** can be passed as the second argument to the [sqlite3_db_config()] interface. 1404 ** can be passed as the second argument to the [sqlite3_db_config()] interface.
1226 ** 1405 **
1227 ** New configuration options may be added in future releases of SQLite. 1406 ** New configuration options may be added in future releases of SQLite.
1228 ** Existing configuration options might be discontinued. Applications 1407 ** Existing configuration options might be discontinued. Applications
1229 ** should check the return code from [sqlite3_db_config()] to make sure that 1408 ** should check the return code from [sqlite3_db_config()] to make sure that
1230 ** the call worked. The [sqlite3_db_config()] interface will return a 1409 ** the call worked. ^The [sqlite3_db_config()] interface will return a
1231 ** non-zero [error code] if a discontinued or unsupported configuration option 1410 ** non-zero [error code] if a discontinued or unsupported configuration option
1232 ** is invoked. 1411 ** is invoked.
1233 ** 1412 **
1234 ** <dl> 1413 ** <dl>
1235 ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> 1414 ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
1236 ** <dd>This option takes three additional arguments that determine the 1415 ** <dd> ^This option takes three additional arguments that determine the
1237 ** [lookaside memory allocator] configuration for the [database connection]. 1416 ** [lookaside memory allocator] configuration for the [database connection].
1238 ** The first argument (the third parameter to [sqlite3_db_config()] is a 1417 ** ^The first argument (the third parameter to [sqlite3_db_config()] is a
1239 ** pointer to an memory buffer to use for lookaside memory. 1418 ** pointer to an memory buffer to use for lookaside memory.
1240 ** The first argument may be NULL in which case SQLite will allocate the 1419 ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
1241 ** lookaside buffer itself using [sqlite3_malloc()]. The second argument is the 1420 ** may be NULL in which case SQLite will allocate the
1242 ** size of each lookaside buffer slot and the third argument is the number of 1421 ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
1422 ** size of each lookaside buffer slot. ^The third argument is the number of
1243 ** slots. The size of the buffer in the first argument must be greater than 1423 ** slots. The size of the buffer in the first argument must be greater than
1244 ** or equal to the product of the second and third arguments. The buffer 1424 ** or equal to the product of the second and third arguments. The buffer
1245 ** must be aligned to an 8-byte boundary. If the second argument is not 1425 ** must be aligned to an 8-byte boundary. ^If the second argument to
1246 ** a multiple of 8, it is internally rounded down to the next smaller 1426 ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
1247 ** multiple of 8. See also: [SQLITE_CONFIG_LOOKASIDE]</dd> 1427 ** rounded down to the next smaller multiple of 8. ^(The lookaside memory
1428 ** configuration for a database connection can only be changed when that
1429 ** connection is not currently using lookaside memory, or in other words
1430 ** when the "current value" returned by
1431 ** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
1432 ** Any attempt to change the lookaside memory configuration when lookaside
1433 ** memory is in use leaves the configuration unchanged and returns
1434 ** [SQLITE_BUSY].)^</dd>
1248 ** 1435 **
1249 ** </dl> 1436 ** </dl>
1250 */ 1437 */
1251 #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ 1438 #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
1252 1439
1253 1440
1254 /* 1441 /*
1255 ** CAPI3REF: Enable Or Disable Extended Result Codes {H12200} <S10700> 1442 ** CAPI3REF: Enable Or Disable Extended Result Codes
1256 ** 1443 **
1257 ** The sqlite3_extended_result_codes() routine enables or disables the 1444 ** ^The sqlite3_extended_result_codes() routine enables or disables the
1258 ** [extended result codes] feature of SQLite. The extended result 1445 ** [extended result codes] feature of SQLite. ^The extended result
1259 ** codes are disabled by default for historical compatibility considerations. 1446 ** codes are disabled by default for historical compatibility.
1260 **
1261 ** Requirements:
1262 ** [H12201] [H12202]
1263 */ 1447 */
1264 SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff); 1448 SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
1265 1449
1266 /* 1450 /*
1267 ** CAPI3REF: Last Insert Rowid {H12220} <S10700> 1451 ** CAPI3REF: Last Insert Rowid
1268 ** 1452 **
1269 ** Each entry in an SQLite table has a unique 64-bit signed 1453 ** ^Each entry in an SQLite table has a unique 64-bit signed
1270 ** integer key called the [ROWID | "rowid"]. The rowid is always available 1454 ** integer key called the [ROWID | "rowid"]. ^The rowid is always available
1271 ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those 1455 ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
1272 ** names are not also used by explicitly declared columns. If 1456 ** names are not also used by explicitly declared columns. ^If
1273 ** the table has a column of type [INTEGER PRIMARY KEY] then that column 1457 ** the table has a column of type [INTEGER PRIMARY KEY] then that column
1274 ** is another alias for the rowid. 1458 ** is another alias for the rowid.
1275 ** 1459 **
1276 ** This routine returns the [rowid] of the most recent 1460 ** ^This routine returns the [rowid] of the most recent
1277 ** successful [INSERT] into the database from the [database connection] 1461 ** successful [INSERT] into the database from the [database connection]
1278 ** in the first argument. If no successful [INSERT]s 1462 ** in the first argument. ^If no successful [INSERT]s
1279 ** have ever occurred on that database connection, zero is returned. 1463 ** have ever occurred on that database connection, zero is returned.
1280 ** 1464 **
1281 ** If an [INSERT] occurs within a trigger, then the [rowid] of the inserted 1465 ** ^(If an [INSERT] occurs within a trigger, then the [rowid] of the inserted
1282 ** row is returned by this routine as long as the trigger is running. 1466 ** row is returned by this routine as long as the trigger is running.
1283 ** But once the trigger terminates, the value returned by this routine 1467 ** But once the trigger terminates, the value returned by this routine
1284 ** reverts to the last value inserted before the trigger fired. 1468 ** reverts to the last value inserted before the trigger fired.)^
1285 ** 1469 **
1286 ** An [INSERT] that fails due to a constraint violation is not a 1470 ** ^An [INSERT] that fails due to a constraint violation is not a
1287 ** successful [INSERT] and does not change the value returned by this 1471 ** successful [INSERT] and does not change the value returned by this
1288 ** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, 1472 ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
1289 ** and INSERT OR ABORT make no changes to the return value of this 1473 ** and INSERT OR ABORT make no changes to the return value of this
1290 ** routine when their insertion fails. When INSERT OR REPLACE 1474 ** routine when their insertion fails. ^(When INSERT OR REPLACE
1291 ** encounters a constraint violation, it does not fail. The 1475 ** encounters a constraint violation, it does not fail. The
1292 ** INSERT continues to completion after deleting rows that caused 1476 ** INSERT continues to completion after deleting rows that caused
1293 ** the constraint problem so INSERT OR REPLACE will always change 1477 ** the constraint problem so INSERT OR REPLACE will always change
1294 ** the return value of this interface. 1478 ** the return value of this interface.)^
1295 ** 1479 **
1296 ** For the purposes of this routine, an [INSERT] is considered to 1480 ** ^For the purposes of this routine, an [INSERT] is considered to
1297 ** be successful even if it is subsequently rolled back. 1481 ** be successful even if it is subsequently rolled back.
1298 ** 1482 **
1299 ** Requirements: 1483 ** This function is accessible to SQL statements via the
1300 ** [H12221] [H12223] 1484 ** [last_insert_rowid() SQL function].
1301 ** 1485 **
1302 ** If a separate thread performs a new [INSERT] on the same 1486 ** If a separate thread performs a new [INSERT] on the same
1303 ** database connection while the [sqlite3_last_insert_rowid()] 1487 ** database connection while the [sqlite3_last_insert_rowid()]
1304 ** function is running and thus changes the last insert [rowid], 1488 ** function is running and thus changes the last insert [rowid],
1305 ** then the value returned by [sqlite3_last_insert_rowid()] is 1489 ** then the value returned by [sqlite3_last_insert_rowid()] is
1306 ** unpredictable and might not equal either the old or the new 1490 ** unpredictable and might not equal either the old or the new
1307 ** last insert [rowid]. 1491 ** last insert [rowid].
1308 */ 1492 */
1309 SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); 1493 SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
1310 1494
1311 /* 1495 /*
1312 ** CAPI3REF: Count The Number Of Rows Modified {H12240} <S10600> 1496 ** CAPI3REF: Count The Number Of Rows Modified
1313 ** 1497 **
1314 ** This function returns the number of database rows that were changed 1498 ** ^This function returns the number of database rows that were changed
1315 ** or inserted or deleted by the most recently completed SQL statement 1499 ** or inserted or deleted by the most recently completed SQL statement
1316 ** on the [database connection] specified by the first parameter. 1500 ** on the [database connection] specified by the first parameter.
1317 ** Only changes that are directly specified by the [INSERT], [UPDATE], 1501 ** ^(Only changes that are directly specified by the [INSERT], [UPDATE],
1318 ** or [DELETE] statement are counted. Auxiliary changes caused by 1502 ** or [DELETE] statement are counted. Auxiliary changes caused by
1319 ** triggers are not counted. Use the [sqlite3_total_changes()] function 1503 ** triggers or [foreign key actions] are not counted.)^ Use the
1320 ** to find the total number of changes including changes caused by triggers. 1504 ** [sqlite3_total_changes()] function to find the total number of changes
1505 ** including changes caused by triggers and foreign key actions.
1321 ** 1506 **
1322 ** Changes to a view that are simulated by an [INSTEAD OF trigger] 1507 ** ^Changes to a view that are simulated by an [INSTEAD OF trigger]
1323 ** are not counted. Only real table changes are counted. 1508 ** are not counted. Only real table changes are counted.
1324 ** 1509 **
1325 ** A "row change" is a change to a single row of a single table 1510 ** ^(A "row change" is a change to a single row of a single table
1326 ** caused by an INSERT, DELETE, or UPDATE statement. Rows that 1511 ** caused by an INSERT, DELETE, or UPDATE statement. Rows that
1327 ** are changed as side effects of [REPLACE] constraint resolution, 1512 ** are changed as side effects of [REPLACE] constraint resolution,
1328 ** rollback, ABORT processing, [DROP TABLE], or by any other 1513 ** rollback, ABORT processing, [DROP TABLE], or by any other
1329 ** mechanisms do not count as direct row changes. 1514 ** mechanisms do not count as direct row changes.)^
1330 ** 1515 **
1331 ** A "trigger context" is a scope of execution that begins and 1516 ** A "trigger context" is a scope of execution that begins and
1332 ** ends with the script of a [CREATE TRIGGER | trigger]. 1517 ** ends with the script of a [CREATE TRIGGER | trigger].
1333 ** Most SQL statements are 1518 ** Most SQL statements are
1334 ** evaluated outside of any trigger. This is the "top level" 1519 ** evaluated outside of any trigger. This is the "top level"
1335 ** trigger context. If a trigger fires from the top level, a 1520 ** trigger context. If a trigger fires from the top level, a
1336 ** new trigger context is entered for the duration of that one 1521 ** new trigger context is entered for the duration of that one
1337 ** trigger. Subtriggers create subcontexts for their duration. 1522 ** trigger. Subtriggers create subcontexts for their duration.
1338 ** 1523 **
1339 ** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does 1524 ** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
1340 ** not create a new trigger context. 1525 ** not create a new trigger context.
1341 ** 1526 **
1342 ** This function returns the number of direct row changes in the 1527 ** ^This function returns the number of direct row changes in the
1343 ** most recent INSERT, UPDATE, or DELETE statement within the same 1528 ** most recent INSERT, UPDATE, or DELETE statement within the same
1344 ** trigger context. 1529 ** trigger context.
1345 ** 1530 **
1346 ** Thus, when called from the top level, this function returns the 1531 ** ^Thus, when called from the top level, this function returns the
1347 ** number of changes in the most recent INSERT, UPDATE, or DELETE 1532 ** number of changes in the most recent INSERT, UPDATE, or DELETE
1348 ** that also occurred at the top level. Within the body of a trigger, 1533 ** that also occurred at the top level. ^(Within the body of a trigger,
1349 ** the sqlite3_changes() interface can be called to find the number of 1534 ** the sqlite3_changes() interface can be called to find the number of
1350 ** changes in the most recently completed INSERT, UPDATE, or DELETE 1535 ** changes in the most recently completed INSERT, UPDATE, or DELETE
1351 ** statement within the body of the same trigger. 1536 ** statement within the body of the same trigger.
1352 ** However, the number returned does not include changes 1537 ** However, the number returned does not include changes
1353 ** caused by subtriggers since those have their own context. 1538 ** caused by subtriggers since those have their own context.)^
1354 ** 1539 **
1355 ** See also the [sqlite3_total_changes()] interface and the 1540 ** See also the [sqlite3_total_changes()] interface, the
1356 ** [count_changes pragma]. 1541 ** [count_changes pragma], and the [changes() SQL function].
1357 **
1358 ** Requirements:
1359 ** [H12241] [H12243]
1360 ** 1542 **
1361 ** If a separate thread makes changes on the same database connection 1543 ** If a separate thread makes changes on the same database connection
1362 ** while [sqlite3_changes()] is running then the value returned 1544 ** while [sqlite3_changes()] is running then the value returned
1363 ** is unpredictable and not meaningful. 1545 ** is unpredictable and not meaningful.
1364 */ 1546 */
1365 SQLITE_API int sqlite3_changes(sqlite3*); 1547 SQLITE_API int sqlite3_changes(sqlite3*);
1366 1548
1367 /* 1549 /*
1368 ** CAPI3REF: Total Number Of Rows Modified {H12260} <S10600> 1550 ** CAPI3REF: Total Number Of Rows Modified
1369 ** 1551 **
1370 ** This function returns the number of row changes caused by [INSERT], 1552 ** ^This function returns the number of row changes caused by [INSERT],
1371 ** [UPDATE] or [DELETE] statements since the [database connection] was opened. 1553 ** [UPDATE] or [DELETE] statements since the [database connection] was opened.
1372 ** The count includes all changes from all 1554 ** ^(The count returned by sqlite3_total_changes() includes all changes
1373 ** [CREATE TRIGGER | trigger] contexts. However, 1555 ** from all [CREATE TRIGGER | trigger] contexts and changes made by
1556 ** [foreign key actions]. However,
1374 ** the count does not include changes used to implement [REPLACE] constraints, 1557 ** the count does not include changes used to implement [REPLACE] constraints,
1375 ** do rollbacks or ABORT processing, or [DROP TABLE] processing. The 1558 ** do rollbacks or ABORT processing, or [DROP TABLE] processing. The
1376 ** count does not include rows of views that fire an [INSTEAD OF trigger], 1559 ** count does not include rows of views that fire an [INSTEAD OF trigger],
1377 ** though if the INSTEAD OF trigger makes changes of its own, those changes 1560 ** though if the INSTEAD OF trigger makes changes of its own, those changes
1378 ** are counted. 1561 ** are counted.)^
1379 ** The changes are counted as soon as the statement that makes them is 1562 ** ^The sqlite3_total_changes() function counts the changes as soon as
1380 ** completed (when the statement handle is passed to [sqlite3_reset()] or 1563 ** the statement that makes them is completed (when the statement handle
1381 ** [sqlite3_finalize()]). 1564 ** is passed to [sqlite3_reset()] or [sqlite3_finalize()]).
1382 ** 1565 **
1383 ** See also the [sqlite3_changes()] interface and the 1566 ** See also the [sqlite3_changes()] interface, the
1384 ** [count_changes pragma]. 1567 ** [count_changes pragma], and the [total_changes() SQL function].
1385 **
1386 ** Requirements:
1387 ** [H12261] [H12263]
1388 ** 1568 **
1389 ** If a separate thread makes changes on the same database connection 1569 ** If a separate thread makes changes on the same database connection
1390 ** while [sqlite3_total_changes()] is running then the value 1570 ** while [sqlite3_total_changes()] is running then the value
1391 ** returned is unpredictable and not meaningful. 1571 ** returned is unpredictable and not meaningful.
1392 */ 1572 */
1393 SQLITE_API int sqlite3_total_changes(sqlite3*); 1573 SQLITE_API int sqlite3_total_changes(sqlite3*);
1394 1574
1395 /* 1575 /*
1396 ** CAPI3REF: Interrupt A Long-Running Query {H12270} <S30500> 1576 ** CAPI3REF: Interrupt A Long-Running Query
1397 ** 1577 **
1398 ** This function causes any pending database operation to abort and 1578 ** ^This function causes any pending database operation to abort and
1399 ** return at its earliest opportunity. This routine is typically 1579 ** return at its earliest opportunity. This routine is typically
1400 ** called in response to a user action such as pressing "Cancel" 1580 ** called in response to a user action such as pressing "Cancel"
1401 ** or Ctrl-C where the user wants a long query operation to halt 1581 ** or Ctrl-C where the user wants a long query operation to halt
1402 ** immediately. 1582 ** immediately.
1403 ** 1583 **
1404 ** It is safe to call this routine from a thread different from the 1584 ** ^It is safe to call this routine from a thread different from the
1405 ** thread that is currently running the database operation. But it 1585 ** thread that is currently running the database operation. But it
1406 ** is not safe to call this routine with a [database connection] that 1586 ** is not safe to call this routine with a [database connection] that
1407 ** is closed or might close before sqlite3_interrupt() returns. 1587 ** is closed or might close before sqlite3_interrupt() returns.
1408 ** 1588 **
1409 ** If an SQL operation is very nearly finished at the time when 1589 ** ^If an SQL operation is very nearly finished at the time when
1410 ** sqlite3_interrupt() is called, then it might not have an opportunity 1590 ** sqlite3_interrupt() is called, then it might not have an opportunity
1411 ** to be interrupted and might continue to completion. 1591 ** to be interrupted and might continue to completion.
1412 ** 1592 **
1413 ** An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. 1593 ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
1414 ** If the interrupted SQL operation is an INSERT, UPDATE, or DELETE 1594 ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
1415 ** that is inside an explicit transaction, then the entire transaction 1595 ** that is inside an explicit transaction, then the entire transaction
1416 ** will be rolled back automatically. 1596 ** will be rolled back automatically.
1417 ** 1597 **
1418 ** The sqlite3_interrupt(D) call is in effect until all currently running 1598 ** ^The sqlite3_interrupt(D) call is in effect until all currently running
1419 ** SQL statements on [database connection] D complete. Any new SQL statements 1599 ** SQL statements on [database connection] D complete. ^Any new SQL statements
1420 ** that are started after the sqlite3_interrupt() call and before the 1600 ** that are started after the sqlite3_interrupt() call and before the
1421 ** running statements reaches zero are interrupted as if they had been 1601 ** running statements reaches zero are interrupted as if they had been
1422 ** running prior to the sqlite3_interrupt() call. New SQL statements 1602 ** running prior to the sqlite3_interrupt() call. ^New SQL statements
1423 ** that are started after the running statement count reaches zero are 1603 ** that are started after the running statement count reaches zero are
1424 ** not effected by the sqlite3_interrupt(). 1604 ** not effected by the sqlite3_interrupt().
1425 ** A call to sqlite3_interrupt(D) that occurs when there are no running 1605 ** ^A call to sqlite3_interrupt(D) that occurs when there are no running
1426 ** SQL statements is a no-op and has no effect on SQL statements 1606 ** SQL statements is a no-op and has no effect on SQL statements
1427 ** that are started after the sqlite3_interrupt() call returns. 1607 ** that are started after the sqlite3_interrupt() call returns.
1428 ** 1608 **
1429 ** Requirements:
1430 ** [H12271] [H12272]
1431 **
1432 ** If the database connection closes while [sqlite3_interrupt()] 1609 ** If the database connection closes while [sqlite3_interrupt()]
1433 ** is running then bad things will likely happen. 1610 ** is running then bad things will likely happen.
1434 */ 1611 */
1435 SQLITE_API void sqlite3_interrupt(sqlite3*); 1612 SQLITE_API void sqlite3_interrupt(sqlite3*);
1436 1613
1437 /* 1614 /*
1438 ** CAPI3REF: Determine If An SQL Statement Is Complete {H10510} <S70200> 1615 ** CAPI3REF: Determine If An SQL Statement Is Complete
1439 ** 1616 **
1440 ** These routines are useful during command-line input to determine if the 1617 ** These routines are useful during command-line input to determine if the
1441 ** currently entered text seems to form a complete SQL statement or 1618 ** currently entered text seems to form a complete SQL statement or
1442 ** if additional input is needed before sending the text into 1619 ** if additional input is needed before sending the text into
1443 ** SQLite for parsing. These routines return 1 if the input string 1620 ** SQLite for parsing. ^These routines return 1 if the input string
1444 ** appears to be a complete SQL statement. A statement is judged to be 1621 ** appears to be a complete SQL statement. ^A statement is judged to be
1445 ** complete if it ends with a semicolon token and is not a prefix of a 1622 ** complete if it ends with a semicolon token and is not a prefix of a
1446 ** well-formed CREATE TRIGGER statement. Semicolons that are embedded within 1623 ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
1447 ** string literals or quoted identifier names or comments are not 1624 ** string literals or quoted identifier names or comments are not
1448 ** independent tokens (they are part of the token in which they are 1625 ** independent tokens (they are part of the token in which they are
1449 ** embedded) and thus do not count as a statement terminator. Whitespace 1626 ** embedded) and thus do not count as a statement terminator. ^Whitespace
1450 ** and comments that follow the final semicolon are ignored. 1627 ** and comments that follow the final semicolon are ignored.
1451 ** 1628 **
1452 ** These routines return 0 if the statement is incomplete. If a 1629 ** ^These routines return 0 if the statement is incomplete. ^If a
1453 ** memory allocation fails, then SQLITE_NOMEM is returned. 1630 ** memory allocation fails, then SQLITE_NOMEM is returned.
1454 ** 1631 **
1455 ** These routines do not parse the SQL statements thus 1632 ** ^These routines do not parse the SQL statements thus
1456 ** will not detect syntactically incorrect SQL. 1633 ** will not detect syntactically incorrect SQL.
1457 ** 1634 **
1458 ** If SQLite has not been initialized using [sqlite3_initialize()] prior 1635 ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
1459 ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked 1636 ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
1460 ** automatically by sqlite3_complete16(). If that initialization fails, 1637 ** automatically by sqlite3_complete16(). If that initialization fails,
1461 ** then the return value from sqlite3_complete16() will be non-zero 1638 ** then the return value from sqlite3_complete16() will be non-zero
1462 ** regardless of whether or not the input SQL is complete. 1639 ** regardless of whether or not the input SQL is complete.)^
1463 **
1464 ** Requirements: [H10511] [H10512]
1465 ** 1640 **
1466 ** The input to [sqlite3_complete()] must be a zero-terminated 1641 ** The input to [sqlite3_complete()] must be a zero-terminated
1467 ** UTF-8 string. 1642 ** UTF-8 string.
1468 ** 1643 **
1469 ** The input to [sqlite3_complete16()] must be a zero-terminated 1644 ** The input to [sqlite3_complete16()] must be a zero-terminated
1470 ** UTF-16 string in native byte order. 1645 ** UTF-16 string in native byte order.
1471 */ 1646 */
1472 SQLITE_API int sqlite3_complete(const char *sql); 1647 SQLITE_API int sqlite3_complete(const char *sql);
1473 SQLITE_API int sqlite3_complete16(const void *sql); 1648 SQLITE_API int sqlite3_complete16(const void *sql);
1474 1649
1475 /* 1650 /*
1476 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {H12310} <S40400> 1651 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
1477 ** 1652 **
1478 ** This routine sets a callback function that might be invoked whenever 1653 ** ^This routine sets a callback function that might be invoked whenever
1479 ** an attempt is made to open a database table that another thread 1654 ** an attempt is made to open a database table that another thread
1480 ** or process has locked. 1655 ** or process has locked.
1481 ** 1656 **
1482 ** If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] 1657 ** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]
1483 ** is returned immediately upon encountering the lock. If the busy callback 1658 ** is returned immediately upon encountering the lock. ^If the busy callback
1484 ** is not NULL, then the callback will be invoked with two arguments. 1659 ** is not NULL, then the callback might be invoked with two arguments.
1485 ** 1660 **
1486 ** The first argument to the handler is a copy of the void* pointer which 1661 ** ^The first argument to the busy handler is a copy of the void* pointer which
1487 ** is the third argument to sqlite3_busy_handler(). The second argument to 1662 ** is the third argument to sqlite3_busy_handler(). ^The second argument to
1488 ** the handler callback is the number of times that the busy handler has 1663 ** the busy handler callback is the number of times that the busy handler has
1489 ** been invoked for this locking event. If the 1664 ** been invoked for this locking event. ^If the
1490 ** busy callback returns 0, then no additional attempts are made to 1665 ** busy callback returns 0, then no additional attempts are made to
1491 ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. 1666 ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
1492 ** If the callback returns non-zero, then another attempt 1667 ** ^If the callback returns non-zero, then another attempt
1493 ** is made to open the database for reading and the cycle repeats. 1668 ** is made to open the database for reading and the cycle repeats.
1494 ** 1669 **
1495 ** The presence of a busy handler does not guarantee that it will be invoked 1670 ** The presence of a busy handler does not guarantee that it will be invoked
1496 ** when there is lock contention. If SQLite determines that invoking the busy 1671 ** when there is lock contention. ^If SQLite determines that invoking the busy
1497 ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] 1672 ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
1498 ** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. 1673 ** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler.
1499 ** Consider a scenario where one process is holding a read lock that 1674 ** Consider a scenario where one process is holding a read lock that
1500 ** it is trying to promote to a reserved lock and 1675 ** it is trying to promote to a reserved lock and
1501 ** a second process is holding a reserved lock that it is trying 1676 ** a second process is holding a reserved lock that it is trying
1502 ** to promote to an exclusive lock. The first process cannot proceed 1677 ** to promote to an exclusive lock. The first process cannot proceed
1503 ** because it is blocked by the second and the second process cannot 1678 ** because it is blocked by the second and the second process cannot
1504 ** proceed because it is blocked by the first. If both processes 1679 ** proceed because it is blocked by the first. If both processes
1505 ** invoke the busy handlers, neither will make any progress. Therefore, 1680 ** invoke the busy handlers, neither will make any progress. Therefore,
1506 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this 1681 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
1507 ** will induce the first process to release its read lock and allow 1682 ** will induce the first process to release its read lock and allow
1508 ** the second process to proceed. 1683 ** the second process to proceed.
1509 ** 1684 **
1510 ** The default busy callback is NULL. 1685 ** ^The default busy callback is NULL.
1511 ** 1686 **
1512 ** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] 1687 ** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
1513 ** when SQLite is in the middle of a large transaction where all the 1688 ** when SQLite is in the middle of a large transaction where all the
1514 ** changes will not fit into the in-memory cache. SQLite will 1689 ** changes will not fit into the in-memory cache. SQLite will
1515 ** already hold a RESERVED lock on the database file, but it needs 1690 ** already hold a RESERVED lock on the database file, but it needs
1516 ** to promote this lock to EXCLUSIVE so that it can spill cache 1691 ** to promote this lock to EXCLUSIVE so that it can spill cache
1517 ** pages into the database file without harm to concurrent 1692 ** pages into the database file without harm to concurrent
1518 ** readers. If it is unable to promote the lock, then the in-memory 1693 ** readers. ^If it is unable to promote the lock, then the in-memory
1519 ** cache will be left in an inconsistent state and so the error 1694 ** cache will be left in an inconsistent state and so the error
1520 ** code is promoted from the relatively benign [SQLITE_BUSY] to 1695 ** code is promoted from the relatively benign [SQLITE_BUSY] to
1521 ** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion 1696 ** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion
1522 ** forces an automatic rollback of the changes. See the 1697 ** forces an automatic rollback of the changes. See the
1523 ** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> 1698 ** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError">
1524 ** CorruptionFollowingBusyError</a> wiki page for a discussion of why 1699 ** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1525 ** this is important. 1700 ** this is important.
1526 ** 1701 **
1527 ** There can only be a single busy handler defined for each 1702 ** ^(There can only be a single busy handler defined for each
1528 ** [database connection]. Setting a new busy handler clears any 1703 ** [database connection]. Setting a new busy handler clears any
1529 ** previously set handler. Note that calling [sqlite3_busy_timeout()] 1704 ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
1530 ** will also set or clear the busy handler. 1705 ** will also set or clear the busy handler.
1531 ** 1706 **
1532 ** The busy callback should not take any actions which modify the 1707 ** The busy callback should not take any actions which modify the
1533 ** database connection that invoked the busy handler. Any such actions 1708 ** database connection that invoked the busy handler. Any such actions
1534 ** result in undefined behavior. 1709 ** result in undefined behavior.
1535 ** 1710 **
1536 ** Requirements:
1537 ** [H12311] [H12312] [H12314] [H12316] [H12318]
1538 **
1539 ** A busy handler must not close the database connection 1711 ** A busy handler must not close the database connection
1540 ** or [prepared statement] that invoked the busy handler. 1712 ** or [prepared statement] that invoked the busy handler.
1541 */ 1713 */
1542 SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); 1714 SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
1543 1715
1544 /* 1716 /*
1545 ** CAPI3REF: Set A Busy Timeout {H12340} <S40410> 1717 ** CAPI3REF: Set A Busy Timeout
1546 ** 1718 **
1547 ** This routine sets a [sqlite3_busy_handler | busy handler] that sleeps 1719 ** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
1548 ** for a specified amount of time when a table is locked. The handler 1720 ** for a specified amount of time when a table is locked. ^The handler
1549 ** will sleep multiple times until at least "ms" milliseconds of sleeping 1721 ** will sleep multiple times until at least "ms" milliseconds of sleeping
1550 ** have accumulated. {H12343} After "ms" milliseconds of sleeping, 1722 ** have accumulated. ^After at least "ms" milliseconds of sleeping,
1551 ** the handler returns 0 which causes [sqlite3_step()] to return 1723 ** the handler returns 0 which causes [sqlite3_step()] to return
1552 ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. 1724 ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
1553 ** 1725 **
1554 ** Calling this routine with an argument less than or equal to zero 1726 ** ^Calling this routine with an argument less than or equal to zero
1555 ** turns off all busy handlers. 1727 ** turns off all busy handlers.
1556 ** 1728 **
1557 ** There can only be a single busy handler for a particular 1729 ** ^(There can only be a single busy handler for a particular
1558 ** [database connection] any any given moment. If another busy handler 1730 ** [database connection] any any given moment. If another busy handler
1559 ** was defined (using [sqlite3_busy_handler()]) prior to calling 1731 ** was defined (using [sqlite3_busy_handler()]) prior to calling
1560 ** this routine, that other busy handler is cleared. 1732 ** this routine, that other busy handler is cleared.)^
1561 **
1562 ** Requirements:
1563 ** [H12341] [H12343] [H12344]
1564 */ 1733 */
1565 SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); 1734 SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
1566 1735
1567 /* 1736 /*
1568 ** CAPI3REF: Convenience Routines For Running Queries {H12370} <S10000> 1737 ** CAPI3REF: Convenience Routines For Running Queries
1738 **
1739 ** This is a legacy interface that is preserved for backwards compatibility.
1740 ** Use of this interface is not recommended.
1569 ** 1741 **
1570 ** Definition: A <b>result table</b> is memory data structure created by the 1742 ** Definition: A <b>result table</b> is memory data structure created by the
1571 ** [sqlite3_get_table()] interface. A result table records the 1743 ** [sqlite3_get_table()] interface. A result table records the
1572 ** complete query results from one or more queries. 1744 ** complete query results from one or more queries.
1573 ** 1745 **
1574 ** The table conceptually has a number of rows and columns. But 1746 ** The table conceptually has a number of rows and columns. But
1575 ** these numbers are not part of the result table itself. These 1747 ** these numbers are not part of the result table itself. These
1576 ** numbers are obtained separately. Let N be the number of rows 1748 ** numbers are obtained separately. Let N be the number of rows
1577 ** and M be the number of columns. 1749 ** and M be the number of columns.
1578 ** 1750 **
1579 ** A result table is an array of pointers to zero-terminated UTF-8 strings. 1751 ** A result table is an array of pointers to zero-terminated UTF-8 strings.
1580 ** There are (N+1)*M elements in the array. The first M pointers point 1752 ** There are (N+1)*M elements in the array. The first M pointers point
1581 ** to zero-terminated strings that contain the names of the columns. 1753 ** to zero-terminated strings that contain the names of the columns.
1582 ** The remaining entries all point to query results. NULL values result 1754 ** The remaining entries all point to query results. NULL values result
1583 ** in NULL pointers. All other values are in their UTF-8 zero-terminated 1755 ** in NULL pointers. All other values are in their UTF-8 zero-terminated
1584 ** string representation as returned by [sqlite3_column_text()]. 1756 ** string representation as returned by [sqlite3_column_text()].
1585 ** 1757 **
1586 ** A result table might consist of one or more memory allocations. 1758 ** A result table might consist of one or more memory allocations.
1587 ** It is not safe to pass a result table directly to [sqlite3_free()]. 1759 ** It is not safe to pass a result table directly to [sqlite3_free()].
1588 ** A result table should be deallocated using [sqlite3_free_table()]. 1760 ** A result table should be deallocated using [sqlite3_free_table()].
1589 ** 1761 **
1590 ** As an example of the result table format, suppose a query result 1762 ** ^(As an example of the result table format, suppose a query result
1591 ** is as follows: 1763 ** is as follows:
1592 ** 1764 **
1593 ** <blockquote><pre> 1765 ** <blockquote><pre>
1594 ** Name | Age 1766 ** Name | Age
1595 ** ----------------------- 1767 ** -----------------------
1596 ** Alice | 43 1768 ** Alice | 43
1597 ** Bob | 28 1769 ** Bob | 28
1598 ** Cindy | 21 1770 ** Cindy | 21
1599 ** </pre></blockquote> 1771 ** </pre></blockquote>
1600 ** 1772 **
1601 ** There are two column (M==2) and three rows (N==3). Thus the 1773 ** There are two column (M==2) and three rows (N==3). Thus the
1602 ** result table has 8 entries. Suppose the result table is stored 1774 ** result table has 8 entries. Suppose the result table is stored
1603 ** in an array names azResult. Then azResult holds this content: 1775 ** in an array names azResult. Then azResult holds this content:
1604 ** 1776 **
1605 ** <blockquote><pre> 1777 ** <blockquote><pre>
1606 ** azResult&#91;0] = "Name"; 1778 ** azResult&#91;0] = "Name";
1607 ** azResult&#91;1] = "Age"; 1779 ** azResult&#91;1] = "Age";
1608 ** azResult&#91;2] = "Alice"; 1780 ** azResult&#91;2] = "Alice";
1609 ** azResult&#91;3] = "43"; 1781 ** azResult&#91;3] = "43";
1610 ** azResult&#91;4] = "Bob"; 1782 ** azResult&#91;4] = "Bob";
1611 ** azResult&#91;5] = "28"; 1783 ** azResult&#91;5] = "28";
1612 ** azResult&#91;6] = "Cindy"; 1784 ** azResult&#91;6] = "Cindy";
1613 ** azResult&#91;7] = "21"; 1785 ** azResult&#91;7] = "21";
1614 ** </pre></blockquote> 1786 ** </pre></blockquote>)^
1615 ** 1787 **
1616 ** The sqlite3_get_table() function evaluates one or more 1788 ** ^The sqlite3_get_table() function evaluates one or more
1617 ** semicolon-separated SQL statements in the zero-terminated UTF-8 1789 ** semicolon-separated SQL statements in the zero-terminated UTF-8
1618 ** string of its 2nd parameter. It returns a result table to the 1790 ** string of its 2nd parameter and returns a result table to the
1619 ** pointer given in its 3rd parameter. 1791 ** pointer given in its 3rd parameter.
1620 ** 1792 **
1621 ** After the calling function has finished using the result, it should 1793 ** After the application has finished with the result from sqlite3_get_table(),
1622 ** pass the pointer to the result table to sqlite3_free_table() in order to 1794 ** it must pass the result table pointer to sqlite3_free_table() in order to
1623 ** release the memory that was malloced. Because of the way the 1795 ** release the memory that was malloced. Because of the way the
1624 ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling 1796 ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
1625 ** function must not try to call [sqlite3_free()] directly. Only 1797 ** function must not try to call [sqlite3_free()] directly. Only
1626 ** [sqlite3_free_table()] is able to release the memory properly and safely. 1798 ** [sqlite3_free_table()] is able to release the memory properly and safely.
1627 ** 1799 **
1628 ** The sqlite3_get_table() interface is implemented as a wrapper around 1800 ** The sqlite3_get_table() interface is implemented as a wrapper around
1629 ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access 1801 ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
1630 ** to any internal data structures of SQLite. It uses only the public 1802 ** to any internal data structures of SQLite. It uses only the public
1631 ** interface defined here. As a consequence, errors that occur in the 1803 ** interface defined here. As a consequence, errors that occur in the
1632 ** wrapper layer outside of the internal [sqlite3_exec()] call are not 1804 ** wrapper layer outside of the internal [sqlite3_exec()] call are not
1633 ** reflected in subsequent calls to [sqlite3_errcode()] or [sqlite3_errmsg()]. 1805 ** reflected in subsequent calls to [sqlite3_errcode()] or
1634 ** 1806 ** [sqlite3_errmsg()].
1635 ** Requirements:
1636 ** [H12371] [H12373] [H12374] [H12376] [H12379] [H12382]
1637 */ 1807 */
1638 SQLITE_API int sqlite3_get_table( 1808 SQLITE_API int sqlite3_get_table(
1639 sqlite3 *db, /* An open database */ 1809 sqlite3 *db, /* An open database */
1640 const char *zSql, /* SQL to be evaluated */ 1810 const char *zSql, /* SQL to be evaluated */
1641 char ***pazResult, /* Results of the query */ 1811 char ***pazResult, /* Results of the query */
1642 int *pnRow, /* Number of result rows written here */ 1812 int *pnRow, /* Number of result rows written here */
1643 int *pnColumn, /* Number of result columns written here */ 1813 int *pnColumn, /* Number of result columns written here */
1644 char **pzErrmsg /* Error msg written here */ 1814 char **pzErrmsg /* Error msg written here */
1645 ); 1815 );
1646 SQLITE_API void sqlite3_free_table(char **result); 1816 SQLITE_API void sqlite3_free_table(char **result);
1647 1817
1648 /* 1818 /*
1649 ** CAPI3REF: Formatted String Printing Functions {H17400} <S70000><S20000> 1819 ** CAPI3REF: Formatted String Printing Functions
1650 ** 1820 **
1651 ** These routines are work-alikes of the "printf()" family of functions 1821 ** These routines are work-alikes of the "printf()" family of functions
1652 ** from the standard C library. 1822 ** from the standard C library.
1653 ** 1823 **
1654 ** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their 1824 ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
1655 ** results into memory obtained from [sqlite3_malloc()]. 1825 ** results into memory obtained from [sqlite3_malloc()].
1656 ** The strings returned by these two routines should be 1826 ** The strings returned by these two routines should be
1657 ** released by [sqlite3_free()]. Both routines return a 1827 ** released by [sqlite3_free()]. ^Both routines return a
1658 ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough 1828 ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
1659 ** memory to hold the resulting string. 1829 ** memory to hold the resulting string.
1660 ** 1830 **
1661 ** In sqlite3_snprintf() routine is similar to "snprintf()" from 1831 ** ^(In sqlite3_snprintf() routine is similar to "snprintf()" from
1662 ** the standard C library. The result is written into the 1832 ** the standard C library. The result is written into the
1663 ** buffer supplied as the second parameter whose size is given by 1833 ** buffer supplied as the second parameter whose size is given by
1664 ** the first parameter. Note that the order of the 1834 ** the first parameter. Note that the order of the
1665 ** first two parameters is reversed from snprintf(). This is an 1835 ** first two parameters is reversed from snprintf().)^ This is an
1666 ** historical accident that cannot be fixed without breaking 1836 ** historical accident that cannot be fixed without breaking
1667 ** backwards compatibility. Note also that sqlite3_snprintf() 1837 ** backwards compatibility. ^(Note also that sqlite3_snprintf()
1668 ** returns a pointer to its buffer instead of the number of 1838 ** returns a pointer to its buffer instead of the number of
1669 ** characters actually written into the buffer. We admit that 1839 ** characters actually written into the buffer.)^ We admit that
1670 ** the number of characters written would be a more useful return 1840 ** the number of characters written would be a more useful return
1671 ** value but we cannot change the implementation of sqlite3_snprintf() 1841 ** value but we cannot change the implementation of sqlite3_snprintf()
1672 ** now without breaking compatibility. 1842 ** now without breaking compatibility.
1673 ** 1843 **
1674 ** As long as the buffer size is greater than zero, sqlite3_snprintf() 1844 ** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
1675 ** guarantees that the buffer is always zero-terminated. The first 1845 ** guarantees that the buffer is always zero-terminated. ^The first
1676 ** parameter "n" is the total size of the buffer, including space for 1846 ** parameter "n" is the total size of the buffer, including space for
1677 ** the zero terminator. So the longest string that can be completely 1847 ** the zero terminator. So the longest string that can be completely
1678 ** written will be n-1 characters. 1848 ** written will be n-1 characters.
1679 ** 1849 **
1680 ** These routines all implement some additional formatting 1850 ** These routines all implement some additional formatting
1681 ** options that are useful for constructing SQL statements. 1851 ** options that are useful for constructing SQL statements.
1682 ** All of the usual printf() formatting options apply. In addition, there 1852 ** All of the usual printf() formatting options apply. In addition, there
1683 ** is are "%q", "%Q", and "%z" options. 1853 ** is are "%q", "%Q", and "%z" options.
1684 ** 1854 **
1685 ** The %q option works like %s in that it substitutes a null-terminated 1855 ** ^(The %q option works like %s in that it substitutes a null-terminated
1686 ** string from the argument list. But %q also doubles every '\'' character. 1856 ** string from the argument list. But %q also doubles every '\'' character.
1687 ** %q is designed for use inside a string literal. By doubling each '\'' 1857 ** %q is designed for use inside a string literal.)^ By doubling each '\''
1688 ** character it escapes that character and allows it to be inserted into 1858 ** character it escapes that character and allows it to be inserted into
1689 ** the string. 1859 ** the string.
1690 ** 1860 **
1691 ** For example, assume the string variable zText contains text as follows: 1861 ** For example, assume the string variable zText contains text as follows:
1692 ** 1862 **
1693 ** <blockquote><pre> 1863 ** <blockquote><pre>
1694 ** char *zText = "It's a happy day!"; 1864 ** char *zText = "It's a happy day!";
1695 ** </pre></blockquote> 1865 ** </pre></blockquote>
1696 ** 1866 **
1697 ** One can use this text in an SQL statement as follows: 1867 ** One can use this text in an SQL statement as follows:
(...skipping 14 matching lines...) Expand all
1712 ** This is correct. Had we used %s instead of %q, the generated SQL 1882 ** This is correct. Had we used %s instead of %q, the generated SQL
1713 ** would have looked like this: 1883 ** would have looked like this:
1714 ** 1884 **
1715 ** <blockquote><pre> 1885 ** <blockquote><pre>
1716 ** INSERT INTO table1 VALUES('It's a happy day!'); 1886 ** INSERT INTO table1 VALUES('It's a happy day!');
1717 ** </pre></blockquote> 1887 ** </pre></blockquote>
1718 ** 1888 **
1719 ** This second example is an SQL syntax error. As a general rule you should 1889 ** This second example is an SQL syntax error. As a general rule you should
1720 ** always use %q instead of %s when inserting text into a string literal. 1890 ** always use %q instead of %s when inserting text into a string literal.
1721 ** 1891 **
1722 ** The %Q option works like %q except it also adds single quotes around 1892 ** ^(The %Q option works like %q except it also adds single quotes around
1723 ** the outside of the total string. Additionally, if the parameter in the 1893 ** the outside of the total string. Additionally, if the parameter in the
1724 ** argument list is a NULL pointer, %Q substitutes the text "NULL" (without 1894 ** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
1725 ** single quotes) in place of the %Q option. So, for example, one could say: 1895 ** single quotes).)^ So, for example, one could say:
1726 ** 1896 **
1727 ** <blockquote><pre> 1897 ** <blockquote><pre>
1728 ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); 1898 ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
1729 ** sqlite3_exec(db, zSQL, 0, 0, 0); 1899 ** sqlite3_exec(db, zSQL, 0, 0, 0);
1730 ** sqlite3_free(zSQL); 1900 ** sqlite3_free(zSQL);
1731 ** </pre></blockquote> 1901 ** </pre></blockquote>
1732 ** 1902 **
1733 ** The code above will render a correct SQL statement in the zSQL 1903 ** The code above will render a correct SQL statement in the zSQL
1734 ** variable even if the zText variable is a NULL pointer. 1904 ** variable even if the zText variable is a NULL pointer.
1735 ** 1905 **
1736 ** The "%z" formatting option works exactly like "%s" with the 1906 ** ^(The "%z" formatting option works like "%s" but with the
1737 ** addition that after the string has been read and copied into 1907 ** addition that after the string has been read and copied into
1738 ** the result, [sqlite3_free()] is called on the input string. {END} 1908 ** the result, [sqlite3_free()] is called on the input string.)^
1739 **
1740 ** Requirements:
1741 ** [H17403] [H17406] [H17407]
1742 */ 1909 */
1743 SQLITE_API char *sqlite3_mprintf(const char*,...); 1910 SQLITE_API char *sqlite3_mprintf(const char*,...);
1744 SQLITE_API char *sqlite3_vmprintf(const char*, va_list); 1911 SQLITE_API char *sqlite3_vmprintf(const char*, va_list);
1745 SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...); 1912 SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);
1746 1913
1747 /* 1914 /*
1748 ** CAPI3REF: Memory Allocation Subsystem {H17300} <S20000> 1915 ** CAPI3REF: Memory Allocation Subsystem
1749 ** 1916 **
1750 ** The SQLite core uses these three routines for all of its own 1917 ** The SQLite core uses these three routines for all of its own
1751 ** internal memory allocation needs. "Core" in the previous sentence 1918 ** internal memory allocation needs. "Core" in the previous sentence
1752 ** does not include operating-system specific VFS implementation. The 1919 ** does not include operating-system specific VFS implementation. The
1753 ** Windows VFS uses native malloc() and free() for some operations. 1920 ** Windows VFS uses native malloc() and free() for some operations.
1754 ** 1921 **
1755 ** The sqlite3_malloc() routine returns a pointer to a block 1922 ** ^The sqlite3_malloc() routine returns a pointer to a block
1756 ** of memory at least N bytes in length, where N is the parameter. 1923 ** of memory at least N bytes in length, where N is the parameter.
1757 ** If sqlite3_malloc() is unable to obtain sufficient free 1924 ** ^If sqlite3_malloc() is unable to obtain sufficient free
1758 ** memory, it returns a NULL pointer. If the parameter N to 1925 ** memory, it returns a NULL pointer. ^If the parameter N to
1759 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns 1926 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1760 ** a NULL pointer. 1927 ** a NULL pointer.
1761 ** 1928 **
1762 ** Calling sqlite3_free() with a pointer previously returned 1929 ** ^Calling sqlite3_free() with a pointer previously returned
1763 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so 1930 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
1764 ** that it might be reused. The sqlite3_free() routine is 1931 ** that it might be reused. ^The sqlite3_free() routine is
1765 ** a no-op if is called with a NULL pointer. Passing a NULL pointer 1932 ** a no-op if is called with a NULL pointer. Passing a NULL pointer
1766 ** to sqlite3_free() is harmless. After being freed, memory 1933 ** to sqlite3_free() is harmless. After being freed, memory
1767 ** should neither be read nor written. Even reading previously freed 1934 ** should neither be read nor written. Even reading previously freed
1768 ** memory might result in a segmentation fault or other severe error. 1935 ** memory might result in a segmentation fault or other severe error.
1769 ** Memory corruption, a segmentation fault, or other severe error 1936 ** Memory corruption, a segmentation fault, or other severe error
1770 ** might result if sqlite3_free() is called with a non-NULL pointer that 1937 ** might result if sqlite3_free() is called with a non-NULL pointer that
1771 ** was not obtained from sqlite3_malloc() or sqlite3_realloc(). 1938 ** was not obtained from sqlite3_malloc() or sqlite3_realloc().
1772 ** 1939 **
1773 ** The sqlite3_realloc() interface attempts to resize a 1940 ** ^(The sqlite3_realloc() interface attempts to resize a
1774 ** prior memory allocation to be at least N bytes, where N is the 1941 ** prior memory allocation to be at least N bytes, where N is the
1775 ** second parameter. The memory allocation to be resized is the first 1942 ** second parameter. The memory allocation to be resized is the first
1776 ** parameter. If the first parameter to sqlite3_realloc() 1943 ** parameter.)^ ^ If the first parameter to sqlite3_realloc()
1777 ** is a NULL pointer then its behavior is identical to calling 1944 ** is a NULL pointer then its behavior is identical to calling
1778 ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). 1945 ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
1779 ** If the second parameter to sqlite3_realloc() is zero or 1946 ** ^If the second parameter to sqlite3_realloc() is zero or
1780 ** negative then the behavior is exactly the same as calling 1947 ** negative then the behavior is exactly the same as calling
1781 ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). 1948 ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
1782 ** sqlite3_realloc() returns a pointer to a memory allocation 1949 ** ^sqlite3_realloc() returns a pointer to a memory allocation
1783 ** of at least N bytes in size or NULL if sufficient memory is unavailable. 1950 ** of at least N bytes in size or NULL if sufficient memory is unavailable.
1784 ** If M is the size of the prior allocation, then min(N,M) bytes 1951 ** ^If M is the size of the prior allocation, then min(N,M) bytes
1785 ** of the prior allocation are copied into the beginning of buffer returned 1952 ** of the prior allocation are copied into the beginning of buffer returned
1786 ** by sqlite3_realloc() and the prior allocation is freed. 1953 ** by sqlite3_realloc() and the prior allocation is freed.
1787 ** If sqlite3_realloc() returns NULL, then the prior allocation 1954 ** ^If sqlite3_realloc() returns NULL, then the prior allocation
1788 ** is not freed. 1955 ** is not freed.
1789 ** 1956 **
1790 ** The memory returned by sqlite3_malloc() and sqlite3_realloc() 1957 ** ^The memory returned by sqlite3_malloc() and sqlite3_realloc()
1791 ** is always aligned to at least an 8 byte boundary. {END} 1958 ** is always aligned to at least an 8 byte boundary, or to a
1792 ** 1959 ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
1793 ** The default implementation of the memory allocation subsystem uses 1960 ** option is used.
1794 ** the malloc(), realloc() and free() provided by the standard C library.
1795 ** {H17382} However, if SQLite is compiled with the
1796 ** SQLITE_MEMORY_SIZE=<i>NNN</i> C preprocessor macro (where <i>NNN</i>
1797 ** is an integer), then SQLite create a static array of at least
1798 ** <i>NNN</i> bytes in size and uses that array for all of its dynamic
1799 ** memory allocation needs. {END} Additional memory allocator options
1800 ** may be added in future releases.
1801 ** 1961 **
1802 ** In SQLite version 3.5.0 and 3.5.1, it was possible to define 1962 ** In SQLite version 3.5.0 and 3.5.1, it was possible to define
1803 ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in 1963 ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
1804 ** implementation of these routines to be omitted. That capability 1964 ** implementation of these routines to be omitted. That capability
1805 ** is no longer provided. Only built-in memory allocators can be used. 1965 ** is no longer provided. Only built-in memory allocators can be used.
1806 ** 1966 **
1807 ** The Windows OS interface layer calls 1967 ** The Windows OS interface layer calls
1808 ** the system malloc() and free() directly when converting 1968 ** the system malloc() and free() directly when converting
1809 ** filenames between the UTF-8 encoding used by SQLite 1969 ** filenames between the UTF-8 encoding used by SQLite
1810 ** and whatever filename encoding is used by the particular Windows 1970 ** and whatever filename encoding is used by the particular Windows
1811 ** installation. Memory allocation errors are detected, but 1971 ** installation. Memory allocation errors are detected, but
1812 ** they are reported back as [SQLITE_CANTOPEN] or 1972 ** they are reported back as [SQLITE_CANTOPEN] or
1813 ** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. 1973 ** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
1814 ** 1974 **
1815 ** Requirements:
1816 ** [H17303] [H17304] [H17305] [H17306] [H17310] [H17312] [H17315] [H17318]
1817 ** [H17321] [H17322] [H17323]
1818 **
1819 ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] 1975 ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
1820 ** must be either NULL or else pointers obtained from a prior 1976 ** must be either NULL or else pointers obtained from a prior
1821 ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have 1977 ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
1822 ** not yet been released. 1978 ** not yet been released.
1823 ** 1979 **
1824 ** The application must not read or write any part of 1980 ** The application must not read or write any part of
1825 ** a block of memory after it has been released using 1981 ** a block of memory after it has been released using
1826 ** [sqlite3_free()] or [sqlite3_realloc()]. 1982 ** [sqlite3_free()] or [sqlite3_realloc()].
1827 */ 1983 */
1828 SQLITE_API void *sqlite3_malloc(int); 1984 SQLITE_API void *sqlite3_malloc(int);
1829 SQLITE_API void *sqlite3_realloc(void*, int); 1985 SQLITE_API void *sqlite3_realloc(void*, int);
1830 SQLITE_API void sqlite3_free(void*); 1986 SQLITE_API void sqlite3_free(void*);
1831 1987
1832 /* 1988 /*
1833 ** CAPI3REF: Memory Allocator Statistics {H17370} <S30210> 1989 ** CAPI3REF: Memory Allocator Statistics
1834 ** 1990 **
1835 ** SQLite provides these two interfaces for reporting on the status 1991 ** SQLite provides these two interfaces for reporting on the status
1836 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] 1992 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
1837 ** routines, which form the built-in memory allocation subsystem. 1993 ** routines, which form the built-in memory allocation subsystem.
1838 ** 1994 **
1839 ** Requirements: 1995 ** ^The [sqlite3_memory_used()] routine returns the number of bytes
1840 ** [H17371] [H17373] [H17374] [H17375] 1996 ** of memory currently outstanding (malloced but not freed).
1997 ** ^The [sqlite3_memory_highwater()] routine returns the maximum
1998 ** value of [sqlite3_memory_used()] since the high-water mark
1999 ** was last reset. ^The values returned by [sqlite3_memory_used()] and
2000 ** [sqlite3_memory_highwater()] include any overhead
2001 ** added by SQLite in its implementation of [sqlite3_malloc()],
2002 ** but not overhead added by the any underlying system library
2003 ** routines that [sqlite3_malloc()] may call.
2004 **
2005 ** ^The memory high-water mark is reset to the current value of
2006 ** [sqlite3_memory_used()] if and only if the parameter to
2007 ** [sqlite3_memory_highwater()] is true. ^The value returned
2008 ** by [sqlite3_memory_highwater(1)] is the high-water mark
2009 ** prior to the reset.
1841 */ 2010 */
1842 SQLITE_API sqlite3_int64 sqlite3_memory_used(void); 2011 SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
1843 SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag); 2012 SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
1844 2013
1845 /* 2014 /*
1846 ** CAPI3REF: Pseudo-Random Number Generator {H17390} <S20000> 2015 ** CAPI3REF: Pseudo-Random Number Generator
1847 ** 2016 **
1848 ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to 2017 ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
1849 ** select random [ROWID | ROWIDs] when inserting new records into a table that 2018 ** select random [ROWID | ROWIDs] when inserting new records into a table that
1850 ** already uses the largest possible [ROWID]. The PRNG is also used for 2019 ** already uses the largest possible [ROWID]. The PRNG is also used for
1851 ** the build-in random() and randomblob() SQL functions. This interface allows 2020 ** the build-in random() and randomblob() SQL functions. This interface allows
1852 ** applications to access the same PRNG for other purposes. 2021 ** applications to access the same PRNG for other purposes.
1853 ** 2022 **
1854 ** A call to this routine stores N bytes of randomness into buffer P. 2023 ** ^A call to this routine stores N bytes of randomness into buffer P.
1855 ** 2024 **
1856 ** The first time this routine is invoked (either internally or by 2025 ** ^The first time this routine is invoked (either internally or by
1857 ** the application) the PRNG is seeded using randomness obtained 2026 ** the application) the PRNG is seeded using randomness obtained
1858 ** from the xRandomness method of the default [sqlite3_vfs] object. 2027 ** from the xRandomness method of the default [sqlite3_vfs] object.
1859 ** On all subsequent invocations, the pseudo-randomness is generated 2028 ** ^On all subsequent invocations, the pseudo-randomness is generated
1860 ** internally and without recourse to the [sqlite3_vfs] xRandomness 2029 ** internally and without recourse to the [sqlite3_vfs] xRandomness
1861 ** method. 2030 ** method.
1862 **
1863 ** Requirements:
1864 ** [H17392]
1865 */ 2031 */
1866 SQLITE_API void sqlite3_randomness(int N, void *P); 2032 SQLITE_API void sqlite3_randomness(int N, void *P);
1867 2033
1868 /* 2034 /*
1869 ** CAPI3REF: Compile-Time Authorization Callbacks {H12500} <S70100> 2035 ** CAPI3REF: Compile-Time Authorization Callbacks
1870 ** 2036 **
1871 ** This routine registers a authorizer callback with a particular 2037 ** ^This routine registers a authorizer callback with a particular
1872 ** [database connection], supplied in the first argument. 2038 ** [database connection], supplied in the first argument.
1873 ** The authorizer callback is invoked as SQL statements are being compiled 2039 ** ^The authorizer callback is invoked as SQL statements are being compiled
1874 ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], 2040 ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
1875 ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various 2041 ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various
1876 ** points during the compilation process, as logic is being created 2042 ** points during the compilation process, as logic is being created
1877 ** to perform various actions, the authorizer callback is invoked to 2043 ** to perform various actions, the authorizer callback is invoked to
1878 ** see if those actions are allowed. The authorizer callback should 2044 ** see if those actions are allowed. ^The authorizer callback should
1879 ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the 2045 ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
1880 ** specific action but allow the SQL statement to continue to be 2046 ** specific action but allow the SQL statement to continue to be
1881 ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be 2047 ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
1882 ** rejected with an error. If the authorizer callback returns 2048 ** rejected with an error. ^If the authorizer callback returns
1883 ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] 2049 ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
1884 ** then the [sqlite3_prepare_v2()] or equivalent call that triggered 2050 ** then the [sqlite3_prepare_v2()] or equivalent call that triggered
1885 ** the authorizer will fail with an error message. 2051 ** the authorizer will fail with an error message.
1886 ** 2052 **
1887 ** When the callback returns [SQLITE_OK], that means the operation 2053 ** When the callback returns [SQLITE_OK], that means the operation
1888 ** requested is ok. When the callback returns [SQLITE_DENY], the 2054 ** requested is ok. ^When the callback returns [SQLITE_DENY], the
1889 ** [sqlite3_prepare_v2()] or equivalent call that triggered the 2055 ** [sqlite3_prepare_v2()] or equivalent call that triggered the
1890 ** authorizer will fail with an error message explaining that 2056 ** authorizer will fail with an error message explaining that
1891 ** access is denied. 2057 ** access is denied.
1892 ** 2058 **
1893 ** The first parameter to the authorizer callback is a copy of the third 2059 ** ^The first parameter to the authorizer callback is a copy of the third
1894 ** parameter to the sqlite3_set_authorizer() interface. The second parameter 2060 ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
1895 ** to the callback is an integer [SQLITE_COPY | action code] that specifies 2061 ** to the callback is an integer [SQLITE_COPY | action code] that specifies
1896 ** the particular action to be authorized. The third through sixth parameters 2062 ** the particular action to be authorized. ^The third through sixth parameters
1897 ** to the callback are zero-terminated strings that contain additional 2063 ** to the callback are zero-terminated strings that contain additional
1898 ** details about the action to be authorized. 2064 ** details about the action to be authorized.
1899 ** 2065 **
1900 ** If the action code is [SQLITE_READ] 2066 ** ^If the action code is [SQLITE_READ]
1901 ** and the callback returns [SQLITE_IGNORE] then the 2067 ** and the callback returns [SQLITE_IGNORE] then the
1902 ** [prepared statement] statement is constructed to substitute 2068 ** [prepared statement] statement is constructed to substitute
1903 ** a NULL value in place of the table column that would have 2069 ** a NULL value in place of the table column that would have
1904 ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] 2070 ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
1905 ** return can be used to deny an untrusted user access to individual 2071 ** return can be used to deny an untrusted user access to individual
1906 ** columns of a table. 2072 ** columns of a table.
1907 ** If the action code is [SQLITE_DELETE] and the callback returns 2073 ** ^If the action code is [SQLITE_DELETE] and the callback returns
1908 ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the 2074 ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
1909 ** [truncate optimization] is disabled and all rows are deleted individually. 2075 ** [truncate optimization] is disabled and all rows are deleted individually.
1910 ** 2076 **
1911 ** An authorizer is used when [sqlite3_prepare | preparing] 2077 ** An authorizer is used when [sqlite3_prepare | preparing]
1912 ** SQL statements from an untrusted source, to ensure that the SQL statements 2078 ** SQL statements from an untrusted source, to ensure that the SQL statements
1913 ** do not try to access data they are not allowed to see, or that they do not 2079 ** do not try to access data they are not allowed to see, or that they do not
1914 ** try to execute malicious statements that damage the database. For 2080 ** try to execute malicious statements that damage the database. For
1915 ** example, an application may allow a user to enter arbitrary 2081 ** example, an application may allow a user to enter arbitrary
1916 ** SQL queries for evaluation by a database. But the application does 2082 ** SQL queries for evaluation by a database. But the application does
1917 ** not want the user to be able to make arbitrary changes to the 2083 ** not want the user to be able to make arbitrary changes to the
1918 ** database. An authorizer could then be put in place while the 2084 ** database. An authorizer could then be put in place while the
1919 ** user-entered SQL is being [sqlite3_prepare | prepared] that 2085 ** user-entered SQL is being [sqlite3_prepare | prepared] that
1920 ** disallows everything except [SELECT] statements. 2086 ** disallows everything except [SELECT] statements.
1921 ** 2087 **
1922 ** Applications that need to process SQL from untrusted sources 2088 ** Applications that need to process SQL from untrusted sources
1923 ** might also consider lowering resource limits using [sqlite3_limit()] 2089 ** might also consider lowering resource limits using [sqlite3_limit()]
1924 ** and limiting database size using the [max_page_count] [PRAGMA] 2090 ** and limiting database size using the [max_page_count] [PRAGMA]
1925 ** in addition to using an authorizer. 2091 ** in addition to using an authorizer.
1926 ** 2092 **
1927 ** Only a single authorizer can be in place on a database connection 2093 ** ^(Only a single authorizer can be in place on a database connection
1928 ** at a time. Each call to sqlite3_set_authorizer overrides the 2094 ** at a time. Each call to sqlite3_set_authorizer overrides the
1929 ** previous call. Disable the authorizer by installing a NULL callback. 2095 ** previous call.)^ ^Disable the authorizer by installing a NULL callback.
1930 ** The authorizer is disabled by default. 2096 ** The authorizer is disabled by default.
1931 ** 2097 **
1932 ** The authorizer callback must not do anything that will modify 2098 ** The authorizer callback must not do anything that will modify
1933 ** the database connection that invoked the authorizer callback. 2099 ** the database connection that invoked the authorizer callback.
1934 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2100 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1935 ** database connections for the meaning of "modify" in this paragraph. 2101 ** database connections for the meaning of "modify" in this paragraph.
1936 ** 2102 **
1937 ** When [sqlite3_prepare_v2()] is used to prepare a statement, the 2103 ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
1938 ** statement might be re-prepared during [sqlite3_step()] due to a 2104 ** statement might be re-prepared during [sqlite3_step()] due to a
1939 ** schema change. Hence, the application should ensure that the 2105 ** schema change. Hence, the application should ensure that the
1940 ** correct authorizer callback remains in place during the [sqlite3_step()]. 2106 ** correct authorizer callback remains in place during the [sqlite3_step()].
1941 ** 2107 **
1942 ** Note that the authorizer callback is invoked only during 2108 ** ^Note that the authorizer callback is invoked only during
1943 ** [sqlite3_prepare()] or its variants. Authorization is not 2109 ** [sqlite3_prepare()] or its variants. Authorization is not
1944 ** performed during statement evaluation in [sqlite3_step()], unless 2110 ** performed during statement evaluation in [sqlite3_step()], unless
1945 ** as stated in the previous paragraph, sqlite3_step() invokes 2111 ** as stated in the previous paragraph, sqlite3_step() invokes
1946 ** sqlite3_prepare_v2() to reprepare a statement after a schema change. 2112 ** sqlite3_prepare_v2() to reprepare a statement after a schema change.
1947 **
1948 ** Requirements:
1949 ** [H12501] [H12502] [H12503] [H12504] [H12505] [H12506] [H12507] [H12510]
1950 ** [H12511] [H12512] [H12520] [H12521] [H12522]
1951 */ 2113 */
1952 SQLITE_API int sqlite3_set_authorizer( 2114 SQLITE_API int sqlite3_set_authorizer(
1953 sqlite3*, 2115 sqlite3*,
1954 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), 2116 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
1955 void *pUserData 2117 void *pUserData
1956 ); 2118 );
1957 2119
1958 /* 2120 /*
1959 ** CAPI3REF: Authorizer Return Codes {H12590} <H12500> 2121 ** CAPI3REF: Authorizer Return Codes
1960 ** 2122 **
1961 ** The [sqlite3_set_authorizer | authorizer callback function] must 2123 ** The [sqlite3_set_authorizer | authorizer callback function] must
1962 ** return either [SQLITE_OK] or one of these two constants in order 2124 ** return either [SQLITE_OK] or one of these two constants in order
1963 ** to signal SQLite whether or not the action is permitted. See the 2125 ** to signal SQLite whether or not the action is permitted. See the
1964 ** [sqlite3_set_authorizer | authorizer documentation] for additional 2126 ** [sqlite3_set_authorizer | authorizer documentation] for additional
1965 ** information. 2127 ** information.
1966 */ 2128 */
1967 #define SQLITE_DENY 1 /* Abort the SQL statement with an error */ 2129 #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
1968 #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ 2130 #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
1969 2131
1970 /* 2132 /*
1971 ** CAPI3REF: Authorizer Action Codes {H12550} <H12500> 2133 ** CAPI3REF: Authorizer Action Codes
1972 ** 2134 **
1973 ** The [sqlite3_set_authorizer()] interface registers a callback function 2135 ** The [sqlite3_set_authorizer()] interface registers a callback function
1974 ** that is invoked to authorize certain SQL statement actions. The 2136 ** that is invoked to authorize certain SQL statement actions. The
1975 ** second parameter to the callback is an integer code that specifies 2137 ** second parameter to the callback is an integer code that specifies
1976 ** what action is being authorized. These are the integer action codes that 2138 ** what action is being authorized. These are the integer action codes that
1977 ** the authorizer callback may be passed. 2139 ** the authorizer callback may be passed.
1978 ** 2140 **
1979 ** These action code values signify what kind of operation is to be 2141 ** These action code values signify what kind of operation is to be
1980 ** authorized. The 3rd and 4th parameters to the authorization 2142 ** authorized. The 3rd and 4th parameters to the authorization
1981 ** callback function will be parameters or NULL depending on which of these 2143 ** callback function will be parameters or NULL depending on which of these
1982 ** codes is used as the second parameter. The 5th parameter to the 2144 ** codes is used as the second parameter. ^(The 5th parameter to the
1983 ** authorizer callback is the name of the database ("main", "temp", 2145 ** authorizer callback is the name of the database ("main", "temp",
1984 ** etc.) if applicable. The 6th parameter to the authorizer callback 2146 ** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
1985 ** is the name of the inner-most trigger or view that is responsible for 2147 ** is the name of the inner-most trigger or view that is responsible for
1986 ** the access attempt or NULL if this access attempt is directly from 2148 ** the access attempt or NULL if this access attempt is directly from
1987 ** top-level SQL code. 2149 ** top-level SQL code.
1988 **
1989 ** Requirements:
1990 ** [H12551] [H12552] [H12553] [H12554]
1991 */ 2150 */
1992 /******************************************* 3rd ************ 4th ***********/ 2151 /******************************************* 3rd ************ 4th ***********/
1993 #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ 2152 #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
1994 #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ 2153 #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
1995 #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ 2154 #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
1996 #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ 2155 #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
1997 #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ 2156 #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
1998 #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ 2157 #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
1999 #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ 2158 #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
2000 #define SQLITE_CREATE_VIEW 8 /* View Name NULL */ 2159 #define SQLITE_CREATE_VIEW 8 /* View Name NULL */
(...skipping 17 matching lines...) Expand all
2018 #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ 2177 #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
2019 #define SQLITE_REINDEX 27 /* Index Name NULL */ 2178 #define SQLITE_REINDEX 27 /* Index Name NULL */
2020 #define SQLITE_ANALYZE 28 /* Table Name NULL */ 2179 #define SQLITE_ANALYZE 28 /* Table Name NULL */
2021 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ 2180 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
2022 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ 2181 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
2023 #define SQLITE_FUNCTION 31 /* NULL Function Name */ 2182 #define SQLITE_FUNCTION 31 /* NULL Function Name */
2024 #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ 2183 #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
2025 #define SQLITE_COPY 0 /* No longer used */ 2184 #define SQLITE_COPY 0 /* No longer used */
2026 2185
2027 /* 2186 /*
2028 ** CAPI3REF: Tracing And Profiling Functions {H12280} <S60400> 2187 ** CAPI3REF: Tracing And Profiling Functions
2029 ** EXPERIMENTAL
2030 ** 2188 **
2031 ** These routines register callback functions that can be used for 2189 ** These routines register callback functions that can be used for
2032 ** tracing and profiling the execution of SQL statements. 2190 ** tracing and profiling the execution of SQL statements.
2033 ** 2191 **
2034 ** The callback function registered by sqlite3_trace() is invoked at 2192 ** ^The callback function registered by sqlite3_trace() is invoked at
2035 ** various times when an SQL statement is being run by [sqlite3_step()]. 2193 ** various times when an SQL statement is being run by [sqlite3_step()].
2036 ** The callback returns a UTF-8 rendering of the SQL statement text 2194 ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
2037 ** as the statement first begins executing. Additional callbacks occur 2195 ** SQL statement text as the statement first begins executing.
2196 ** ^(Additional sqlite3_trace() callbacks might occur
2038 ** as each triggered subprogram is entered. The callbacks for triggers 2197 ** as each triggered subprogram is entered. The callbacks for triggers
2039 ** contain a UTF-8 SQL comment that identifies the trigger. 2198 ** contain a UTF-8 SQL comment that identifies the trigger.)^
2040 ** 2199 **
2041 ** The callback function registered by sqlite3_profile() is invoked 2200 ** ^The callback function registered by sqlite3_profile() is invoked
2042 ** as each SQL statement finishes. The profile callback contains 2201 ** as each SQL statement finishes. ^The profile callback contains
2043 ** the original statement text and an estimate of wall-clock time 2202 ** the original statement text and an estimate of wall-clock time
2044 ** of how long that statement took to run. 2203 ** of how long that statement took to run. ^The profile callback
2045 ** 2204 ** time is in units of nanoseconds, however the current implementation
2046 ** Requirements: 2205 ** is only capable of millisecond resolution so the six least significant
2047 ** [H12281] [H12282] [H12283] [H12284] [H12285] [H12287] [H12288] [H12289] 2206 ** digits in the time are meaningless. Future versions of SQLite
2048 ** [H12290] 2207 ** might provide greater resolution on the profiler callback. The
2208 ** sqlite3_profile() function is considered experimental and is
2209 ** subject to change in future versions of SQLite.
2049 */ 2210 */
2050 SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_trace(sqlite3*, void(*xTrace)(void* ,const char*), void*); 2211 SQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void* );
2051 SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, 2212 SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*,
2052 void(*xProfile)(void*,const char*,sqlite3_uint64), void*); 2213 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
2053 2214
2054 /* 2215 /*
2055 ** CAPI3REF: Query Progress Callbacks {H12910} <S60400> 2216 ** CAPI3REF: Query Progress Callbacks
2056 ** 2217 **
2057 ** This routine configures a callback function - the 2218 ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
2058 ** progress callback - that is invoked periodically during long 2219 ** function X to be invoked periodically during long running calls to
2059 ** running calls to [sqlite3_exec()], [sqlite3_step()] and 2220 ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
2060 ** [sqlite3_get_table()]. An example use for this 2221 ** database connection D. An example use for this
2061 ** interface is to keep a GUI updated during a large query. 2222 ** interface is to keep a GUI updated during a large query.
2062 ** 2223 **
2063 ** If the progress callback returns non-zero, the operation is 2224 ** ^The parameter P is passed through as the only parameter to the
2225 ** callback function X. ^The parameter N is the number of
2226 ** [virtual machine instructions] that are evaluated between successive
2227 ** invocations of the callback X.
2228 **
2229 ** ^Only a single progress handler may be defined at one time per
2230 ** [database connection]; setting a new progress handler cancels the
2231 ** old one. ^Setting parameter X to NULL disables the progress handler.
2232 ** ^The progress handler is also disabled by setting N to a value less
2233 ** than 1.
2234 **
2235 ** ^If the progress callback returns non-zero, the operation is
2064 ** interrupted. This feature can be used to implement a 2236 ** interrupted. This feature can be used to implement a
2065 ** "Cancel" button on a GUI progress dialog box. 2237 ** "Cancel" button on a GUI progress dialog box.
2066 ** 2238 **
2067 ** The progress handler must not do anything that will modify 2239 ** The progress handler callback must not do anything that will modify
2068 ** the database connection that invoked the progress handler. 2240 ** the database connection that invoked the progress handler.
2069 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2241 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
2070 ** database connections for the meaning of "modify" in this paragraph. 2242 ** database connections for the meaning of "modify" in this paragraph.
2071 ** 2243 **
2072 ** Requirements:
2073 ** [H12911] [H12912] [H12913] [H12914] [H12915] [H12916] [H12917] [H12918]
2074 **
2075 */ 2244 */
2076 SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); 2245 SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
2077 2246
2078 /* 2247 /*
2079 ** CAPI3REF: Opening A New Database Connection {H12700} <S40200> 2248 ** CAPI3REF: Opening A New Database Connection
2080 ** 2249 **
2081 ** These routines open an SQLite database file whose name is given by the 2250 ** ^These routines open an SQLite database file whose name is given by the
2082 ** filename argument. The filename argument is interpreted as UTF-8 for 2251 ** filename argument. ^The filename argument is interpreted as UTF-8 for
2083 ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte 2252 ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
2084 ** order for sqlite3_open16(). A [database connection] handle is usually 2253 ** order for sqlite3_open16(). ^(A [database connection] handle is usually
2085 ** returned in *ppDb, even if an error occurs. The only exception is that 2254 ** returned in *ppDb, even if an error occurs. The only exception is that
2086 ** if SQLite is unable to allocate memory to hold the [sqlite3] object, 2255 ** if SQLite is unable to allocate memory to hold the [sqlite3] object,
2087 ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] 2256 ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
2088 ** object. If the database is opened (and/or created) successfully, then 2257 ** object.)^ ^(If the database is opened (and/or created) successfully, then
2089 ** [SQLITE_OK] is returned. Otherwise an [error code] is returned. The 2258 ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
2090 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain 2259 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
2091 ** an English language description of the error. 2260 ** an English language description of the error following a failure of any
2261 ** of the sqlite3_open() routines.
2092 ** 2262 **
2093 ** The default encoding for the database will be UTF-8 if 2263 ** ^The default encoding for the database will be UTF-8 if
2094 ** sqlite3_open() or sqlite3_open_v2() is called and 2264 ** sqlite3_open() or sqlite3_open_v2() is called and
2095 ** UTF-16 in the native byte order if sqlite3_open16() is used. 2265 ** UTF-16 in the native byte order if sqlite3_open16() is used.
2096 ** 2266 **
2097 ** Whether or not an error occurs when it is opened, resources 2267 ** Whether or not an error occurs when it is opened, resources
2098 ** associated with the [database connection] handle should be released by 2268 ** associated with the [database connection] handle should be released by
2099 ** passing it to [sqlite3_close()] when it is no longer required. 2269 ** passing it to [sqlite3_close()] when it is no longer required.
2100 ** 2270 **
2101 ** The sqlite3_open_v2() interface works like sqlite3_open() 2271 ** The sqlite3_open_v2() interface works like sqlite3_open()
2102 ** except that it accepts two additional parameters for additional control 2272 ** except that it accepts two additional parameters for additional control
2103 ** over the new database connection. The flags parameter can take one of 2273 ** over the new database connection. ^(The flags parameter to
2274 ** sqlite3_open_v2() can take one of
2104 ** the following three values, optionally combined with the 2275 ** the following three values, optionally combined with the
2105 ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], 2276 ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE],
2106 ** and/or [SQLITE_OPEN_PRIVATECACHE] flags: 2277 ** and/or [SQLITE_OPEN_PRIVATECACHE] flags:)^
2107 ** 2278 **
2108 ** <dl> 2279 ** <dl>
2109 ** <dt>[SQLITE_OPEN_READONLY]</dt> 2280 ** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
2110 ** <dd>The database is opened in read-only mode. If the database does not 2281 ** <dd>The database is opened in read-only mode. If the database does not
2111 ** already exist, an error is returned.</dd> 2282 ** already exist, an error is returned.</dd>)^
2112 ** 2283 **
2113 ** <dt>[SQLITE_OPEN_READWRITE]</dt> 2284 ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
2114 ** <dd>The database is opened for reading and writing if possible, or reading 2285 ** <dd>The database is opened for reading and writing if possible, or reading
2115 ** only if the file is write protected by the operating system. In either 2286 ** only if the file is write protected by the operating system. In either
2116 ** case the database must already exist, otherwise an error is returned.</dd> 2287 ** case the database must already exist, otherwise an error is returned.</dd>)^
2117 ** 2288 **
2118 ** <dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> 2289 ** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
2119 ** <dd>The database is opened for reading and writing, and is creates it if 2290 ** <dd>The database is opened for reading and writing, and is creates it if
2120 ** it does not already exist. This is the behavior that is always used for 2291 ** it does not already exist. This is the behavior that is always used for
2121 ** sqlite3_open() and sqlite3_open16().</dd> 2292 ** sqlite3_open() and sqlite3_open16().</dd>)^
2122 ** </dl> 2293 ** </dl>
2123 ** 2294 **
2124 ** If the 3rd parameter to sqlite3_open_v2() is not one of the 2295 ** If the 3rd parameter to sqlite3_open_v2() is not one of the
2125 ** combinations shown above or one of the combinations shown above combined 2296 ** combinations shown above or one of the combinations shown above combined
2126 ** with the [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], 2297 ** with the [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX],
2127 ** [SQLITE_OPEN_SHAREDCACHE] and/or [SQLITE_OPEN_SHAREDCACHE] flags, 2298 ** [SQLITE_OPEN_SHAREDCACHE] and/or [SQLITE_OPEN_PRIVATECACHE] flags,
2128 ** then the behavior is undefined. 2299 ** then the behavior is undefined.
2129 ** 2300 **
2130 ** If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection 2301 ** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
2131 ** opens in the multi-thread [threading mode] as long as the single-thread 2302 ** opens in the multi-thread [threading mode] as long as the single-thread
2132 ** mode has not been set at compile-time or start-time. If the 2303 ** mode has not been set at compile-time or start-time. ^If the
2133 ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens 2304 ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
2134 ** in the serialized [threading mode] unless single-thread was 2305 ** in the serialized [threading mode] unless single-thread was
2135 ** previously selected at compile-time or start-time. 2306 ** previously selected at compile-time or start-time.
2136 ** The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be 2307 ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be
2137 ** eligible to use [shared cache mode], regardless of whether or not shared 2308 ** eligible to use [shared cache mode], regardless of whether or not shared
2138 ** cache is enabled using [sqlite3_enable_shared_cache()]. The 2309 ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The
2139 ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not 2310 ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not
2140 ** participate in [shared cache mode] even if it is enabled. 2311 ** participate in [shared cache mode] even if it is enabled.
2141 ** 2312 **
2142 ** If the filename is ":memory:", then a private, temporary in-memory database 2313 ** ^If the filename is ":memory:", then a private, temporary in-memory database
2143 ** is created for the connection. This in-memory database will vanish when 2314 ** is created for the connection. ^This in-memory database will vanish when
2144 ** the database connection is closed. Future versions of SQLite might 2315 ** the database connection is closed. Future versions of SQLite might
2145 ** make use of additional special filenames that begin with the ":" character. 2316 ** make use of additional special filenames that begin with the ":" character.
2146 ** It is recommended that when a database filename actually does begin with 2317 ** It is recommended that when a database filename actually does begin with
2147 ** a ":" character you should prefix the filename with a pathname such as 2318 ** a ":" character you should prefix the filename with a pathname such as
2148 ** "./" to avoid ambiguity. 2319 ** "./" to avoid ambiguity.
2149 ** 2320 **
2150 ** If the filename is an empty string, then a private, temporary 2321 ** ^If the filename is an empty string, then a private, temporary
2151 ** on-disk database will be created. This private database will be 2322 ** on-disk database will be created. ^This private database will be
2152 ** automatically deleted as soon as the database connection is closed. 2323 ** automatically deleted as soon as the database connection is closed.
2153 ** 2324 **
2154 ** The fourth parameter to sqlite3_open_v2() is the name of the 2325 ** ^The fourth parameter to sqlite3_open_v2() is the name of the
2155 ** [sqlite3_vfs] object that defines the operating system interface that 2326 ** [sqlite3_vfs] object that defines the operating system interface that
2156 ** the new database connection should use. If the fourth parameter is 2327 ** the new database connection should use. ^If the fourth parameter is
2157 ** a NULL pointer then the default [sqlite3_vfs] object is used. 2328 ** a NULL pointer then the default [sqlite3_vfs] object is used.
2158 ** 2329 **
2159 ** <b>Note to Windows users:</b> The encoding used for the filename argument 2330 ** <b>Note to Windows users:</b> The encoding used for the filename argument
2160 ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever 2331 ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
2161 ** codepage is currently defined. Filenames containing international 2332 ** codepage is currently defined. Filenames containing international
2162 ** characters must be converted to UTF-8 prior to passing them into 2333 ** characters must be converted to UTF-8 prior to passing them into
2163 ** sqlite3_open() or sqlite3_open_v2(). 2334 ** sqlite3_open() or sqlite3_open_v2().
2164 **
2165 ** Requirements:
2166 ** [H12701] [H12702] [H12703] [H12704] [H12706] [H12707] [H12709] [H12711]
2167 ** [H12712] [H12713] [H12714] [H12717] [H12719] [H12721] [H12723]
2168 */ 2335 */
2169 SQLITE_API int sqlite3_open( 2336 SQLITE_API int sqlite3_open(
2170 const char *filename, /* Database filename (UTF-8) */ 2337 const char *filename, /* Database filename (UTF-8) */
2171 sqlite3 **ppDb /* OUT: SQLite db handle */ 2338 sqlite3 **ppDb /* OUT: SQLite db handle */
2172 ); 2339 );
2173 SQLITE_API int sqlite3_open16( 2340 SQLITE_API int sqlite3_open16(
2174 const void *filename, /* Database filename (UTF-16) */ 2341 const void *filename, /* Database filename (UTF-16) */
2175 sqlite3 **ppDb /* OUT: SQLite db handle */ 2342 sqlite3 **ppDb /* OUT: SQLite db handle */
2176 ); 2343 );
2177 SQLITE_API int sqlite3_open_v2( 2344 SQLITE_API int sqlite3_open_v2(
2178 const char *filename, /* Database filename (UTF-8) */ 2345 const char *filename, /* Database filename (UTF-8) */
2179 sqlite3 **ppDb, /* OUT: SQLite db handle */ 2346 sqlite3 **ppDb, /* OUT: SQLite db handle */
2180 int flags, /* Flags */ 2347 int flags, /* Flags */
2181 const char *zVfs /* Name of VFS module to use */ 2348 const char *zVfs /* Name of VFS module to use */
2182 ); 2349 );
2183 2350
2184 /* 2351 /*
2185 ** CAPI3REF: Error Codes And Messages {H12800} <S60200> 2352 ** CAPI3REF: Error Codes And Messages
2186 ** 2353 **
2187 ** The sqlite3_errcode() interface returns the numeric [result code] or 2354 ** ^The sqlite3_errcode() interface returns the numeric [result code] or
2188 ** [extended result code] for the most recent failed sqlite3_* API call 2355 ** [extended result code] for the most recent failed sqlite3_* API call
2189 ** associated with a [database connection]. If a prior API call failed 2356 ** associated with a [database connection]. If a prior API call failed
2190 ** but the most recent API call succeeded, the return value from 2357 ** but the most recent API call succeeded, the return value from
2191 ** sqlite3_errcode() is undefined. The sqlite3_extended_errcode() 2358 ** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode()
2192 ** interface is the same except that it always returns the 2359 ** interface is the same except that it always returns the
2193 ** [extended result code] even when extended result codes are 2360 ** [extended result code] even when extended result codes are
2194 ** disabled. 2361 ** disabled.
2195 ** 2362 **
2196 ** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language 2363 ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
2197 ** text that describes the error, as either UTF-8 or UTF-16 respectively. 2364 ** text that describes the error, as either UTF-8 or UTF-16 respectively.
2198 ** Memory to hold the error message string is managed internally. 2365 ** ^(Memory to hold the error message string is managed internally.
2199 ** The application does not need to worry about freeing the result. 2366 ** The application does not need to worry about freeing the result.
2200 ** However, the error string might be overwritten or deallocated by 2367 ** However, the error string might be overwritten or deallocated by
2201 ** subsequent calls to other SQLite interface functions. 2368 ** subsequent calls to other SQLite interface functions.)^
2202 ** 2369 **
2203 ** When the serialized [threading mode] is in use, it might be the 2370 ** When the serialized [threading mode] is in use, it might be the
2204 ** case that a second error occurs on a separate thread in between 2371 ** case that a second error occurs on a separate thread in between
2205 ** the time of the first error and the call to these interfaces. 2372 ** the time of the first error and the call to these interfaces.
2206 ** When that happens, the second error will be reported since these 2373 ** When that happens, the second error will be reported since these
2207 ** interfaces always report the most recent result. To avoid 2374 ** interfaces always report the most recent result. To avoid
2208 ** this, each thread can obtain exclusive use of the [database connection] D 2375 ** this, each thread can obtain exclusive use of the [database connection] D
2209 ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning 2376 ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
2210 ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after 2377 ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
2211 ** all calls to the interfaces listed here are completed. 2378 ** all calls to the interfaces listed here are completed.
2212 ** 2379 **
2213 ** If an interface fails with SQLITE_MISUSE, that means the interface 2380 ** If an interface fails with SQLITE_MISUSE, that means the interface
2214 ** was invoked incorrectly by the application. In that case, the 2381 ** was invoked incorrectly by the application. In that case, the
2215 ** error code and message may or may not be set. 2382 ** error code and message may or may not be set.
2216 **
2217 ** Requirements:
2218 ** [H12801] [H12802] [H12803] [H12807] [H12808] [H12809]
2219 */ 2383 */
2220 SQLITE_API int sqlite3_errcode(sqlite3 *db); 2384 SQLITE_API int sqlite3_errcode(sqlite3 *db);
2221 SQLITE_API int sqlite3_extended_errcode(sqlite3 *db); 2385 SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
2222 SQLITE_API const char *sqlite3_errmsg(sqlite3*); 2386 SQLITE_API const char *sqlite3_errmsg(sqlite3*);
2223 SQLITE_API const void *sqlite3_errmsg16(sqlite3*); 2387 SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
2224 2388
2225 /* 2389 /*
2226 ** CAPI3REF: SQL Statement Object {H13000} <H13010> 2390 ** CAPI3REF: SQL Statement Object
2227 ** KEYWORDS: {prepared statement} {prepared statements} 2391 ** KEYWORDS: {prepared statement} {prepared statements}
2228 ** 2392 **
2229 ** An instance of this object represents a single SQL statement. 2393 ** An instance of this object represents a single SQL statement.
2230 ** This object is variously known as a "prepared statement" or a 2394 ** This object is variously known as a "prepared statement" or a
2231 ** "compiled SQL statement" or simply as a "statement". 2395 ** "compiled SQL statement" or simply as a "statement".
2232 ** 2396 **
2233 ** The life of a statement object goes something like this: 2397 ** The life of a statement object goes something like this:
2234 ** 2398 **
2235 ** <ol> 2399 ** <ol>
2236 ** <li> Create the object using [sqlite3_prepare_v2()] or a related 2400 ** <li> Create the object using [sqlite3_prepare_v2()] or a related
2237 ** function. 2401 ** function.
2238 ** <li> Bind values to [host parameters] using the sqlite3_bind_*() 2402 ** <li> Bind values to [host parameters] using the sqlite3_bind_*()
2239 ** interfaces. 2403 ** interfaces.
2240 ** <li> Run the SQL by calling [sqlite3_step()] one or more times. 2404 ** <li> Run the SQL by calling [sqlite3_step()] one or more times.
2241 ** <li> Reset the statement using [sqlite3_reset()] then go back 2405 ** <li> Reset the statement using [sqlite3_reset()] then go back
2242 ** to step 2. Do this zero or more times. 2406 ** to step 2. Do this zero or more times.
2243 ** <li> Destroy the object using [sqlite3_finalize()]. 2407 ** <li> Destroy the object using [sqlite3_finalize()].
2244 ** </ol> 2408 ** </ol>
2245 ** 2409 **
2246 ** Refer to documentation on individual methods above for additional 2410 ** Refer to documentation on individual methods above for additional
2247 ** information. 2411 ** information.
2248 */ 2412 */
2249 typedef struct sqlite3_stmt sqlite3_stmt; 2413 typedef struct sqlite3_stmt sqlite3_stmt;
2250 2414
2251 /* 2415 /*
2252 ** CAPI3REF: Run-time Limits {H12760} <S20600> 2416 ** CAPI3REF: Run-time Limits
2253 ** 2417 **
2254 ** This interface allows the size of various constructs to be limited 2418 ** ^(This interface allows the size of various constructs to be limited
2255 ** on a connection by connection basis. The first parameter is the 2419 ** on a connection by connection basis. The first parameter is the
2256 ** [database connection] whose limit is to be set or queried. The 2420 ** [database connection] whose limit is to be set or queried. The
2257 ** second parameter is one of the [limit categories] that define a 2421 ** second parameter is one of the [limit categories] that define a
2258 ** class of constructs to be size limited. The third parameter is the 2422 ** class of constructs to be size limited. The third parameter is the
2259 ** new limit for that construct. The function returns the old limit. 2423 ** new limit for that construct.)^
2260 ** 2424 **
2261 ** If the new limit is a negative number, the limit is unchanged. 2425 ** ^If the new limit is a negative number, the limit is unchanged.
2262 ** For the limit category of SQLITE_LIMIT_XYZ there is a 2426 ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
2263 ** [limits | hard upper bound] 2427 ** [limits | hard upper bound]
2264 ** set by a compile-time C preprocessor macro named 2428 ** set at compile-time by a C preprocessor macro called
2265 ** [limits | SQLITE_MAX_XYZ]. 2429 ** [limits | SQLITE_MAX_<i>NAME</i>].
2266 ** (The "_LIMIT_" in the name is changed to "_MAX_".) 2430 ** (The "_LIMIT_" in the name is changed to "_MAX_".))^
2267 ** Attempts to increase a limit above its hard upper bound are 2431 ** ^Attempts to increase a limit above its hard upper bound are
2268 ** silently truncated to the hard upper limit. 2432 ** silently truncated to the hard upper bound.
2269 ** 2433 **
2270 ** Run time limits are intended for use in applications that manage 2434 ** ^Regardless of whether or not the limit was changed, the
2435 ** [sqlite3_limit()] interface returns the prior value of the limit.
2436 ** ^Hence, to find the current value of a limit without changing it,
2437 ** simply invoke this interface with the third parameter set to -1.
2438 **
2439 ** Run-time limits are intended for use in applications that manage
2271 ** both their own internal database and also databases that are controlled 2440 ** both their own internal database and also databases that are controlled
2272 ** by untrusted external sources. An example application might be a 2441 ** by untrusted external sources. An example application might be a
2273 ** web browser that has its own databases for storing history and 2442 ** web browser that has its own databases for storing history and
2274 ** separate databases controlled by JavaScript applications downloaded 2443 ** separate databases controlled by JavaScript applications downloaded
2275 ** off the Internet. The internal databases can be given the 2444 ** off the Internet. The internal databases can be given the
2276 ** large, default limits. Databases managed by external sources can 2445 ** large, default limits. Databases managed by external sources can
2277 ** be given much smaller limits designed to prevent a denial of service 2446 ** be given much smaller limits designed to prevent a denial of service
2278 ** attack. Developers might also want to use the [sqlite3_set_authorizer()] 2447 ** attack. Developers might also want to use the [sqlite3_set_authorizer()]
2279 ** interface to further control untrusted SQL. The size of the database 2448 ** interface to further control untrusted SQL. The size of the database
2280 ** created by an untrusted script can be contained using the 2449 ** created by an untrusted script can be contained using the
2281 ** [max_page_count] [PRAGMA]. 2450 ** [max_page_count] [PRAGMA].
2282 ** 2451 **
2283 ** New run-time limit categories may be added in future releases. 2452 ** New run-time limit categories may be added in future releases.
2284 **
2285 ** Requirements:
2286 ** [H12762] [H12766] [H12769]
2287 */ 2453 */
2288 SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal); 2454 SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
2289 2455
2290 /* 2456 /*
2291 ** CAPI3REF: Run-Time Limit Categories {H12790} <H12760> 2457 ** CAPI3REF: Run-Time Limit Categories
2292 ** KEYWORDS: {limit category} {limit categories} 2458 ** KEYWORDS: {limit category} {*limit categories}
2293 ** 2459 **
2294 ** These constants define various performance limits 2460 ** These constants define various performance limits
2295 ** that can be lowered at run-time using [sqlite3_limit()]. 2461 ** that can be lowered at run-time using [sqlite3_limit()].
2296 ** The synopsis of the meanings of the various limits is shown below. 2462 ** The synopsis of the meanings of the various limits is shown below.
2297 ** Additional information is available at [limits | Limits in SQLite]. 2463 ** Additional information is available at [limits | Limits in SQLite].
2298 ** 2464 **
2299 ** <dl> 2465 ** <dl>
2300 ** <dt>SQLITE_LIMIT_LENGTH</dt> 2466 ** ^(<dt>SQLITE_LIMIT_LENGTH</dt>
2301 ** <dd>The maximum size of any string or BLOB or table row.<dd> 2467 ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
2302 ** 2468 **
2303 ** <dt>SQLITE_LIMIT_SQL_LENGTH</dt> 2469 ** ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
2304 ** <dd>The maximum length of an SQL statement.</dd> 2470 ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
2305 ** 2471 **
2306 ** <dt>SQLITE_LIMIT_COLUMN</dt> 2472 ** ^(<dt>SQLITE_LIMIT_COLUMN</dt>
2307 ** <dd>The maximum number of columns in a table definition or in the 2473 ** <dd>The maximum number of columns in a table definition or in the
2308 ** result set of a [SELECT] or the maximum number of columns in an index 2474 ** result set of a [SELECT] or the maximum number of columns in an index
2309 ** or in an ORDER BY or GROUP BY clause.</dd> 2475 ** or in an ORDER BY or GROUP BY clause.</dd>)^
2310 ** 2476 **
2311 ** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt> 2477 ** ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
2312 ** <dd>The maximum depth of the parse tree on any expression.</dd> 2478 ** <dd>The maximum depth of the parse tree on any expression.</dd>)^
2313 ** 2479 **
2314 ** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> 2480 ** ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
2315 ** <dd>The maximum number of terms in a compound SELECT statement.</dd> 2481 ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
2316 ** 2482 **
2317 ** <dt>SQLITE_LIMIT_VDBE_OP</dt> 2483 ** ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
2318 ** <dd>The maximum number of instructions in a virtual machine program 2484 ** <dd>The maximum number of instructions in a virtual machine program
2319 ** used to implement an SQL statement.</dd> 2485 ** used to implement an SQL statement. This limit is not currently
2486 ** enforced, though that might be added in some future release of
2487 ** SQLite.</dd>)^
2320 ** 2488 **
2321 ** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt> 2489 ** ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
2322 ** <dd>The maximum number of arguments on a function.</dd> 2490 ** <dd>The maximum number of arguments on a function.</dd>)^
2323 ** 2491 **
2324 ** <dt>SQLITE_LIMIT_ATTACHED</dt> 2492 ** ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
2325 ** <dd>The maximum number of [ATTACH | attached databases].</dd> 2493 ** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
2326 ** 2494 **
2327 ** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> 2495 ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
2328 ** <dd>The maximum length of the pattern argument to the [LIKE] or 2496 ** <dd>The maximum length of the pattern argument to the [LIKE] or
2329 ** [GLOB] operators.</dd> 2497 ** [GLOB] operators.</dd>)^
2330 ** 2498 **
2331 ** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> 2499 ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
2332 ** <dd>The maximum number of variables in an SQL statement that can 2500 ** <dd>The maximum index number of any [parameter] in an SQL statement.)^
2333 ** be bound.</dd>
2334 ** 2501 **
2335 ** <dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> 2502 ** ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
2336 ** <dd>The maximum depth of recursion for triggers.</dd> 2503 ** <dd>The maximum depth of recursion for triggers.</dd>)^
2337 ** </dl> 2504 ** </dl>
2338 */ 2505 */
2339 #define SQLITE_LIMIT_LENGTH 0 2506 #define SQLITE_LIMIT_LENGTH 0
2340 #define SQLITE_LIMIT_SQL_LENGTH 1 2507 #define SQLITE_LIMIT_SQL_LENGTH 1
2341 #define SQLITE_LIMIT_COLUMN 2 2508 #define SQLITE_LIMIT_COLUMN 2
2342 #define SQLITE_LIMIT_EXPR_DEPTH 3 2509 #define SQLITE_LIMIT_EXPR_DEPTH 3
2343 #define SQLITE_LIMIT_COMPOUND_SELECT 4 2510 #define SQLITE_LIMIT_COMPOUND_SELECT 4
2344 #define SQLITE_LIMIT_VDBE_OP 5 2511 #define SQLITE_LIMIT_VDBE_OP 5
2345 #define SQLITE_LIMIT_FUNCTION_ARG 6 2512 #define SQLITE_LIMIT_FUNCTION_ARG 6
2346 #define SQLITE_LIMIT_ATTACHED 7 2513 #define SQLITE_LIMIT_ATTACHED 7
2347 #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 2514 #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
2348 #define SQLITE_LIMIT_VARIABLE_NUMBER 9 2515 #define SQLITE_LIMIT_VARIABLE_NUMBER 9
2349 #define SQLITE_LIMIT_TRIGGER_DEPTH 10 2516 #define SQLITE_LIMIT_TRIGGER_DEPTH 10
2350 2517
2351 /* 2518 /*
2352 ** CAPI3REF: Compiling An SQL Statement {H13010} <S10000> 2519 ** CAPI3REF: Compiling An SQL Statement
2353 ** KEYWORDS: {SQL statement compiler} 2520 ** KEYWORDS: {SQL statement compiler}
2354 ** 2521 **
2355 ** To execute an SQL query, it must first be compiled into a byte-code 2522 ** To execute an SQL query, it must first be compiled into a byte-code
2356 ** program using one of these routines. 2523 ** program using one of these routines.
2357 ** 2524 **
2358 ** The first argument, "db", is a [database connection] obtained from a 2525 ** The first argument, "db", is a [database connection] obtained from a
2359 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or 2526 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
2360 ** [sqlite3_open16()]. The database connection must not have been closed. 2527 ** [sqlite3_open16()]. The database connection must not have been closed.
2361 ** 2528 **
2362 ** The second argument, "zSql", is the statement to be compiled, encoded 2529 ** The second argument, "zSql", is the statement to be compiled, encoded
2363 ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() 2530 ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
2364 ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() 2531 ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
2365 ** use UTF-16. 2532 ** use UTF-16.
2366 ** 2533 **
2367 ** If the nByte argument is less than zero, then zSql is read up to the 2534 ** ^If the nByte argument is less than zero, then zSql is read up to the
2368 ** first zero terminator. If nByte is non-negative, then it is the maximum 2535 ** first zero terminator. ^If nByte is non-negative, then it is the maximum
2369 ** number of bytes read from zSql. When nByte is non-negative, the 2536 ** number of bytes read from zSql. ^When nByte is non-negative, the
2370 ** zSql string ends at either the first '\000' or '\u0000' character or 2537 ** zSql string ends at either the first '\000' or '\u0000' character or
2371 ** the nByte-th byte, whichever comes first. If the caller knows 2538 ** the nByte-th byte, whichever comes first. If the caller knows
2372 ** that the supplied string is nul-terminated, then there is a small 2539 ** that the supplied string is nul-terminated, then there is a small
2373 ** performance advantage to be gained by passing an nByte parameter that 2540 ** performance advantage to be gained by passing an nByte parameter that
2374 ** is equal to the number of bytes in the input string <i>including</i> 2541 ** is equal to the number of bytes in the input string <i>including</i>
2375 ** the nul-terminator bytes. 2542 ** the nul-terminator bytes.
2376 ** 2543 **
2377 ** If pzTail is not NULL then *pzTail is made to point to the first byte 2544 ** ^If pzTail is not NULL then *pzTail is made to point to the first byte
2378 ** past the end of the first SQL statement in zSql. These routines only 2545 ** past the end of the first SQL statement in zSql. These routines only
2379 ** compile the first statement in zSql, so *pzTail is left pointing to 2546 ** compile the first statement in zSql, so *pzTail is left pointing to
2380 ** what remains uncompiled. 2547 ** what remains uncompiled.
2381 ** 2548 **
2382 ** *ppStmt is left pointing to a compiled [prepared statement] that can be 2549 ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
2383 ** executed using [sqlite3_step()]. If there is an error, *ppStmt is set 2550 ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
2384 ** to NULL. If the input text contains no SQL (if the input is an empty 2551 ** to NULL. ^If the input text contains no SQL (if the input is an empty
2385 ** string or a comment) then *ppStmt is set to NULL. 2552 ** string or a comment) then *ppStmt is set to NULL.
2386 ** The calling procedure is responsible for deleting the compiled 2553 ** The calling procedure is responsible for deleting the compiled
2387 ** SQL statement using [sqlite3_finalize()] after it has finished with it. 2554 ** SQL statement using [sqlite3_finalize()] after it has finished with it.
2388 ** ppStmt may not be NULL. 2555 ** ppStmt may not be NULL.
2389 ** 2556 **
2390 ** On success, [SQLITE_OK] is returned, otherwise an [error code] is returned. 2557 ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
2558 ** otherwise an [error code] is returned.
2391 ** 2559 **
2392 ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are 2560 ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
2393 ** recommended for all new programs. The two older interfaces are retained 2561 ** recommended for all new programs. The two older interfaces are retained
2394 ** for backwards compatibility, but their use is discouraged. 2562 ** for backwards compatibility, but their use is discouraged.
2395 ** In the "v2" interfaces, the prepared statement 2563 ** ^In the "v2" interfaces, the prepared statement
2396 ** that is returned (the [sqlite3_stmt] object) contains a copy of the 2564 ** that is returned (the [sqlite3_stmt] object) contains a copy of the
2397 ** original SQL text. This causes the [sqlite3_step()] interface to 2565 ** original SQL text. This causes the [sqlite3_step()] interface to
2398 ** behave a differently in two ways: 2566 ** behave differently in three ways:
2399 ** 2567 **
2400 ** <ol> 2568 ** <ol>
2401 ** <li> 2569 ** <li>
2402 ** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it 2570 ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
2403 ** always used to do, [sqlite3_step()] will automatically recompile the SQL 2571 ** always used to do, [sqlite3_step()] will automatically recompile the SQL
2404 ** statement and try to run it again. If the schema has changed in 2572 ** statement and try to run it again.
2405 ** a way that makes the statement no longer valid, [sqlite3_step()] will still
2406 ** return [SQLITE_SCHEMA]. But unlike the legacy behavior, [SQLITE_SCHEMA] is
2407 ** now a fatal error. Calling [sqlite3_prepare_v2()] again will not make the
2408 ** error go away. Note: use [sqlite3_errmsg()] to find the text
2409 ** of the parsing error that results in an [SQLITE_SCHEMA] return.
2410 ** </li> 2573 ** </li>
2411 ** 2574 **
2412 ** <li> 2575 ** <li>
2413 ** When an error occurs, [sqlite3_step()] will return one of the detailed 2576 ** ^When an error occurs, [sqlite3_step()] will return one of the detailed
2414 ** [error codes] or [extended error codes]. The legacy behavior was that 2577 ** [error codes] or [extended error codes]. ^The legacy behavior was that
2415 ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code 2578 ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
2416 ** and you would have to make a second call to [sqlite3_reset()] in order 2579 ** and the application would have to make a second call to [sqlite3_reset()]
2417 ** to find the underlying cause of the problem. With the "v2" prepare 2580 ** in order to find the underlying cause of the problem. With the "v2" prepare
2418 ** interfaces, the underlying reason for the error is returned immediately. 2581 ** interfaces, the underlying reason for the error is returned immediately.
2419 ** </li> 2582 ** </li>
2583 **
2584 ** <li>
2585 ** ^If the specific value bound to [parameter | host parameter] in the
2586 ** WHERE clause might influence the choice of query plan for a statement,
2587 ** then the statement will be automatically recompiled, as if there had been
2588 ** a schema change, on the first [sqlite3_step()] call following any change
2589 ** to the [sqlite3_bind_text | bindings] of that [parameter].
2590 ** ^The specific value of WHERE-clause [parameter] might influence the
2591 ** choice of query plan if the parameter is the left-hand side of a [LIKE]
2592 ** or [GLOB] operator or if the parameter is compared to an indexed column
2593 ** and the [SQLITE_ENABLE_STAT2] compile-time option is enabled.
2594 ** the
2595 ** </li>
2420 ** </ol> 2596 ** </ol>
2421 **
2422 ** Requirements:
2423 ** [H13011] [H13012] [H13013] [H13014] [H13015] [H13016] [H13019] [H13021]
2424 **
2425 */ 2597 */
2426 SQLITE_API int sqlite3_prepare( 2598 SQLITE_API int sqlite3_prepare(
2427 sqlite3 *db, /* Database handle */ 2599 sqlite3 *db, /* Database handle */
2428 const char *zSql, /* SQL statement, UTF-8 encoded */ 2600 const char *zSql, /* SQL statement, UTF-8 encoded */
2429 int nByte, /* Maximum length of zSql in bytes. */ 2601 int nByte, /* Maximum length of zSql in bytes. */
2430 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2602 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2431 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 2603 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2432 ); 2604 );
2433 SQLITE_API int sqlite3_prepare_v2( 2605 SQLITE_API int sqlite3_prepare_v2(
2434 sqlite3 *db, /* Database handle */ 2606 sqlite3 *db, /* Database handle */
(...skipping 11 matching lines...) Expand all
2446 ); 2618 );
2447 SQLITE_API int sqlite3_prepare16_v2( 2619 SQLITE_API int sqlite3_prepare16_v2(
2448 sqlite3 *db, /* Database handle */ 2620 sqlite3 *db, /* Database handle */
2449 const void *zSql, /* SQL statement, UTF-16 encoded */ 2621 const void *zSql, /* SQL statement, UTF-16 encoded */
2450 int nByte, /* Maximum length of zSql in bytes. */ 2622 int nByte, /* Maximum length of zSql in bytes. */
2451 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2623 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2452 const void **pzTail /* OUT: Pointer to unused portion of zSql */ 2624 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2453 ); 2625 );
2454 2626
2455 /* 2627 /*
2456 ** CAPI3REF: Retrieving Statement SQL {H13100} <H13000> 2628 ** CAPI3REF: Retrieving Statement SQL
2457 ** 2629 **
2458 ** This interface can be used to retrieve a saved copy of the original 2630 ** ^This interface can be used to retrieve a saved copy of the original
2459 ** SQL text used to create a [prepared statement] if that statement was 2631 ** SQL text used to create a [prepared statement] if that statement was
2460 ** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. 2632 ** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
2461 **
2462 ** Requirements:
2463 ** [H13101] [H13102] [H13103]
2464 */ 2633 */
2465 SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); 2634 SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
2466 2635
2467 /* 2636 /*
2468 ** CAPI3REF: Dynamically Typed Value Object {H15000} <S20200> 2637 ** CAPI3REF: Dynamically Typed Value Object
2469 ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} 2638 ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
2470 ** 2639 **
2471 ** SQLite uses the sqlite3_value object to represent all values 2640 ** SQLite uses the sqlite3_value object to represent all values
2472 ** that can be stored in a database table. SQLite uses dynamic typing 2641 ** that can be stored in a database table. SQLite uses dynamic typing
2473 ** for the values it stores. Values stored in sqlite3_value objects 2642 ** for the values it stores. ^Values stored in sqlite3_value objects
2474 ** can be integers, floating point values, strings, BLOBs, or NULL. 2643 ** can be integers, floating point values, strings, BLOBs, or NULL.
2475 ** 2644 **
2476 ** An sqlite3_value object may be either "protected" or "unprotected". 2645 ** An sqlite3_value object may be either "protected" or "unprotected".
2477 ** Some interfaces require a protected sqlite3_value. Other interfaces 2646 ** Some interfaces require a protected sqlite3_value. Other interfaces
2478 ** will accept either a protected or an unprotected sqlite3_value. 2647 ** will accept either a protected or an unprotected sqlite3_value.
2479 ** Every interface that accepts sqlite3_value arguments specifies 2648 ** Every interface that accepts sqlite3_value arguments specifies
2480 ** whether or not it requires a protected sqlite3_value. 2649 ** whether or not it requires a protected sqlite3_value.
2481 ** 2650 **
2482 ** The terms "protected" and "unprotected" refer to whether or not 2651 ** The terms "protected" and "unprotected" refer to whether or not
2483 ** a mutex is held. A internal mutex is held for a protected 2652 ** a mutex is held. A internal mutex is held for a protected
2484 ** sqlite3_value object but no mutex is held for an unprotected 2653 ** sqlite3_value object but no mutex is held for an unprotected
2485 ** sqlite3_value object. If SQLite is compiled to be single-threaded 2654 ** sqlite3_value object. If SQLite is compiled to be single-threaded
2486 ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) 2655 ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
2487 ** or if SQLite is run in one of reduced mutex modes 2656 ** or if SQLite is run in one of reduced mutex modes
2488 ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] 2657 ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
2489 ** then there is no distinction between protected and unprotected 2658 ** then there is no distinction between protected and unprotected
2490 ** sqlite3_value objects and they can be used interchangeably. However, 2659 ** sqlite3_value objects and they can be used interchangeably. However,
2491 ** for maximum code portability it is recommended that applications 2660 ** for maximum code portability it is recommended that applications
2492 ** still make the distinction between between protected and unprotected 2661 ** still make the distinction between protected and unprotected
2493 ** sqlite3_value objects even when not strictly required. 2662 ** sqlite3_value objects even when not strictly required.
2494 ** 2663 **
2495 ** The sqlite3_value objects that are passed as parameters into the 2664 ** ^The sqlite3_value objects that are passed as parameters into the
2496 ** implementation of [application-defined SQL functions] are protected. 2665 ** implementation of [application-defined SQL functions] are protected.
2497 ** The sqlite3_value object returned by 2666 ** ^The sqlite3_value object returned by
2498 ** [sqlite3_column_value()] is unprotected. 2667 ** [sqlite3_column_value()] is unprotected.
2499 ** Unprotected sqlite3_value objects may only be used with 2668 ** Unprotected sqlite3_value objects may only be used with
2500 ** [sqlite3_result_value()] and [sqlite3_bind_value()]. 2669 ** [sqlite3_result_value()] and [sqlite3_bind_value()].
2501 ** The [sqlite3_value_blob | sqlite3_value_type()] family of 2670 ** The [sqlite3_value_blob | sqlite3_value_type()] family of
2502 ** interfaces require protected sqlite3_value objects. 2671 ** interfaces require protected sqlite3_value objects.
2503 */ 2672 */
2504 typedef struct Mem sqlite3_value; 2673 typedef struct Mem sqlite3_value;
2505 2674
2506 /* 2675 /*
2507 ** CAPI3REF: SQL Function Context Object {H16001} <S20200> 2676 ** CAPI3REF: SQL Function Context Object
2508 ** 2677 **
2509 ** The context in which an SQL function executes is stored in an 2678 ** The context in which an SQL function executes is stored in an
2510 ** sqlite3_context object. A pointer to an sqlite3_context object 2679 ** sqlite3_context object. ^A pointer to an sqlite3_context object
2511 ** is always first parameter to [application-defined SQL functions]. 2680 ** is always first parameter to [application-defined SQL functions].
2512 ** The application-defined SQL function implementation will pass this 2681 ** The application-defined SQL function implementation will pass this
2513 ** pointer through into calls to [sqlite3_result_int | sqlite3_result()], 2682 ** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
2514 ** [sqlite3_aggregate_context()], [sqlite3_user_data()], 2683 ** [sqlite3_aggregate_context()], [sqlite3_user_data()],
2515 ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], 2684 ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
2516 ** and/or [sqlite3_set_auxdata()]. 2685 ** and/or [sqlite3_set_auxdata()].
2517 */ 2686 */
2518 typedef struct sqlite3_context sqlite3_context; 2687 typedef struct sqlite3_context sqlite3_context;
2519 2688
2520 /* 2689 /*
2521 ** CAPI3REF: Binding Values To Prepared Statements {H13500} <S70300> 2690 ** CAPI3REF: Binding Values To Prepared Statements
2522 ** KEYWORDS: {host parameter} {host parameters} {host parameter name} 2691 ** KEYWORDS: {host parameter} {host parameters} {host parameter name}
2523 ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} 2692 ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
2524 ** 2693 **
2525 ** In the SQL strings input to [sqlite3_prepare_v2()] and its variants, 2694 ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
2526 ** literals may be replaced by a [parameter] that matches one of following 2695 ** literals may be replaced by a [parameter] that matches one of following
2527 ** templates: 2696 ** templates:
2528 ** 2697 **
2529 ** <ul> 2698 ** <ul>
2530 ** <li> ? 2699 ** <li> ?
2531 ** <li> ?NNN 2700 ** <li> ?NNN
2532 ** <li> :VVV 2701 ** <li> :VVV
2533 ** <li> @VVV 2702 ** <li> @VVV
2534 ** <li> $VVV 2703 ** <li> $VVV
2535 ** </ul> 2704 ** </ul>
2536 ** 2705 **
2537 ** In the templates above, NNN represents an integer literal, 2706 ** In the templates above, NNN represents an integer literal,
2538 ** and VVV represents an alphanumeric identifer. The values of these 2707 ** and VVV represents an alphanumeric identifier.)^ ^The values of these
2539 ** parameters (also called "host parameter names" or "SQL parameters") 2708 ** parameters (also called "host parameter names" or "SQL parameters")
2540 ** can be set using the sqlite3_bind_*() routines defined here. 2709 ** can be set using the sqlite3_bind_*() routines defined here.
2541 ** 2710 **
2542 ** The first argument to the sqlite3_bind_*() routines is always 2711 ** ^The first argument to the sqlite3_bind_*() routines is always
2543 ** a pointer to the [sqlite3_stmt] object returned from 2712 ** a pointer to the [sqlite3_stmt] object returned from
2544 ** [sqlite3_prepare_v2()] or its variants. 2713 ** [sqlite3_prepare_v2()] or its variants.
2545 ** 2714 **
2546 ** The second argument is the index of the SQL parameter to be set. 2715 ** ^The second argument is the index of the SQL parameter to be set.
2547 ** The leftmost SQL parameter has an index of 1. When the same named 2716 ** ^The leftmost SQL parameter has an index of 1. ^When the same named
2548 ** SQL parameter is used more than once, second and subsequent 2717 ** SQL parameter is used more than once, second and subsequent
2549 ** occurrences have the same index as the first occurrence. 2718 ** occurrences have the same index as the first occurrence.
2550 ** The index for named parameters can be looked up using the 2719 ** ^The index for named parameters can be looked up using the
2551 ** [sqlite3_bind_parameter_index()] API if desired. The index 2720 ** [sqlite3_bind_parameter_index()] API if desired. ^The index
2552 ** for "?NNN" parameters is the value of NNN. 2721 ** for "?NNN" parameters is the value of NNN.
2553 ** The NNN value must be between 1 and the [sqlite3_limit()] 2722 ** ^The NNN value must be between 1 and the [sqlite3_limit()]
2554 ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). 2723 ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
2555 ** 2724 **
2556 ** The third argument is the value to bind to the parameter. 2725 ** ^The third argument is the value to bind to the parameter.
2557 ** 2726 **
2558 ** In those routines that have a fourth argument, its value is the 2727 ** ^(In those routines that have a fourth argument, its value is the
2559 ** number of bytes in the parameter. To be clear: the value is the 2728 ** number of bytes in the parameter. To be clear: the value is the
2560 ** number of <u>bytes</u> in the value, not the number of characters. 2729 ** number of <u>bytes</u> in the value, not the number of characters.)^
2561 ** If the fourth parameter is negative, the length of the string is 2730 ** ^If the fourth parameter is negative, the length of the string is
2562 ** the number of bytes up to the first zero terminator. 2731 ** the number of bytes up to the first zero terminator.
2563 ** 2732 **
2564 ** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and 2733 ** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
2565 ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or 2734 ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
2566 ** string after SQLite has finished with it. If the fifth argument is 2735 ** string after SQLite has finished with it. ^If the fifth argument is
2567 ** the special value [SQLITE_STATIC], then SQLite assumes that the 2736 ** the special value [SQLITE_STATIC], then SQLite assumes that the
2568 ** information is in static, unmanaged space and does not need to be freed. 2737 ** information is in static, unmanaged space and does not need to be freed.
2569 ** If the fifth argument has the value [SQLITE_TRANSIENT], then 2738 ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
2570 ** SQLite makes its own private copy of the data immediately, before 2739 ** SQLite makes its own private copy of the data immediately, before
2571 ** the sqlite3_bind_*() routine returns. 2740 ** the sqlite3_bind_*() routine returns.
2572 ** 2741 **
2573 ** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that 2742 ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
2574 ** is filled with zeroes. A zeroblob uses a fixed amount of memory 2743 ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
2575 ** (just an integer to hold its size) while it is being processed. 2744 ** (just an integer to hold its size) while it is being processed.
2576 ** Zeroblobs are intended to serve as placeholders for BLOBs whose 2745 ** Zeroblobs are intended to serve as placeholders for BLOBs whose
2577 ** content is later written using 2746 ** content is later written using
2578 ** [sqlite3_blob_open | incremental BLOB I/O] routines. 2747 ** [sqlite3_blob_open | incremental BLOB I/O] routines.
2579 ** A negative value for the zeroblob results in a zero-length BLOB. 2748 ** ^A negative value for the zeroblob results in a zero-length BLOB.
2580 ** 2749 **
2581 ** The sqlite3_bind_*() routines must be called after 2750 ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
2582 ** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and 2751 ** for the [prepared statement] or with a prepared statement for which
2583 ** before [sqlite3_step()]. 2752 ** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
2584 ** Bindings are not cleared by the [sqlite3_reset()] routine. 2753 ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
2585 ** Unbound parameters are interpreted as NULL. 2754 ** routine is passed a [prepared statement] that has been finalized, the
2755 ** result is undefined and probably harmful.
2586 ** 2756 **
2587 ** These routines return [SQLITE_OK] on success or an error code if 2757 ** ^Bindings are not cleared by the [sqlite3_reset()] routine.
2588 ** anything goes wrong. [SQLITE_RANGE] is returned if the parameter 2758 ** ^Unbound parameters are interpreted as NULL.
2589 ** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails. 2759 **
2590 ** [SQLITE_MISUSE] might be returned if these routines are called on a 2760 ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
2591 ** virtual machine that is the wrong state or which has already been finalized. 2761 ** [error code] if anything goes wrong.
2592 ** Detection of misuse is unreliable. Applications should not depend 2762 ** ^[SQLITE_RANGE] is returned if the parameter
2593 ** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a 2763 ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
2594 ** a logic error in the application. Future versions of SQLite might
2595 ** panic rather than return SQLITE_MISUSE.
2596 ** 2764 **
2597 ** See also: [sqlite3_bind_parameter_count()], 2765 ** See also: [sqlite3_bind_parameter_count()],
2598 ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. 2766 ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
2599 **
2600 ** Requirements:
2601 ** [H13506] [H13509] [H13512] [H13515] [H13518] [H13521] [H13524] [H13527]
2602 ** [H13530] [H13533] [H13536] [H13539] [H13542] [H13545] [H13548] [H13551]
2603 **
2604 */ 2767 */
2605 SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*) (void*)); 2768 SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*) (void*));
2606 SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); 2769 SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
2607 SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); 2770 SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
2608 SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); 2771 SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
2609 SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); 2772 SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
2610 SQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*) (void*)); 2773 SQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*) (void*));
2611 SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*) (void*)); 2774 SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*) (void*));
2612 SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); 2775 SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
2613 SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); 2776 SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
2614 2777
2615 /* 2778 /*
2616 ** CAPI3REF: Number Of SQL Parameters {H13600} <S70300> 2779 ** CAPI3REF: Number Of SQL Parameters
2617 ** 2780 **
2618 ** This routine can be used to find the number of [SQL parameters] 2781 ** ^This routine can be used to find the number of [SQL parameters]
2619 ** in a [prepared statement]. SQL parameters are tokens of the 2782 ** in a [prepared statement]. SQL parameters are tokens of the
2620 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as 2783 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
2621 ** placeholders for values that are [sqlite3_bind_blob | bound] 2784 ** placeholders for values that are [sqlite3_bind_blob | bound]
2622 ** to the parameters at a later time. 2785 ** to the parameters at a later time.
2623 ** 2786 **
2624 ** This routine actually returns the index of the largest (rightmost) 2787 ** ^(This routine actually returns the index of the largest (rightmost)
2625 ** parameter. For all forms except ?NNN, this will correspond to the 2788 ** parameter. For all forms except ?NNN, this will correspond to the
2626 ** number of unique parameters. If parameters of the ?NNN are used, 2789 ** number of unique parameters. If parameters of the ?NNN form are used,
2627 ** there may be gaps in the list. 2790 ** there may be gaps in the list.)^
2628 ** 2791 **
2629 ** See also: [sqlite3_bind_blob|sqlite3_bind()], 2792 ** See also: [sqlite3_bind_blob|sqlite3_bind()],
2630 ** [sqlite3_bind_parameter_name()], and 2793 ** [sqlite3_bind_parameter_name()], and
2631 ** [sqlite3_bind_parameter_index()]. 2794 ** [sqlite3_bind_parameter_index()].
2632 **
2633 ** Requirements:
2634 ** [H13601]
2635 */ 2795 */
2636 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*); 2796 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
2637 2797
2638 /* 2798 /*
2639 ** CAPI3REF: Name Of A Host Parameter {H13620} <S70300> 2799 ** CAPI3REF: Name Of A Host Parameter
2640 ** 2800 **
2641 ** This routine returns a pointer to the name of the n-th 2801 ** ^The sqlite3_bind_parameter_name(P,N) interface returns
2642 ** [SQL parameter] in a [prepared statement]. 2802 ** the name of the N-th [SQL parameter] in the [prepared statement] P.
2643 ** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" 2803 ** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
2644 ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" 2804 ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
2645 ** respectively. 2805 ** respectively.
2646 ** In other words, the initial ":" or "$" or "@" or "?" 2806 ** In other words, the initial ":" or "$" or "@" or "?"
2647 ** is included as part of the name. 2807 ** is included as part of the name.)^
2648 ** Parameters of the form "?" without a following integer have no name 2808 ** ^Parameters of the form "?" without a following integer have no name
2649 ** and are also referred to as "anonymous parameters". 2809 ** and are referred to as "nameless" or "anonymous parameters".
2650 ** 2810 **
2651 ** The first host parameter has an index of 1, not 0. 2811 ** ^The first host parameter has an index of 1, not 0.
2652 ** 2812 **
2653 ** If the value n is out of range or if the n-th parameter is 2813 ** ^If the value N is out of range or if the N-th parameter is
2654 ** nameless, then NULL is returned. The returned string is 2814 ** nameless, then NULL is returned. ^The returned string is
2655 ** always in UTF-8 encoding even if the named parameter was 2815 ** always in UTF-8 encoding even if the named parameter was
2656 ** originally specified as UTF-16 in [sqlite3_prepare16()] or 2816 ** originally specified as UTF-16 in [sqlite3_prepare16()] or
2657 ** [sqlite3_prepare16_v2()]. 2817 ** [sqlite3_prepare16_v2()].
2658 ** 2818 **
2659 ** See also: [sqlite3_bind_blob|sqlite3_bind()], 2819 ** See also: [sqlite3_bind_blob|sqlite3_bind()],
2660 ** [sqlite3_bind_parameter_count()], and 2820 ** [sqlite3_bind_parameter_count()], and
2661 ** [sqlite3_bind_parameter_index()]. 2821 ** [sqlite3_bind_parameter_index()].
2662 **
2663 ** Requirements:
2664 ** [H13621]
2665 */ 2822 */
2666 SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); 2823 SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
2667 2824
2668 /* 2825 /*
2669 ** CAPI3REF: Index Of A Parameter With A Given Name {H13640} <S70300> 2826 ** CAPI3REF: Index Of A Parameter With A Given Name
2670 ** 2827 **
2671 ** Return the index of an SQL parameter given its name. The 2828 ** ^Return the index of an SQL parameter given its name. ^The
2672 ** index value returned is suitable for use as the second 2829 ** index value returned is suitable for use as the second
2673 ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero 2830 ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero
2674 ** is returned if no matching parameter is found. The parameter 2831 ** is returned if no matching parameter is found. ^The parameter
2675 ** name must be given in UTF-8 even if the original statement 2832 ** name must be given in UTF-8 even if the original statement
2676 ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. 2833 ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
2677 ** 2834 **
2678 ** See also: [sqlite3_bind_blob|sqlite3_bind()], 2835 ** See also: [sqlite3_bind_blob|sqlite3_bind()],
2679 ** [sqlite3_bind_parameter_count()], and 2836 ** [sqlite3_bind_parameter_count()], and
2680 ** [sqlite3_bind_parameter_index()]. 2837 ** [sqlite3_bind_parameter_index()].
2681 **
2682 ** Requirements:
2683 ** [H13641]
2684 */ 2838 */
2685 SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); 2839 SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
2686 2840
2687 /* 2841 /*
2688 ** CAPI3REF: Reset All Bindings On A Prepared Statement {H13660} <S70300> 2842 ** CAPI3REF: Reset All Bindings On A Prepared Statement
2689 ** 2843 **
2690 ** Contrary to the intuition of many, [sqlite3_reset()] does not reset 2844 ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
2691 ** the [sqlite3_bind_blob | bindings] on a [prepared statement]. 2845 ** the [sqlite3_bind_blob | bindings] on a [prepared statement].
2692 ** Use this routine to reset all host parameters to NULL. 2846 ** ^Use this routine to reset all host parameters to NULL.
2693 **
2694 ** Requirements:
2695 ** [H13661]
2696 */ 2847 */
2697 SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*); 2848 SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
2698 2849
2699 /* 2850 /*
2700 ** CAPI3REF: Number Of Columns In A Result Set {H13710} <S10700> 2851 ** CAPI3REF: Number Of Columns In A Result Set
2701 ** 2852 **
2702 ** Return the number of columns in the result set returned by the 2853 ** ^Return the number of columns in the result set returned by the
2703 ** [prepared statement]. This routine returns 0 if pStmt is an SQL 2854 ** [prepared statement]. ^This routine returns 0 if pStmt is an SQL
2704 ** statement that does not return data (for example an [UPDATE]). 2855 ** statement that does not return data (for example an [UPDATE]).
2705 ** 2856 **
2706 ** Requirements: 2857 ** See also: [sqlite3_data_count()]
2707 ** [H13711]
2708 */ 2858 */
2709 SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt); 2859 SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
2710 2860
2711 /* 2861 /*
2712 ** CAPI3REF: Column Names In A Result Set {H13720} <S10700> 2862 ** CAPI3REF: Column Names In A Result Set
2713 ** 2863 **
2714 ** These routines return the name assigned to a particular column 2864 ** ^These routines return the name assigned to a particular column
2715 ** in the result set of a [SELECT] statement. The sqlite3_column_name() 2865 ** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
2716 ** interface returns a pointer to a zero-terminated UTF-8 string 2866 ** interface returns a pointer to a zero-terminated UTF-8 string
2717 ** and sqlite3_column_name16() returns a pointer to a zero-terminated 2867 ** and sqlite3_column_name16() returns a pointer to a zero-terminated
2718 ** UTF-16 string. The first parameter is the [prepared statement] 2868 ** UTF-16 string. ^The first parameter is the [prepared statement]
2719 ** that implements the [SELECT] statement. The second parameter is the 2869 ** that implements the [SELECT] statement. ^The second parameter is the
2720 ** column number. The leftmost column is number 0. 2870 ** column number. ^The leftmost column is number 0.
2721 ** 2871 **
2722 ** The returned string pointer is valid until either the [prepared statement] 2872 ** ^The returned string pointer is valid until either the [prepared statement]
2723 ** is destroyed by [sqlite3_finalize()] or until the next call to 2873 ** is destroyed by [sqlite3_finalize()] or until the next call to
2724 ** sqlite3_column_name() or sqlite3_column_name16() on the same column. 2874 ** sqlite3_column_name() or sqlite3_column_name16() on the same column.
2725 ** 2875 **
2726 ** If sqlite3_malloc() fails during the processing of either routine 2876 ** ^If sqlite3_malloc() fails during the processing of either routine
2727 ** (for example during a conversion from UTF-8 to UTF-16) then a 2877 ** (for example during a conversion from UTF-8 to UTF-16) then a
2728 ** NULL pointer is returned. 2878 ** NULL pointer is returned.
2729 ** 2879 **
2730 ** The name of a result column is the value of the "AS" clause for 2880 ** ^The name of a result column is the value of the "AS" clause for
2731 ** that column, if there is an AS clause. If there is no AS clause 2881 ** that column, if there is an AS clause. If there is no AS clause
2732 ** then the name of the column is unspecified and may change from 2882 ** then the name of the column is unspecified and may change from
2733 ** one release of SQLite to the next. 2883 ** one release of SQLite to the next.
2734 **
2735 ** Requirements:
2736 ** [H13721] [H13723] [H13724] [H13725] [H13726] [H13727]
2737 */ 2884 */
2738 SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N); 2885 SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);
2739 SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N); 2886 SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
2740 2887
2741 /* 2888 /*
2742 ** CAPI3REF: Source Of Data In A Query Result {H13740} <S10700> 2889 ** CAPI3REF: Source Of Data In A Query Result
2743 ** 2890 **
2744 ** These routines provide a means to determine what column of what 2891 ** ^These routines provide a means to determine the database, table, and
2745 ** table in which database a result of a [SELECT] statement comes from. 2892 ** table column that is the origin of a particular result column in
2746 ** The name of the database or table or column can be returned as 2893 ** [SELECT] statement.
2747 ** either a UTF-8 or UTF-16 string. The _database_ routines return 2894 ** ^The name of the database or table or column can be returned as
2895 ** either a UTF-8 or UTF-16 string. ^The _database_ routines return
2748 ** the database name, the _table_ routines return the table name, and 2896 ** the database name, the _table_ routines return the table name, and
2749 ** the origin_ routines return the column name. 2897 ** the origin_ routines return the column name.
2750 ** The returned string is valid until the [prepared statement] is destroyed 2898 ** ^The returned string is valid until the [prepared statement] is destroyed
2751 ** using [sqlite3_finalize()] or until the same information is requested 2899 ** using [sqlite3_finalize()] or until the same information is requested
2752 ** again in a different encoding. 2900 ** again in a different encoding.
2753 ** 2901 **
2754 ** The names returned are the original un-aliased names of the 2902 ** ^The names returned are the original un-aliased names of the
2755 ** database, table, and column. 2903 ** database, table, and column.
2756 ** 2904 **
2757 ** The first argument to the following calls is a [prepared statement]. 2905 ** ^The first argument to these interfaces is a [prepared statement].
2758 ** These functions return information about the Nth column returned by 2906 ** ^These functions return information about the Nth result column returned by
2759 ** the statement, where N is the second function argument. 2907 ** the statement, where N is the second function argument.
2908 ** ^The left-most column is column 0 for these routines.
2760 ** 2909 **
2761 ** If the Nth column returned by the statement is an expression or 2910 ** ^If the Nth column returned by the statement is an expression or
2762 ** subquery and is not a column value, then all of these functions return 2911 ** subquery and is not a column value, then all of these functions return
2763 ** NULL. These routine might also return NULL if a memory allocation error 2912 ** NULL. ^These routine might also return NULL if a memory allocation error
2764 ** occurs. Otherwise, they return the name of the attached database, table 2913 ** occurs. ^Otherwise, they return the name of the attached database, table,
2765 ** and column that query result column was extracted from. 2914 ** or column that query result column was extracted from.
2766 ** 2915 **
2767 ** As with all other SQLite APIs, those postfixed with "16" return 2916 ** ^As with all other SQLite APIs, those whose names end with "16" return
2768 ** UTF-16 encoded strings, the other functions return UTF-8. {END} 2917 ** UTF-16 encoded strings and the other functions return UTF-8.
2769 ** 2918 **
2770 ** These APIs are only available if the library was compiled with the 2919 ** ^These APIs are only available if the library was compiled with the
2771 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. 2920 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
2772 ** 2921 **
2773 ** {A13751}
2774 ** If two or more threads call one or more of these routines against the same 2922 ** If two or more threads call one or more of these routines against the same
2775 ** prepared statement and column at the same time then the results are 2923 ** prepared statement and column at the same time then the results are
2776 ** undefined. 2924 ** undefined.
2777 ** 2925 **
2778 ** Requirements:
2779 ** [H13741] [H13742] [H13743] [H13744] [H13745] [H13746] [H13748]
2780 **
2781 ** If two or more threads call one or more 2926 ** If two or more threads call one or more
2782 ** [sqlite3_column_database_name | column metadata interfaces] 2927 ** [sqlite3_column_database_name | column metadata interfaces]
2783 ** for the same [prepared statement] and result column 2928 ** for the same [prepared statement] and result column
2784 ** at the same time then the results are undefined. 2929 ** at the same time then the results are undefined.
2785 */ 2930 */
2786 SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int); 2931 SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);
2787 SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int); 2932 SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
2788 SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int); 2933 SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);
2789 SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int); 2934 SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
2790 SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int); 2935 SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
2791 SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); 2936 SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
2792 2937
2793 /* 2938 /*
2794 ** CAPI3REF: Declared Datatype Of A Query Result {H13760} <S10700> 2939 ** CAPI3REF: Declared Datatype Of A Query Result
2795 ** 2940 **
2796 ** The first parameter is a [prepared statement]. 2941 ** ^(The first parameter is a [prepared statement].
2797 ** If this statement is a [SELECT] statement and the Nth column of the 2942 ** If this statement is a [SELECT] statement and the Nth column of the
2798 ** returned result set of that [SELECT] is a table column (not an 2943 ** returned result set of that [SELECT] is a table column (not an
2799 ** expression or subquery) then the declared type of the table 2944 ** expression or subquery) then the declared type of the table
2800 ** column is returned. If the Nth column of the result set is an 2945 ** column is returned.)^ ^If the Nth column of the result set is an
2801 ** expression or subquery, then a NULL pointer is returned. 2946 ** expression or subquery, then a NULL pointer is returned.
2802 ** The returned string is always UTF-8 encoded. {END} 2947 ** ^The returned string is always UTF-8 encoded.
2803 ** 2948 **
2804 ** For example, given the database schema: 2949 ** ^(For example, given the database schema:
2805 ** 2950 **
2806 ** CREATE TABLE t1(c1 VARIANT); 2951 ** CREATE TABLE t1(c1 VARIANT);
2807 ** 2952 **
2808 ** and the following statement to be compiled: 2953 ** and the following statement to be compiled:
2809 ** 2954 **
2810 ** SELECT c1 + 1, c1 FROM t1; 2955 ** SELECT c1 + 1, c1 FROM t1;
2811 ** 2956 **
2812 ** this routine would return the string "VARIANT" for the second result 2957 ** this routine would return the string "VARIANT" for the second result
2813 ** column (i==1), and a NULL pointer for the first result column (i==0). 2958 ** column (i==1), and a NULL pointer for the first result column (i==0).)^
2814 ** 2959 **
2815 ** SQLite uses dynamic run-time typing. So just because a column 2960 ** ^SQLite uses dynamic run-time typing. ^So just because a column
2816 ** is declared to contain a particular type does not mean that the 2961 ** is declared to contain a particular type does not mean that the
2817 ** data stored in that column is of the declared type. SQLite is 2962 ** data stored in that column is of the declared type. SQLite is
2818 ** strongly typed, but the typing is dynamic not static. Type 2963 ** strongly typed, but the typing is dynamic not static. ^Type
2819 ** is associated with individual values, not with the containers 2964 ** is associated with individual values, not with the containers
2820 ** used to hold those values. 2965 ** used to hold those values.
2821 **
2822 ** Requirements:
2823 ** [H13761] [H13762] [H13763]
2824 */ 2966 */
2825 SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int); 2967 SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);
2826 SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int); 2968 SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
2827 2969
2828 /* 2970 /*
2829 ** CAPI3REF: Evaluate An SQL Statement {H13200} <S10000> 2971 ** CAPI3REF: Evaluate An SQL Statement
2830 ** 2972 **
2831 ** After a [prepared statement] has been prepared using either 2973 ** After a [prepared statement] has been prepared using either
2832 ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy 2974 ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
2833 ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function 2975 ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
2834 ** must be called one or more times to evaluate the statement. 2976 ** must be called one or more times to evaluate the statement.
2835 ** 2977 **
2836 ** The details of the behavior of the sqlite3_step() interface depend 2978 ** The details of the behavior of the sqlite3_step() interface depend
2837 ** on whether the statement was prepared using the newer "v2" interface 2979 ** on whether the statement was prepared using the newer "v2" interface
2838 ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy 2980 ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
2839 ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the 2981 ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
2840 ** new "v2" interface is recommended for new applications but the legacy 2982 ** new "v2" interface is recommended for new applications but the legacy
2841 ** interface will continue to be supported. 2983 ** interface will continue to be supported.
2842 ** 2984 **
2843 ** In the legacy interface, the return value will be either [SQLITE_BUSY], 2985 ** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
2844 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. 2986 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
2845 ** With the "v2" interface, any of the other [result codes] or 2987 ** ^With the "v2" interface, any of the other [result codes] or
2846 ** [extended result codes] might be returned as well. 2988 ** [extended result codes] might be returned as well.
2847 ** 2989 **
2848 ** [SQLITE_BUSY] means that the database engine was unable to acquire the 2990 ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
2849 ** database locks it needs to do its job. If the statement is a [COMMIT] 2991 ** database locks it needs to do its job. ^If the statement is a [COMMIT]
2850 ** or occurs outside of an explicit transaction, then you can retry the 2992 ** or occurs outside of an explicit transaction, then you can retry the
2851 ** statement. If the statement is not a [COMMIT] and occurs within a 2993 ** statement. If the statement is not a [COMMIT] and occurs within a
2852 ** explicit transaction then you should rollback the transaction before 2994 ** explicit transaction then you should rollback the transaction before
2853 ** continuing. 2995 ** continuing.
2854 ** 2996 **
2855 ** [SQLITE_DONE] means that the statement has finished executing 2997 ** ^[SQLITE_DONE] means that the statement has finished executing
2856 ** successfully. sqlite3_step() should not be called again on this virtual 2998 ** successfully. sqlite3_step() should not be called again on this virtual
2857 ** machine without first calling [sqlite3_reset()] to reset the virtual 2999 ** machine without first calling [sqlite3_reset()] to reset the virtual
2858 ** machine back to its initial state. 3000 ** machine back to its initial state.
2859 ** 3001 **
2860 ** If the SQL statement being executed returns any data, then [SQLITE_ROW] 3002 ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
2861 ** is returned each time a new row of data is ready for processing by the 3003 ** is returned each time a new row of data is ready for processing by the
2862 ** caller. The values may be accessed using the [column access functions]. 3004 ** caller. The values may be accessed using the [column access functions].
2863 ** sqlite3_step() is called again to retrieve the next row of data. 3005 ** sqlite3_step() is called again to retrieve the next row of data.
2864 ** 3006 **
2865 ** [SQLITE_ERROR] means that a run-time error (such as a constraint 3007 ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
2866 ** violation) has occurred. sqlite3_step() should not be called again on 3008 ** violation) has occurred. sqlite3_step() should not be called again on
2867 ** the VM. More information may be found by calling [sqlite3_errmsg()]. 3009 ** the VM. More information may be found by calling [sqlite3_errmsg()].
2868 ** With the legacy interface, a more specific error code (for example, 3010 ** ^With the legacy interface, a more specific error code (for example,
2869 ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) 3011 ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
2870 ** can be obtained by calling [sqlite3_reset()] on the 3012 ** can be obtained by calling [sqlite3_reset()] on the
2871 ** [prepared statement]. In the "v2" interface, 3013 ** [prepared statement]. ^In the "v2" interface,
2872 ** the more specific error code is returned directly by sqlite3_step(). 3014 ** the more specific error code is returned directly by sqlite3_step().
2873 ** 3015 **
2874 ** [SQLITE_MISUSE] means that the this routine was called inappropriately. 3016 ** [SQLITE_MISUSE] means that the this routine was called inappropriately.
2875 ** Perhaps it was called on a [prepared statement] that has 3017 ** Perhaps it was called on a [prepared statement] that has
2876 ** already been [sqlite3_finalize | finalized] or on one that had 3018 ** already been [sqlite3_finalize | finalized] or on one that had
2877 ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could 3019 ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
2878 ** be the case that the same database connection is being used by two or 3020 ** be the case that the same database connection is being used by two or
2879 ** more threads at the same moment in time. 3021 ** more threads at the same moment in time.
2880 ** 3022 **
3023 ** For all versions of SQLite up to and including 3.6.23.1, it was required
3024 ** after sqlite3_step() returned anything other than [SQLITE_ROW] that
3025 ** [sqlite3_reset()] be called before any subsequent invocation of
3026 ** sqlite3_step(). Failure to invoke [sqlite3_reset()] in this way would
3027 ** result in an [SQLITE_MISUSE] return from sqlite3_step(). But after
3028 ** version 3.6.23.1, sqlite3_step() began calling [sqlite3_reset()]
3029 ** automatically in this circumstance rather than returning [SQLITE_MISUSE].
3030 **
2881 ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() 3031 ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
2882 ** API always returns a generic error code, [SQLITE_ERROR], following any 3032 ** API always returns a generic error code, [SQLITE_ERROR], following any
2883 ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call 3033 ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
2884 ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the 3034 ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
2885 ** specific [error codes] that better describes the error. 3035 ** specific [error codes] that better describes the error.
2886 ** We admit that this is a goofy design. The problem has been fixed 3036 ** We admit that this is a goofy design. The problem has been fixed
2887 ** with the "v2" interface. If you prepare all of your SQL statements 3037 ** with the "v2" interface. If you prepare all of your SQL statements
2888 ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead 3038 ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
2889 ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, 3039 ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
2890 ** then the more specific [error codes] are returned directly 3040 ** then the more specific [error codes] are returned directly
2891 ** by sqlite3_step(). The use of the "v2" interface is recommended. 3041 ** by sqlite3_step(). The use of the "v2" interface is recommended.
2892 **
2893 ** Requirements:
2894 ** [H13202] [H15304] [H15306] [H15308] [H15310]
2895 */ 3042 */
2896 SQLITE_API int sqlite3_step(sqlite3_stmt*); 3043 SQLITE_API int sqlite3_step(sqlite3_stmt*);
2897 3044
2898 /* 3045 /*
2899 ** CAPI3REF: Number of columns in a result set {H13770} <S10700> 3046 ** CAPI3REF: Number of columns in a result set
2900 ** 3047 **
2901 ** Returns the number of values in the current row of the result set. 3048 ** ^The sqlite3_data_count(P) interface returns the number of columns in the
3049 ** current row of the result set of [prepared statement] P.
3050 ** ^If prepared statement P does not have results ready to return
3051 ** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of
3052 ** interfaces) then sqlite3_data_count(P) returns 0.
3053 ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
2902 ** 3054 **
2903 ** Requirements: 3055 ** See also: [sqlite3_column_count()]
2904 ** [H13771] [H13772]
2905 */ 3056 */
2906 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt); 3057 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
2907 3058
2908 /* 3059 /*
2909 ** CAPI3REF: Fundamental Datatypes {H10265} <S10110><S10120> 3060 ** CAPI3REF: Fundamental Datatypes
2910 ** KEYWORDS: SQLITE_TEXT 3061 ** KEYWORDS: SQLITE_TEXT
2911 ** 3062 **
2912 ** {H10266} Every value in SQLite has one of five fundamental datatypes: 3063 ** ^(Every value in SQLite has one of five fundamental datatypes:
2913 ** 3064 **
2914 ** <ul> 3065 ** <ul>
2915 ** <li> 64-bit signed integer 3066 ** <li> 64-bit signed integer
2916 ** <li> 64-bit IEEE floating point number 3067 ** <li> 64-bit IEEE floating point number
2917 ** <li> string 3068 ** <li> string
2918 ** <li> BLOB 3069 ** <li> BLOB
2919 ** <li> NULL 3070 ** <li> NULL
2920 ** </ul> {END} 3071 ** </ul>)^
2921 ** 3072 **
2922 ** These constants are codes for each of those types. 3073 ** These constants are codes for each of those types.
2923 ** 3074 **
2924 ** Note that the SQLITE_TEXT constant was also used in SQLite version 2 3075 ** Note that the SQLITE_TEXT constant was also used in SQLite version 2
2925 ** for a completely different meaning. Software that links against both 3076 ** for a completely different meaning. Software that links against both
2926 ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not 3077 ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
2927 ** SQLITE_TEXT. 3078 ** SQLITE_TEXT.
2928 */ 3079 */
2929 #define SQLITE_INTEGER 1 3080 #define SQLITE_INTEGER 1
2930 #define SQLITE_FLOAT 2 3081 #define SQLITE_FLOAT 2
2931 #define SQLITE_BLOB 4 3082 #define SQLITE_BLOB 4
2932 #define SQLITE_NULL 5 3083 #define SQLITE_NULL 5
2933 #ifdef SQLITE_TEXT 3084 #ifdef SQLITE_TEXT
2934 # undef SQLITE_TEXT 3085 # undef SQLITE_TEXT
2935 #else 3086 #else
2936 # define SQLITE_TEXT 3 3087 # define SQLITE_TEXT 3
2937 #endif 3088 #endif
2938 #define SQLITE3_TEXT 3 3089 #define SQLITE3_TEXT 3
2939 3090
2940 /* 3091 /*
2941 ** CAPI3REF: Result Values From A Query {H13800} <S10700> 3092 ** CAPI3REF: Result Values From A Query
2942 ** KEYWORDS: {column access functions} 3093 ** KEYWORDS: {column access functions}
2943 ** 3094 **
2944 ** These routines form the "result set query" interface. 3095 ** These routines form the "result set" interface.
2945 ** 3096 **
2946 ** These routines return information about a single column of the current 3097 ** ^These routines return information about a single column of the current
2947 ** result row of a query. In every case the first argument is a pointer 3098 ** result row of a query. ^In every case the first argument is a pointer
2948 ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] 3099 ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
2949 ** that was returned from [sqlite3_prepare_v2()] or one of its variants) 3100 ** that was returned from [sqlite3_prepare_v2()] or one of its variants)
2950 ** and the second argument is the index of the column for which information 3101 ** and the second argument is the index of the column for which information
2951 ** should be returned. The leftmost column of the result set has the index 0. 3102 ** should be returned. ^The leftmost column of the result set has the index 0.
3103 ** ^The number of columns in the result can be determined using
3104 ** [sqlite3_column_count()].
2952 ** 3105 **
2953 ** If the SQL statement does not currently point to a valid row, or if the 3106 ** If the SQL statement does not currently point to a valid row, or if the
2954 ** column index is out of range, the result is undefined. 3107 ** column index is out of range, the result is undefined.
2955 ** These routines may only be called when the most recent call to 3108 ** These routines may only be called when the most recent call to
2956 ** [sqlite3_step()] has returned [SQLITE_ROW] and neither 3109 ** [sqlite3_step()] has returned [SQLITE_ROW] and neither
2957 ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. 3110 ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
2958 ** If any of these routines are called after [sqlite3_reset()] or 3111 ** If any of these routines are called after [sqlite3_reset()] or
2959 ** [sqlite3_finalize()] or after [sqlite3_step()] has returned 3112 ** [sqlite3_finalize()] or after [sqlite3_step()] has returned
2960 ** something other than [SQLITE_ROW], the results are undefined. 3113 ** something other than [SQLITE_ROW], the results are undefined.
2961 ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] 3114 ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
2962 ** are called from a different thread while any of these routines 3115 ** are called from a different thread while any of these routines
2963 ** are pending, then the results are undefined. 3116 ** are pending, then the results are undefined.
2964 ** 3117 **
2965 ** The sqlite3_column_type() routine returns the 3118 ** ^The sqlite3_column_type() routine returns the
2966 ** [SQLITE_INTEGER | datatype code] for the initial data type 3119 ** [SQLITE_INTEGER | datatype code] for the initial data type
2967 ** of the result column. The returned value is one of [SQLITE_INTEGER], 3120 ** of the result column. ^The returned value is one of [SQLITE_INTEGER],
2968 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value 3121 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
2969 ** returned by sqlite3_column_type() is only meaningful if no type 3122 ** returned by sqlite3_column_type() is only meaningful if no type
2970 ** conversions have occurred as described below. After a type conversion, 3123 ** conversions have occurred as described below. After a type conversion,
2971 ** the value returned by sqlite3_column_type() is undefined. Future 3124 ** the value returned by sqlite3_column_type() is undefined. Future
2972 ** versions of SQLite may change the behavior of sqlite3_column_type() 3125 ** versions of SQLite may change the behavior of sqlite3_column_type()
2973 ** following a type conversion. 3126 ** following a type conversion.
2974 ** 3127 **
2975 ** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() 3128 ** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
2976 ** routine returns the number of bytes in that BLOB or string. 3129 ** routine returns the number of bytes in that BLOB or string.
2977 ** If the result is a UTF-16 string, then sqlite3_column_bytes() converts 3130 ** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
2978 ** the string to UTF-8 and then returns the number of bytes. 3131 ** the string to UTF-8 and then returns the number of bytes.
2979 ** If the result is a numeric value then sqlite3_column_bytes() uses 3132 ** ^If the result is a numeric value then sqlite3_column_bytes() uses
2980 ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns 3133 ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
2981 ** the number of bytes in that string. 3134 ** the number of bytes in that string.
2982 ** The value returned does not include the zero terminator at the end 3135 ** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
2983 ** of the string. For clarity: the value returned is the number of 3136 **
3137 ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
3138 ** routine returns the number of bytes in that BLOB or string.
3139 ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
3140 ** the string to UTF-16 and then returns the number of bytes.
3141 ** ^If the result is a numeric value then sqlite3_column_bytes16() uses
3142 ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
3143 ** the number of bytes in that string.
3144 ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
3145 **
3146 ** ^The values returned by [sqlite3_column_bytes()] and
3147 ** [sqlite3_column_bytes16()] do not include the zero terminators at the end
3148 ** of the string. ^For clarity: the values returned by
3149 ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
2984 ** bytes in the string, not the number of characters. 3150 ** bytes in the string, not the number of characters.
2985 ** 3151 **
2986 ** Strings returned by sqlite3_column_text() and sqlite3_column_text16(), 3152 ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
2987 ** even empty strings, are always zero terminated. The return 3153 ** even empty strings, are always zero terminated. ^The return
2988 ** value from sqlite3_column_blob() for a zero-length BLOB is an arbitrary 3154 ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
2989 ** pointer, possibly even a NULL pointer.
2990 ** 3155 **
2991 ** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes() 3156 ** ^The object returned by [sqlite3_column_value()] is an
2992 ** but leaves the result in UTF-16 in native byte order instead of UTF-8.
2993 ** The zero terminator is not included in this count.
2994 **
2995 ** The object returned by [sqlite3_column_value()] is an
2996 ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object 3157 ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
2997 ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. 3158 ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
2998 ** If the [unprotected sqlite3_value] object returned by 3159 ** If the [unprotected sqlite3_value] object returned by
2999 ** [sqlite3_column_value()] is used in any other way, including calls 3160 ** [sqlite3_column_value()] is used in any other way, including calls
3000 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()], 3161 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
3001 ** or [sqlite3_value_bytes()], then the behavior is undefined. 3162 ** or [sqlite3_value_bytes()], then the behavior is undefined.
3002 ** 3163 **
3003 ** These routines attempt to convert the value where appropriate. For 3164 ** These routines attempt to convert the value where appropriate. ^For
3004 ** example, if the internal representation is FLOAT and a text result 3165 ** example, if the internal representation is FLOAT and a text result
3005 ** is requested, [sqlite3_snprintf()] is used internally to perform the 3166 ** is requested, [sqlite3_snprintf()] is used internally to perform the
3006 ** conversion automatically. The following table details the conversions 3167 ** conversion automatically. ^(The following table details the conversions
3007 ** that are applied: 3168 ** that are applied:
3008 ** 3169 **
3009 ** <blockquote> 3170 ** <blockquote>
3010 ** <table border="1"> 3171 ** <table border="1">
3011 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion 3172 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
3012 ** 3173 **
3013 ** <tr><td> NULL <td> INTEGER <td> Result is 0 3174 ** <tr><td> NULL <td> INTEGER <td> Result is 0
3014 ** <tr><td> NULL <td> FLOAT <td> Result is 0.0 3175 ** <tr><td> NULL <td> FLOAT <td> Result is 0.0
3015 ** <tr><td> NULL <td> TEXT <td> Result is NULL pointer 3176 ** <tr><td> NULL <td> TEXT <td> Result is NULL pointer
3016 ** <tr><td> NULL <td> BLOB <td> Result is NULL pointer 3177 ** <tr><td> NULL <td> BLOB <td> Result is NULL pointer
3017 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float 3178 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
3018 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer 3179 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
3019 ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT 3180 ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
3020 ** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer 3181 ** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer
3021 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float 3182 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
3022 ** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT 3183 ** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT
3023 ** <tr><td> TEXT <td> INTEGER <td> Use atoi() 3184 ** <tr><td> TEXT <td> INTEGER <td> Use atoi()
3024 ** <tr><td> TEXT <td> FLOAT <td> Use atof() 3185 ** <tr><td> TEXT <td> FLOAT <td> Use atof()
3025 ** <tr><td> TEXT <td> BLOB <td> No change 3186 ** <tr><td> TEXT <td> BLOB <td> No change
3026 ** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() 3187 ** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi()
3027 ** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() 3188 ** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof()
3028 ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed 3189 ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
3029 ** </table> 3190 ** </table>
3030 ** </blockquote> 3191 ** </blockquote>)^
3031 ** 3192 **
3032 ** The table above makes reference to standard C library functions atoi() 3193 ** The table above makes reference to standard C library functions atoi()
3033 ** and atof(). SQLite does not really use these functions. It has its 3194 ** and atof(). SQLite does not really use these functions. It has its
3034 ** own equivalent internal routines. The atoi() and atof() names are 3195 ** own equivalent internal routines. The atoi() and atof() names are
3035 ** used in the table for brevity and because they are familiar to most 3196 ** used in the table for brevity and because they are familiar to most
3036 ** C programmers. 3197 ** C programmers.
3037 ** 3198 **
3038 ** Note that when type conversions occur, pointers returned by prior 3199 ** Note that when type conversions occur, pointers returned by prior
3039 ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or 3200 ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
3040 ** sqlite3_column_text16() may be invalidated. 3201 ** sqlite3_column_text16() may be invalidated.
3041 ** Type conversions and pointer invalidations might occur 3202 ** Type conversions and pointer invalidations might occur
3042 ** in the following cases: 3203 ** in the following cases:
3043 ** 3204 **
3044 ** <ul> 3205 ** <ul>
3045 ** <li> The initial content is a BLOB and sqlite3_column_text() or 3206 ** <li> The initial content is a BLOB and sqlite3_column_text() or
3046 ** sqlite3_column_text16() is called. A zero-terminator might 3207 ** sqlite3_column_text16() is called. A zero-terminator might
3047 ** need to be added to the string.</li> 3208 ** need to be added to the string.</li>
3048 ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or 3209 ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
3049 ** sqlite3_column_text16() is called. The content must be converted 3210 ** sqlite3_column_text16() is called. The content must be converted
3050 ** to UTF-16.</li> 3211 ** to UTF-16.</li>
3051 ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or 3212 ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
3052 ** sqlite3_column_text() is called. The content must be converted 3213 ** sqlite3_column_text() is called. The content must be converted
3053 ** to UTF-8.</li> 3214 ** to UTF-8.</li>
3054 ** </ul> 3215 ** </ul>
3055 ** 3216 **
3056 ** Conversions between UTF-16be and UTF-16le are always done in place and do 3217 ** ^Conversions between UTF-16be and UTF-16le are always done in place and do
3057 ** not invalidate a prior pointer, though of course the content of the buffer 3218 ** not invalidate a prior pointer, though of course the content of the buffer
3058 ** that the prior pointer points to will have been modified. Other kinds 3219 ** that the prior pointer references will have been modified. Other kinds
3059 ** of conversion are done in place when it is possible, but sometimes they 3220 ** of conversion are done in place when it is possible, but sometimes they
3060 ** are not possible and in those cases prior pointers are invalidated. 3221 ** are not possible and in those cases prior pointers are invalidated.
3061 ** 3222 **
3062 ** The safest and easiest to remember policy is to invoke these routines 3223 ** The safest and easiest to remember policy is to invoke these routines
3063 ** in one of the following ways: 3224 ** in one of the following ways:
3064 ** 3225 **
3065 ** <ul> 3226 ** <ul>
3066 ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> 3227 ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
3067 ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> 3228 ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
3068 ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> 3229 ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
3069 ** </ul> 3230 ** </ul>
3070 ** 3231 **
3071 ** In other words, you should call sqlite3_column_text(), 3232 ** In other words, you should call sqlite3_column_text(),
3072 ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result 3233 ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
3073 ** into the desired format, then invoke sqlite3_column_bytes() or 3234 ** into the desired format, then invoke sqlite3_column_bytes() or
3074 ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls 3235 ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
3075 ** to sqlite3_column_text() or sqlite3_column_blob() with calls to 3236 ** to sqlite3_column_text() or sqlite3_column_blob() with calls to
3076 ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() 3237 ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
3077 ** with calls to sqlite3_column_bytes(). 3238 ** with calls to sqlite3_column_bytes().
3078 ** 3239 **
3079 ** The pointers returned are valid until a type conversion occurs as 3240 ** ^The pointers returned are valid until a type conversion occurs as
3080 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or 3241 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
3081 ** [sqlite3_finalize()] is called. The memory space used to hold strings 3242 ** [sqlite3_finalize()] is called. ^The memory space used to hold strings
3082 ** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned 3243 ** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned
3083 ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 3244 ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
3084 ** [sqlite3_free()]. 3245 ** [sqlite3_free()].
3085 ** 3246 **
3086 ** If a memory allocation error occurs during the evaluation of any 3247 ** ^(If a memory allocation error occurs during the evaluation of any
3087 ** of these routines, a default value is returned. The default value 3248 ** of these routines, a default value is returned. The default value
3088 ** is either the integer 0, the floating point number 0.0, or a NULL 3249 ** is either the integer 0, the floating point number 0.0, or a NULL
3089 ** pointer. Subsequent calls to [sqlite3_errcode()] will return 3250 ** pointer. Subsequent calls to [sqlite3_errcode()] will return
3090 ** [SQLITE_NOMEM]. 3251 ** [SQLITE_NOMEM].)^
3091 **
3092 ** Requirements:
3093 ** [H13803] [H13806] [H13809] [H13812] [H13815] [H13818] [H13821] [H13824]
3094 ** [H13827] [H13830]
3095 */ 3252 */
3096 SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); 3253 SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
3097 SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); 3254 SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
3098 SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); 3255 SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
3099 SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); 3256 SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
3100 SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); 3257 SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
3101 SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); 3258 SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
3102 SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); 3259 SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
3103 SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); 3260 SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
3104 SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); 3261 SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
3105 SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); 3262 SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
3106 3263
3107 /* 3264 /*
3108 ** CAPI3REF: Destroy A Prepared Statement Object {H13300} <S70300><S30100> 3265 ** CAPI3REF: Destroy A Prepared Statement Object
3109 ** 3266 **
3110 ** The sqlite3_finalize() function is called to delete a [prepared statement]. 3267 ** ^The sqlite3_finalize() function is called to delete a [prepared statement].
3111 ** If the statement was executed successfully or not executed at all, then 3268 ** ^If the most recent evaluation of the statement encountered no errors or
3112 ** SQLITE_OK is returned. If execution of the statement failed then an 3269 ** or if the statement is never been evaluated, then sqlite3_finalize() returns
3113 ** [error code] or [extended error code] is returned. 3270 ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
3271 ** sqlite3_finalize(S) returns the appropriate [error code] or
3272 ** [extended error code].
3114 ** 3273 **
3115 ** This routine can be called at any point during the execution of the 3274 ** ^The sqlite3_finalize(S) routine can be called at any point during
3116 ** [prepared statement]. If the virtual machine has not 3275 ** the life cycle of [prepared statement] S:
3117 ** completed execution when this routine is called, that is like 3276 ** before statement S is ever evaluated, after
3118 ** encountering an error or an [sqlite3_interrupt | interrupt]. 3277 ** one or more calls to [sqlite3_reset()], or after any call
3119 ** Incomplete updates may be rolled back and transactions canceled, 3278 ** to [sqlite3_step()] regardless of whether or not the statement has
3120 ** depending on the circumstances, and the 3279 ** completed execution.
3121 ** [error code] returned will be [SQLITE_ABORT].
3122 ** 3280 **
3123 ** Requirements: 3281 ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
3124 ** [H11302] [H11304] 3282 **
3283 ** The application must finalize every [prepared statement] in order to avoid
3284 ** resource leaks. It is a grievous error for the application to try to use
3285 ** a prepared statement after it has been finalized. Any use of a prepared
3286 ** statement after it has been finalized can result in undefined and
3287 ** undesirable behavior such as segfaults and heap corruption.
3125 */ 3288 */
3126 SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt); 3289 SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
3127 3290
3128 /* 3291 /*
3129 ** CAPI3REF: Reset A Prepared Statement Object {H13330} <S70300> 3292 ** CAPI3REF: Reset A Prepared Statement Object
3130 ** 3293 **
3131 ** The sqlite3_reset() function is called to reset a [prepared statement] 3294 ** The sqlite3_reset() function is called to reset a [prepared statement]
3132 ** object back to its initial state, ready to be re-executed. 3295 ** object back to its initial state, ready to be re-executed.
3133 ** Any SQL statement variables that had values bound to them using 3296 ** ^Any SQL statement variables that had values bound to them using
3134 ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. 3297 ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
3135 ** Use [sqlite3_clear_bindings()] to reset the bindings. 3298 ** Use [sqlite3_clear_bindings()] to reset the bindings.
3136 ** 3299 **
3137 ** {H11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S 3300 ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
3138 ** back to the beginning of its program. 3301 ** back to the beginning of its program.
3139 ** 3302 **
3140 ** {H11334} If the most recent call to [sqlite3_step(S)] for the 3303 ** ^If the most recent call to [sqlite3_step(S)] for the
3141 ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], 3304 ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
3142 ** or if [sqlite3_step(S)] has never before been called on S, 3305 ** or if [sqlite3_step(S)] has never before been called on S,
3143 ** then [sqlite3_reset(S)] returns [SQLITE_OK]. 3306 ** then [sqlite3_reset(S)] returns [SQLITE_OK].
3144 ** 3307 **
3145 ** {H11336} If the most recent call to [sqlite3_step(S)] for the 3308 ** ^If the most recent call to [sqlite3_step(S)] for the
3146 ** [prepared statement] S indicated an error, then 3309 ** [prepared statement] S indicated an error, then
3147 ** [sqlite3_reset(S)] returns an appropriate [error code]. 3310 ** [sqlite3_reset(S)] returns an appropriate [error code].
3148 ** 3311 **
3149 ** {H11338} The [sqlite3_reset(S)] interface does not change the values 3312 ** ^The [sqlite3_reset(S)] interface does not change the values
3150 ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. 3313 ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
3151 */ 3314 */
3152 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); 3315 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
3153 3316
3154 /* 3317 /*
3155 ** CAPI3REF: Create Or Redefine SQL Functions {H16100} <S20200> 3318 ** CAPI3REF: Create Or Redefine SQL Functions
3156 ** KEYWORDS: {function creation routines} 3319 ** KEYWORDS: {function creation routines}
3157 ** KEYWORDS: {application-defined SQL function} 3320 ** KEYWORDS: {application-defined SQL function}
3158 ** KEYWORDS: {application-defined SQL functions} 3321 ** KEYWORDS: {application-defined SQL functions}
3159 ** 3322 **
3160 ** These two functions (collectively known as "function creation routines") 3323 ** ^These functions (collectively known as "function creation routines")
3161 ** are used to add SQL functions or aggregates or to redefine the behavior 3324 ** are used to add SQL functions or aggregates or to redefine the behavior
3162 ** of existing SQL functions or aggregates. The only difference between the 3325 ** of existing SQL functions or aggregates. The only differences between
3163 ** two is that the second parameter, the name of the (scalar) function or 3326 ** these routines are the text encoding expected for
3164 ** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16 3327 ** the the second parameter (the name of the function being created)
3165 ** for sqlite3_create_function16(). 3328 ** and the presence or absence of a destructor callback for
3329 ** the application data pointer.
3166 ** 3330 **
3167 ** The first parameter is the [database connection] to which the SQL 3331 ** ^The first parameter is the [database connection] to which the SQL
3168 ** function is to be added. If a single program uses more than one database 3332 ** function is to be added. ^If an application uses more than one database
3169 ** connection internally, then SQL functions must be added individually to 3333 ** connection then application-defined SQL functions must be added
3170 ** each database connection. 3334 ** to each database connection separately.
3171 ** 3335 **
3172 ** The second parameter is the name of the SQL function to be created or 3336 ** ^The second parameter is the name of the SQL function to be created or
3173 ** redefined. The length of the name is limited to 255 bytes, exclusive of 3337 ** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
3174 ** the zero-terminator. Note that the name length limit is in bytes, not 3338 ** representation, exclusive of the zero-terminator. ^Note that the name
3175 ** characters. Any attempt to create a function with a longer name 3339 ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
3176 ** will result in [SQLITE_ERROR] being returned. 3340 ** ^Any attempt to create a function with a longer name
3341 ** will result in [SQLITE_MISUSE] being returned.
3177 ** 3342 **
3178 ** The third parameter (nArg) 3343 ** ^The third parameter (nArg)
3179 ** is the number of arguments that the SQL function or 3344 ** is the number of arguments that the SQL function or
3180 ** aggregate takes. If this parameter is -1, then the SQL function or 3345 ** aggregate takes. ^If this parameter is -1, then the SQL function or
3181 ** aggregate may take any number of arguments between 0 and the limit 3346 ** aggregate may take any number of arguments between 0 and the limit
3182 ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third 3347 ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
3183 ** parameter is less than -1 or greater than 127 then the behavior is 3348 ** parameter is less than -1 or greater than 127 then the behavior is
3184 ** undefined. 3349 ** undefined.
3185 ** 3350 **
3186 ** The fourth parameter, eTextRep, specifies what 3351 ** ^The fourth parameter, eTextRep, specifies what
3187 ** [SQLITE_UTF8 | text encoding] this SQL function prefers for 3352 ** [SQLITE_UTF8 | text encoding] this SQL function prefers for
3188 ** its parameters. Any SQL function implementation should be able to work 3353 ** its parameters. Every SQL function implementation must be able to work
3189 ** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be 3354 ** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be
3190 ** more efficient with one encoding than another. An application may 3355 ** more efficient with one encoding than another. ^An application may
3191 ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple 3356 ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple
3192 ** times with the same function but with different values of eTextRep. 3357 ** times with the same function but with different values of eTextRep.
3193 ** When multiple implementations of the same function are available, SQLite 3358 ** ^When multiple implementations of the same function are available, SQLite
3194 ** will pick the one that involves the least amount of data conversion. 3359 ** will pick the one that involves the least amount of data conversion.
3195 ** If there is only a single implementation which does not care what text 3360 ** If there is only a single implementation which does not care what text
3196 ** encoding is used, then the fourth argument should be [SQLITE_ANY]. 3361 ** encoding is used, then the fourth argument should be [SQLITE_ANY].
3197 ** 3362 **
3198 ** The fifth parameter is an arbitrary pointer. The implementation of the 3363 ** ^(The fifth parameter is an arbitrary pointer. The implementation of the
3199 ** function can gain access to this pointer using [sqlite3_user_data()]. 3364 ** function can gain access to this pointer using [sqlite3_user_data()].)^
3200 ** 3365 **
3201 ** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are 3366 ** ^The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
3202 ** pointers to C-language functions that implement the SQL function or 3367 ** pointers to C-language functions that implement the SQL function or
3203 ** aggregate. A scalar SQL function requires an implementation of the xFunc 3368 ** aggregate. ^A scalar SQL function requires an implementation of the xFunc
3204 ** callback only, NULL pointers should be passed as the xStep and xFinal 3369 ** callback only; NULL pointers must be passed as the xStep and xFinal
3205 ** parameters. An aggregate SQL function requires an implementation of xStep 3370 ** parameters. ^An aggregate SQL function requires an implementation of xStep
3206 ** and xFinal and NULL should be passed for xFunc. To delete an existing 3371 ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
3207 ** SQL function or aggregate, pass NULL for all three function callbacks. 3372 ** SQL function or aggregate, pass NULL poiners for all three function
3373 ** callbacks.
3208 ** 3374 **
3209 ** It is permitted to register multiple implementations of the same 3375 ** ^If the tenth parameter to sqlite3_create_function_v2() is not NULL,
3376 ** then it is invoked when the function is deleted, either by being
3377 ** overloaded or when the database connection closes.
3378 ** ^When the destructure callback of the tenth parameter is invoked, it
3379 ** is passed a single argument which is a copy of the pointer which was
3380 ** the fifth parameter to sqlite3_create_function_v2().
3381 **
3382 ** ^It is permitted to register multiple implementations of the same
3210 ** functions with the same name but with either differing numbers of 3383 ** functions with the same name but with either differing numbers of
3211 ** arguments or differing preferred text encodings. SQLite will use 3384 ** arguments or differing preferred text encodings. ^SQLite will use
3212 ** the implementation that most closely matches the way in which the 3385 ** the implementation that most closely matches the way in which the
3213 ** SQL function is used. A function implementation with a non-negative 3386 ** SQL function is used. ^A function implementation with a non-negative
3214 ** nArg parameter is a better match than a function implementation with 3387 ** nArg parameter is a better match than a function implementation with
3215 ** a negative nArg. A function where the preferred text encoding 3388 ** a negative nArg. ^A function where the preferred text encoding
3216 ** matches the database encoding is a better 3389 ** matches the database encoding is a better
3217 ** match than a function where the encoding is different. 3390 ** match than a function where the encoding is different.
3218 ** A function where the encoding difference is between UTF16le and UTF16be 3391 ** ^A function where the encoding difference is between UTF16le and UTF16be
3219 ** is a closer match than a function where the encoding difference is 3392 ** is a closer match than a function where the encoding difference is
3220 ** between UTF8 and UTF16. 3393 ** between UTF8 and UTF16.
3221 ** 3394 **
3222 ** Built-in functions may be overloaded by new application-defined functions. 3395 ** ^Built-in functions may be overloaded by new application-defined functions.
3223 ** The first application-defined function with a given name overrides all
3224 ** built-in functions in the same [database connection] with the same name.
3225 ** Subsequent application-defined functions of the same name only override
3226 ** prior application-defined functions that are an exact match for the
3227 ** number of parameters and preferred encoding.
3228 ** 3396 **
3229 ** An application-defined function is permitted to call other 3397 ** ^An application-defined function is permitted to call other
3230 ** SQLite interfaces. However, such calls must not 3398 ** SQLite interfaces. However, such calls must not
3231 ** close the database connection nor finalize or reset the prepared 3399 ** close the database connection nor finalize or reset the prepared
3232 ** statement in which the function is running. 3400 ** statement in which the function is running.
3233 **
3234 ** Requirements:
3235 ** [H16103] [H16106] [H16109] [H16112] [H16118] [H16121] [H16127]
3236 ** [H16130] [H16133] [H16136] [H16139] [H16142]
3237 */ 3401 */
3238 SQLITE_API int sqlite3_create_function( 3402 SQLITE_API int sqlite3_create_function(
3239 sqlite3 *db, 3403 sqlite3 *db,
3240 const char *zFunctionName, 3404 const char *zFunctionName,
3241 int nArg, 3405 int nArg,
3242 int eTextRep, 3406 int eTextRep,
3243 void *pApp, 3407 void *pApp,
3244 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 3408 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3245 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 3409 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3246 void (*xFinal)(sqlite3_context*) 3410 void (*xFinal)(sqlite3_context*)
3247 ); 3411 );
3248 SQLITE_API int sqlite3_create_function16( 3412 SQLITE_API int sqlite3_create_function16(
3249 sqlite3 *db, 3413 sqlite3 *db,
3250 const void *zFunctionName, 3414 const void *zFunctionName,
3251 int nArg, 3415 int nArg,
3252 int eTextRep, 3416 int eTextRep,
3253 void *pApp, 3417 void *pApp,
3254 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 3418 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3255 void (*xStep)(sqlite3_context*,int,sqlite3_value**), 3419 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3256 void (*xFinal)(sqlite3_context*) 3420 void (*xFinal)(sqlite3_context*)
3257 ); 3421 );
3422 SQLITE_API int sqlite3_create_function_v2(
3423 sqlite3 *db,
3424 const char *zFunctionName,
3425 int nArg,
3426 int eTextRep,
3427 void *pApp,
3428 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3429 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3430 void (*xFinal)(sqlite3_context*),
3431 void(*xDestroy)(void*)
3432 );
3258 3433
3259 /* 3434 /*
3260 ** CAPI3REF: Text Encodings {H10267} <S50200> <H16100> 3435 ** CAPI3REF: Text Encodings
3261 ** 3436 **
3262 ** These constant define integer codes that represent the various 3437 ** These constant define integer codes that represent the various
3263 ** text encodings supported by SQLite. 3438 ** text encodings supported by SQLite.
3264 */ 3439 */
3265 #define SQLITE_UTF8 1 3440 #define SQLITE_UTF8 1
3266 #define SQLITE_UTF16LE 2 3441 #define SQLITE_UTF16LE 2
3267 #define SQLITE_UTF16BE 3 3442 #define SQLITE_UTF16BE 3
3268 #define SQLITE_UTF16 4 /* Use native byte order */ 3443 #define SQLITE_UTF16 4 /* Use native byte order */
3269 #define SQLITE_ANY 5 /* sqlite3_create_function only */ 3444 #define SQLITE_ANY 5 /* sqlite3_create_function only */
3270 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ 3445 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
(...skipping 11 matching lines...) Expand all
3282 #ifndef SQLITE_OMIT_DEPRECATED 3457 #ifndef SQLITE_OMIT_DEPRECATED
3283 SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); 3458 SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
3284 SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); 3459 SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
3285 SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite 3_stmt*); 3460 SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite 3_stmt*);
3286 SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); 3461 SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
3287 SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); 3462 SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
3288 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int6 4,int),void*,sqlite3_int64); 3463 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int6 4,int),void*,sqlite3_int64);
3289 #endif 3464 #endif
3290 3465
3291 /* 3466 /*
3292 ** CAPI3REF: Obtaining SQL Function Parameter Values {H15100} <S20200> 3467 ** CAPI3REF: Obtaining SQL Function Parameter Values
3293 ** 3468 **
3294 ** The C-language implementation of SQL functions and aggregates uses 3469 ** The C-language implementation of SQL functions and aggregates uses
3295 ** this set of interface routines to access the parameter values on 3470 ** this set of interface routines to access the parameter values on
3296 ** the function or aggregate. 3471 ** the function or aggregate.
3297 ** 3472 **
3298 ** The xFunc (for scalar functions) or xStep (for aggregates) parameters 3473 ** The xFunc (for scalar functions) or xStep (for aggregates) parameters
3299 ** to [sqlite3_create_function()] and [sqlite3_create_function16()] 3474 ** to [sqlite3_create_function()] and [sqlite3_create_function16()]
3300 ** define callbacks that implement the SQL functions and aggregates. 3475 ** define callbacks that implement the SQL functions and aggregates.
3301 ** The 4th parameter to these callbacks is an array of pointers to 3476 ** The 4th parameter to these callbacks is an array of pointers to
3302 ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for 3477 ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
3303 ** each parameter to the SQL function. These routines are used to 3478 ** each parameter to the SQL function. These routines are used to
3304 ** extract values from the [sqlite3_value] objects. 3479 ** extract values from the [sqlite3_value] objects.
3305 ** 3480 **
3306 ** These routines work only with [protected sqlite3_value] objects. 3481 ** These routines work only with [protected sqlite3_value] objects.
3307 ** Any attempt to use these routines on an [unprotected sqlite3_value] 3482 ** Any attempt to use these routines on an [unprotected sqlite3_value]
3308 ** object results in undefined behavior. 3483 ** object results in undefined behavior.
3309 ** 3484 **
3310 ** These routines work just like the corresponding [column access functions] 3485 ** ^These routines work just like the corresponding [column access functions]
3311 ** except that these routines take a single [protected sqlite3_value] object 3486 ** except that these routines take a single [protected sqlite3_value] object
3312 ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. 3487 ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
3313 ** 3488 **
3314 ** The sqlite3_value_text16() interface extracts a UTF-16 string 3489 ** ^The sqlite3_value_text16() interface extracts a UTF-16 string
3315 ** in the native byte-order of the host machine. The 3490 ** in the native byte-order of the host machine. ^The
3316 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces 3491 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
3317 ** extract UTF-16 strings as big-endian and little-endian respectively. 3492 ** extract UTF-16 strings as big-endian and little-endian respectively.
3318 ** 3493 **
3319 ** The sqlite3_value_numeric_type() interface attempts to apply 3494 ** ^(The sqlite3_value_numeric_type() interface attempts to apply
3320 ** numeric affinity to the value. This means that an attempt is 3495 ** numeric affinity to the value. This means that an attempt is
3321 ** made to convert the value to an integer or floating point. If 3496 ** made to convert the value to an integer or floating point. If
3322 ** such a conversion is possible without loss of information (in other 3497 ** such a conversion is possible without loss of information (in other
3323 ** words, if the value is a string that looks like a number) 3498 ** words, if the value is a string that looks like a number)
3324 ** then the conversion is performed. Otherwise no conversion occurs. 3499 ** then the conversion is performed. Otherwise no conversion occurs.
3325 ** The [SQLITE_INTEGER | datatype] after conversion is returned. 3500 ** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
3326 ** 3501 **
3327 ** Please pay particular attention to the fact that the pointer returned 3502 ** Please pay particular attention to the fact that the pointer returned
3328 ** from [sqlite3_value_blob()], [sqlite3_value_text()], or 3503 ** from [sqlite3_value_blob()], [sqlite3_value_text()], or
3329 ** [sqlite3_value_text16()] can be invalidated by a subsequent call to 3504 ** [sqlite3_value_text16()] can be invalidated by a subsequent call to
3330 ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], 3505 ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
3331 ** or [sqlite3_value_text16()]. 3506 ** or [sqlite3_value_text16()].
3332 ** 3507 **
3333 ** These routines must be called from the same thread as 3508 ** These routines must be called from the same thread as
3334 ** the SQL function that supplied the [sqlite3_value*] parameters. 3509 ** the SQL function that supplied the [sqlite3_value*] parameters.
3335 **
3336 ** Requirements:
3337 ** [H15103] [H15106] [H15109] [H15112] [H15115] [H15118] [H15121] [H15124]
3338 ** [H15127] [H15130] [H15133] [H15136]
3339 */ 3510 */
3340 SQLITE_API const void *sqlite3_value_blob(sqlite3_value*); 3511 SQLITE_API const void *sqlite3_value_blob(sqlite3_value*);
3341 SQLITE_API int sqlite3_value_bytes(sqlite3_value*); 3512 SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
3342 SQLITE_API int sqlite3_value_bytes16(sqlite3_value*); 3513 SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
3343 SQLITE_API double sqlite3_value_double(sqlite3_value*); 3514 SQLITE_API double sqlite3_value_double(sqlite3_value*);
3344 SQLITE_API int sqlite3_value_int(sqlite3_value*); 3515 SQLITE_API int sqlite3_value_int(sqlite3_value*);
3345 SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); 3516 SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
3346 SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); 3517 SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);
3347 SQLITE_API const void *sqlite3_value_text16(sqlite3_value*); 3518 SQLITE_API const void *sqlite3_value_text16(sqlite3_value*);
3348 SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); 3519 SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);
3349 SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); 3520 SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);
3350 SQLITE_API int sqlite3_value_type(sqlite3_value*); 3521 SQLITE_API int sqlite3_value_type(sqlite3_value*);
3351 SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); 3522 SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
3352 3523
3353 /* 3524 /*
3354 ** CAPI3REF: Obtain Aggregate Function Context {H16210} <S20200> 3525 ** CAPI3REF: Obtain Aggregate Function Context
3355 ** 3526 **
3356 ** The implementation of aggregate SQL functions use this routine to allocate 3527 ** Implementations of aggregate SQL functions use this
3357 ** a structure for storing their state. 3528 ** routine to allocate memory for storing their state.
3358 ** 3529 **
3359 ** The first time the sqlite3_aggregate_context() routine is called for a 3530 ** ^The first time the sqlite3_aggregate_context(C,N) routine is called
3360 ** particular aggregate, SQLite allocates nBytes of memory, zeroes out that 3531 ** for a particular aggregate function, SQLite
3361 ** memory, and returns a pointer to it. On second and subsequent calls to 3532 ** allocates N of memory, zeroes out that memory, and returns a pointer
3362 ** sqlite3_aggregate_context() for the same aggregate function index, 3533 ** to the new memory. ^On second and subsequent calls to
3363 ** the same buffer is returned. The implementation of the aggregate can use 3534 ** sqlite3_aggregate_context() for the same aggregate function instance,
3364 ** the returned buffer to accumulate data. 3535 ** the same buffer is returned. Sqlite3_aggregate_context() is normally
3536 ** called once for each invocation of the xStep callback and then one
3537 ** last time when the xFinal callback is invoked. ^(When no rows match
3538 ** an aggregate query, the xStep() callback of the aggregate function
3539 ** implementation is never called and xFinal() is called exactly once.
3540 ** In those cases, sqlite3_aggregate_context() might be called for the
3541 ** first time from within xFinal().)^
3365 ** 3542 **
3366 ** SQLite automatically frees the allocated buffer when the aggregate 3543 ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is
3367 ** query concludes. 3544 ** less than or equal to zero or if a memory allocate error occurs.
3368 ** 3545 **
3369 ** The first parameter should be a copy of the 3546 ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
3547 ** determined by the N parameter on first successful call. Changing the
3548 ** value of N in subsequent call to sqlite3_aggregate_context() within
3549 ** the same aggregate function instance will not resize the memory
3550 ** allocation.)^
3551 **
3552 ** ^SQLite automatically frees the memory allocated by
3553 ** sqlite3_aggregate_context() when the aggregate query concludes.
3554 **
3555 ** The first parameter must be a copy of the
3370 ** [sqlite3_context | SQL function context] that is the first parameter 3556 ** [sqlite3_context | SQL function context] that is the first parameter
3371 ** to the callback routine that implements the aggregate function. 3557 ** to the xStep or xFinal callback routine that implements the aggregate
3558 ** function.
3372 ** 3559 **
3373 ** This routine must be called from the same thread in which 3560 ** This routine must be called from the same thread in which
3374 ** the aggregate SQL function is running. 3561 ** the aggregate SQL function is running.
3375 **
3376 ** Requirements:
3377 ** [H16211] [H16213] [H16215] [H16217]
3378 */ 3562 */
3379 SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); 3563 SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
3380 3564
3381 /* 3565 /*
3382 ** CAPI3REF: User Data For Functions {H16240} <S20200> 3566 ** CAPI3REF: User Data For Functions
3383 ** 3567 **
3384 ** The sqlite3_user_data() interface returns a copy of 3568 ** ^The sqlite3_user_data() interface returns a copy of
3385 ** the pointer that was the pUserData parameter (the 5th parameter) 3569 ** the pointer that was the pUserData parameter (the 5th parameter)
3386 ** of the [sqlite3_create_function()] 3570 ** of the [sqlite3_create_function()]
3387 ** and [sqlite3_create_function16()] routines that originally 3571 ** and [sqlite3_create_function16()] routines that originally
3388 ** registered the application defined function. {END} 3572 ** registered the application defined function.
3389 ** 3573 **
3390 ** This routine must be called from the same thread in which 3574 ** This routine must be called from the same thread in which
3391 ** the application-defined function is running. 3575 ** the application-defined function is running.
3392 **
3393 ** Requirements:
3394 ** [H16243]
3395 */ 3576 */
3396 SQLITE_API void *sqlite3_user_data(sqlite3_context*); 3577 SQLITE_API void *sqlite3_user_data(sqlite3_context*);
3397 3578
3398 /* 3579 /*
3399 ** CAPI3REF: Database Connection For Functions {H16250} <S60600><S20200> 3580 ** CAPI3REF: Database Connection For Functions
3400 ** 3581 **
3401 ** The sqlite3_context_db_handle() interface returns a copy of 3582 ** ^The sqlite3_context_db_handle() interface returns a copy of
3402 ** the pointer to the [database connection] (the 1st parameter) 3583 ** the pointer to the [database connection] (the 1st parameter)
3403 ** of the [sqlite3_create_function()] 3584 ** of the [sqlite3_create_function()]
3404 ** and [sqlite3_create_function16()] routines that originally 3585 ** and [sqlite3_create_function16()] routines that originally
3405 ** registered the application defined function. 3586 ** registered the application defined function.
3406 **
3407 ** Requirements:
3408 ** [H16253]
3409 */ 3587 */
3410 SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*); 3588 SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
3411 3589
3412 /* 3590 /*
3413 ** CAPI3REF: Function Auxiliary Data {H16270} <S20200> 3591 ** CAPI3REF: Function Auxiliary Data
3414 ** 3592 **
3415 ** The following two functions may be used by scalar SQL functions to 3593 ** The following two functions may be used by scalar SQL functions to
3416 ** associate metadata with argument values. If the same value is passed to 3594 ** associate metadata with argument values. If the same value is passed to
3417 ** multiple invocations of the same SQL function during query execution, under 3595 ** multiple invocations of the same SQL function during query execution, under
3418 ** some circumstances the associated metadata may be preserved. This may 3596 ** some circumstances the associated metadata may be preserved. This may
3419 ** be used, for example, to add a regular-expression matching scalar 3597 ** be used, for example, to add a regular-expression matching scalar
3420 ** function. The compiled version of the regular expression is stored as 3598 ** function. The compiled version of the regular expression is stored as
3421 ** metadata associated with the SQL value passed as the regular expression 3599 ** metadata associated with the SQL value passed as the regular expression
3422 ** pattern. The compiled regular expression can be reused on multiple 3600 ** pattern. The compiled regular expression can be reused on multiple
3423 ** invocations of the same function so that the original pattern string 3601 ** invocations of the same function so that the original pattern string
3424 ** does not need to be recompiled on each invocation. 3602 ** does not need to be recompiled on each invocation.
3425 ** 3603 **
3426 ** The sqlite3_get_auxdata() interface returns a pointer to the metadata 3604 ** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata
3427 ** associated by the sqlite3_set_auxdata() function with the Nth argument 3605 ** associated by the sqlite3_set_auxdata() function with the Nth argument
3428 ** value to the application-defined function. If no metadata has been ever 3606 ** value to the application-defined function. ^If no metadata has been ever
3429 ** been set for the Nth argument of the function, or if the corresponding 3607 ** been set for the Nth argument of the function, or if the corresponding
3430 ** function parameter has changed since the meta-data was set, 3608 ** function parameter has changed since the meta-data was set,
3431 ** then sqlite3_get_auxdata() returns a NULL pointer. 3609 ** then sqlite3_get_auxdata() returns a NULL pointer.
3432 ** 3610 **
3433 ** The sqlite3_set_auxdata() interface saves the metadata 3611 ** ^The sqlite3_set_auxdata() interface saves the metadata
3434 ** pointed to by its 3rd parameter as the metadata for the N-th 3612 ** pointed to by its 3rd parameter as the metadata for the N-th
3435 ** argument of the application-defined function. Subsequent 3613 ** argument of the application-defined function. Subsequent
3436 ** calls to sqlite3_get_auxdata() might return this data, if it has 3614 ** calls to sqlite3_get_auxdata() might return this data, if it has
3437 ** not been destroyed. 3615 ** not been destroyed.
3438 ** If it is not NULL, SQLite will invoke the destructor 3616 ** ^If it is not NULL, SQLite will invoke the destructor
3439 ** function given by the 4th parameter to sqlite3_set_auxdata() on 3617 ** function given by the 4th parameter to sqlite3_set_auxdata() on
3440 ** the metadata when the corresponding function parameter changes 3618 ** the metadata when the corresponding function parameter changes
3441 ** or when the SQL statement completes, whichever comes first. 3619 ** or when the SQL statement completes, whichever comes first.
3442 ** 3620 **
3443 ** SQLite is free to call the destructor and drop metadata on any 3621 ** SQLite is free to call the destructor and drop metadata on any
3444 ** parameter of any function at any time. The only guarantee is that 3622 ** parameter of any function at any time. ^The only guarantee is that
3445 ** the destructor will be called before the metadata is dropped. 3623 ** the destructor will be called before the metadata is dropped.
3446 ** 3624 **
3447 ** In practice, metadata is preserved between function calls for 3625 ** ^(In practice, metadata is preserved between function calls for
3448 ** expressions that are constant at compile time. This includes literal 3626 ** expressions that are constant at compile time. This includes literal
3449 ** values and SQL variables. 3627 ** values and [parameters].)^
3450 ** 3628 **
3451 ** These routines must be called from the same thread in which 3629 ** These routines must be called from the same thread in which
3452 ** the SQL function is running. 3630 ** the SQL function is running.
3453 **
3454 ** Requirements:
3455 ** [H16272] [H16274] [H16276] [H16277] [H16278] [H16279]
3456 */ 3631 */
3457 SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N); 3632 SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
3458 SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(voi d*)); 3633 SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(voi d*));
3459 3634
3460 3635
3461 /* 3636 /*
3462 ** CAPI3REF: Constants Defining Special Destructor Behavior {H10280} <S30100> 3637 ** CAPI3REF: Constants Defining Special Destructor Behavior
3463 ** 3638 **
3464 ** These are special values for the destructor that is passed in as the 3639 ** These are special values for the destructor that is passed in as the
3465 ** final argument to routines like [sqlite3_result_blob()]. If the destructor 3640 ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
3466 ** argument is SQLITE_STATIC, it means that the content pointer is constant 3641 ** argument is SQLITE_STATIC, it means that the content pointer is constant
3467 ** and will never change. It does not need to be destroyed. The 3642 ** and will never change. It does not need to be destroyed. ^The
3468 ** SQLITE_TRANSIENT value means that the content will likely change in 3643 ** SQLITE_TRANSIENT value means that the content will likely change in
3469 ** the near future and that SQLite should make its own private copy of 3644 ** the near future and that SQLite should make its own private copy of
3470 ** the content before returning. 3645 ** the content before returning.
3471 ** 3646 **
3472 ** The typedef is necessary to work around problems in certain 3647 ** The typedef is necessary to work around problems in certain
3473 ** C++ compilers. See ticket #2191. 3648 ** C++ compilers. See ticket #2191.
3474 */ 3649 */
3475 typedef void (*sqlite3_destructor_type)(void*); 3650 typedef void (*sqlite3_destructor_type)(void*);
3476 #define SQLITE_STATIC ((sqlite3_destructor_type)0) 3651 #define SQLITE_STATIC ((sqlite3_destructor_type)0)
3477 #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) 3652 #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
3478 3653
3479 /* 3654 /*
3480 ** CAPI3REF: Setting The Result Of An SQL Function {H16400} <S20200> 3655 ** CAPI3REF: Setting The Result Of An SQL Function
3481 ** 3656 **
3482 ** These routines are used by the xFunc or xFinal callbacks that 3657 ** These routines are used by the xFunc or xFinal callbacks that
3483 ** implement SQL functions and aggregates. See 3658 ** implement SQL functions and aggregates. See
3484 ** [sqlite3_create_function()] and [sqlite3_create_function16()] 3659 ** [sqlite3_create_function()] and [sqlite3_create_function16()]
3485 ** for additional information. 3660 ** for additional information.
3486 ** 3661 **
3487 ** These functions work very much like the [parameter binding] family of 3662 ** These functions work very much like the [parameter binding] family of
3488 ** functions used to bind values to host parameters in prepared statements. 3663 ** functions used to bind values to host parameters in prepared statements.
3489 ** Refer to the [SQL parameter] documentation for additional information. 3664 ** Refer to the [SQL parameter] documentation for additional information.
3490 ** 3665 **
3491 ** The sqlite3_result_blob() interface sets the result from 3666 ** ^The sqlite3_result_blob() interface sets the result from
3492 ** an application-defined function to be the BLOB whose content is pointed 3667 ** an application-defined function to be the BLOB whose content is pointed
3493 ** to by the second parameter and which is N bytes long where N is the 3668 ** to by the second parameter and which is N bytes long where N is the
3494 ** third parameter. 3669 ** third parameter.
3495 ** 3670 **
3496 ** The sqlite3_result_zeroblob() interfaces set the result of 3671 ** ^The sqlite3_result_zeroblob() interfaces set the result of
3497 ** the application-defined function to be a BLOB containing all zero 3672 ** the application-defined function to be a BLOB containing all zero
3498 ** bytes and N bytes in size, where N is the value of the 2nd parameter. 3673 ** bytes and N bytes in size, where N is the value of the 2nd parameter.
3499 ** 3674 **
3500 ** The sqlite3_result_double() interface sets the result from 3675 ** ^The sqlite3_result_double() interface sets the result from
3501 ** an application-defined function to be a floating point value specified 3676 ** an application-defined function to be a floating point value specified
3502 ** by its 2nd argument. 3677 ** by its 2nd argument.
3503 ** 3678 **
3504 ** The sqlite3_result_error() and sqlite3_result_error16() functions 3679 ** ^The sqlite3_result_error() and sqlite3_result_error16() functions
3505 ** cause the implemented SQL function to throw an exception. 3680 ** cause the implemented SQL function to throw an exception.
3506 ** SQLite uses the string pointed to by the 3681 ** ^SQLite uses the string pointed to by the
3507 ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() 3682 ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
3508 ** as the text of an error message. SQLite interprets the error 3683 ** as the text of an error message. ^SQLite interprets the error
3509 ** message string from sqlite3_result_error() as UTF-8. SQLite 3684 ** message string from sqlite3_result_error() as UTF-8. ^SQLite
3510 ** interprets the string from sqlite3_result_error16() as UTF-16 in native 3685 ** interprets the string from sqlite3_result_error16() as UTF-16 in native
3511 ** byte order. If the third parameter to sqlite3_result_error() 3686 ** byte order. ^If the third parameter to sqlite3_result_error()
3512 ** or sqlite3_result_error16() is negative then SQLite takes as the error 3687 ** or sqlite3_result_error16() is negative then SQLite takes as the error
3513 ** message all text up through the first zero character. 3688 ** message all text up through the first zero character.
3514 ** If the third parameter to sqlite3_result_error() or 3689 ** ^If the third parameter to sqlite3_result_error() or
3515 ** sqlite3_result_error16() is non-negative then SQLite takes that many 3690 ** sqlite3_result_error16() is non-negative then SQLite takes that many
3516 ** bytes (not characters) from the 2nd parameter as the error message. 3691 ** bytes (not characters) from the 2nd parameter as the error message.
3517 ** The sqlite3_result_error() and sqlite3_result_error16() 3692 ** ^The sqlite3_result_error() and sqlite3_result_error16()
3518 ** routines make a private copy of the error message text before 3693 ** routines make a private copy of the error message text before
3519 ** they return. Hence, the calling function can deallocate or 3694 ** they return. Hence, the calling function can deallocate or
3520 ** modify the text after they return without harm. 3695 ** modify the text after they return without harm.
3521 ** The sqlite3_result_error_code() function changes the error code 3696 ** ^The sqlite3_result_error_code() function changes the error code
3522 ** returned by SQLite as a result of an error in a function. By default, 3697 ** returned by SQLite as a result of an error in a function. ^By default,
3523 ** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error() 3698 ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
3524 ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. 3699 ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
3525 ** 3700 **
3526 ** The sqlite3_result_toobig() interface causes SQLite to throw an error 3701 ** ^The sqlite3_result_toobig() interface causes SQLite to throw an error
3527 ** indicating that a string or BLOB is to long to represent. 3702 ** indicating that a string or BLOB is too long to represent.
3528 ** 3703 **
3529 ** The sqlite3_result_nomem() interface causes SQLite to throw an error 3704 ** ^The sqlite3_result_nomem() interface causes SQLite to throw an error
3530 ** indicating that a memory allocation failed. 3705 ** indicating that a memory allocation failed.
3531 ** 3706 **
3532 ** The sqlite3_result_int() interface sets the return value 3707 ** ^The sqlite3_result_int() interface sets the return value
3533 ** of the application-defined function to be the 32-bit signed integer 3708 ** of the application-defined function to be the 32-bit signed integer
3534 ** value given in the 2nd argument. 3709 ** value given in the 2nd argument.
3535 ** The sqlite3_result_int64() interface sets the return value 3710 ** ^The sqlite3_result_int64() interface sets the return value
3536 ** of the application-defined function to be the 64-bit signed integer 3711 ** of the application-defined function to be the 64-bit signed integer
3537 ** value given in the 2nd argument. 3712 ** value given in the 2nd argument.
3538 ** 3713 **
3539 ** The sqlite3_result_null() interface sets the return value 3714 ** ^The sqlite3_result_null() interface sets the return value
3540 ** of the application-defined function to be NULL. 3715 ** of the application-defined function to be NULL.
3541 ** 3716 **
3542 ** The sqlite3_result_text(), sqlite3_result_text16(), 3717 ** ^The sqlite3_result_text(), sqlite3_result_text16(),
3543 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces 3718 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
3544 ** set the return value of the application-defined function to be 3719 ** set the return value of the application-defined function to be
3545 ** a text string which is represented as UTF-8, UTF-16 native byte order, 3720 ** a text string which is represented as UTF-8, UTF-16 native byte order,
3546 ** UTF-16 little endian, or UTF-16 big endian, respectively. 3721 ** UTF-16 little endian, or UTF-16 big endian, respectively.
3547 ** SQLite takes the text result from the application from 3722 ** ^SQLite takes the text result from the application from
3548 ** the 2nd parameter of the sqlite3_result_text* interfaces. 3723 ** the 2nd parameter of the sqlite3_result_text* interfaces.
3549 ** If the 3rd parameter to the sqlite3_result_text* interfaces 3724 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
3550 ** is negative, then SQLite takes result text from the 2nd parameter 3725 ** is negative, then SQLite takes result text from the 2nd parameter
3551 ** through the first zero character. 3726 ** through the first zero character.
3552 ** If the 3rd parameter to the sqlite3_result_text* interfaces 3727 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
3553 ** is non-negative, then as many bytes (not characters) of the text 3728 ** is non-negative, then as many bytes (not characters) of the text
3554 ** pointed to by the 2nd parameter are taken as the application-defined 3729 ** pointed to by the 2nd parameter are taken as the application-defined
3555 ** function result. 3730 ** function result.
3556 ** If the 4th parameter to the sqlite3_result_text* interfaces 3731 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
3557 ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that 3732 ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
3558 ** function as the destructor on the text or BLOB result when it has 3733 ** function as the destructor on the text or BLOB result when it has
3559 ** finished using that result. 3734 ** finished using that result.
3560 ** If the 4th parameter to the sqlite3_result_text* interfaces or to 3735 ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
3561 ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite 3736 ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
3562 ** assumes that the text or BLOB result is in constant space and does not 3737 ** assumes that the text or BLOB result is in constant space and does not
3563 ** copy the content of the parameter nor call a destructor on the content 3738 ** copy the content of the parameter nor call a destructor on the content
3564 ** when it has finished using that result. 3739 ** when it has finished using that result.
3565 ** If the 4th parameter to the sqlite3_result_text* interfaces 3740 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
3566 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT 3741 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
3567 ** then SQLite makes a copy of the result into space obtained from 3742 ** then SQLite makes a copy of the result into space obtained from
3568 ** from [sqlite3_malloc()] before it returns. 3743 ** from [sqlite3_malloc()] before it returns.
3569 ** 3744 **
3570 ** The sqlite3_result_value() interface sets the result of 3745 ** ^The sqlite3_result_value() interface sets the result of
3571 ** the application-defined function to be a copy the 3746 ** the application-defined function to be a copy the
3572 ** [unprotected sqlite3_value] object specified by the 2nd parameter. The 3747 ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
3573 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value] 3748 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
3574 ** so that the [sqlite3_value] specified in the parameter may change or 3749 ** so that the [sqlite3_value] specified in the parameter may change or
3575 ** be deallocated after sqlite3_result_value() returns without harm. 3750 ** be deallocated after sqlite3_result_value() returns without harm.
3576 ** A [protected sqlite3_value] object may always be used where an 3751 ** ^A [protected sqlite3_value] object may always be used where an
3577 ** [unprotected sqlite3_value] object is required, so either 3752 ** [unprotected sqlite3_value] object is required, so either
3578 ** kind of [sqlite3_value] object can be used with this interface. 3753 ** kind of [sqlite3_value] object can be used with this interface.
3579 ** 3754 **
3580 ** If these routines are called from within the different thread 3755 ** If these routines are called from within the different thread
3581 ** than the one containing the application-defined function that received 3756 ** than the one containing the application-defined function that received
3582 ** the [sqlite3_context] pointer, the results are undefined. 3757 ** the [sqlite3_context] pointer, the results are undefined.
3583 **
3584 ** Requirements:
3585 ** [H16403] [H16406] [H16409] [H16412] [H16415] [H16418] [H16421] [H16424]
3586 ** [H16427] [H16430] [H16433] [H16436] [H16439] [H16442] [H16445] [H16448]
3587 ** [H16451] [H16454] [H16457] [H16460] [H16463]
3588 */ 3758 */
3589 SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)( void*)); 3759 SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)( void*));
3590 SQLITE_API void sqlite3_result_double(sqlite3_context*, double); 3760 SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
3591 SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); 3761 SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
3592 SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); 3762 SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
3593 SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*); 3763 SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
3594 SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*); 3764 SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
3595 SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int); 3765 SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
3596 SQLITE_API void sqlite3_result_int(sqlite3_context*, int); 3766 SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
3597 SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); 3767 SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
3598 SQLITE_API void sqlite3_result_null(sqlite3_context*); 3768 SQLITE_API void sqlite3_result_null(sqlite3_context*);
3599 SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)( void*)); 3769 SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)( void*));
3600 SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(* )(void*)); 3770 SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(* )(void*));
3601 SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void( *)(void*)); 3771 SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void( *)(void*));
3602 SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void( *)(void*)); 3772 SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void( *)(void*));
3603 SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); 3773 SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
3604 SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); 3774 SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
3605 3775
3606 /* 3776 /*
3607 ** CAPI3REF: Define New Collating Sequences {H16600} <S20300> 3777 ** CAPI3REF: Define New Collating Sequences
3608 ** 3778 **
3609 ** These functions are used to add new collation sequences to the 3779 ** ^These functions add, remove, or modify a [collation] associated
3610 ** [database connection] specified as the first argument. 3780 ** with the [database connection] specified as the first argument.
3611 ** 3781 **
3612 ** The name of the new collation sequence is specified as a UTF-8 string 3782 ** ^The name of the collation is a UTF-8 string
3613 ** for sqlite3_create_collation() and sqlite3_create_collation_v2() 3783 ** for sqlite3_create_collation() and sqlite3_create_collation_v2()
3614 ** and a UTF-16 string for sqlite3_create_collation16(). In all cases 3784 ** and a UTF-16 string in native byte order for sqlite3_create_collation16().
3615 ** the name is passed as the second function argument. 3785 ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
3786 ** considered to be the same name.
3616 ** 3787 **
3617 ** The third argument may be one of the constants [SQLITE_UTF8], 3788 ** ^(The third argument (eTextRep) must be one of the constants:
3618 ** [SQLITE_UTF16LE], or [SQLITE_UTF16BE], indicating that the user-supplied 3789 ** <ul>
3619 ** routine expects to be passed pointers to strings encoded using UTF-8, 3790 ** <li> [SQLITE_UTF8],
3620 ** UTF-16 little-endian, or UTF-16 big-endian, respectively. The 3791 ** <li> [SQLITE_UTF16LE],
3621 ** third argument might also be [SQLITE_UTF16] to indicate that the routine 3792 ** <li> [SQLITE_UTF16BE],
3622 ** expects pointers to be UTF-16 strings in the native byte order, or the 3793 ** <li> [SQLITE_UTF16], or
3623 ** argument can be [SQLITE_UTF16_ALIGNED] if the 3794 ** <li> [SQLITE_UTF16_ALIGNED].
3624 ** the routine expects pointers to 16-bit word aligned strings 3795 ** </ul>)^
3625 ** of UTF-16 in the native byte order. 3796 ** ^The eTextRep argument determines the encoding of strings passed
3797 ** to the collating function callback, xCallback.
3798 ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
3799 ** force strings to be UTF16 with native byte order.
3800 ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
3801 ** on an even byte address.
3626 ** 3802 **
3627 ** A pointer to the user supplied routine must be passed as the fifth 3803 ** ^The fourth argument, pArg, is a application data pointer that is passed
3628 ** argument. If it is NULL, this is the same as deleting the collation 3804 ** through as the first argument to the collating function callback.
3629 ** sequence (so that SQLite cannot call it anymore).
3630 ** Each time the application supplied function is invoked, it is passed
3631 ** as its first parameter a copy of the void* passed as the fourth argument
3632 ** to sqlite3_create_collation() or sqlite3_create_collation16().
3633 ** 3805 **
3634 ** The remaining arguments to the application-supplied routine are two strings, 3806 ** ^The fifth argument, xCallback, is a pointer to the collating function.
3635 ** each represented by a (length, data) pair and encoded in the encoding 3807 ** ^Multiple collating functions can be registered using the same name but
3636 ** that was passed as the third argument when the collation sequence was 3808 ** with different eTextRep parameters and SQLite will use whichever
3637 ** registered. {END} The application defined collation routine should 3809 ** function requires the least amount of data transformation.
3638 ** return negative, zero or positive if the first string is less than, 3810 ** ^If the xCallback argument is NULL then the collating function is
3639 ** equal to, or greater than the second string. i.e. (STRING1 - STRING2). 3811 ** deleted. ^When all collating functions having the same name are deleted,
3812 ** that collation is no longer usable.
3640 ** 3813 **
3641 ** The sqlite3_create_collation_v2() works like sqlite3_create_collation() 3814 ** ^The collating function callback is invoked with a copy of the pArg
3642 ** except that it takes an extra argument which is a destructor for 3815 ** application data pointer and with two strings in the encoding specified
3643 ** the collation. The destructor is called when the collation is 3816 ** by the eTextRep argument. The collating function must return an
3644 ** destroyed and is passed a copy of the fourth parameter void* pointer 3817 ** integer that is negative, zero, or positive
3645 ** of the sqlite3_create_collation_v2(). 3818 ** if the first string is less than, equal to, or greater than the second,
3646 ** Collations are destroyed when they are overridden by later calls to the 3819 ** respectively. A collating function must alway return the same answer
3647 ** collation creation functions or when the [database connection] is closed 3820 ** given the same inputs. If two or more collating functions are registered
3648 ** using [sqlite3_close()]. 3821 ** to the same collation name (using different eTextRep values) then all
3822 ** must give an equivalent answer when invoked with equivalent strings.
3823 ** The collating function must obey the following properties for all
3824 ** strings A, B, and C:
3825 **
3826 ** <ol>
3827 ** <li> If A==B then B==A.
3828 ** <li> If A==B and B==C then A==C.
3829 ** <li> If A&lt;B THEN B&gt;A.
3830 ** <li> If A&lt;B and B&lt;C then A&lt;C.
3831 ** </ol>
3832 **
3833 ** If a collating function fails any of the above constraints and that
3834 ** collating function is registered and used, then the behavior of SQLite
3835 ** is undefined.
3836 **
3837 ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
3838 ** with the addition that the xDestroy callback is invoked on pArg when
3839 ** the collating function is deleted.
3840 ** ^Collating functions are deleted when they are overridden by later
3841 ** calls to the collation creation functions or when the
3842 ** [database connection] is closed using [sqlite3_close()].
3649 ** 3843 **
3650 ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. 3844 ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
3651 **
3652 ** Requirements:
3653 ** [H16603] [H16604] [H16606] [H16609] [H16612] [H16615] [H16618] [H16621]
3654 ** [H16624] [H16627] [H16630]
3655 */ 3845 */
3656 SQLITE_API int sqlite3_create_collation( 3846 SQLITE_API int sqlite3_create_collation(
3657 sqlite3*, 3847 sqlite3*,
3658 const char *zName, 3848 const char *zName,
3659 int eTextRep, 3849 int eTextRep,
3660 void*, 3850 void *pArg,
3661 int(*xCompare)(void*,int,const void*,int,const void*) 3851 int(*xCompare)(void*,int,const void*,int,const void*)
3662 ); 3852 );
3663 SQLITE_API int sqlite3_create_collation_v2( 3853 SQLITE_API int sqlite3_create_collation_v2(
3664 sqlite3*, 3854 sqlite3*,
3665 const char *zName, 3855 const char *zName,
3666 int eTextRep, 3856 int eTextRep,
3667 void*, 3857 void *pArg,
3668 int(*xCompare)(void*,int,const void*,int,const void*), 3858 int(*xCompare)(void*,int,const void*,int,const void*),
3669 void(*xDestroy)(void*) 3859 void(*xDestroy)(void*)
3670 ); 3860 );
3671 SQLITE_API int sqlite3_create_collation16( 3861 SQLITE_API int sqlite3_create_collation16(
3672 sqlite3*, 3862 sqlite3*,
3673 const void *zName, 3863 const void *zName,
3674 int eTextRep, 3864 int eTextRep,
3675 void*, 3865 void *pArg,
3676 int(*xCompare)(void*,int,const void*,int,const void*) 3866 int(*xCompare)(void*,int,const void*,int,const void*)
3677 ); 3867 );
3678 3868
3679 /* 3869 /*
3680 ** CAPI3REF: Collation Needed Callbacks {H16700} <S20300> 3870 ** CAPI3REF: Collation Needed Callbacks
3681 ** 3871 **
3682 ** To avoid having to register all collation sequences before a database 3872 ** ^To avoid having to register all collation sequences before a database
3683 ** can be used, a single callback function may be registered with the 3873 ** can be used, a single callback function may be registered with the
3684 ** [database connection] to be called whenever an undefined collation 3874 ** [database connection] to be invoked whenever an undefined collation
3685 ** sequence is required. 3875 ** sequence is required.
3686 ** 3876 **
3687 ** If the function is registered using the sqlite3_collation_needed() API, 3877 ** ^If the function is registered using the sqlite3_collation_needed() API,
3688 ** then it is passed the names of undefined collation sequences as strings 3878 ** then it is passed the names of undefined collation sequences as strings
3689 ** encoded in UTF-8. {H16703} If sqlite3_collation_needed16() is used, 3879 ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
3690 ** the names are passed as UTF-16 in machine native byte order. 3880 ** the names are passed as UTF-16 in machine native byte order.
3691 ** A call to either function replaces any existing callback. 3881 ** ^A call to either function replaces the existing collation-needed callback.
3692 ** 3882 **
3693 ** When the callback is invoked, the first argument passed is a copy 3883 ** ^(When the callback is invoked, the first argument passed is a copy
3694 ** of the second argument to sqlite3_collation_needed() or 3884 ** of the second argument to sqlite3_collation_needed() or
3695 ** sqlite3_collation_needed16(). The second argument is the database 3885 ** sqlite3_collation_needed16(). The second argument is the database
3696 ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], 3886 ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
3697 ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation 3887 ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
3698 ** sequence function required. The fourth parameter is the name of the 3888 ** sequence function required. The fourth parameter is the name of the
3699 ** required collation sequence. 3889 ** required collation sequence.)^
3700 ** 3890 **
3701 ** The callback function should register the desired collation using 3891 ** The callback function should register the desired collation using
3702 ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or 3892 ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
3703 ** [sqlite3_create_collation_v2()]. 3893 ** [sqlite3_create_collation_v2()].
3704 **
3705 ** Requirements:
3706 ** [H16702] [H16704] [H16706]
3707 */ 3894 */
3708 SQLITE_API int sqlite3_collation_needed( 3895 SQLITE_API int sqlite3_collation_needed(
3709 sqlite3*, 3896 sqlite3*,
3710 void*, 3897 void*,
3711 void(*)(void*,sqlite3*,int eTextRep,const char*) 3898 void(*)(void*,sqlite3*,int eTextRep,const char*)
3712 ); 3899 );
3713 SQLITE_API int sqlite3_collation_needed16( 3900 SQLITE_API int sqlite3_collation_needed16(
3714 sqlite3*, 3901 sqlite3*,
3715 void*, 3902 void*,
3716 void(*)(void*,sqlite3*,int eTextRep,const void*) 3903 void(*)(void*,sqlite3*,int eTextRep,const void*)
3717 ); 3904 );
3718 3905
3906 #ifdef SQLITE_HAS_CODEC
3719 /* 3907 /*
3720 ** Specify the key for an encrypted database. This routine should be 3908 ** Specify the key for an encrypted database. This routine should be
3721 ** called right after sqlite3_open(). 3909 ** called right after sqlite3_open().
3722 ** 3910 **
3723 ** The code to implement this API is not available in the public release 3911 ** The code to implement this API is not available in the public release
3724 ** of SQLite. 3912 ** of SQLite.
3725 */ 3913 */
3726 SQLITE_API int sqlite3_key( 3914 SQLITE_API int sqlite3_key(
3727 sqlite3 *db, /* Database to be rekeyed */ 3915 sqlite3 *db, /* Database to be rekeyed */
3728 const void *pKey, int nKey /* The key */ 3916 const void *pKey, int nKey /* The key */
3729 ); 3917 );
3730 3918
3731 /* 3919 /*
3732 ** Change the key on an open database. If the current database is not 3920 ** Change the key on an open database. If the current database is not
3733 ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the 3921 ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
3734 ** database is decrypted. 3922 ** database is decrypted.
3735 ** 3923 **
3736 ** The code to implement this API is not available in the public release 3924 ** The code to implement this API is not available in the public release
3737 ** of SQLite. 3925 ** of SQLite.
3738 */ 3926 */
3739 SQLITE_API int sqlite3_rekey( 3927 SQLITE_API int sqlite3_rekey(
3740 sqlite3 *db, /* Database to be rekeyed */ 3928 sqlite3 *db, /* Database to be rekeyed */
3741 const void *pKey, int nKey /* The new key */ 3929 const void *pKey, int nKey /* The new key */
3742 ); 3930 );
3743 3931
3744 /* 3932 /*
3745 ** CAPI3REF: Suspend Execution For A Short Time {H10530} <S40410> 3933 ** Specify the activation key for a SEE database. Unless
3934 ** activated, none of the SEE routines will work.
3935 */
3936 SQLITE_API void sqlite3_activate_see(
3937 const char *zPassPhrase /* Activation phrase */
3938 );
3939 #endif
3940
3941 #ifdef SQLITE_ENABLE_CEROD
3942 /*
3943 ** Specify the activation key for a CEROD database. Unless
3944 ** activated, none of the CEROD routines will work.
3945 */
3946 SQLITE_API void sqlite3_activate_cerod(
3947 const char *zPassPhrase /* Activation phrase */
3948 );
3949 #endif
3950
3951 /*
3952 ** CAPI3REF: Suspend Execution For A Short Time
3746 ** 3953 **
3747 ** The sqlite3_sleep() function causes the current thread to suspend execution 3954 ** The sqlite3_sleep() function causes the current thread to suspend execution
3748 ** for at least a number of milliseconds specified in its parameter. 3955 ** for at least a number of milliseconds specified in its parameter.
3749 ** 3956 **
3750 ** If the operating system does not support sleep requests with 3957 ** If the operating system does not support sleep requests with
3751 ** millisecond time resolution, then the time will be rounded up to 3958 ** millisecond time resolution, then the time will be rounded up to
3752 ** the nearest second. The number of milliseconds of sleep actually 3959 ** the nearest second. The number of milliseconds of sleep actually
3753 ** requested from the operating system is returned. 3960 ** requested from the operating system is returned.
3754 ** 3961 **
3755 ** SQLite implements this interface by calling the xSleep() 3962 ** ^SQLite implements this interface by calling the xSleep()
3756 ** method of the default [sqlite3_vfs] object. 3963 ** method of the default [sqlite3_vfs] object. If the xSleep() method
3757 ** 3964 ** of the default VFS is not implemented correctly, or not implemented at
3758 ** Requirements: [H10533] [H10536] 3965 ** all, then the behavior of sqlite3_sleep() may deviate from the description
3966 ** in the previous paragraphs.
3759 */ 3967 */
3760 SQLITE_API int sqlite3_sleep(int); 3968 SQLITE_API int sqlite3_sleep(int);
3761 3969
3762 /* 3970 /*
3763 ** CAPI3REF: Name Of The Folder Holding Temporary Files {H10310} <S20000> 3971 ** CAPI3REF: Name Of The Folder Holding Temporary Files
3764 ** 3972 **
3765 ** If this global variable is made to point to a string which is 3973 ** ^(If this global variable is made to point to a string which is
3766 ** the name of a folder (a.k.a. directory), then all temporary files 3974 ** the name of a folder (a.k.a. directory), then all temporary files
3767 ** created by SQLite will be placed in that directory. If this variable 3975 ** created by SQLite when using a built-in [sqlite3_vfs | VFS]
3976 ** will be placed in that directory.)^ ^If this variable
3768 ** is a NULL pointer, then SQLite performs a search for an appropriate 3977 ** is a NULL pointer, then SQLite performs a search for an appropriate
3769 ** temporary file directory. 3978 ** temporary file directory.
3770 ** 3979 **
3771 ** It is not safe to read or modify this variable in more than one 3980 ** It is not safe to read or modify this variable in more than one
3772 ** thread at a time. It is not safe to read or modify this variable 3981 ** thread at a time. It is not safe to read or modify this variable
3773 ** if a [database connection] is being used at the same time in a separate 3982 ** if a [database connection] is being used at the same time in a separate
3774 ** thread. 3983 ** thread.
3775 ** It is intended that this variable be set once 3984 ** It is intended that this variable be set once
3776 ** as part of process initialization and before any SQLite interface 3985 ** as part of process initialization and before any SQLite interface
3777 ** routines have been called and that this variable remain unchanged 3986 ** routines have been called and that this variable remain unchanged
3778 ** thereafter. 3987 ** thereafter.
3779 ** 3988 **
3780 ** The [temp_store_directory pragma] may modify this variable and cause 3989 ** ^The [temp_store_directory pragma] may modify this variable and cause
3781 ** it to point to memory obtained from [sqlite3_malloc]. Furthermore, 3990 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
3782 ** the [temp_store_directory pragma] always assumes that any string 3991 ** the [temp_store_directory pragma] always assumes that any string
3783 ** that this variable points to is held in memory obtained from 3992 ** that this variable points to is held in memory obtained from
3784 ** [sqlite3_malloc] and the pragma may attempt to free that memory 3993 ** [sqlite3_malloc] and the pragma may attempt to free that memory
3785 ** using [sqlite3_free]. 3994 ** using [sqlite3_free].
3786 ** Hence, if this variable is modified directly, either it should be 3995 ** Hence, if this variable is modified directly, either it should be
3787 ** made NULL or made to point to memory obtained from [sqlite3_malloc] 3996 ** made NULL or made to point to memory obtained from [sqlite3_malloc]
3788 ** or else the use of the [temp_store_directory pragma] should be avoided. 3997 ** or else the use of the [temp_store_directory pragma] should be avoided.
3789 */ 3998 */
3790 SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; 3999 SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;
3791 4000
3792 /* 4001 /*
3793 ** CAPI3REF: Test For Auto-Commit Mode {H12930} <S60200> 4002 ** CAPI3REF: Test For Auto-Commit Mode
3794 ** KEYWORDS: {autocommit mode} 4003 ** KEYWORDS: {autocommit mode}
3795 ** 4004 **
3796 ** The sqlite3_get_autocommit() interface returns non-zero or 4005 ** ^The sqlite3_get_autocommit() interface returns non-zero or
3797 ** zero if the given database connection is or is not in autocommit mode, 4006 ** zero if the given database connection is or is not in autocommit mode,
3798 ** respectively. Autocommit mode is on by default. 4007 ** respectively. ^Autocommit mode is on by default.
3799 ** Autocommit mode is disabled by a [BEGIN] statement. 4008 ** ^Autocommit mode is disabled by a [BEGIN] statement.
3800 ** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. 4009 ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
3801 ** 4010 **
3802 ** If certain kinds of errors occur on a statement within a multi-statement 4011 ** If certain kinds of errors occur on a statement within a multi-statement
3803 ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], 4012 ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
3804 ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the 4013 ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
3805 ** transaction might be rolled back automatically. The only way to 4014 ** transaction might be rolled back automatically. The only way to
3806 ** find out whether SQLite automatically rolled back the transaction after 4015 ** find out whether SQLite automatically rolled back the transaction after
3807 ** an error is to use this function. 4016 ** an error is to use this function.
3808 ** 4017 **
3809 ** If another thread changes the autocommit status of the database 4018 ** If another thread changes the autocommit status of the database
3810 ** connection while this routine is running, then the return value 4019 ** connection while this routine is running, then the return value
3811 ** is undefined. 4020 ** is undefined.
3812 **
3813 ** Requirements: [H12931] [H12932] [H12933] [H12934]
3814 */ 4021 */
3815 SQLITE_API int sqlite3_get_autocommit(sqlite3*); 4022 SQLITE_API int sqlite3_get_autocommit(sqlite3*);
3816 4023
3817 /* 4024 /*
3818 ** CAPI3REF: Find The Database Handle Of A Prepared Statement {H13120} <S60600> 4025 ** CAPI3REF: Find The Database Handle Of A Prepared Statement
3819 ** 4026 **
3820 ** The sqlite3_db_handle interface returns the [database connection] handle 4027 ** ^The sqlite3_db_handle interface returns the [database connection] handle
3821 ** to which a [prepared statement] belongs. The [database connection] 4028 ** to which a [prepared statement] belongs. ^The [database connection]
3822 ** returned by sqlite3_db_handle is the same [database connection] that was the first argument 4029 ** returned by sqlite3_db_handle is the same [database connection]
4030 ** that was the first argument
3823 ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to 4031 ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
3824 ** create the statement in the first place. 4032 ** create the statement in the first place.
3825 **
3826 ** Requirements: [H13123]
3827 */ 4033 */
3828 SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*); 4034 SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
3829 4035
3830 /* 4036 /*
3831 ** CAPI3REF: Find the next prepared statement {H13140} <S60600> 4037 ** CAPI3REF: Find the next prepared statement
3832 ** 4038 **
3833 ** This interface returns a pointer to the next [prepared statement] after 4039 ** ^This interface returns a pointer to the next [prepared statement] after
3834 ** pStmt associated with the [database connection] pDb. If pStmt is NULL 4040 ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
3835 ** then this interface returns a pointer to the first prepared statement 4041 ** then this interface returns a pointer to the first prepared statement
3836 ** associated with the database connection pDb. If no prepared statement 4042 ** associated with the database connection pDb. ^If no prepared statement
3837 ** satisfies the conditions of this routine, it returns NULL. 4043 ** satisfies the conditions of this routine, it returns NULL.
3838 ** 4044 **
3839 ** The [database connection] pointer D in a call to 4045 ** The [database connection] pointer D in a call to
3840 ** [sqlite3_next_stmt(D,S)] must refer to an open database 4046 ** [sqlite3_next_stmt(D,S)] must refer to an open database
3841 ** connection and in particular must not be a NULL pointer. 4047 ** connection and in particular must not be a NULL pointer.
3842 **
3843 ** Requirements: [H13143] [H13146] [H13149] [H13152]
3844 */ 4048 */
3845 SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); 4049 SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
3846 4050
3847 /* 4051 /*
3848 ** CAPI3REF: Commit And Rollback Notification Callbacks {H12950} <S60400> 4052 ** CAPI3REF: Commit And Rollback Notification Callbacks
3849 ** 4053 **
3850 ** The sqlite3_commit_hook() interface registers a callback 4054 ** ^The sqlite3_commit_hook() interface registers a callback
3851 ** function to be invoked whenever a transaction is [COMMIT | committed]. 4055 ** function to be invoked whenever a transaction is [COMMIT | committed].
3852 ** Any callback set by a previous call to sqlite3_commit_hook() 4056 ** ^Any callback set by a previous call to sqlite3_commit_hook()
3853 ** for the same database connection is overridden. 4057 ** for the same database connection is overridden.
3854 ** The sqlite3_rollback_hook() interface registers a callback 4058 ** ^The sqlite3_rollback_hook() interface registers a callback
3855 ** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. 4059 ** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
3856 ** Any callback set by a previous call to sqlite3_commit_hook() 4060 ** ^Any callback set by a previous call to sqlite3_rollback_hook()
3857 ** for the same database connection is overridden. 4061 ** for the same database connection is overridden.
3858 ** The pArg argument is passed through to the callback. 4062 ** ^The pArg argument is passed through to the callback.
3859 ** If the callback on a commit hook function returns non-zero, 4063 ** ^If the callback on a commit hook function returns non-zero,
3860 ** then the commit is converted into a rollback. 4064 ** then the commit is converted into a rollback.
3861 ** 4065 **
3862 ** If another function was previously registered, its 4066 ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
3863 ** pArg value is returned. Otherwise NULL is returned. 4067 ** return the P argument from the previous call of the same function
4068 ** on the same [database connection] D, or NULL for
4069 ** the first call for each function on D.
3864 ** 4070 **
3865 ** The callback implementation must not do anything that will modify 4071 ** The callback implementation must not do anything that will modify
3866 ** the database connection that invoked the callback. Any actions 4072 ** the database connection that invoked the callback. Any actions
3867 ** to modify the database connection must be deferred until after the 4073 ** to modify the database connection must be deferred until after the
3868 ** completion of the [sqlite3_step()] call that triggered the commit 4074 ** completion of the [sqlite3_step()] call that triggered the commit
3869 ** or rollback hook in the first place. 4075 ** or rollback hook in the first place.
3870 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 4076 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3871 ** database connections for the meaning of "modify" in this paragraph. 4077 ** database connections for the meaning of "modify" in this paragraph.
3872 ** 4078 **
3873 ** Registering a NULL function disables the callback. 4079 ** ^Registering a NULL function disables the callback.
3874 ** 4080 **
3875 ** When the commit hook callback routine returns zero, the [COMMIT] 4081 ** ^When the commit hook callback routine returns zero, the [COMMIT]
3876 ** operation is allowed to continue normally. If the commit hook 4082 ** operation is allowed to continue normally. ^If the commit hook
3877 ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. 4083 ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
3878 ** The rollback hook is invoked on a rollback that results from a commit 4084 ** ^The rollback hook is invoked on a rollback that results from a commit
3879 ** hook returning non-zero, just as it would be with any other rollback. 4085 ** hook returning non-zero, just as it would be with any other rollback.
3880 ** 4086 **
3881 ** For the purposes of this API, a transaction is said to have been 4087 ** ^For the purposes of this API, a transaction is said to have been
3882 ** rolled back if an explicit "ROLLBACK" statement is executed, or 4088 ** rolled back if an explicit "ROLLBACK" statement is executed, or
3883 ** an error or constraint causes an implicit rollback to occur. 4089 ** an error or constraint causes an implicit rollback to occur.
3884 ** The rollback callback is not invoked if a transaction is 4090 ** ^The rollback callback is not invoked if a transaction is
3885 ** automatically rolled back because the database connection is closed. 4091 ** automatically rolled back because the database connection is closed.
3886 ** The rollback callback is not invoked if a transaction is
3887 ** rolled back because a commit callback returned non-zero.
3888 ** <todo> Check on this </todo>
3889 ** 4092 **
3890 ** See also the [sqlite3_update_hook()] interface. 4093 ** See also the [sqlite3_update_hook()] interface.
3891 **
3892 ** Requirements:
3893 ** [H12951] [H12952] [H12953] [H12954] [H12955]
3894 ** [H12961] [H12962] [H12963] [H12964]
3895 */ 4094 */
3896 SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); 4095 SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
3897 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); 4096 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
3898 4097
3899 /* 4098 /*
3900 ** CAPI3REF: Data Change Notification Callbacks {H12970} <S60400> 4099 ** CAPI3REF: Data Change Notification Callbacks
3901 ** 4100 **
3902 ** The sqlite3_update_hook() interface registers a callback function 4101 ** ^The sqlite3_update_hook() interface registers a callback function
3903 ** with the [database connection] identified by the first argument 4102 ** with the [database connection] identified by the first argument
3904 ** to be invoked whenever a row is updated, inserted or deleted. 4103 ** to be invoked whenever a row is updated, inserted or deleted.
3905 ** Any callback set by a previous call to this function 4104 ** ^Any callback set by a previous call to this function
3906 ** for the same database connection is overridden. 4105 ** for the same database connection is overridden.
3907 ** 4106 **
3908 ** The second argument is a pointer to the function to invoke when a 4107 ** ^The second argument is a pointer to the function to invoke when a
3909 ** row is updated, inserted or deleted. 4108 ** row is updated, inserted or deleted.
3910 ** The first argument to the callback is a copy of the third argument 4109 ** ^The first argument to the callback is a copy of the third argument
3911 ** to sqlite3_update_hook(). 4110 ** to sqlite3_update_hook().
3912 ** The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], 4111 ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
3913 ** or [SQLITE_UPDATE], depending on the operation that caused the callback 4112 ** or [SQLITE_UPDATE], depending on the operation that caused the callback
3914 ** to be invoked. 4113 ** to be invoked.
3915 ** The third and fourth arguments to the callback contain pointers to the 4114 ** ^The third and fourth arguments to the callback contain pointers to the
3916 ** database and table name containing the affected row. 4115 ** database and table name containing the affected row.
3917 ** The final callback parameter is the [rowid] of the row. 4116 ** ^The final callback parameter is the [rowid] of the row.
3918 ** In the case of an update, this is the [rowid] after the update takes place. 4117 ** ^In the case of an update, this is the [rowid] after the update takes place.
3919 ** 4118 **
3920 ** The update hook is not invoked when internal system tables are 4119 ** ^(The update hook is not invoked when internal system tables are
3921 ** modified (i.e. sqlite_master and sqlite_sequence). 4120 ** modified (i.e. sqlite_master and sqlite_sequence).)^
3922 ** 4121 **
3923 ** In the current implementation, the update hook 4122 ** ^In the current implementation, the update hook
3924 ** is not invoked when duplication rows are deleted because of an 4123 ** is not invoked when duplication rows are deleted because of an
3925 ** [ON CONFLICT | ON CONFLICT REPLACE] clause. Nor is the update hook 4124 ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
3926 ** invoked when rows are deleted using the [truncate optimization]. 4125 ** invoked when rows are deleted using the [truncate optimization].
3927 ** The exceptions defined in this paragraph might change in a future 4126 ** The exceptions defined in this paragraph might change in a future
3928 ** release of SQLite. 4127 ** release of SQLite.
3929 ** 4128 **
3930 ** The update hook implementation must not do anything that will modify 4129 ** The update hook implementation must not do anything that will modify
3931 ** the database connection that invoked the update hook. Any actions 4130 ** the database connection that invoked the update hook. Any actions
3932 ** to modify the database connection must be deferred until after the 4131 ** to modify the database connection must be deferred until after the
3933 ** completion of the [sqlite3_step()] call that triggered the update hook. 4132 ** completion of the [sqlite3_step()] call that triggered the update hook.
3934 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 4133 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3935 ** database connections for the meaning of "modify" in this paragraph. 4134 ** database connections for the meaning of "modify" in this paragraph.
3936 ** 4135 **
3937 ** If another function was previously registered, its pArg value 4136 ** ^The sqlite3_update_hook(D,C,P) function
3938 ** is returned. Otherwise NULL is returned. 4137 ** returns the P argument from the previous call
4138 ** on the same [database connection] D, or NULL for
4139 ** the first call on D.
3939 ** 4140 **
3940 ** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] 4141 ** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
3941 ** interfaces. 4142 ** interfaces.
3942 **
3943 ** Requirements:
3944 ** [H12971] [H12973] [H12975] [H12977] [H12979] [H12981] [H12983] [H12986]
3945 */ 4143 */
3946 SQLITE_API void *sqlite3_update_hook( 4144 SQLITE_API void *sqlite3_update_hook(
3947 sqlite3*, 4145 sqlite3*,
3948 void(*)(void *,int ,char const *,char const *,sqlite3_int64), 4146 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
3949 void* 4147 void*
3950 ); 4148 );
3951 4149
3952 /* 4150 /*
3953 ** CAPI3REF: Enable Or Disable Shared Pager Cache {H10330} <S30900> 4151 ** CAPI3REF: Enable Or Disable Shared Pager Cache
3954 ** KEYWORDS: {shared cache} 4152 ** KEYWORDS: {shared cache}
3955 ** 4153 **
3956 ** This routine enables or disables the sharing of the database cache 4154 ** ^(This routine enables or disables the sharing of the database cache
3957 ** and schema data structures between [database connection | connections] 4155 ** and schema data structures between [database connection | connections]
3958 ** to the same database. Sharing is enabled if the argument is true 4156 ** to the same database. Sharing is enabled if the argument is true
3959 ** and disabled if the argument is false. 4157 ** and disabled if the argument is false.)^
3960 ** 4158 **
3961 ** Cache sharing is enabled and disabled for an entire process. 4159 ** ^Cache sharing is enabled and disabled for an entire process.
3962 ** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, 4160 ** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
3963 ** sharing was enabled or disabled for each thread separately. 4161 ** sharing was enabled or disabled for each thread separately.
3964 ** 4162 **
3965 ** The cache sharing mode set by this interface effects all subsequent 4163 ** ^(The cache sharing mode set by this interface effects all subsequent
3966 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. 4164 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
3967 ** Existing database connections continue use the sharing mode 4165 ** Existing database connections continue use the sharing mode
3968 ** that was in effect at the time they were opened. 4166 ** that was in effect at the time they were opened.)^
3969 ** 4167 **
3970 ** Virtual tables cannot be used with a shared cache. When shared 4168 ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
3971 ** cache is enabled, the [sqlite3_create_module()] API used to register 4169 ** successfully. An [error code] is returned otherwise.)^
3972 ** virtual tables will always return an error.
3973 ** 4170 **
3974 ** This routine returns [SQLITE_OK] if shared cache was enabled or disabled 4171 ** ^Shared cache is disabled by default. But this might change in
3975 ** successfully. An [error code] is returned otherwise.
3976 **
3977 ** Shared cache is disabled by default. But this might change in
3978 ** future releases of SQLite. Applications that care about shared 4172 ** future releases of SQLite. Applications that care about shared
3979 ** cache setting should set it explicitly. 4173 ** cache setting should set it explicitly.
3980 ** 4174 **
3981 ** See Also: [SQLite Shared-Cache Mode] 4175 ** See Also: [SQLite Shared-Cache Mode]
3982 **
3983 ** Requirements: [H10331] [H10336] [H10337] [H10339]
3984 */ 4176 */
3985 SQLITE_API int sqlite3_enable_shared_cache(int); 4177 SQLITE_API int sqlite3_enable_shared_cache(int);
3986 4178
3987 /* 4179 /*
3988 ** CAPI3REF: Attempt To Free Heap Memory {H17340} <S30220> 4180 ** CAPI3REF: Attempt To Free Heap Memory
3989 ** 4181 **
3990 ** The sqlite3_release_memory() interface attempts to free N bytes 4182 ** ^The sqlite3_release_memory() interface attempts to free N bytes
3991 ** of heap memory by deallocating non-essential memory allocations 4183 ** of heap memory by deallocating non-essential memory allocations
3992 ** held by the database library. {END} Memory used to cache database 4184 ** held by the database library. Memory used to cache database
3993 ** pages to improve performance is an example of non-essential memory. 4185 ** pages to improve performance is an example of non-essential memory.
3994 ** sqlite3_release_memory() returns the number of bytes actually freed, 4186 ** ^sqlite3_release_memory() returns the number of bytes actually freed,
3995 ** which might be more or less than the amount requested. 4187 ** which might be more or less than the amount requested.
3996 ** 4188 ** ^The sqlite3_release_memory() routine is a no-op returning zero
3997 ** Requirements: [H17341] [H17342] 4189 ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
3998 */ 4190 */
3999 SQLITE_API int sqlite3_release_memory(int); 4191 SQLITE_API int sqlite3_release_memory(int);
4000 4192
4001 /* 4193 /*
4002 ** CAPI3REF: Impose A Limit On Heap Size {H17350} <S30220> 4194 ** CAPI3REF: Impose A Limit On Heap Size
4003 ** 4195 **
4004 ** The sqlite3_soft_heap_limit() interface places a "soft" limit 4196 ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
4005 ** on the amount of heap memory that may be allocated by SQLite. 4197 ** soft limit on the amount of heap memory that may be allocated by SQLite.
4006 ** If an internal allocation is requested that would exceed the 4198 ** ^SQLite strives to keep heap memory utilization below the soft heap
4007 ** soft heap limit, [sqlite3_release_memory()] is invoked one or 4199 ** limit by reducing the number of pages held in the page cache
4008 ** more times to free up some space before the allocation is performed. 4200 ** as heap memory usages approaches the limit.
4201 ** ^The soft heap limit is "soft" because even though SQLite strives to stay
4202 ** below the limit, it will exceed the limit rather than generate
4203 ** an [SQLITE_NOMEM] error. In other words, the soft heap limit
4204 ** is advisory only.
4009 ** 4205 **
4010 ** The limit is called "soft", because if [sqlite3_release_memory()] 4206 ** ^The return value from sqlite3_soft_heap_limit64() is the size of
4011 ** cannot free sufficient memory to prevent the limit from being exceeded, 4207 ** the soft heap limit prior to the call. ^If the argument N is negative
4012 ** the memory is allocated anyway and the current operation proceeds. 4208 ** then no change is made to the soft heap limit. Hence, the current
4209 ** size of the soft heap limit can be determined by invoking
4210 ** sqlite3_soft_heap_limit64() with a negative argument.
4013 ** 4211 **
4014 ** A negative or zero value for N means that there is no soft heap limit and 4212 ** ^If the argument N is zero then the soft heap limit is disabled.
4015 ** [sqlite3_release_memory()] will only be called when memory is exhausted.
4016 ** The default value for the soft heap limit is zero.
4017 ** 4213 **
4018 ** SQLite makes a best effort to honor the soft heap limit. 4214 ** ^(The soft heap limit is not enforced in the current implementation
4019 ** But if the soft heap limit cannot be honored, execution will 4215 ** if one or more of following conditions are true:
4020 ** continue without error or notification. This is why the limit is
4021 ** called a "soft" limit. It is advisory only.
4022 ** 4216 **
4023 ** Prior to SQLite version 3.5.0, this routine only constrained the memory 4217 ** <ul>
4024 ** allocated by a single thread - the same thread in which this routine 4218 ** <li> The soft heap limit is set to zero.
4025 ** runs. Beginning with SQLite version 3.5.0, the soft heap limit is 4219 ** <li> Memory accounting is disabled using a combination of the
4026 ** applied to all threads. The value specified for the soft heap limit 4220 ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
4027 ** is an upper bound on the total memory allocation for all threads. In 4221 ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
4028 ** version 3.5.0 there is no mechanism for limiting the heap usage for 4222 ** <li> An alternative page cache implementation is specifed using
4029 ** individual threads. 4223 ** [sqlite3_config]([SQLITE_CONFIG_PCACHE],...).
4224 ** <li> The page cache allocates from its own memory pool supplied
4225 ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
4226 ** from the heap.
4227 ** </ul>)^
4030 ** 4228 **
4031 ** Requirements: 4229 ** Beginning with SQLite version 3.7.3, the soft heap limit is enforced
4032 ** [H16351] [H16352] [H16353] [H16354] [H16355] [H16358] 4230 ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
4231 ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
4232 ** the soft heap limit is enforced on every memory allocation. Without
4233 ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
4234 ** when memory is allocated by the page cache. Testing suggests that because
4235 ** the page cache is the predominate memory user in SQLite, most
4236 ** applications will achieve adequate soft heap limit enforcement without
4237 ** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT].
4238 **
4239 ** The circumstances under which SQLite will enforce the soft heap limit may
4240 ** changes in future releases of SQLite.
4033 */ 4241 */
4034 SQLITE_API void sqlite3_soft_heap_limit(int); 4242 SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
4035 4243
4036 /* 4244 /*
4037 ** CAPI3REF: Extract Metadata About A Column Of A Table {H12850} <S60300> 4245 ** CAPI3REF: Deprecated Soft Heap Limit Interface
4246 ** DEPRECATED
4038 ** 4247 **
4039 ** This routine returns metadata about a specific column of a specific 4248 ** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
4249 ** interface. This routine is provided for historical compatibility
4250 ** only. All new applications should use the
4251 ** [sqlite3_soft_heap_limit64()] interface rather than this one.
4252 */
4253 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
4254
4255
4256 /*
4257 ** CAPI3REF: Extract Metadata About A Column Of A Table
4258 **
4259 ** ^This routine returns metadata about a specific column of a specific
4040 ** database table accessible using the [database connection] handle 4260 ** database table accessible using the [database connection] handle
4041 ** passed as the first function argument. 4261 ** passed as the first function argument.
4042 ** 4262 **
4043 ** The column is identified by the second, third and fourth parameters to 4263 ** ^The column is identified by the second, third and fourth parameters to
4044 ** this function. The second parameter is either the name of the database 4264 ** this function. ^The second parameter is either the name of the database
4045 ** (i.e. "main", "temp" or an attached database) containing the specified 4265 ** (i.e. "main", "temp", or an attached database) containing the specified
4046 ** table or NULL. If it is NULL, then all attached databases are searched 4266 ** table or NULL. ^If it is NULL, then all attached databases are searched
4047 ** for the table using the same algorithm used by the database engine to 4267 ** for the table using the same algorithm used by the database engine to
4048 ** resolve unqualified table references. 4268 ** resolve unqualified table references.
4049 ** 4269 **
4050 ** The third and fourth parameters to this function are the table and column 4270 ** ^The third and fourth parameters to this function are the table and column
4051 ** name of the desired column, respectively. Neither of these parameters 4271 ** name of the desired column, respectively. Neither of these parameters
4052 ** may be NULL. 4272 ** may be NULL.
4053 ** 4273 **
4054 ** Metadata is returned by writing to the memory locations passed as the 5th 4274 ** ^Metadata is returned by writing to the memory locations passed as the 5th
4055 ** and subsequent parameters to this function. Any of these arguments may be 4275 ** and subsequent parameters to this function. ^Any of these arguments may be
4056 ** NULL, in which case the corresponding element of metadata is omitted. 4276 ** NULL, in which case the corresponding element of metadata is omitted.
4057 ** 4277 **
4058 ** <blockquote> 4278 ** ^(<blockquote>
4059 ** <table border="1"> 4279 ** <table border="1">
4060 ** <tr><th> Parameter <th> Output<br>Type <th> Description 4280 ** <tr><th> Parameter <th> Output<br>Type <th> Description
4061 ** 4281 **
4062 ** <tr><td> 5th <td> const char* <td> Data type 4282 ** <tr><td> 5th <td> const char* <td> Data type
4063 ** <tr><td> 6th <td> const char* <td> Name of default collation sequence 4283 ** <tr><td> 6th <td> const char* <td> Name of default collation sequence
4064 ** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint 4284 ** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
4065 ** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY 4285 ** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
4066 ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] 4286 ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
4067 ** </table> 4287 ** </table>
4068 ** </blockquote> 4288 ** </blockquote>)^
4069 ** 4289 **
4070 ** The memory pointed to by the character pointers returned for the 4290 ** ^The memory pointed to by the character pointers returned for the
4071 ** declaration type and collation sequence is valid only until the next 4291 ** declaration type and collation sequence is valid only until the next
4072 ** call to any SQLite API function. 4292 ** call to any SQLite API function.
4073 ** 4293 **
4074 ** If the specified table is actually a view, an [error code] is returned. 4294 ** ^If the specified table is actually a view, an [error code] is returned.
4075 ** 4295 **
4076 ** If the specified column is "rowid", "oid" or "_rowid_" and an 4296 ** ^If the specified column is "rowid", "oid" or "_rowid_" and an
4077 ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output 4297 ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
4078 ** parameters are set for the explicitly declared column. If there is no 4298 ** parameters are set for the explicitly declared column. ^(If there is no
4079 ** explicitly declared [INTEGER PRIMARY KEY] column, then the output 4299 ** explicitly declared [INTEGER PRIMARY KEY] column, then the output
4080 ** parameters are set as follows: 4300 ** parameters are set as follows:
4081 ** 4301 **
4082 ** <pre> 4302 ** <pre>
4083 ** data type: "INTEGER" 4303 ** data type: "INTEGER"
4084 ** collation sequence: "BINARY" 4304 ** collation sequence: "BINARY"
4085 ** not null: 0 4305 ** not null: 0
4086 ** primary key: 1 4306 ** primary key: 1
4087 ** auto increment: 0 4307 ** auto increment: 0
4088 ** </pre> 4308 ** </pre>)^
4089 ** 4309 **
4090 ** This function may load one or more schemas from database files. If an 4310 ** ^(This function may load one or more schemas from database files. If an
4091 ** error occurs during this process, or if the requested table or column 4311 ** error occurs during this process, or if the requested table or column
4092 ** cannot be found, an [error code] is returned and an error message left 4312 ** cannot be found, an [error code] is returned and an error message left
4093 ** in the [database connection] (to be retrieved using sqlite3_errmsg()). 4313 ** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^
4094 ** 4314 **
4095 ** This API is only available if the library was compiled with the 4315 ** ^This API is only available if the library was compiled with the
4096 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. 4316 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
4097 */ 4317 */
4098 SQLITE_API int sqlite3_table_column_metadata( 4318 SQLITE_API int sqlite3_table_column_metadata(
4099 sqlite3 *db, /* Connection handle */ 4319 sqlite3 *db, /* Connection handle */
4100 const char *zDbName, /* Database name or NULL */ 4320 const char *zDbName, /* Database name or NULL */
4101 const char *zTableName, /* Table name */ 4321 const char *zTableName, /* Table name */
4102 const char *zColumnName, /* Column name */ 4322 const char *zColumnName, /* Column name */
4103 char const **pzDataType, /* OUTPUT: Declared data type */ 4323 char const **pzDataType, /* OUTPUT: Declared data type */
4104 char const **pzCollSeq, /* OUTPUT: Collation sequence name */ 4324 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
4105 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ 4325 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
4106 int *pPrimaryKey, /* OUTPUT: True if column part of PK */ 4326 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
4107 int *pAutoinc /* OUTPUT: True if column is auto-increment */ 4327 int *pAutoinc /* OUTPUT: True if column is auto-increment */
4108 ); 4328 );
4109 4329
4110 /* 4330 /*
4111 ** CAPI3REF: Load An Extension {H12600} <S20500> 4331 ** CAPI3REF: Load An Extension
4112 ** 4332 **
4113 ** This interface loads an SQLite extension library from the named file. 4333 ** ^This interface loads an SQLite extension library from the named file.
4114 ** 4334 **
4115 ** {H12601} The sqlite3_load_extension() interface attempts to load an 4335 ** ^The sqlite3_load_extension() interface attempts to load an
4116 ** SQLite extension library contained in the file zFile. 4336 ** SQLite extension library contained in the file zFile.
4117 ** 4337 **
4118 ** {H12602} The entry point is zProc. 4338 ** ^The entry point is zProc.
4339 ** ^zProc may be 0, in which case the name of the entry point
4340 ** defaults to "sqlite3_extension_init".
4341 ** ^The sqlite3_load_extension() interface returns
4342 ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
4343 ** ^If an error occurs and pzErrMsg is not 0, then the
4344 ** [sqlite3_load_extension()] interface shall attempt to
4345 ** fill *pzErrMsg with error message text stored in memory
4346 ** obtained from [sqlite3_malloc()]. The calling function
4347 ** should free this memory by calling [sqlite3_free()].
4119 ** 4348 **
4120 ** {H12603} zProc may be 0, in which case the name of the entry point 4349 ** ^Extension loading must be enabled using
4121 ** defaults to "sqlite3_extension_init". 4350 ** [sqlite3_enable_load_extension()] prior to calling this API,
4351 ** otherwise an error will be returned.
4122 ** 4352 **
4123 ** {H12604} The sqlite3_load_extension() interface shall return 4353 ** See also the [load_extension() SQL function].
4124 ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
4125 **
4126 ** {H12605} If an error occurs and pzErrMsg is not 0, then the
4127 ** [sqlite3_load_extension()] interface shall attempt to
4128 ** fill *pzErrMsg with error message text stored in memory
4129 ** obtained from [sqlite3_malloc()]. {END} The calling function
4130 ** should free this memory by calling [sqlite3_free()].
4131 **
4132 ** {H12606} Extension loading must be enabled using
4133 ** [sqlite3_enable_load_extension()] prior to calling this API,
4134 ** otherwise an error will be returned.
4135 */ 4354 */
4136 SQLITE_API int sqlite3_load_extension( 4355 SQLITE_API int sqlite3_load_extension(
4137 sqlite3 *db, /* Load the extension into this database connection */ 4356 sqlite3 *db, /* Load the extension into this database connection */
4138 const char *zFile, /* Name of the shared library containing extension */ 4357 const char *zFile, /* Name of the shared library containing extension */
4139 const char *zProc, /* Entry point. Derived from zFile if 0 */ 4358 const char *zProc, /* Entry point. Derived from zFile if 0 */
4140 char **pzErrMsg /* Put error message here if not 0 */ 4359 char **pzErrMsg /* Put error message here if not 0 */
4141 ); 4360 );
4142 4361
4143 /* 4362 /*
4144 ** CAPI3REF: Enable Or Disable Extension Loading {H12620} <S20500> 4363 ** CAPI3REF: Enable Or Disable Extension Loading
4145 ** 4364 **
4146 ** So as not to open security holes in older applications that are 4365 ** ^So as not to open security holes in older applications that are
4147 ** unprepared to deal with extension loading, and as a means of disabling 4366 ** unprepared to deal with extension loading, and as a means of disabling
4148 ** extension loading while evaluating user-entered SQL, the following API 4367 ** extension loading while evaluating user-entered SQL, the following API
4149 ** is provided to turn the [sqlite3_load_extension()] mechanism on and off. 4368 ** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
4150 ** 4369 **
4151 ** Extension loading is off by default. See ticket #1863. 4370 ** ^Extension loading is off by default. See ticket #1863.
4152 ** 4371 ** ^Call the sqlite3_enable_load_extension() routine with onoff==1
4153 ** {H12621} Call the sqlite3_enable_load_extension() routine with onoff==1 4372 ** to turn extension loading on and call it with onoff==0 to turn
4154 ** to turn extension loading on and call it with onoff==0 to turn 4373 ** it back off again.
4155 ** it back off again.
4156 **
4157 ** {H12622} Extension loading is off by default.
4158 */ 4374 */
4159 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); 4375 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
4160 4376
4161 /* 4377 /*
4162 ** CAPI3REF: Automatically Load An Extensions {H12640} <S20500> 4378 ** CAPI3REF: Automatically Load Statically Linked Extensions
4163 ** 4379 **
4164 ** This API can be invoked at program startup in order to register 4380 ** ^This interface causes the xEntryPoint() function to be invoked for
4165 ** one or more statically linked extensions that will be available 4381 ** each new [database connection] that is created. The idea here is that
4166 ** to all new [database connections]. {END} 4382 ** xEntryPoint() is the entry point for a statically linked SQLite extension
4383 ** that is to be automatically loaded into all new database connections.
4167 ** 4384 **
4168 ** This routine stores a pointer to the extension in an array that is 4385 ** ^(Even though the function prototype shows that xEntryPoint() takes
4169 ** obtained from [sqlite3_malloc()]. If you run a memory leak checker 4386 ** no arguments and returns void, SQLite invokes xEntryPoint() with three
4170 ** on your program and it reports a leak because of this array, invoke 4387 ** arguments and expects and integer result as if the signature of the
4171 ** [sqlite3_reset_auto_extension()] prior to shutdown to free the memory. 4388 ** entry point where as follows:
4172 ** 4389 **
4173 ** {H12641} This function registers an extension entry point that is 4390 ** <blockquote><pre>
4174 ** automatically invoked whenever a new [database connection] 4391 ** &nbsp; int xEntryPoint(
4175 ** is opened using [sqlite3_open()], [sqlite3_open16()], 4392 ** &nbsp; sqlite3 *db,
4176 ** or [sqlite3_open_v2()]. 4393 ** &nbsp; const char **pzErrMsg,
4394 ** &nbsp; const struct sqlite3_api_routines *pThunk
4395 ** &nbsp; );
4396 ** </pre></blockquote>)^
4177 ** 4397 **
4178 ** {H12642} Duplicate extensions are detected so calling this routine 4398 ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
4179 ** multiple times with the same extension is harmless. 4399 ** point to an appropriate error message (obtained from [sqlite3_mprintf()])
4400 ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
4401 ** is NULL before calling the xEntryPoint(). ^SQLite will invoke
4402 ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
4403 ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
4404 ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
4180 ** 4405 **
4181 ** {H12643} This routine stores a pointer to the extension in an array 4406 ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
4182 ** that is obtained from [sqlite3_malloc()]. 4407 ** on the list of automatic extensions is a harmless no-op. ^No entry point
4408 ** will be called more than once for each database connection that is opened.
4183 ** 4409 **
4184 ** {H12644} Automatic extensions apply across all threads. 4410 ** See also: [sqlite3_reset_auto_extension()].
4185 */ 4411 */
4186 SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void)); 4412 SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void));
4187 4413
4188 /* 4414 /*
4189 ** CAPI3REF: Reset Automatic Extension Loading {H12660} <S20500> 4415 ** CAPI3REF: Reset Automatic Extension Loading
4190 ** 4416 **
4191 ** This function disables all previously registered automatic 4417 ** ^This interface disables all automatic extensions previously
4192 ** extensions. {END} It undoes the effect of all prior 4418 ** registered using [sqlite3_auto_extension()].
4193 ** [sqlite3_auto_extension()] calls.
4194 **
4195 ** {H12661} This function disables all previously registered
4196 ** automatic extensions.
4197 **
4198 ** {H12662} This function disables automatic extensions in all threads.
4199 */ 4419 */
4200 SQLITE_API void sqlite3_reset_auto_extension(void); 4420 SQLITE_API void sqlite3_reset_auto_extension(void);
4201 4421
4202 /* 4422 /*
4203 ****** EXPERIMENTAL - subject to change without notice **************
4204 **
4205 ** The interface to the virtual-table mechanism is currently considered 4423 ** The interface to the virtual-table mechanism is currently considered
4206 ** to be experimental. The interface might change in incompatible ways. 4424 ** to be experimental. The interface might change in incompatible ways.
4207 ** If this is a problem for you, do not use the interface at this time. 4425 ** If this is a problem for you, do not use the interface at this time.
4208 ** 4426 **
4209 ** When the virtual-table mechanism stabilizes, we will declare the 4427 ** When the virtual-table mechanism stabilizes, we will declare the
4210 ** interface fixed, support it indefinitely, and remove this comment. 4428 ** interface fixed, support it indefinitely, and remove this comment.
4211 */ 4429 */
4212 4430
4213 /* 4431 /*
4214 ** Structures used by the virtual table interface 4432 ** Structures used by the virtual table interface
4215 */ 4433 */
4216 typedef struct sqlite3_vtab sqlite3_vtab; 4434 typedef struct sqlite3_vtab sqlite3_vtab;
4217 typedef struct sqlite3_index_info sqlite3_index_info; 4435 typedef struct sqlite3_index_info sqlite3_index_info;
4218 typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; 4436 typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
4219 typedef struct sqlite3_module sqlite3_module; 4437 typedef struct sqlite3_module sqlite3_module;
4220 4438
4221 /* 4439 /*
4222 ** CAPI3REF: Virtual Table Object {H18000} <S20400> 4440 ** CAPI3REF: Virtual Table Object
4223 ** KEYWORDS: sqlite3_module {virtual table module} 4441 ** KEYWORDS: sqlite3_module {virtual table module}
4224 ** EXPERIMENTAL
4225 ** 4442 **
4226 ** This structure, sometimes called a a "virtual table module", 4443 ** This structure, sometimes called a a "virtual table module",
4227 ** defines the implementation of a [virtual tables]. 4444 ** defines the implementation of a [virtual tables].
4228 ** This structure consists mostly of methods for the module. 4445 ** This structure consists mostly of methods for the module.
4229 ** 4446 **
4230 ** A virtual table module is created by filling in a persistent 4447 ** ^A virtual table module is created by filling in a persistent
4231 ** instance of this structure and passing a pointer to that instance 4448 ** instance of this structure and passing a pointer to that instance
4232 ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. 4449 ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
4233 ** The registration remains valid until it is replaced by a different 4450 ** ^The registration remains valid until it is replaced by a different
4234 ** module or until the [database connection] closes. The content 4451 ** module or until the [database connection] closes. The content
4235 ** of this structure must not change while it is registered with 4452 ** of this structure must not change while it is registered with
4236 ** any database connection. 4453 ** any database connection.
4237 */ 4454 */
4238 struct sqlite3_module { 4455 struct sqlite3_module {
4239 int iVersion; 4456 int iVersion;
4240 int (*xCreate)(sqlite3*, void *pAux, 4457 int (*xCreate)(sqlite3*, void *pAux,
4241 int argc, const char *const*argv, 4458 int argc, const char *const*argv,
4242 sqlite3_vtab **ppVTab, char**); 4459 sqlite3_vtab **ppVTab, char**);
4243 int (*xConnect)(sqlite3*, void *pAux, 4460 int (*xConnect)(sqlite3*, void *pAux,
(...skipping 15 matching lines...) Expand all
4259 int (*xSync)(sqlite3_vtab *pVTab); 4476 int (*xSync)(sqlite3_vtab *pVTab);
4260 int (*xCommit)(sqlite3_vtab *pVTab); 4477 int (*xCommit)(sqlite3_vtab *pVTab);
4261 int (*xRollback)(sqlite3_vtab *pVTab); 4478 int (*xRollback)(sqlite3_vtab *pVTab);
4262 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, 4479 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
4263 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), 4480 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
4264 void **ppArg); 4481 void **ppArg);
4265 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); 4482 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
4266 }; 4483 };
4267 4484
4268 /* 4485 /*
4269 ** CAPI3REF: Virtual Table Indexing Information {H18100} <S20400> 4486 ** CAPI3REF: Virtual Table Indexing Information
4270 ** KEYWORDS: sqlite3_index_info 4487 ** KEYWORDS: sqlite3_index_info
4271 ** EXPERIMENTAL
4272 ** 4488 **
4273 ** The sqlite3_index_info structure and its substructures is used to 4489 ** The sqlite3_index_info structure and its substructures is used as part
4490 ** of the [virtual table] interface to
4274 ** pass information into and receive the reply from the [xBestIndex] 4491 ** pass information into and receive the reply from the [xBestIndex]
4275 ** method of a [virtual table module]. The fields under **Inputs** are the 4492 ** method of a [virtual table module]. The fields under **Inputs** are the
4276 ** inputs to xBestIndex and are read-only. xBestIndex inserts its 4493 ** inputs to xBestIndex and are read-only. xBestIndex inserts its
4277 ** results into the **Outputs** fields. 4494 ** results into the **Outputs** fields.
4278 ** 4495 **
4279 ** The aConstraint[] array records WHERE clause constraints of the form: 4496 ** ^(The aConstraint[] array records WHERE clause constraints of the form:
4280 ** 4497 **
4281 ** <pre>column OP expr</pre> 4498 ** <blockquote>column OP expr</blockquote>
4282 ** 4499 **
4283 ** where OP is =, &lt;, &lt;=, &gt;, or &gt;=. The particular operator is 4500 ** where OP is =, &lt;, &lt;=, &gt;, or &gt;=.)^ ^(The particular operator is
4284 ** stored in aConstraint[].op. The index of the column is stored in 4501 ** stored in aConstraint[].op using one of the
4285 ** aConstraint[].iColumn. aConstraint[].usable is TRUE if the 4502 ** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
4503 ** ^(The index of the column is stored in
4504 ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
4286 ** expr on the right-hand side can be evaluated (and thus the constraint 4505 ** expr on the right-hand side can be evaluated (and thus the constraint
4287 ** is usable) and false if it cannot. 4506 ** is usable) and false if it cannot.)^
4288 ** 4507 **
4289 ** The optimizer automatically inverts terms of the form "expr OP column" 4508 ** ^The optimizer automatically inverts terms of the form "expr OP column"
4290 ** and makes other simplifications to the WHERE clause in an attempt to 4509 ** and makes other simplifications to the WHERE clause in an attempt to
4291 ** get as many WHERE clause terms into the form shown above as possible. 4510 ** get as many WHERE clause terms into the form shown above as possible.
4292 ** The aConstraint[] array only reports WHERE clause terms in the correct 4511 ** ^The aConstraint[] array only reports WHERE clause terms that are
4293 ** form that refer to the particular virtual table being queried. 4512 ** relevant to the particular virtual table being queried.
4294 ** 4513 **
4295 ** Information about the ORDER BY clause is stored in aOrderBy[]. 4514 ** ^Information about the ORDER BY clause is stored in aOrderBy[].
4296 ** Each term of aOrderBy records a column of the ORDER BY clause. 4515 ** ^Each term of aOrderBy records a column of the ORDER BY clause.
4297 ** 4516 **
4298 ** The [xBestIndex] method must fill aConstraintUsage[] with information 4517 ** The [xBestIndex] method must fill aConstraintUsage[] with information
4299 ** about what parameters to pass to xFilter. If argvIndex>0 then 4518 ** about what parameters to pass to xFilter. ^If argvIndex>0 then
4300 ** the right-hand side of the corresponding aConstraint[] is evaluated 4519 ** the right-hand side of the corresponding aConstraint[] is evaluated
4301 ** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit 4520 ** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
4302 ** is true, then the constraint is assumed to be fully handled by the 4521 ** is true, then the constraint is assumed to be fully handled by the
4303 ** virtual table and is not checked again by SQLite. 4522 ** virtual table and is not checked again by SQLite.)^
4304 ** 4523 **
4305 ** The idxNum and idxPtr values are recorded and passed into the 4524 ** ^The idxNum and idxPtr values are recorded and passed into the
4306 ** [xFilter] method. 4525 ** [xFilter] method.
4307 ** [sqlite3_free()] is used to free idxPtr if and only iff 4526 ** ^[sqlite3_free()] is used to free idxPtr if and only if
4308 ** needToFreeIdxPtr is true. 4527 ** needToFreeIdxPtr is true.
4309 ** 4528 **
4310 ** The orderByConsumed means that output from [xFilter]/[xNext] will occur in 4529 ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
4311 ** the correct order to satisfy the ORDER BY clause so that no separate 4530 ** the correct order to satisfy the ORDER BY clause so that no separate
4312 ** sorting step is required. 4531 ** sorting step is required.
4313 ** 4532 **
4314 ** The estimatedCost value is an estimate of the cost of doing the 4533 ** ^The estimatedCost value is an estimate of the cost of doing the
4315 ** particular lookup. A full scan of a table with N entries should have 4534 ** particular lookup. A full scan of a table with N entries should have
4316 ** a cost of N. A binary search of a table of N entries should have a 4535 ** a cost of N. A binary search of a table of N entries should have a
4317 ** cost of approximately log(N). 4536 ** cost of approximately log(N).
4318 */ 4537 */
4319 struct sqlite3_index_info { 4538 struct sqlite3_index_info {
4320 /* Inputs */ 4539 /* Inputs */
4321 int nConstraint; /* Number of entries in aConstraint */ 4540 int nConstraint; /* Number of entries in aConstraint */
4322 struct sqlite3_index_constraint { 4541 struct sqlite3_index_constraint {
4323 int iColumn; /* Column on left-hand side of constraint */ 4542 int iColumn; /* Column on left-hand side of constraint */
4324 unsigned char op; /* Constraint operator */ 4543 unsigned char op; /* Constraint operator */
4325 unsigned char usable; /* True if this constraint is usable */ 4544 unsigned char usable; /* True if this constraint is usable */
4326 int iTermOffset; /* Used internally - xBestIndex should ignore */ 4545 int iTermOffset; /* Used internally - xBestIndex should ignore */
4327 } *aConstraint; /* Table of WHERE clause constraints */ 4546 } *aConstraint; /* Table of WHERE clause constraints */
4328 int nOrderBy; /* Number of terms in the ORDER BY clause */ 4547 int nOrderBy; /* Number of terms in the ORDER BY clause */
4329 struct sqlite3_index_orderby { 4548 struct sqlite3_index_orderby {
4330 int iColumn; /* Column number */ 4549 int iColumn; /* Column number */
4331 unsigned char desc; /* True for DESC. False for ASC. */ 4550 unsigned char desc; /* True for DESC. False for ASC. */
4332 } *aOrderBy; /* The ORDER BY clause */ 4551 } *aOrderBy; /* The ORDER BY clause */
4333 /* Outputs */ 4552 /* Outputs */
4334 struct sqlite3_index_constraint_usage { 4553 struct sqlite3_index_constraint_usage {
4335 int argvIndex; /* if >0, constraint is part of argv to xFilter */ 4554 int argvIndex; /* if >0, constraint is part of argv to xFilter */
4336 unsigned char omit; /* Do not code a test for this constraint */ 4555 unsigned char omit; /* Do not code a test for this constraint */
4337 } *aConstraintUsage; 4556 } *aConstraintUsage;
4338 int idxNum; /* Number used to identify the index */ 4557 int idxNum; /* Number used to identify the index */
4339 char *idxStr; /* String, possibly obtained from sqlite3_malloc */ 4558 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
4340 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ 4559 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
4341 int orderByConsumed; /* True if output is already ordered */ 4560 int orderByConsumed; /* True if output is already ordered */
4342 double estimatedCost; /* Estimated cost of using this index */ 4561 double estimatedCost; /* Estimated cost of using this index */
4343 }; 4562 };
4563
4564 /*
4565 ** CAPI3REF: Virtual Table Constraint Operator Codes
4566 **
4567 ** These macros defined the allowed values for the
4568 ** [sqlite3_index_info].aConstraint[].op field. Each value represents
4569 ** an operator that is part of a constraint term in the wHERE clause of
4570 ** a query that uses a [virtual table].
4571 */
4344 #define SQLITE_INDEX_CONSTRAINT_EQ 2 4572 #define SQLITE_INDEX_CONSTRAINT_EQ 2
4345 #define SQLITE_INDEX_CONSTRAINT_GT 4 4573 #define SQLITE_INDEX_CONSTRAINT_GT 4
4346 #define SQLITE_INDEX_CONSTRAINT_LE 8 4574 #define SQLITE_INDEX_CONSTRAINT_LE 8
4347 #define SQLITE_INDEX_CONSTRAINT_LT 16 4575 #define SQLITE_INDEX_CONSTRAINT_LT 16
4348 #define SQLITE_INDEX_CONSTRAINT_GE 32 4576 #define SQLITE_INDEX_CONSTRAINT_GE 32
4349 #define SQLITE_INDEX_CONSTRAINT_MATCH 64 4577 #define SQLITE_INDEX_CONSTRAINT_MATCH 64
4350 4578
4351 /* 4579 /*
4352 ** CAPI3REF: Register A Virtual Table Implementation {H18200} <S20400> 4580 ** CAPI3REF: Register A Virtual Table Implementation
4353 ** EXPERIMENTAL
4354 ** 4581 **
4355 ** This routine is used to register a new [virtual table module] name. 4582 ** ^These routines are used to register a new [virtual table module] name.
4356 ** Module names must be registered before 4583 ** ^Module names must be registered before
4357 ** creating a new [virtual table] using the module, or before using a 4584 ** creating a new [virtual table] using the module and before using a
4358 ** preexisting [virtual table] for the module. 4585 ** preexisting [virtual table] for the module.
4359 ** 4586 **
4360 ** The module name is registered on the [database connection] specified 4587 ** ^The module name is registered on the [database connection] specified
4361 ** by the first parameter. The name of the module is given by the 4588 ** by the first parameter. ^The name of the module is given by the
4362 ** second parameter. The third parameter is a pointer to 4589 ** second parameter. ^The third parameter is a pointer to
4363 ** the implementation of the [virtual table module]. The fourth 4590 ** the implementation of the [virtual table module]. ^The fourth
4364 ** parameter is an arbitrary client data pointer that is passed through 4591 ** parameter is an arbitrary client data pointer that is passed through
4365 ** into the [xCreate] and [xConnect] methods of the virtual table module 4592 ** into the [xCreate] and [xConnect] methods of the virtual table module
4366 ** when a new virtual table is be being created or reinitialized. 4593 ** when a new virtual table is be being created or reinitialized.
4367 ** 4594 **
4368 ** This interface has exactly the same effect as calling 4595 ** ^The sqlite3_create_module_v2() interface has a fifth parameter which
4369 ** [sqlite3_create_module_v2()] with a NULL client data destructor. 4596 ** is a pointer to a destructor for the pClientData. ^SQLite will
4597 ** invoke the destructor function (if it is not NULL) when SQLite
4598 ** no longer needs the pClientData pointer. ^The sqlite3_create_module()
4599 ** interface is equivalent to sqlite3_create_module_v2() with a NULL
4600 ** destructor.
4370 */ 4601 */
4371 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_create_module( 4602 SQLITE_API int sqlite3_create_module(
4372 sqlite3 *db, /* SQLite connection to register module with */ 4603 sqlite3 *db, /* SQLite connection to register module with */
4373 const char *zName, /* Name of the module */ 4604 const char *zName, /* Name of the module */
4374 const sqlite3_module *p, /* Methods for the module */ 4605 const sqlite3_module *p, /* Methods for the module */
4375 void *pClientData /* Client data for xCreate/xConnect */ 4606 void *pClientData /* Client data for xCreate/xConnect */
4376 ); 4607 );
4377 4608 SQLITE_API int sqlite3_create_module_v2(
4378 /*
4379 ** CAPI3REF: Register A Virtual Table Implementation {H18210} <S20400>
4380 ** EXPERIMENTAL
4381 **
4382 ** This routine is identical to the [sqlite3_create_module()] method,
4383 ** except that it has an extra parameter to specify
4384 ** a destructor function for the client data pointer. SQLite will
4385 ** invoke the destructor function (if it is not NULL) when SQLite
4386 ** no longer needs the pClientData pointer.
4387 */
4388 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_create_module_v2(
4389 sqlite3 *db, /* SQLite connection to register module with */ 4609 sqlite3 *db, /* SQLite connection to register module with */
4390 const char *zName, /* Name of the module */ 4610 const char *zName, /* Name of the module */
4391 const sqlite3_module *p, /* Methods for the module */ 4611 const sqlite3_module *p, /* Methods for the module */
4392 void *pClientData, /* Client data for xCreate/xConnect */ 4612 void *pClientData, /* Client data for xCreate/xConnect */
4393 void(*xDestroy)(void*) /* Module destructor function */ 4613 void(*xDestroy)(void*) /* Module destructor function */
4394 ); 4614 );
4395 4615
4396 /* 4616 /*
4397 ** CAPI3REF: Virtual Table Instance Object {H18010} <S20400> 4617 ** CAPI3REF: Virtual Table Instance Object
4398 ** KEYWORDS: sqlite3_vtab 4618 ** KEYWORDS: sqlite3_vtab
4399 ** EXPERIMENTAL
4400 ** 4619 **
4401 ** Every [virtual table module] implementation uses a subclass 4620 ** Every [virtual table module] implementation uses a subclass
4402 ** of the following structure to describe a particular instance 4621 ** of this object to describe a particular instance
4403 ** of the [virtual table]. Each subclass will 4622 ** of the [virtual table]. Each subclass will
4404 ** be tailored to the specific needs of the module implementation. 4623 ** be tailored to the specific needs of the module implementation.
4405 ** The purpose of this superclass is to define certain fields that are 4624 ** The purpose of this superclass is to define certain fields that are
4406 ** common to all module implementations. 4625 ** common to all module implementations.
4407 ** 4626 **
4408 ** Virtual tables methods can set an error message by assigning a 4627 ** ^Virtual tables methods can set an error message by assigning a
4409 ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should 4628 ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
4410 ** take care that any prior string is freed by a call to [sqlite3_free()] 4629 ** take care that any prior string is freed by a call to [sqlite3_free()]
4411 ** prior to assigning a new string to zErrMsg. After the error message 4630 ** prior to assigning a new string to zErrMsg. ^After the error message
4412 ** is delivered up to the client application, the string will be automatically 4631 ** is delivered up to the client application, the string will be automatically
4413 ** freed by sqlite3_free() and the zErrMsg field will be zeroed. 4632 ** freed by sqlite3_free() and the zErrMsg field will be zeroed.
4414 */ 4633 */
4415 struct sqlite3_vtab { 4634 struct sqlite3_vtab {
4416 const sqlite3_module *pModule; /* The module for this virtual table */ 4635 const sqlite3_module *pModule; /* The module for this virtual table */
4417 int nRef; /* NO LONGER USED */ 4636 int nRef; /* NO LONGER USED */
4418 char *zErrMsg; /* Error message from sqlite3_mprintf() */ 4637 char *zErrMsg; /* Error message from sqlite3_mprintf() */
4419 /* Virtual table implementations will typically add additional fields */ 4638 /* Virtual table implementations will typically add additional fields */
4420 }; 4639 };
4421 4640
4422 /* 4641 /*
4423 ** CAPI3REF: Virtual Table Cursor Object {H18020} <S20400> 4642 ** CAPI3REF: Virtual Table Cursor Object
4424 ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} 4643 ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
4425 ** EXPERIMENTAL
4426 ** 4644 **
4427 ** Every [virtual table module] implementation uses a subclass of the 4645 ** Every [virtual table module] implementation uses a subclass of the
4428 ** following structure to describe cursors that point into the 4646 ** following structure to describe cursors that point into the
4429 ** [virtual table] and are used 4647 ** [virtual table] and are used
4430 ** to loop through the virtual table. Cursors are created using the 4648 ** to loop through the virtual table. Cursors are created using the
4431 ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed 4649 ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
4432 ** by the [sqlite3_module.xClose | xClose] method. Cussors are used 4650 ** by the [sqlite3_module.xClose | xClose] method. Cursors are used
4433 ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods 4651 ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
4434 ** of the module. Each module implementation will define 4652 ** of the module. Each module implementation will define
4435 ** the content of a cursor structure to suit its own needs. 4653 ** the content of a cursor structure to suit its own needs.
4436 ** 4654 **
4437 ** This superclass exists in order to define fields of the cursor that 4655 ** This superclass exists in order to define fields of the cursor that
4438 ** are common to all implementations. 4656 ** are common to all implementations.
4439 */ 4657 */
4440 struct sqlite3_vtab_cursor { 4658 struct sqlite3_vtab_cursor {
4441 sqlite3_vtab *pVtab; /* Virtual table of this cursor */ 4659 sqlite3_vtab *pVtab; /* Virtual table of this cursor */
4442 /* Virtual table implementations will typically add additional fields */ 4660 /* Virtual table implementations will typically add additional fields */
4443 }; 4661 };
4444 4662
4445 /* 4663 /*
4446 ** CAPI3REF: Declare The Schema Of A Virtual Table {H18280} <S20400> 4664 ** CAPI3REF: Declare The Schema Of A Virtual Table
4447 ** EXPERIMENTAL
4448 ** 4665 **
4449 ** The [xCreate] and [xConnect] methods of a 4666 ** ^The [xCreate] and [xConnect] methods of a
4450 ** [virtual table module] call this interface 4667 ** [virtual table module] call this interface
4451 ** to declare the format (the names and datatypes of the columns) of 4668 ** to declare the format (the names and datatypes of the columns) of
4452 ** the virtual tables they implement. 4669 ** the virtual tables they implement.
4453 */ 4670 */
4454 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_declare_vtab(sqlite3*, const char *zS QL); 4671 SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
4455 4672
4456 /* 4673 /*
4457 ** CAPI3REF: Overload A Function For A Virtual Table {H18300} <S20400> 4674 ** CAPI3REF: Overload A Function For A Virtual Table
4458 ** EXPERIMENTAL
4459 ** 4675 **
4460 ** Virtual tables can provide alternative implementations of functions 4676 ** ^(Virtual tables can provide alternative implementations of functions
4461 ** using the [xFindFunction] method of the [virtual table module]. 4677 ** using the [xFindFunction] method of the [virtual table module].
4462 ** But global versions of those functions 4678 ** But global versions of those functions
4463 ** must exist in order to be overloaded. 4679 ** must exist in order to be overloaded.)^
4464 ** 4680 **
4465 ** This API makes sure a global version of a function with a particular 4681 ** ^(This API makes sure a global version of a function with a particular
4466 ** name and number of parameters exists. If no such function exists 4682 ** name and number of parameters exists. If no such function exists
4467 ** before this API is called, a new function is created. The implementation 4683 ** before this API is called, a new function is created.)^ ^The implementation
4468 ** of the new function always causes an exception to be thrown. So 4684 ** of the new function always causes an exception to be thrown. So
4469 ** the new function is not good for anything by itself. Its only 4685 ** the new function is not good for anything by itself. Its only
4470 ** purpose is to be a placeholder function that can be overloaded 4686 ** purpose is to be a placeholder function that can be overloaded
4471 ** by a [virtual table]. 4687 ** by a [virtual table].
4472 */ 4688 */
4473 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_overload_function(sqlite3*, const cha r *zFuncName, int nArg); 4689 SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nA rg);
4690
4691 /* Begin preload-cache.patch for Chromium */
4692 /*
4693 ** Preload the databases into the pager cache, up to the maximum size of the
4694 ** pager cache.
4695 **
4696 ** For a database to be loaded successfully, the pager must be active. That is,
4697 ** there must be an open statement on that database. See sqlite3pager_loadall
4698 **
4699 ** There might be many databases attached to the given connection. We iterate
4700 ** them all and try to load them. If none are loadable successfully, we return
4701 ** an error. Otherwise, we return OK.
4702 */
4703 int sqlite3Preload(sqlite3 *db);
4704 /* End preload-cache.patch for Chromium */
4474 4705
4475 /* 4706 /*
4476 ** The interface to the virtual-table mechanism defined above (back up 4707 ** The interface to the virtual-table mechanism defined above (back up
4477 ** to a comment remarkably similar to this one) is currently considered 4708 ** to a comment remarkably similar to this one) is currently considered
4478 ** to be experimental. The interface might change in incompatible ways. 4709 ** to be experimental. The interface might change in incompatible ways.
4479 ** If this is a problem for you, do not use the interface at this time. 4710 ** If this is a problem for you, do not use the interface at this time.
4480 ** 4711 **
4481 ** When the virtual-table mechanism stabilizes, we will declare the 4712 ** When the virtual-table mechanism stabilizes, we will declare the
4482 ** interface fixed, support it indefinitely, and remove this comment. 4713 ** interface fixed, support it indefinitely, and remove this comment.
4483 **
4484 ****** EXPERIMENTAL - subject to change without notice **************
4485 */ 4714 */
4486 4715
4487 /* 4716 /*
4488 ** CAPI3REF: A Handle To An Open BLOB {H17800} <S30230> 4717 ** CAPI3REF: A Handle To An Open BLOB
4489 ** KEYWORDS: {BLOB handle} {BLOB handles} 4718 ** KEYWORDS: {BLOB handle} {BLOB handles}
4490 ** 4719 **
4491 ** An instance of this object represents an open BLOB on which 4720 ** An instance of this object represents an open BLOB on which
4492 ** [sqlite3_blob_open | incremental BLOB I/O] can be performed. 4721 ** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
4493 ** Objects of this type are created by [sqlite3_blob_open()] 4722 ** ^Objects of this type are created by [sqlite3_blob_open()]
4494 ** and destroyed by [sqlite3_blob_close()]. 4723 ** and destroyed by [sqlite3_blob_close()].
4495 ** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces 4724 ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
4496 ** can be used to read or write small subsections of the BLOB. 4725 ** can be used to read or write small subsections of the BLOB.
4497 ** The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. 4726 ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
4498 */ 4727 */
4499 typedef struct sqlite3_blob sqlite3_blob; 4728 typedef struct sqlite3_blob sqlite3_blob;
4500 4729
4501 /* 4730 /*
4502 ** CAPI3REF: Open A BLOB For Incremental I/O {H17810} <S30230> 4731 ** CAPI3REF: Open A BLOB For Incremental I/O
4503 ** 4732 **
4504 ** This interfaces opens a [BLOB handle | handle] to the BLOB located 4733 ** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
4505 ** in row iRow, column zColumn, table zTable in database zDb; 4734 ** in row iRow, column zColumn, table zTable in database zDb;
4506 ** in other words, the same BLOB that would be selected by: 4735 ** in other words, the same BLOB that would be selected by:
4507 ** 4736 **
4508 ** <pre> 4737 ** <pre>
4509 ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; 4738 ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
4510 ** </pre> {END} 4739 ** </pre>)^
4511 ** 4740 **
4512 ** If the flags parameter is non-zero, then the BLOB is opened for read 4741 ** ^If the flags parameter is non-zero, then the BLOB is opened for read
4513 ** and write access. If it is zero, the BLOB is opened for read access. 4742 ** and write access. ^If it is zero, the BLOB is opened for read access.
4743 ** ^It is not possible to open a column that is part of an index or primary
4744 ** key for writing. ^If [foreign key constraints] are enabled, it is
4745 ** not possible to open a column that is part of a [child key] for writing.
4514 ** 4746 **
4515 ** Note that the database name is not the filename that contains 4747 ** ^Note that the database name is not the filename that contains
4516 ** the database but rather the symbolic name of the database that 4748 ** the database but rather the symbolic name of the database that
4517 ** is assigned when the database is connected using [ATTACH]. 4749 ** appears after the AS keyword when the database is connected using [ATTACH].
4518 ** For the main database file, the database name is "main". 4750 ** ^For the main database file, the database name is "main".
4519 ** For TEMP tables, the database name is "temp". 4751 ** ^For TEMP tables, the database name is "temp".
4520 ** 4752 **
4521 ** On success, [SQLITE_OK] is returned and the new [BLOB handle] is written 4753 ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written
4522 ** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set 4754 ** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set
4523 ** to be a null pointer. 4755 ** to be a null pointer.)^
4524 ** This function sets the [database connection] error code and message 4756 ** ^This function sets the [database connection] error code and message
4525 ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related 4757 ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related
4526 ** functions. Note that the *ppBlob variable is always initialized in a 4758 ** functions. ^Note that the *ppBlob variable is always initialized in a
4527 ** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob 4759 ** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob
4528 ** regardless of the success or failure of this routine. 4760 ** regardless of the success or failure of this routine.
4529 ** 4761 **
4530 ** If the row that a BLOB handle points to is modified by an 4762 ** ^(If the row that a BLOB handle points to is modified by an
4531 ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects 4763 ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
4532 ** then the BLOB handle is marked as "expired". 4764 ** then the BLOB handle is marked as "expired".
4533 ** This is true if any column of the row is changed, even a column 4765 ** This is true if any column of the row is changed, even a column
4534 ** other than the one the BLOB handle is open on. 4766 ** other than the one the BLOB handle is open on.)^
4535 ** Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for 4767 ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
4536 ** a expired BLOB handle fail with an return code of [SQLITE_ABORT]. 4768 ** a expired BLOB handle fail with an return code of [SQLITE_ABORT].
4537 ** Changes written into a BLOB prior to the BLOB expiring are not 4769 ** ^(Changes written into a BLOB prior to the BLOB expiring are not
4538 ** rollback by the expiration of the BLOB. Such changes will eventually 4770 ** rolled back by the expiration of the BLOB. Such changes will eventually
4539 ** commit if the transaction continues to completion. 4771 ** commit if the transaction continues to completion.)^
4540 ** 4772 **
4541 ** Use the [sqlite3_blob_bytes()] interface to determine the size of 4773 ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
4542 ** the opened blob. The size of a blob may not be changed by this 4774 ** the opened blob. ^The size of a blob may not be changed by this
4543 ** interface. Use the [UPDATE] SQL command to change the size of a 4775 ** interface. Use the [UPDATE] SQL command to change the size of a
4544 ** blob. 4776 ** blob.
4545 ** 4777 **
4546 ** The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces 4778 ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
4547 ** and the built-in [zeroblob] SQL function can be used, if desired, 4779 ** and the built-in [zeroblob] SQL function can be used, if desired,
4548 ** to create an empty, zero-filled blob in which to read or write using 4780 ** to create an empty, zero-filled blob in which to read or write using
4549 ** this interface. 4781 ** this interface.
4550 ** 4782 **
4551 ** To avoid a resource leak, every open [BLOB handle] should eventually 4783 ** To avoid a resource leak, every open [BLOB handle] should eventually
4552 ** be released by a call to [sqlite3_blob_close()]. 4784 ** be released by a call to [sqlite3_blob_close()].
4553 **
4554 ** Requirements:
4555 ** [H17813] [H17814] [H17816] [H17819] [H17821] [H17824]
4556 */ 4785 */
4557 SQLITE_API int sqlite3_blob_open( 4786 SQLITE_API int sqlite3_blob_open(
4558 sqlite3*, 4787 sqlite3*,
4559 const char *zDb, 4788 const char *zDb,
4560 const char *zTable, 4789 const char *zTable,
4561 const char *zColumn, 4790 const char *zColumn,
4562 sqlite3_int64 iRow, 4791 sqlite3_int64 iRow,
4563 int flags, 4792 int flags,
4564 sqlite3_blob **ppBlob 4793 sqlite3_blob **ppBlob
4565 ); 4794 );
4566 4795
4567 /* 4796 /*
4568 ** CAPI3REF: Close A BLOB Handle {H17830} <S30230> 4797 ** CAPI3REF: Close A BLOB Handle
4569 ** 4798 **
4570 ** Closes an open [BLOB handle]. 4799 ** ^Closes an open [BLOB handle].
4571 ** 4800 **
4572 ** Closing a BLOB shall cause the current transaction to commit 4801 ** ^Closing a BLOB shall cause the current transaction to commit
4573 ** if there are no other BLOBs, no pending prepared statements, and the 4802 ** if there are no other BLOBs, no pending prepared statements, and the
4574 ** database connection is in [autocommit mode]. 4803 ** database connection is in [autocommit mode].
4575 ** If any writes were made to the BLOB, they might be held in cache 4804 ** ^If any writes were made to the BLOB, they might be held in cache
4576 ** until the close operation if they will fit. 4805 ** until the close operation if they will fit.
4577 ** 4806 **
4578 ** Closing the BLOB often forces the changes 4807 ** ^(Closing the BLOB often forces the changes
4579 ** out to disk and so if any I/O errors occur, they will likely occur 4808 ** out to disk and so if any I/O errors occur, they will likely occur
4580 ** at the time when the BLOB is closed. Any errors that occur during 4809 ** at the time when the BLOB is closed. Any errors that occur during
4581 ** closing are reported as a non-zero return value. 4810 ** closing are reported as a non-zero return value.)^
4582 ** 4811 **
4583 ** The BLOB is closed unconditionally. Even if this routine returns 4812 ** ^(The BLOB is closed unconditionally. Even if this routine returns
4584 ** an error code, the BLOB is still closed. 4813 ** an error code, the BLOB is still closed.)^
4585 ** 4814 **
4586 ** Calling this routine with a null pointer (which as would be returned 4815 ** ^Calling this routine with a null pointer (such as would be returned
4587 ** by failed call to [sqlite3_blob_open()]) is a harmless no-op. 4816 ** by a failed call to [sqlite3_blob_open()]) is a harmless no-op.
4588 **
4589 ** Requirements:
4590 ** [H17833] [H17836] [H17839]
4591 */ 4817 */
4592 SQLITE_API int sqlite3_blob_close(sqlite3_blob *); 4818 SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
4593 4819
4594 /* 4820 /*
4595 ** CAPI3REF: Return The Size Of An Open BLOB {H17840} <S30230> 4821 ** CAPI3REF: Return The Size Of An Open BLOB
4596 ** 4822 **
4597 ** Returns the size in bytes of the BLOB accessible via the 4823 ** ^Returns the size in bytes of the BLOB accessible via the
4598 ** successfully opened [BLOB handle] in its only argument. The 4824 ** successfully opened [BLOB handle] in its only argument. ^The
4599 ** incremental blob I/O routines can only read or overwriting existing 4825 ** incremental blob I/O routines can only read or overwriting existing
4600 ** blob content; they cannot change the size of a blob. 4826 ** blob content; they cannot change the size of a blob.
4601 ** 4827 **
4602 ** This routine only works on a [BLOB handle] which has been created 4828 ** This routine only works on a [BLOB handle] which has been created
4603 ** by a prior successful call to [sqlite3_blob_open()] and which has not 4829 ** by a prior successful call to [sqlite3_blob_open()] and which has not
4604 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in 4830 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4605 ** to this routine results in undefined and probably undesirable behavior. 4831 ** to this routine results in undefined and probably undesirable behavior.
4606 **
4607 ** Requirements:
4608 ** [H17843]
4609 */ 4832 */
4610 SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *); 4833 SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
4611 4834
4612 /* 4835 /*
4613 ** CAPI3REF: Read Data From A BLOB Incrementally {H17850} <S30230> 4836 ** CAPI3REF: Read Data From A BLOB Incrementally
4614 ** 4837 **
4615 ** This function is used to read data from an open [BLOB handle] into a 4838 ** ^(This function is used to read data from an open [BLOB handle] into a
4616 ** caller-supplied buffer. N bytes of data are copied into buffer Z 4839 ** caller-supplied buffer. N bytes of data are copied into buffer Z
4617 ** from the open BLOB, starting at offset iOffset. 4840 ** from the open BLOB, starting at offset iOffset.)^
4618 ** 4841 **
4619 ** If offset iOffset is less than N bytes from the end of the BLOB, 4842 ** ^If offset iOffset is less than N bytes from the end of the BLOB,
4620 ** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is 4843 ** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
4621 ** less than zero, [SQLITE_ERROR] is returned and no data is read. 4844 ** less than zero, [SQLITE_ERROR] is returned and no data is read.
4622 ** The size of the blob (and hence the maximum value of N+iOffset) 4845 ** ^The size of the blob (and hence the maximum value of N+iOffset)
4623 ** can be determined using the [sqlite3_blob_bytes()] interface. 4846 ** can be determined using the [sqlite3_blob_bytes()] interface.
4624 ** 4847 **
4625 ** An attempt to read from an expired [BLOB handle] fails with an 4848 ** ^An attempt to read from an expired [BLOB handle] fails with an
4626 ** error code of [SQLITE_ABORT]. 4849 ** error code of [SQLITE_ABORT].
4627 ** 4850 **
4628 ** On success, SQLITE_OK is returned. 4851 ** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
4629 ** Otherwise, an [error code] or an [extended error code] is returned. 4852 ** Otherwise, an [error code] or an [extended error code] is returned.)^
4630 ** 4853 **
4631 ** This routine only works on a [BLOB handle] which has been created 4854 ** This routine only works on a [BLOB handle] which has been created
4632 ** by a prior successful call to [sqlite3_blob_open()] and which has not 4855 ** by a prior successful call to [sqlite3_blob_open()] and which has not
4633 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in 4856 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4634 ** to this routine results in undefined and probably undesirable behavior. 4857 ** to this routine results in undefined and probably undesirable behavior.
4635 ** 4858 **
4636 ** See also: [sqlite3_blob_write()]. 4859 ** See also: [sqlite3_blob_write()].
4637 **
4638 ** Requirements:
4639 ** [H17853] [H17856] [H17859] [H17862] [H17863] [H17865] [H17868]
4640 */ 4860 */
4641 SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); 4861 SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
4642 4862
4643 /* 4863 /*
4644 ** CAPI3REF: Write Data Into A BLOB Incrementally {H17870} <S30230> 4864 ** CAPI3REF: Write Data Into A BLOB Incrementally
4645 ** 4865 **
4646 ** This function is used to write data into an open [BLOB handle] from a 4866 ** ^This function is used to write data into an open [BLOB handle] from a
4647 ** caller-supplied buffer. N bytes of data are copied from the buffer Z 4867 ** caller-supplied buffer. ^N bytes of data are copied from the buffer Z
4648 ** into the open BLOB, starting at offset iOffset. 4868 ** into the open BLOB, starting at offset iOffset.
4649 ** 4869 **
4650 ** If the [BLOB handle] passed as the first argument was not opened for 4870 ** ^If the [BLOB handle] passed as the first argument was not opened for
4651 ** writing (the flags parameter to [sqlite3_blob_open()] was zero), 4871 ** writing (the flags parameter to [sqlite3_blob_open()] was zero),
4652 ** this function returns [SQLITE_READONLY]. 4872 ** this function returns [SQLITE_READONLY].
4653 ** 4873 **
4654 ** This function may only modify the contents of the BLOB; it is 4874 ** ^This function may only modify the contents of the BLOB; it is
4655 ** not possible to increase the size of a BLOB using this API. 4875 ** not possible to increase the size of a BLOB using this API.
4656 ** If offset iOffset is less than N bytes from the end of the BLOB, 4876 ** ^If offset iOffset is less than N bytes from the end of the BLOB,
4657 ** [SQLITE_ERROR] is returned and no data is written. If N is 4877 ** [SQLITE_ERROR] is returned and no data is written. ^If N is
4658 ** less than zero [SQLITE_ERROR] is returned and no data is written. 4878 ** less than zero [SQLITE_ERROR] is returned and no data is written.
4659 ** The size of the BLOB (and hence the maximum value of N+iOffset) 4879 ** The size of the BLOB (and hence the maximum value of N+iOffset)
4660 ** can be determined using the [sqlite3_blob_bytes()] interface. 4880 ** can be determined using the [sqlite3_blob_bytes()] interface.
4661 ** 4881 **
4662 ** An attempt to write to an expired [BLOB handle] fails with an 4882 ** ^An attempt to write to an expired [BLOB handle] fails with an
4663 ** error code of [SQLITE_ABORT]. Writes to the BLOB that occurred 4883 ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
4664 ** before the [BLOB handle] expired are not rolled back by the 4884 ** before the [BLOB handle] expired are not rolled back by the
4665 ** expiration of the handle, though of course those changes might 4885 ** expiration of the handle, though of course those changes might
4666 ** have been overwritten by the statement that expired the BLOB handle 4886 ** have been overwritten by the statement that expired the BLOB handle
4667 ** or by other independent statements. 4887 ** or by other independent statements.
4668 ** 4888 **
4669 ** On success, SQLITE_OK is returned. 4889 ** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
4670 ** Otherwise, an [error code] or an [extended error code] is returned. 4890 ** Otherwise, an [error code] or an [extended error code] is returned.)^
4671 ** 4891 **
4672 ** This routine only works on a [BLOB handle] which has been created 4892 ** This routine only works on a [BLOB handle] which has been created
4673 ** by a prior successful call to [sqlite3_blob_open()] and which has not 4893 ** by a prior successful call to [sqlite3_blob_open()] and which has not
4674 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in 4894 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4675 ** to this routine results in undefined and probably undesirable behavior. 4895 ** to this routine results in undefined and probably undesirable behavior.
4676 ** 4896 **
4677 ** See also: [sqlite3_blob_read()]. 4897 ** See also: [sqlite3_blob_read()].
4678 **
4679 ** Requirements:
4680 ** [H17873] [H17874] [H17875] [H17876] [H17877] [H17879] [H17882] [H17885]
4681 ** [H17888]
4682 */ 4898 */
4683 SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOff set); 4899 SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOff set);
4684 4900
4685 /* Begin preload-cache.patch for Chromium */
4686 /* 4901 /*
4687 ** Preload the databases into the pager cache, up to the maximum size of the 4902 ** CAPI3REF: Virtual File System Objects
4688 ** pager cache.
4689 **
4690 ** For a database to be loaded successfully, the pager must be active. That is,
4691 ** there must be an open statement on that database. See sqlite3pager_loadall
4692 **
4693 ** There might be many databases attached to the given connection. We iterate
4694 ** them all and try to load them. If none are loadable successfully, we return
4695 ** an error. Otherwise, we return OK.
4696 */
4697 int sqlite3Preload(sqlite3 *db);
4698 /* End preload-cache.patch for Chromium */
4699
4700 /*
4701 ** CAPI3REF: Virtual File System Objects {H11200} <S20100>
4702 ** 4903 **
4703 ** A virtual filesystem (VFS) is an [sqlite3_vfs] object 4904 ** A virtual filesystem (VFS) is an [sqlite3_vfs] object
4704 ** that SQLite uses to interact 4905 ** that SQLite uses to interact
4705 ** with the underlying operating system. Most SQLite builds come with a 4906 ** with the underlying operating system. Most SQLite builds come with a
4706 ** single default VFS that is appropriate for the host computer. 4907 ** single default VFS that is appropriate for the host computer.
4707 ** New VFSes can be registered and existing VFSes can be unregistered. 4908 ** New VFSes can be registered and existing VFSes can be unregistered.
4708 ** The following interfaces are provided. 4909 ** The following interfaces are provided.
4709 ** 4910 **
4710 ** The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. 4911 ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
4711 ** Names are case sensitive. 4912 ** ^Names are case sensitive.
4712 ** Names are zero-terminated UTF-8 strings. 4913 ** ^Names are zero-terminated UTF-8 strings.
4713 ** If there is no match, a NULL pointer is returned. 4914 ** ^If there is no match, a NULL pointer is returned.
4714 ** If zVfsName is NULL then the default VFS is returned. 4915 ** ^If zVfsName is NULL then the default VFS is returned.
4715 ** 4916 **
4716 ** New VFSes are registered with sqlite3_vfs_register(). 4917 ** ^New VFSes are registered with sqlite3_vfs_register().
4717 ** Each new VFS becomes the default VFS if the makeDflt flag is set. 4918 ** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
4718 ** The same VFS can be registered multiple times without injury. 4919 ** ^The same VFS can be registered multiple times without injury.
4719 ** To make an existing VFS into the default VFS, register it again 4920 ** ^To make an existing VFS into the default VFS, register it again
4720 ** with the makeDflt flag set. If two different VFSes with the 4921 ** with the makeDflt flag set. If two different VFSes with the
4721 ** same name are registered, the behavior is undefined. If a 4922 ** same name are registered, the behavior is undefined. If a
4722 ** VFS is registered with a name that is NULL or an empty string, 4923 ** VFS is registered with a name that is NULL or an empty string,
4723 ** then the behavior is undefined. 4924 ** then the behavior is undefined.
4724 ** 4925 **
4725 ** Unregister a VFS with the sqlite3_vfs_unregister() interface. 4926 ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
4726 ** If the default VFS is unregistered, another VFS is chosen as 4927 ** ^(If the default VFS is unregistered, another VFS is chosen as
4727 ** the default. The choice for the new VFS is arbitrary. 4928 ** the default. The choice for the new VFS is arbitrary.)^
4728 **
4729 ** Requirements:
4730 ** [H11203] [H11206] [H11209] [H11212] [H11215] [H11218]
4731 */ 4929 */
4732 SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); 4930 SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
4733 SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); 4931 SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
4734 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); 4932 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
4735 4933
4736 /* 4934 /*
4737 ** CAPI3REF: Mutexes {H17000} <S20000> 4935 ** CAPI3REF: Mutexes
4738 ** 4936 **
4739 ** The SQLite core uses these routines for thread 4937 ** The SQLite core uses these routines for thread
4740 ** synchronization. Though they are intended for internal 4938 ** synchronization. Though they are intended for internal
4741 ** use by SQLite, code that links against SQLite is 4939 ** use by SQLite, code that links against SQLite is
4742 ** permitted to use any of these routines. 4940 ** permitted to use any of these routines.
4743 ** 4941 **
4744 ** The SQLite source code contains multiple implementations 4942 ** The SQLite source code contains multiple implementations
4745 ** of these mutex routines. An appropriate implementation 4943 ** of these mutex routines. An appropriate implementation
4746 ** is selected automatically at compile-time. The following 4944 ** is selected automatically at compile-time. ^(The following
4747 ** implementations are available in the SQLite core: 4945 ** implementations are available in the SQLite core:
4748 ** 4946 **
4749 ** <ul> 4947 ** <ul>
4750 ** <li> SQLITE_MUTEX_OS2 4948 ** <li> SQLITE_MUTEX_OS2
4751 ** <li> SQLITE_MUTEX_PTHREAD 4949 ** <li> SQLITE_MUTEX_PTHREAD
4752 ** <li> SQLITE_MUTEX_W32 4950 ** <li> SQLITE_MUTEX_W32
4753 ** <li> SQLITE_MUTEX_NOOP 4951 ** <li> SQLITE_MUTEX_NOOP
4754 ** </ul> 4952 ** </ul>)^
4755 ** 4953 **
4756 ** The SQLITE_MUTEX_NOOP implementation is a set of routines 4954 ** ^The SQLITE_MUTEX_NOOP implementation is a set of routines
4757 ** that does no real locking and is appropriate for use in 4955 ** that does no real locking and is appropriate for use in
4758 ** a single-threaded application. The SQLITE_MUTEX_OS2, 4956 ** a single-threaded application. ^The SQLITE_MUTEX_OS2,
4759 ** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations 4957 ** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations
4760 ** are appropriate for use on OS/2, Unix, and Windows. 4958 ** are appropriate for use on OS/2, Unix, and Windows.
4761 ** 4959 **
4762 ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor 4960 ** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
4763 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex 4961 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
4764 ** implementation is included with the library. In this case the 4962 ** implementation is included with the library. In this case the
4765 ** application must supply a custom mutex implementation using the 4963 ** application must supply a custom mutex implementation using the
4766 ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function 4964 ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
4767 ** before calling sqlite3_initialize() or any other public sqlite3_ 4965 ** before calling sqlite3_initialize() or any other public sqlite3_
4768 ** function that calls sqlite3_initialize(). 4966 ** function that calls sqlite3_initialize().)^
4769 ** 4967 **
4770 ** {H17011} The sqlite3_mutex_alloc() routine allocates a new 4968 ** ^The sqlite3_mutex_alloc() routine allocates a new
4771 ** mutex and returns a pointer to it. {H17012} If it returns NULL 4969 ** mutex and returns a pointer to it. ^If it returns NULL
4772 ** that means that a mutex could not be allocated. {H17013} SQLite 4970 ** that means that a mutex could not be allocated. ^SQLite
4773 ** will unwind its stack and return an error. {H17014} The argument 4971 ** will unwind its stack and return an error. ^(The argument
4774 ** to sqlite3_mutex_alloc() is one of these integer constants: 4972 ** to sqlite3_mutex_alloc() is one of these integer constants:
4775 ** 4973 **
4776 ** <ul> 4974 ** <ul>
4777 ** <li> SQLITE_MUTEX_FAST 4975 ** <li> SQLITE_MUTEX_FAST
4778 ** <li> SQLITE_MUTEX_RECURSIVE 4976 ** <li> SQLITE_MUTEX_RECURSIVE
4779 ** <li> SQLITE_MUTEX_STATIC_MASTER 4977 ** <li> SQLITE_MUTEX_STATIC_MASTER
4780 ** <li> SQLITE_MUTEX_STATIC_MEM 4978 ** <li> SQLITE_MUTEX_STATIC_MEM
4781 ** <li> SQLITE_MUTEX_STATIC_MEM2 4979 ** <li> SQLITE_MUTEX_STATIC_MEM2
4782 ** <li> SQLITE_MUTEX_STATIC_PRNG 4980 ** <li> SQLITE_MUTEX_STATIC_PRNG
4783 ** <li> SQLITE_MUTEX_STATIC_LRU 4981 ** <li> SQLITE_MUTEX_STATIC_LRU
4784 ** <li> SQLITE_MUTEX_STATIC_LRU2 4982 ** <li> SQLITE_MUTEX_STATIC_LRU2
4785 ** </ul> 4983 ** </ul>)^
4786 ** 4984 **
4787 ** {H17015} The first two constants cause sqlite3_mutex_alloc() to create 4985 ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
4788 ** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE 4986 ** cause sqlite3_mutex_alloc() to create
4789 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END} 4987 ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
4988 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
4790 ** The mutex implementation does not need to make a distinction 4989 ** The mutex implementation does not need to make a distinction
4791 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does 4990 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
4792 ** not want to. {H17016} But SQLite will only request a recursive mutex in 4991 ** not want to. ^SQLite will only request a recursive mutex in
4793 ** cases where it really needs one. {END} If a faster non-recursive mutex 4992 ** cases where it really needs one. ^If a faster non-recursive mutex
4794 ** implementation is available on the host platform, the mutex subsystem 4993 ** implementation is available on the host platform, the mutex subsystem
4795 ** might return such a mutex in response to SQLITE_MUTEX_FAST. 4994 ** might return such a mutex in response to SQLITE_MUTEX_FAST.
4796 ** 4995 **
4797 ** {H17017} The other allowed parameters to sqlite3_mutex_alloc() each return 4996 ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
4798 ** a pointer to a static preexisting mutex. {END} Six static mutexes are 4997 ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
4998 ** a pointer to a static preexisting mutex. ^Six static mutexes are
4799 ** used by the current version of SQLite. Future versions of SQLite 4999 ** used by the current version of SQLite. Future versions of SQLite
4800 ** may add additional static mutexes. Static mutexes are for internal 5000 ** may add additional static mutexes. Static mutexes are for internal
4801 ** use by SQLite only. Applications that use SQLite mutexes should 5001 ** use by SQLite only. Applications that use SQLite mutexes should
4802 ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or 5002 ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
4803 ** SQLITE_MUTEX_RECURSIVE. 5003 ** SQLITE_MUTEX_RECURSIVE.
4804 ** 5004 **
4805 ** {H17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST 5005 ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
4806 ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() 5006 ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
4807 ** returns a different mutex on every call. {H17034} But for the static 5007 ** returns a different mutex on every call. ^But for the static
4808 ** mutex types, the same mutex is returned on every call that has 5008 ** mutex types, the same mutex is returned on every call that has
4809 ** the same type number. 5009 ** the same type number.
4810 ** 5010 **
4811 ** {H17019} The sqlite3_mutex_free() routine deallocates a previously 5011 ** ^The sqlite3_mutex_free() routine deallocates a previously
4812 ** allocated dynamic mutex. {H17020} SQLite is careful to deallocate every 5012 ** allocated dynamic mutex. ^SQLite is careful to deallocate every
4813 ** dynamic mutex that it allocates. {A17021} The dynamic mutexes must not be in 5013 ** dynamic mutex that it allocates. The dynamic mutexes must not be in
4814 ** use when they are deallocated. {A17022} Attempting to deallocate a static 5014 ** use when they are deallocated. Attempting to deallocate a static
4815 ** mutex results in undefined behavior. {H17023} SQLite never deallocates 5015 ** mutex results in undefined behavior. ^SQLite never deallocates
4816 ** a static mutex. {END} 5016 ** a static mutex.
4817 ** 5017 **
4818 ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt 5018 ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
4819 ** to enter a mutex. {H17024} If another thread is already within the mutex, 5019 ** to enter a mutex. ^If another thread is already within the mutex,
4820 ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return 5020 ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
4821 ** SQLITE_BUSY. {H17025} The sqlite3_mutex_try() interface returns [SQLITE_OK] 5021 ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
4822 ** upon successful entry. {H17026} Mutexes created using 5022 ** upon successful entry. ^(Mutexes created using
4823 ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. 5023 ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
4824 ** {H17027} In such cases the, 5024 ** In such cases the,
4825 ** mutex must be exited an equal number of times before another thread 5025 ** mutex must be exited an equal number of times before another thread
4826 ** can enter. {A17028} If the same thread tries to enter any other 5026 ** can enter.)^ ^(If the same thread tries to enter any other
4827 ** kind of mutex more than once, the behavior is undefined. 5027 ** kind of mutex more than once, the behavior is undefined.
4828 ** {H17029} SQLite will never exhibit 5028 ** SQLite will never exhibit
4829 ** such behavior in its own use of mutexes. 5029 ** such behavior in its own use of mutexes.)^
4830 ** 5030 **
4831 ** Some systems (for example, Windows 95) do not support the operation 5031 ** ^(Some systems (for example, Windows 95) do not support the operation
4832 ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() 5032 ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
4833 ** will always return SQLITE_BUSY. {H17030} The SQLite core only ever uses 5033 ** will always return SQLITE_BUSY. The SQLite core only ever uses
4834 ** sqlite3_mutex_try() as an optimization so this is acceptable behavior. 5034 ** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^
4835 ** 5035 **
4836 ** {H17031} The sqlite3_mutex_leave() routine exits a mutex that was 5036 ** ^The sqlite3_mutex_leave() routine exits a mutex that was
4837 ** previously entered by the same thread. {A17032} The behavior 5037 ** previously entered by the same thread. ^(The behavior
4838 ** is undefined if the mutex is not currently entered by the 5038 ** is undefined if the mutex is not currently entered by the
4839 ** calling thread or is not currently allocated. {H17033} SQLite will 5039 ** calling thread or is not currently allocated. SQLite will
4840 ** never do either. {END} 5040 ** never do either.)^
4841 ** 5041 **
4842 ** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or 5042 ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
4843 ** sqlite3_mutex_leave() is a NULL pointer, then all three routines 5043 ** sqlite3_mutex_leave() is a NULL pointer, then all three routines
4844 ** behave as no-ops. 5044 ** behave as no-ops.
4845 ** 5045 **
4846 ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. 5046 ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
4847 */ 5047 */
4848 SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int); 5048 SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
4849 SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*); 5049 SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
4850 SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*); 5050 SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
4851 SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*); 5051 SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
4852 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*); 5052 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
4853 5053
4854 /* 5054 /*
4855 ** CAPI3REF: Mutex Methods Object {H17120} <S20130> 5055 ** CAPI3REF: Mutex Methods Object
4856 ** EXPERIMENTAL
4857 ** 5056 **
4858 ** An instance of this structure defines the low-level routines 5057 ** An instance of this structure defines the low-level routines
4859 ** used to allocate and use mutexes. 5058 ** used to allocate and use mutexes.
4860 ** 5059 **
4861 ** Usually, the default mutex implementations provided by SQLite are 5060 ** Usually, the default mutex implementations provided by SQLite are
4862 ** sufficient, however the user has the option of substituting a custom 5061 ** sufficient, however the user has the option of substituting a custom
4863 ** implementation for specialized deployments or systems for which SQLite 5062 ** implementation for specialized deployments or systems for which SQLite
4864 ** does not provide a suitable implementation. In this case, the user 5063 ** does not provide a suitable implementation. In this case, the user
4865 ** creates and populates an instance of this structure to pass 5064 ** creates and populates an instance of this structure to pass
4866 ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. 5065 ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
4867 ** Additionally, an instance of this structure can be used as an 5066 ** Additionally, an instance of this structure can be used as an
4868 ** output variable when querying the system for the current mutex 5067 ** output variable when querying the system for the current mutex
4869 ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. 5068 ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
4870 ** 5069 **
4871 ** The xMutexInit method defined by this structure is invoked as 5070 ** ^The xMutexInit method defined by this structure is invoked as
4872 ** part of system initialization by the sqlite3_initialize() function. 5071 ** part of system initialization by the sqlite3_initialize() function.
4873 ** {H17001} The xMutexInit routine shall be called by SQLite once for each 5072 ** ^The xMutexInit routine is called by SQLite exactly once for each
4874 ** effective call to [sqlite3_initialize()]. 5073 ** effective call to [sqlite3_initialize()].
4875 ** 5074 **
4876 ** The xMutexEnd method defined by this structure is invoked as 5075 ** ^The xMutexEnd method defined by this structure is invoked as
4877 ** part of system shutdown by the sqlite3_shutdown() function. The 5076 ** part of system shutdown by the sqlite3_shutdown() function. The
4878 ** implementation of this method is expected to release all outstanding 5077 ** implementation of this method is expected to release all outstanding
4879 ** resources obtained by the mutex methods implementation, especially 5078 ** resources obtained by the mutex methods implementation, especially
4880 ** those obtained by the xMutexInit method. {H17003} The xMutexEnd() 5079 ** those obtained by the xMutexInit method. ^The xMutexEnd()
4881 ** interface shall be invoked once for each call to [sqlite3_shutdown()]. 5080 ** interface is invoked exactly once for each call to [sqlite3_shutdown()].
4882 ** 5081 **
4883 ** The remaining seven methods defined by this structure (xMutexAlloc, 5082 ** ^(The remaining seven methods defined by this structure (xMutexAlloc,
4884 ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and 5083 ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
4885 ** xMutexNotheld) implement the following interfaces (respectively): 5084 ** xMutexNotheld) implement the following interfaces (respectively):
4886 ** 5085 **
4887 ** <ul> 5086 ** <ul>
4888 ** <li> [sqlite3_mutex_alloc()] </li> 5087 ** <li> [sqlite3_mutex_alloc()] </li>
4889 ** <li> [sqlite3_mutex_free()] </li> 5088 ** <li> [sqlite3_mutex_free()] </li>
4890 ** <li> [sqlite3_mutex_enter()] </li> 5089 ** <li> [sqlite3_mutex_enter()] </li>
4891 ** <li> [sqlite3_mutex_try()] </li> 5090 ** <li> [sqlite3_mutex_try()] </li>
4892 ** <li> [sqlite3_mutex_leave()] </li> 5091 ** <li> [sqlite3_mutex_leave()] </li>
4893 ** <li> [sqlite3_mutex_held()] </li> 5092 ** <li> [sqlite3_mutex_held()] </li>
4894 ** <li> [sqlite3_mutex_notheld()] </li> 5093 ** <li> [sqlite3_mutex_notheld()] </li>
4895 ** </ul> 5094 ** </ul>)^
4896 ** 5095 **
4897 ** The only difference is that the public sqlite3_XXX functions enumerated 5096 ** The only difference is that the public sqlite3_XXX functions enumerated
4898 ** above silently ignore any invocations that pass a NULL pointer instead 5097 ** above silently ignore any invocations that pass a NULL pointer instead
4899 ** of a valid mutex handle. The implementations of the methods defined 5098 ** of a valid mutex handle. The implementations of the methods defined
4900 ** by this structure are not required to handle this case, the results 5099 ** by this structure are not required to handle this case, the results
4901 ** of passing a NULL pointer instead of a valid mutex handle are undefined 5100 ** of passing a NULL pointer instead of a valid mutex handle are undefined
4902 ** (i.e. it is acceptable to provide an implementation that segfaults if 5101 ** (i.e. it is acceptable to provide an implementation that segfaults if
4903 ** it is passed a NULL pointer). 5102 ** it is passed a NULL pointer).
4904 ** 5103 **
4905 ** The xMutexInit() method must be threadsafe. It must be harmless to 5104 ** The xMutexInit() method must be threadsafe. ^It must be harmless to
4906 ** invoke xMutexInit() mutiple times within the same process and without 5105 ** invoke xMutexInit() multiple times within the same process and without
4907 ** intervening calls to xMutexEnd(). Second and subsequent calls to 5106 ** intervening calls to xMutexEnd(). Second and subsequent calls to
4908 ** xMutexInit() must be no-ops. 5107 ** xMutexInit() must be no-ops.
4909 ** 5108 **
4910 ** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] 5109 ** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
4911 ** and its associates). Similarly, xMutexAlloc() must not use SQLite memory 5110 ** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory
4912 ** allocation for a static mutex. However xMutexAlloc() may use SQLite 5111 ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
4913 ** memory allocation for a fast or recursive mutex. 5112 ** memory allocation for a fast or recursive mutex.
4914 ** 5113 **
4915 ** SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is 5114 ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
4916 ** called, but only if the prior call to xMutexInit returned SQLITE_OK. 5115 ** called, but only if the prior call to xMutexInit returned SQLITE_OK.
4917 ** If xMutexInit fails in any way, it is expected to clean up after itself 5116 ** If xMutexInit fails in any way, it is expected to clean up after itself
4918 ** prior to returning. 5117 ** prior to returning.
4919 */ 5118 */
4920 typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; 5119 typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
4921 struct sqlite3_mutex_methods { 5120 struct sqlite3_mutex_methods {
4922 int (*xMutexInit)(void); 5121 int (*xMutexInit)(void);
4923 int (*xMutexEnd)(void); 5122 int (*xMutexEnd)(void);
4924 sqlite3_mutex *(*xMutexAlloc)(int); 5123 sqlite3_mutex *(*xMutexAlloc)(int);
4925 void (*xMutexFree)(sqlite3_mutex *); 5124 void (*xMutexFree)(sqlite3_mutex *);
4926 void (*xMutexEnter)(sqlite3_mutex *); 5125 void (*xMutexEnter)(sqlite3_mutex *);
4927 int (*xMutexTry)(sqlite3_mutex *); 5126 int (*xMutexTry)(sqlite3_mutex *);
4928 void (*xMutexLeave)(sqlite3_mutex *); 5127 void (*xMutexLeave)(sqlite3_mutex *);
4929 int (*xMutexHeld)(sqlite3_mutex *); 5128 int (*xMutexHeld)(sqlite3_mutex *);
4930 int (*xMutexNotheld)(sqlite3_mutex *); 5129 int (*xMutexNotheld)(sqlite3_mutex *);
4931 }; 5130 };
4932 5131
4933 /* 5132 /*
4934 ** CAPI3REF: Mutex Verification Routines {H17080} <S20130> <S30800> 5133 ** CAPI3REF: Mutex Verification Routines
4935 ** 5134 **
4936 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines 5135 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
4937 ** are intended for use inside assert() statements. {H17081} The SQLite core 5136 ** are intended for use inside assert() statements. ^The SQLite core
4938 ** never uses these routines except inside an assert() and applications 5137 ** never uses these routines except inside an assert() and applications
4939 ** are advised to follow the lead of the core. {H17082} The core only 5138 ** are advised to follow the lead of the core. ^The SQLite core only
4940 ** provides implementations for these routines when it is compiled 5139 ** provides implementations for these routines when it is compiled
4941 ** with the SQLITE_DEBUG flag. {A17087} External mutex implementations 5140 ** with the SQLITE_DEBUG flag. ^External mutex implementations
4942 ** are only required to provide these routines if SQLITE_DEBUG is 5141 ** are only required to provide these routines if SQLITE_DEBUG is
4943 ** defined and if NDEBUG is not defined. 5142 ** defined and if NDEBUG is not defined.
4944 ** 5143 **
4945 ** {H17083} These routines should return true if the mutex in their argument 5144 ** ^These routines should return true if the mutex in their argument
4946 ** is held or not held, respectively, by the calling thread. 5145 ** is held or not held, respectively, by the calling thread.
4947 ** 5146 **
4948 ** {X17084} The implementation is not required to provided versions of these 5147 ** ^The implementation is not required to provided versions of these
4949 ** routines that actually work. If the implementation does not provide working 5148 ** routines that actually work. If the implementation does not provide working
4950 ** versions of these routines, it should at least provide stubs that always 5149 ** versions of these routines, it should at least provide stubs that always
4951 ** return true so that one does not get spurious assertion failures. 5150 ** return true so that one does not get spurious assertion failures.
4952 ** 5151 **
4953 ** {H17085} If the argument to sqlite3_mutex_held() is a NULL pointer then 5152 ** ^If the argument to sqlite3_mutex_held() is a NULL pointer then
4954 ** the routine should return 1. {END} This seems counter-intuitive since 5153 ** the routine should return 1. This seems counter-intuitive since
4955 ** clearly the mutex cannot be held if it does not exist. But the 5154 ** clearly the mutex cannot be held if it does not exist. But the
4956 ** the reason the mutex does not exist is because the build is not 5155 ** the reason the mutex does not exist is because the build is not
4957 ** using mutexes. And we do not want the assert() containing the 5156 ** using mutexes. And we do not want the assert() containing the
4958 ** call to sqlite3_mutex_held() to fail, so a non-zero return is 5157 ** call to sqlite3_mutex_held() to fail, so a non-zero return is
4959 ** the appropriate thing to do. {H17086} The sqlite3_mutex_notheld() 5158 ** the appropriate thing to do. ^The sqlite3_mutex_notheld()
4960 ** interface should also return 1 when given a NULL pointer. 5159 ** interface should also return 1 when given a NULL pointer.
4961 */ 5160 */
5161 #ifndef NDEBUG
4962 SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*); 5162 SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
4963 SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*); 5163 SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
5164 #endif
4964 5165
4965 /* 5166 /*
4966 ** CAPI3REF: Mutex Types {H17001} <H17000> 5167 ** CAPI3REF: Mutex Types
4967 ** 5168 **
4968 ** The [sqlite3_mutex_alloc()] interface takes a single argument 5169 ** The [sqlite3_mutex_alloc()] interface takes a single argument
4969 ** which is one of these integer constants. 5170 ** which is one of these integer constants.
4970 ** 5171 **
4971 ** The set of static mutexes may change from one SQLite release to the 5172 ** The set of static mutexes may change from one SQLite release to the
4972 ** next. Applications that override the built-in mutex logic must be 5173 ** next. Applications that override the built-in mutex logic must be
4973 ** prepared to accommodate additional static mutexes. 5174 ** prepared to accommodate additional static mutexes.
4974 */ 5175 */
4975 #define SQLITE_MUTEX_FAST 0 5176 #define SQLITE_MUTEX_FAST 0
4976 #define SQLITE_MUTEX_RECURSIVE 1 5177 #define SQLITE_MUTEX_RECURSIVE 1
4977 #define SQLITE_MUTEX_STATIC_MASTER 2 5178 #define SQLITE_MUTEX_STATIC_MASTER 2
4978 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ 5179 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
4979 #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ 5180 #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
4980 #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ 5181 #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
4981 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ 5182 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
4982 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ 5183 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
4983 #define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */ 5184 #define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */
4984 5185
4985 /* 5186 /*
4986 ** CAPI3REF: Retrieve the mutex for a database connection {H17002} <H17000> 5187 ** CAPI3REF: Retrieve the mutex for a database connection
4987 ** 5188 **
4988 ** This interface returns a pointer the [sqlite3_mutex] object that 5189 ** ^This interface returns a pointer the [sqlite3_mutex] object that
4989 ** serializes access to the [database connection] given in the argument 5190 ** serializes access to the [database connection] given in the argument
4990 ** when the [threading mode] is Serialized. 5191 ** when the [threading mode] is Serialized.
4991 ** If the [threading mode] is Single-thread or Multi-thread then this 5192 ** ^If the [threading mode] is Single-thread or Multi-thread then this
4992 ** routine returns a NULL pointer. 5193 ** routine returns a NULL pointer.
4993 */ 5194 */
4994 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*); 5195 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
4995 5196
4996 /* 5197 /*
4997 ** CAPI3REF: Low-Level Control Of Database Files {H11300} <S30800> 5198 ** CAPI3REF: Low-Level Control Of Database Files
4998 ** 5199 **
4999 ** {H11301} The [sqlite3_file_control()] interface makes a direct call to the 5200 ** ^The [sqlite3_file_control()] interface makes a direct call to the
5000 ** xFileControl method for the [sqlite3_io_methods] object associated 5201 ** xFileControl method for the [sqlite3_io_methods] object associated
5001 ** with a particular database identified by the second argument. {H11302} The 5202 ** with a particular database identified by the second argument. ^The
5002 ** name of the database is the name assigned to the database by the 5203 ** name of the database "main" for the main database or "temp" for the
5003 ** <a href="lang_attach.html">ATTACH</a> SQL command that opened the 5204 ** TEMP database, or the name that appears after the AS keyword for
5004 ** database. {H11303} To control the main database file, use the name "main" 5205 ** databases that are added using the [ATTACH] SQL command.
5005 ** or a NULL pointer. {H11304} The third and fourth parameters to this routine 5206 ** ^A NULL pointer can be used in place of "main" to refer to the
5207 ** main database file.
5208 ** ^The third and fourth parameters to this routine
5006 ** are passed directly through to the second and third parameters of 5209 ** are passed directly through to the second and third parameters of
5007 ** the xFileControl method. {H11305} The return value of the xFileControl 5210 ** the xFileControl method. ^The return value of the xFileControl
5008 ** method becomes the return value of this routine. 5211 ** method becomes the return value of this routine.
5009 ** 5212 **
5010 ** {H11306} If the second parameter (zDbName) does not match the name of any 5213 ** ^If the second parameter (zDbName) does not match the name of any
5011 ** open database file, then SQLITE_ERROR is returned. {H11307} This error 5214 ** open database file, then SQLITE_ERROR is returned. ^This error
5012 ** code is not remembered and will not be recalled by [sqlite3_errcode()] 5215 ** code is not remembered and will not be recalled by [sqlite3_errcode()]
5013 ** or [sqlite3_errmsg()]. {A11308} The underlying xFileControl method might 5216 ** or [sqlite3_errmsg()]. The underlying xFileControl method might
5014 ** also return SQLITE_ERROR. {A11309} There is no way to distinguish between 5217 ** also return SQLITE_ERROR. There is no way to distinguish between
5015 ** an incorrect zDbName and an SQLITE_ERROR return from the underlying 5218 ** an incorrect zDbName and an SQLITE_ERROR return from the underlying
5016 ** xFileControl method. {END} 5219 ** xFileControl method.
5017 ** 5220 **
5018 ** See also: [SQLITE_FCNTL_LOCKSTATE] 5221 ** See also: [SQLITE_FCNTL_LOCKSTATE]
5019 */ 5222 */
5020 SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void* ); 5223 SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void* );
5021 5224
5022 /* 5225 /*
5023 ** CAPI3REF: Testing Interface {H11400} <S30800> 5226 ** CAPI3REF: Testing Interface
5024 ** 5227 **
5025 ** The sqlite3_test_control() interface is used to read out internal 5228 ** ^The sqlite3_test_control() interface is used to read out internal
5026 ** state of SQLite and to inject faults into SQLite for testing 5229 ** state of SQLite and to inject faults into SQLite for testing
5027 ** purposes. The first parameter is an operation code that determines 5230 ** purposes. ^The first parameter is an operation code that determines
5028 ** the number, meaning, and operation of all subsequent parameters. 5231 ** the number, meaning, and operation of all subsequent parameters.
5029 ** 5232 **
5030 ** This interface is not for use by applications. It exists solely 5233 ** This interface is not for use by applications. It exists solely
5031 ** for verifying the correct operation of the SQLite library. Depending 5234 ** for verifying the correct operation of the SQLite library. Depending
5032 ** on how the SQLite library is compiled, this interface might not exist. 5235 ** on how the SQLite library is compiled, this interface might not exist.
5033 ** 5236 **
5034 ** The details of the operation codes, their meanings, the parameters 5237 ** The details of the operation codes, their meanings, the parameters
5035 ** they take, and what they do are all subject to change without notice. 5238 ** they take, and what they do are all subject to change without notice.
5036 ** Unlike most of the SQLite API, this function is not guaranteed to 5239 ** Unlike most of the SQLite API, this function is not guaranteed to
5037 ** operate consistently from one release to the next. 5240 ** operate consistently from one release to the next.
5038 */ 5241 */
5039 SQLITE_API int sqlite3_test_control(int op, ...); 5242 SQLITE_API int sqlite3_test_control(int op, ...);
5040 5243
5041 /* 5244 /*
5042 ** CAPI3REF: Testing Interface Operation Codes {H11410} <H11400> 5245 ** CAPI3REF: Testing Interface Operation Codes
5043 ** 5246 **
5044 ** These constants are the valid operation code parameters used 5247 ** These constants are the valid operation code parameters used
5045 ** as the first argument to [sqlite3_test_control()]. 5248 ** as the first argument to [sqlite3_test_control()].
5046 ** 5249 **
5047 ** These parameters and their meanings are subject to change 5250 ** These parameters and their meanings are subject to change
5048 ** without notice. These values are for testing purposes only. 5251 ** without notice. These values are for testing purposes only.
5049 ** Applications should not use any of these parameters or the 5252 ** Applications should not use any of these parameters or the
5050 ** [sqlite3_test_control()] interface. 5253 ** [sqlite3_test_control()] interface.
5051 */ 5254 */
5255 #define SQLITE_TESTCTRL_FIRST 5
5052 #define SQLITE_TESTCTRL_PRNG_SAVE 5 5256 #define SQLITE_TESTCTRL_PRNG_SAVE 5
5053 #define SQLITE_TESTCTRL_PRNG_RESTORE 6 5257 #define SQLITE_TESTCTRL_PRNG_RESTORE 6
5054 #define SQLITE_TESTCTRL_PRNG_RESET 7 5258 #define SQLITE_TESTCTRL_PRNG_RESET 7
5055 #define SQLITE_TESTCTRL_BITVEC_TEST 8 5259 #define SQLITE_TESTCTRL_BITVEC_TEST 8
5056 #define SQLITE_TESTCTRL_FAULT_INSTALL 9 5260 #define SQLITE_TESTCTRL_FAULT_INSTALL 9
5057 #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 5261 #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
5058 #define SQLITE_TESTCTRL_PENDING_BYTE 11 5262 #define SQLITE_TESTCTRL_PENDING_BYTE 11
5059 #define SQLITE_TESTCTRL_ASSERT 12 5263 #define SQLITE_TESTCTRL_ASSERT 12
5060 #define SQLITE_TESTCTRL_ALWAYS 13 5264 #define SQLITE_TESTCTRL_ALWAYS 13
5061 #define SQLITE_TESTCTRL_RESERVE 14 5265 #define SQLITE_TESTCTRL_RESERVE 14
5266 #define SQLITE_TESTCTRL_OPTIMIZATIONS 15
5267 #define SQLITE_TESTCTRL_ISKEYWORD 16
5268 #define SQLITE_TESTCTRL_PGHDRSZ 17
5269 #define SQLITE_TESTCTRL_SCRATCHMALLOC 18
5270 #define SQLITE_TESTCTRL_LAST 18
5062 5271
5063 /* 5272 /*
5064 ** CAPI3REF: SQLite Runtime Status {H17200} <S60200> 5273 ** CAPI3REF: SQLite Runtime Status
5065 ** EXPERIMENTAL
5066 ** 5274 **
5067 ** This interface is used to retrieve runtime status information 5275 ** ^This interface is used to retrieve runtime status information
5068 ** about the preformance of SQLite, and optionally to reset various 5276 ** about the performance of SQLite, and optionally to reset various
5069 ** highwater marks. The first argument is an integer code for 5277 ** highwater marks. ^The first argument is an integer code for
5070 ** the specific parameter to measure. Recognized integer codes 5278 ** the specific parameter to measure. ^(Recognized integer codes
5071 ** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...]. 5279 ** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...].)^
5072 ** The current value of the parameter is returned into *pCurrent. 5280 ** ^The current value of the parameter is returned into *pCurrent.
5073 ** The highest recorded value is returned in *pHighwater. If the 5281 ** ^The highest recorded value is returned in *pHighwater. ^If the
5074 ** resetFlag is true, then the highest record value is reset after 5282 ** resetFlag is true, then the highest record value is reset after
5075 ** *pHighwater is written. Some parameters do not record the highest 5283 ** *pHighwater is written. ^(Some parameters do not record the highest
5076 ** value. For those parameters 5284 ** value. For those parameters
5077 ** nothing is written into *pHighwater and the resetFlag is ignored. 5285 ** nothing is written into *pHighwater and the resetFlag is ignored.)^
5078 ** Other parameters record only the highwater mark and not the current 5286 ** ^(Other parameters record only the highwater mark and not the current
5079 ** value. For these latter parameters nothing is written into *pCurrent. 5287 ** value. For these latter parameters nothing is written into *pCurrent.)^
5080 ** 5288 **
5081 ** This routine returns SQLITE_OK on success and a non-zero 5289 ** ^The sqlite3_status() routine returns SQLITE_OK on success and a
5082 ** [error code] on failure. 5290 ** non-zero [error code] on failure.
5083 ** 5291 **
5084 ** This routine is threadsafe but is not atomic. This routine can be 5292 ** This routine is threadsafe but is not atomic. This routine can be
5085 ** called while other threads are running the same or different SQLite 5293 ** called while other threads are running the same or different SQLite
5086 ** interfaces. However the values returned in *pCurrent and 5294 ** interfaces. However the values returned in *pCurrent and
5087 ** *pHighwater reflect the status of SQLite at different points in time 5295 ** *pHighwater reflect the status of SQLite at different points in time
5088 ** and it is possible that another thread might change the parameter 5296 ** and it is possible that another thread might change the parameter
5089 ** in between the times when *pCurrent and *pHighwater are written. 5297 ** in between the times when *pCurrent and *pHighwater are written.
5090 ** 5298 **
5091 ** See also: [sqlite3_db_status()] 5299 ** See also: [sqlite3_db_status()]
5092 */ 5300 */
5093 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_status(int op, int *pCurrent, int *pH ighwater, int resetFlag); 5301 SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetF lag);
5094 5302
5095 5303
5096 /* 5304 /*
5097 ** CAPI3REF: Status Parameters {H17250} <H17200> 5305 ** CAPI3REF: Status Parameters
5098 ** EXPERIMENTAL
5099 ** 5306 **
5100 ** These integer constants designate various run-time status parameters 5307 ** These integer constants designate various run-time status parameters
5101 ** that can be returned by [sqlite3_status()]. 5308 ** that can be returned by [sqlite3_status()].
5102 ** 5309 **
5103 ** <dl> 5310 ** <dl>
5104 ** <dt>SQLITE_STATUS_MEMORY_USED</dt> 5311 ** ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
5105 ** <dd>This parameter is the current amount of memory checked out 5312 ** <dd>This parameter is the current amount of memory checked out
5106 ** using [sqlite3_malloc()], either directly or indirectly. The 5313 ** using [sqlite3_malloc()], either directly or indirectly. The
5107 ** figure includes calls made to [sqlite3_malloc()] by the application 5314 ** figure includes calls made to [sqlite3_malloc()] by the application
5108 ** and internal memory usage by the SQLite library. Scratch memory 5315 ** and internal memory usage by the SQLite library. Scratch memory
5109 ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache 5316 ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
5110 ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in 5317 ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
5111 ** this parameter. The amount returned is the sum of the allocation 5318 ** this parameter. The amount returned is the sum of the allocation
5112 ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd> 5319 ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
5113 ** 5320 **
5114 ** <dt>SQLITE_STATUS_MALLOC_SIZE</dt> 5321 ** ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
5115 ** <dd>This parameter records the largest memory allocation request 5322 ** <dd>This parameter records the largest memory allocation request
5116 ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their 5323 ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
5117 ** internal equivalents). Only the value returned in the 5324 ** internal equivalents). Only the value returned in the
5118 ** *pHighwater parameter to [sqlite3_status()] is of interest. 5325 ** *pHighwater parameter to [sqlite3_status()] is of interest.
5119 ** The value written into the *pCurrent parameter is undefined.</dd> 5326 ** The value written into the *pCurrent parameter is undefined.</dd>)^
5120 ** 5327 **
5121 ** <dt>SQLITE_STATUS_PAGECACHE_USED</dt> 5328 ** ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
5329 ** <dd>This parameter records the number of separate memory allocations.</dd>)^
5330 **
5331 ** ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
5122 ** <dd>This parameter returns the number of pages used out of the 5332 ** <dd>This parameter returns the number of pages used out of the
5123 ** [pagecache memory allocator] that was configured using 5333 ** [pagecache memory allocator] that was configured using
5124 ** [SQLITE_CONFIG_PAGECACHE]. The 5334 ** [SQLITE_CONFIG_PAGECACHE]. The
5125 ** value returned is in pages, not in bytes.</dd> 5335 ** value returned is in pages, not in bytes.</dd>)^
5126 ** 5336 **
5127 ** <dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> 5337 ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
5128 ** <dd>This parameter returns the number of bytes of page cache 5338 ** <dd>This parameter returns the number of bytes of page cache
5129 ** allocation which could not be statisfied by the [SQLITE_CONFIG_PAGECACHE] 5339 ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
5130 ** buffer and where forced to overflow to [sqlite3_malloc()]. The 5340 ** buffer and where forced to overflow to [sqlite3_malloc()]. The
5131 ** returned value includes allocations that overflowed because they 5341 ** returned value includes allocations that overflowed because they
5132 ** where too large (they were larger than the "sz" parameter to 5342 ** where too large (they were larger than the "sz" parameter to
5133 ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because 5343 ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
5134 ** no space was left in the page cache.</dd> 5344 ** no space was left in the page cache.</dd>)^
5135 ** 5345 **
5136 ** <dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> 5346 ** ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
5137 ** <dd>This parameter records the largest memory allocation request 5347 ** <dd>This parameter records the largest memory allocation request
5138 ** handed to [pagecache memory allocator]. Only the value returned in the 5348 ** handed to [pagecache memory allocator]. Only the value returned in the
5139 ** *pHighwater parameter to [sqlite3_status()] is of interest. 5349 ** *pHighwater parameter to [sqlite3_status()] is of interest.
5140 ** The value written into the *pCurrent parameter is undefined.</dd> 5350 ** The value written into the *pCurrent parameter is undefined.</dd>)^
5141 ** 5351 **
5142 ** <dt>SQLITE_STATUS_SCRATCH_USED</dt> 5352 ** ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt>
5143 ** <dd>This parameter returns the number of allocations used out of the 5353 ** <dd>This parameter returns the number of allocations used out of the
5144 ** [scratch memory allocator] configured using 5354 ** [scratch memory allocator] configured using
5145 ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not 5355 ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
5146 ** in bytes. Since a single thread may only have one scratch allocation 5356 ** in bytes. Since a single thread may only have one scratch allocation
5147 ** outstanding at time, this parameter also reports the number of threads 5357 ** outstanding at time, this parameter also reports the number of threads
5148 ** using scratch memory at the same time.</dd> 5358 ** using scratch memory at the same time.</dd>)^
5149 ** 5359 **
5150 ** <dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> 5360 ** ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
5151 ** <dd>This parameter returns the number of bytes of scratch memory 5361 ** <dd>This parameter returns the number of bytes of scratch memory
5152 ** allocation which could not be statisfied by the [SQLITE_CONFIG_SCRATCH] 5362 ** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH]
5153 ** buffer and where forced to overflow to [sqlite3_malloc()]. The values 5363 ** buffer and where forced to overflow to [sqlite3_malloc()]. The values
5154 ** returned include overflows because the requested allocation was too 5364 ** returned include overflows because the requested allocation was too
5155 ** larger (that is, because the requested allocation was larger than the 5365 ** larger (that is, because the requested allocation was larger than the
5156 ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer 5366 ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
5157 ** slots were available. 5367 ** slots were available.
5158 ** </dd> 5368 ** </dd>)^
5159 ** 5369 **
5160 ** <dt>SQLITE_STATUS_SCRATCH_SIZE</dt> 5370 ** ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
5161 ** <dd>This parameter records the largest memory allocation request 5371 ** <dd>This parameter records the largest memory allocation request
5162 ** handed to [scratch memory allocator]. Only the value returned in the 5372 ** handed to [scratch memory allocator]. Only the value returned in the
5163 ** *pHighwater parameter to [sqlite3_status()] is of interest. 5373 ** *pHighwater parameter to [sqlite3_status()] is of interest.
5164 ** The value written into the *pCurrent parameter is undefined.</dd> 5374 ** The value written into the *pCurrent parameter is undefined.</dd>)^
5165 ** 5375 **
5166 ** <dt>SQLITE_STATUS_PARSER_STACK</dt> 5376 ** ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
5167 ** <dd>This parameter records the deepest parser stack. It is only 5377 ** <dd>This parameter records the deepest parser stack. It is only
5168 ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd> 5378 ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
5169 ** </dl> 5379 ** </dl>
5170 ** 5380 **
5171 ** New status parameters may be added from time to time. 5381 ** New status parameters may be added from time to time.
5172 */ 5382 */
5173 #define SQLITE_STATUS_MEMORY_USED 0 5383 #define SQLITE_STATUS_MEMORY_USED 0
5174 #define SQLITE_STATUS_PAGECACHE_USED 1 5384 #define SQLITE_STATUS_PAGECACHE_USED 1
5175 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 5385 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
5176 #define SQLITE_STATUS_SCRATCH_USED 3 5386 #define SQLITE_STATUS_SCRATCH_USED 3
5177 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 5387 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4
5178 #define SQLITE_STATUS_MALLOC_SIZE 5 5388 #define SQLITE_STATUS_MALLOC_SIZE 5
5179 #define SQLITE_STATUS_PARSER_STACK 6 5389 #define SQLITE_STATUS_PARSER_STACK 6
5180 #define SQLITE_STATUS_PAGECACHE_SIZE 7 5390 #define SQLITE_STATUS_PAGECACHE_SIZE 7
5181 #define SQLITE_STATUS_SCRATCH_SIZE 8 5391 #define SQLITE_STATUS_SCRATCH_SIZE 8
5392 #define SQLITE_STATUS_MALLOC_COUNT 9
5182 5393
5183 /* 5394 /*
5184 ** CAPI3REF: Database Connection Status {H17500} <S60200> 5395 ** CAPI3REF: Database Connection Status
5185 ** EXPERIMENTAL
5186 ** 5396 **
5187 ** This interface is used to retrieve runtime status information 5397 ** ^This interface is used to retrieve runtime status information
5188 ** about a single [database connection]. The first argument is the 5398 ** about a single [database connection]. ^The first argument is the
5189 ** database connection object to be interrogated. The second argument 5399 ** database connection object to be interrogated. ^The second argument
5190 ** is the parameter to interrogate. Currently, the only allowed value 5400 ** is an integer constant, taken from the set of
5191 ** for the second parameter is [SQLITE_DBSTATUS_LOOKASIDE_USED]. 5401 ** [SQLITE_DBSTATUS_LOOKASIDE_USED | SQLITE_DBSTATUS_*] macros, that
5192 ** Additional options will likely appear in future releases of SQLite. 5402 ** determines the parameter to interrogate. The set of
5403 ** [SQLITE_DBSTATUS_LOOKASIDE_USED | SQLITE_DBSTATUS_*] macros is likely
5404 ** to grow in future releases of SQLite.
5193 ** 5405 **
5194 ** The current value of the requested parameter is written into *pCur 5406 ** ^The current value of the requested parameter is written into *pCur
5195 ** and the highest instantaneous value is written into *pHiwtr. If 5407 ** and the highest instantaneous value is written into *pHiwtr. ^If
5196 ** the resetFlg is true, then the highest instantaneous value is 5408 ** the resetFlg is true, then the highest instantaneous value is
5197 ** reset back down to the current value. 5409 ** reset back down to the current value.
5198 ** 5410 **
5411 ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
5412 ** non-zero [error code] on failure.
5413 **
5199 ** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. 5414 ** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
5200 */ 5415 */
5201 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_db_status(sqlite3*, int op, int *pCur , int *pHiwtr, int resetFlg); 5416 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int r esetFlg);
5202 5417
5203 /* 5418 /*
5204 ** CAPI3REF: Status Parameters for database connections {H17520} <H17500> 5419 ** CAPI3REF: Status Parameters for database connections
5205 ** EXPERIMENTAL
5206 ** 5420 **
5207 ** These constants are the available integer "verbs" that can be passed as 5421 ** These constants are the available integer "verbs" that can be passed as
5208 ** the second argument to the [sqlite3_db_status()] interface. 5422 ** the second argument to the [sqlite3_db_status()] interface.
5209 ** 5423 **
5210 ** New verbs may be added in future releases of SQLite. Existing verbs 5424 ** New verbs may be added in future releases of SQLite. Existing verbs
5211 ** might be discontinued. Applications should check the return code from 5425 ** might be discontinued. Applications should check the return code from
5212 ** [sqlite3_db_status()] to make sure that the call worked. 5426 ** [sqlite3_db_status()] to make sure that the call worked.
5213 ** The [sqlite3_db_status()] interface will return a non-zero error code 5427 ** The [sqlite3_db_status()] interface will return a non-zero error code
5214 ** if a discontinued or unsupported verb is invoked. 5428 ** if a discontinued or unsupported verb is invoked.
5215 ** 5429 **
5216 ** <dl> 5430 ** <dl>
5217 ** <dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> 5431 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
5218 ** <dd>This parameter returns the number of lookaside memory slots currently 5432 ** <dd>This parameter returns the number of lookaside memory slots currently
5219 ** checked out.</dd> 5433 ** checked out.</dd>)^
5434 **
5435 ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
5436 ** <dd>This parameter returns the approximate number of of bytes of heap
5437 ** memory used by all pager caches associated with the database connection.)^
5438 ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
5439 **
5440 ** ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
5441 ** <dd>This parameter returns the approximate number of of bytes of heap
5442 ** memory used to store the schema for all databases associated
5443 ** with the connection - main, temp, and any [ATTACH]-ed databases.)^
5444 ** ^The full amount of memory used by the schemas is reported, even if the
5445 ** schema memory is shared with other database connections due to
5446 ** [shared cache mode] being enabled.
5447 ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
5448 **
5449 ** ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
5450 ** <dd>This parameter returns the approximate number of of bytes of heap
5451 ** and lookaside memory used by all prepared statements associated with
5452 ** the database connection.)^
5453 ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
5454 ** </dd>
5220 ** </dl> 5455 ** </dl>
5221 */ 5456 */
5222 #define SQLITE_DBSTATUS_LOOKASIDE_USED 0 5457 #define SQLITE_DBSTATUS_LOOKASIDE_USED 0
5458 #define SQLITE_DBSTATUS_CACHE_USED 1
5459 #define SQLITE_DBSTATUS_SCHEMA_USED 2
5460 #define SQLITE_DBSTATUS_STMT_USED 3
5461 #define SQLITE_DBSTATUS_MAX 3 /* Largest defined DBSTATUS */
5223 5462
5224 5463
5225 /* 5464 /*
5226 ** CAPI3REF: Prepared Statement Status {H17550} <S60200> 5465 ** CAPI3REF: Prepared Statement Status
5227 ** EXPERIMENTAL
5228 ** 5466 **
5229 ** Each prepared statement maintains various 5467 ** ^(Each prepared statement maintains various
5230 ** [SQLITE_STMTSTATUS_SORT | counters] that measure the number 5468 ** [SQLITE_STMTSTATUS_SORT | counters] that measure the number
5231 ** of times it has performed specific operations. These counters can 5469 ** of times it has performed specific operations.)^ These counters can
5232 ** be used to monitor the performance characteristics of the prepared 5470 ** be used to monitor the performance characteristics of the prepared
5233 ** statements. For example, if the number of table steps greatly exceeds 5471 ** statements. For example, if the number of table steps greatly exceeds
5234 ** the number of table searches or result rows, that would tend to indicate 5472 ** the number of table searches or result rows, that would tend to indicate
5235 ** that the prepared statement is using a full table scan rather than 5473 ** that the prepared statement is using a full table scan rather than
5236 ** an index. 5474 ** an index.
5237 ** 5475 **
5238 ** This interface is used to retrieve and reset counter values from 5476 ** ^(This interface is used to retrieve and reset counter values from
5239 ** a [prepared statement]. The first argument is the prepared statement 5477 ** a [prepared statement]. The first argument is the prepared statement
5240 ** object to be interrogated. The second argument 5478 ** object to be interrogated. The second argument
5241 ** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter] 5479 ** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter]
5242 ** to be interrogated. 5480 ** to be interrogated.)^
5243 ** The current value of the requested counter is returned. 5481 ** ^The current value of the requested counter is returned.
5244 ** If the resetFlg is true, then the counter is reset to zero after this 5482 ** ^If the resetFlg is true, then the counter is reset to zero after this
5245 ** interface call returns. 5483 ** interface call returns.
5246 ** 5484 **
5247 ** See also: [sqlite3_status()] and [sqlite3_db_status()]. 5485 ** See also: [sqlite3_status()] and [sqlite3_db_status()].
5248 */ 5486 */
5249 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); 5487 SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
5250 5488
5251 /* 5489 /*
5252 ** CAPI3REF: Status Parameters for prepared statements {H17570} <H17550> 5490 ** CAPI3REF: Status Parameters for prepared statements
5253 ** EXPERIMENTAL
5254 ** 5491 **
5255 ** These preprocessor macros define integer codes that name counter 5492 ** These preprocessor macros define integer codes that name counter
5256 ** values associated with the [sqlite3_stmt_status()] interface. 5493 ** values associated with the [sqlite3_stmt_status()] interface.
5257 ** The meanings of the various counters are as follows: 5494 ** The meanings of the various counters are as follows:
5258 ** 5495 **
5259 ** <dl> 5496 ** <dl>
5260 ** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> 5497 ** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
5261 ** <dd>This is the number of times that SQLite has stepped forward in 5498 ** <dd>^This is the number of times that SQLite has stepped forward in
5262 ** a table as part of a full table scan. Large numbers for this counter 5499 ** a table as part of a full table scan. Large numbers for this counter
5263 ** may indicate opportunities for performance improvement through 5500 ** may indicate opportunities for performance improvement through
5264 ** careful use of indices.</dd> 5501 ** careful use of indices.</dd>
5265 ** 5502 **
5266 ** <dt>SQLITE_STMTSTATUS_SORT</dt> 5503 ** <dt>SQLITE_STMTSTATUS_SORT</dt>
5267 ** <dd>This is the number of sort operations that have occurred. 5504 ** <dd>^This is the number of sort operations that have occurred.
5268 ** A non-zero value in this counter may indicate an opportunity to 5505 ** A non-zero value in this counter may indicate an opportunity to
5269 ** improvement performance through careful use of indices.</dd> 5506 ** improvement performance through careful use of indices.</dd>
5270 ** 5507 **
5508 ** <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
5509 ** <dd>^This is the number of rows inserted into transient indices that
5510 ** were created automatically in order to help joins run faster.
5511 ** A non-zero value in this counter may indicate an opportunity to
5512 ** improvement performance by adding permanent indices that do not
5513 ** need to be reinitialized each time the statement is run.</dd>
5514 **
5271 ** </dl> 5515 ** </dl>
5272 */ 5516 */
5273 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 5517 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
5274 #define SQLITE_STMTSTATUS_SORT 2 5518 #define SQLITE_STMTSTATUS_SORT 2
5519 #define SQLITE_STMTSTATUS_AUTOINDEX 3
5275 5520
5276 /* 5521 /*
5277 ** CAPI3REF: Custom Page Cache Object 5522 ** CAPI3REF: Custom Page Cache Object
5278 ** EXPERIMENTAL
5279 ** 5523 **
5280 ** The sqlite3_pcache type is opaque. It is implemented by 5524 ** The sqlite3_pcache type is opaque. It is implemented by
5281 ** the pluggable module. The SQLite core has no knowledge of 5525 ** the pluggable module. The SQLite core has no knowledge of
5282 ** its size or internal structure and never deals with the 5526 ** its size or internal structure and never deals with the
5283 ** sqlite3_pcache object except by holding and passing pointers 5527 ** sqlite3_pcache object except by holding and passing pointers
5284 ** to the object. 5528 ** to the object.
5285 ** 5529 **
5286 ** See [sqlite3_pcache_methods] for additional information. 5530 ** See [sqlite3_pcache_methods] for additional information.
5287 */ 5531 */
5288 typedef struct sqlite3_pcache sqlite3_pcache; 5532 typedef struct sqlite3_pcache sqlite3_pcache;
5289 5533
5290 /* 5534 /*
5291 ** CAPI3REF: Application Defined Page Cache. 5535 ** CAPI3REF: Application Defined Page Cache.
5292 ** KEYWORDS: {page cache} 5536 ** KEYWORDS: {page cache}
5293 ** EXPERIMENTAL
5294 ** 5537 **
5295 ** The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can 5538 ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can
5296 ** register an alternative page cache implementation by passing in an 5539 ** register an alternative page cache implementation by passing in an
5297 ** instance of the sqlite3_pcache_methods structure. The majority of the 5540 ** instance of the sqlite3_pcache_methods structure.)^
5298 ** heap memory used by SQLite is used by the page cache to cache data read 5541 ** In many applications, most of the heap memory allocated by
5299 ** from, or ready to be written to, the database file. By implementing a 5542 ** SQLite is used for the page cache.
5300 ** custom page cache using this API, an application can control more 5543 ** By implementing a
5301 ** precisely the amount of memory consumed by SQLite, the way in which 5544 ** custom page cache using this API, an application can better control
5545 ** the amount of memory consumed by SQLite, the way in which
5302 ** that memory is allocated and released, and the policies used to 5546 ** that memory is allocated and released, and the policies used to
5303 ** determine exactly which parts of a database file are cached and for 5547 ** determine exactly which parts of a database file are cached and for
5304 ** how long. 5548 ** how long.
5305 ** 5549 **
5306 ** The contents of the sqlite3_pcache_methods structure are copied to an 5550 ** The alternative page cache mechanism is an
5551 ** extreme measure that is only needed by the most demanding applications.
5552 ** The built-in page cache is recommended for most uses.
5553 **
5554 ** ^(The contents of the sqlite3_pcache_methods structure are copied to an
5307 ** internal buffer by SQLite within the call to [sqlite3_config]. Hence 5555 ** internal buffer by SQLite within the call to [sqlite3_config]. Hence
5308 ** the application may discard the parameter after the call to 5556 ** the application may discard the parameter after the call to
5309 ** [sqlite3_config()] returns. 5557 ** [sqlite3_config()] returns.)^
5310 ** 5558 **
5311 ** The xInit() method is called once for each call to [sqlite3_initialize()] 5559 ** ^(The xInit() method is called once for each effective
5312 ** (usually only once during the lifetime of the process). It is passed 5560 ** call to [sqlite3_initialize()])^
5313 ** a copy of the sqlite3_pcache_methods.pArg value. It can be used to set 5561 ** (usually only once during the lifetime of the process). ^(The xInit()
5314 ** up global structures and mutexes required by the custom page cache 5562 ** method is passed a copy of the sqlite3_pcache_methods.pArg value.)^
5315 ** implementation. 5563 ** The intent of the xInit() method is to set up global data structures
5564 ** required by the custom page cache implementation.
5565 ** ^(If the xInit() method is NULL, then the
5566 ** built-in default page cache is used instead of the application defined
5567 ** page cache.)^
5316 ** 5568 **
5317 ** The xShutdown() method is called from within [sqlite3_shutdown()], 5569 ** ^The xShutdown() method is called by [sqlite3_shutdown()].
5318 ** if the application invokes this API. It can be used to clean up 5570 ** It can be used to clean up
5319 ** any outstanding resources before process shutdown, if required. 5571 ** any outstanding resources before process shutdown, if required.
5572 ** ^The xShutdown() method may be NULL.
5320 ** 5573 **
5321 ** SQLite holds a [SQLITE_MUTEX_RECURSIVE] mutex when it invokes 5574 ** ^SQLite automatically serializes calls to the xInit method,
5322 ** the xInit method, so the xInit method need not be threadsafe. The 5575 ** so the xInit method need not be threadsafe. ^The
5323 ** xShutdown method is only called from [sqlite3_shutdown()] so it does 5576 ** xShutdown method is only called from [sqlite3_shutdown()] so it does
5324 ** not need to be threadsafe either. All other methods must be threadsafe 5577 ** not need to be threadsafe either. All other methods must be threadsafe
5325 ** in multithreaded applications. 5578 ** in multithreaded applications.
5326 ** 5579 **
5327 ** SQLite will never invoke xInit() more than once without an intervening 5580 ** ^SQLite will never invoke xInit() more than once without an intervening
5328 ** call to xShutdown(). 5581 ** call to xShutdown().
5329 ** 5582 **
5330 ** The xCreate() method is used to construct a new cache instance. SQLite 5583 ** ^SQLite invokes the xCreate() method to construct a new cache instance.
5331 ** will typically create one cache instance for each open database file, 5584 ** SQLite will typically create one cache instance for each open database file,
5332 ** though this is not guaranteed. The 5585 ** though this is not guaranteed. ^The
5333 ** first parameter, szPage, is the size in bytes of the pages that must 5586 ** first parameter, szPage, is the size in bytes of the pages that must
5334 ** be allocated by the cache. szPage will not be a power of two. szPage 5587 ** be allocated by the cache. ^szPage will not be a power of two. ^szPage
5335 ** will the page size of the database file that is to be cached plus an 5588 ** will the page size of the database file that is to be cached plus an
5336 ** increment (here called "R") of about 100 or 200. SQLite will use the 5589 ** increment (here called "R") of about 100 or 200. SQLite will use the
5337 ** extra R bytes on each page to store metadata about the underlying 5590 ** extra R bytes on each page to store metadata about the underlying
5338 ** database page on disk. The value of R depends 5591 ** database page on disk. The value of R depends
5339 ** on the SQLite version, the target platform, and how SQLite was compiled. 5592 ** on the SQLite version, the target platform, and how SQLite was compiled.
5340 ** R is constant for a particular build of SQLite. The second argument to 5593 ** ^R is constant for a particular build of SQLite. ^The second argument to
5341 ** xCreate(), bPurgeable, is true if the cache being created will 5594 ** xCreate(), bPurgeable, is true if the cache being created will
5342 ** be used to cache database pages of a file stored on disk, or 5595 ** be used to cache database pages of a file stored on disk, or
5343 ** false if it is used for an in-memory database. The cache implementation 5596 ** false if it is used for an in-memory database. The cache implementation
5344 ** does not have to do anything special based with the value of bPurgeable; 5597 ** does not have to do anything special based with the value of bPurgeable;
5345 ** it is purely advisory. On a cache where bPurgeable is false, SQLite will 5598 ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
5346 ** never invoke xUnpin() except to deliberately delete a page. 5599 ** never invoke xUnpin() except to deliberately delete a page.
5347 ** In other words, a cache created with bPurgeable set to false will 5600 ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
5601 ** false will always have the "discard" flag set to true.
5602 ** ^Hence, a cache created with bPurgeable false will
5348 ** never contain any unpinned pages. 5603 ** never contain any unpinned pages.
5349 ** 5604 **
5350 ** The xCachesize() method may be called at any time by SQLite to set the 5605 ** ^(The xCachesize() method may be called at any time by SQLite to set the
5351 ** suggested maximum cache-size (number of pages stored by) the cache 5606 ** suggested maximum cache-size (number of pages stored by) the cache
5352 ** instance passed as the first argument. This is the value configured using 5607 ** instance passed as the first argument. This is the value configured using
5353 ** the SQLite "[PRAGMA cache_size]" command. As with the bPurgeable parameter, 5608 ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
5354 ** the implementation is not required to do anything with this 5609 ** parameter, the implementation is not required to do anything with this
5355 ** value; it is advisory only. 5610 ** value; it is advisory only.
5356 ** 5611 **
5357 ** The xPagecount() method should return the number of pages currently 5612 ** The xPagecount() method must return the number of pages currently
5358 ** stored in the cache. 5613 ** stored in the cache, both pinned and unpinned.
5359 ** 5614 **
5360 ** The xFetch() method is used to fetch a page and return a pointer to it. 5615 ** The xFetch() method locates a page in the cache and returns a pointer to
5361 ** A 'page', in this context, is a buffer of szPage bytes aligned at an 5616 ** the page, or a NULL pointer.
5362 ** 8-byte boundary. The page to be fetched is determined by the key. The 5617 ** A "page", in this context, means a buffer of szPage bytes aligned at an
5363 ** mimimum key value is 1. After it has been retrieved using xFetch, the page 5618 ** 8-byte boundary. The page to be fetched is determined by the key. ^The
5619 ** mimimum key value is 1. After it has been retrieved using xFetch, the page
5364 ** is considered to be "pinned". 5620 ** is considered to be "pinned".
5365 ** 5621 **
5366 ** If the requested page is already in the page cache, then the page cache 5622 ** If the requested page is already in the page cache, then the page cache
5367 ** implementation must return a pointer to the page buffer with its content 5623 ** implementation must return a pointer to the page buffer with its content
5368 ** intact. If the requested page is not already in the cache, then the 5624 ** intact. If the requested page is not already in the cache, then the
5369 ** behavior of the cache implementation is determined by the value of the 5625 ** behavior of the cache implementation should use the value of the createFlag
5370 ** createFlag parameter passed to xFetch, according to the following table: 5626 ** parameter to help it determined what action to take:
5371 ** 5627 **
5372 ** <table border=1 width=85% align=center> 5628 ** <table border=1 width=85% align=center>
5373 ** <tr><th> createFlag <th> Behaviour when page is not already in cache 5629 ** <tr><th> createFlag <th> Behaviour when page is not already in cache
5374 ** <tr><td> 0 <td> Do not allocate a new page. Return NULL. 5630 ** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
5375 ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. 5631 ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
5376 ** Otherwise return NULL. 5632 ** Otherwise return NULL.
5377 ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return 5633 ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
5378 ** NULL if allocating a new page is effectively impossible. 5634 ** NULL if allocating a new page is effectively impossible.
5379 ** </table> 5635 ** </table>
5380 ** 5636 **
5381 ** SQLite will normally invoke xFetch() with a createFlag of 0 or 1. If 5637 ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
5382 ** a call to xFetch() with createFlag==1 returns NULL, then SQLite will 5638 ** will only use a createFlag of 2 after a prior call with a createFlag of 1
5639 ** failed.)^ In between the to xFetch() calls, SQLite may
5383 ** attempt to unpin one or more cache pages by spilling the content of 5640 ** attempt to unpin one or more cache pages by spilling the content of
5384 ** pinned pages to disk and synching the operating system disk cache. After 5641 ** pinned pages to disk and synching the operating system disk cache.
5385 ** attempting to unpin pages, the xFetch() method will be invoked again with
5386 ** a createFlag of 2.
5387 ** 5642 **
5388 ** xUnpin() is called by SQLite with a pointer to a currently pinned page 5643 ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
5389 ** as its second argument. If the third parameter, discard, is non-zero, 5644 ** as its second argument. If the third parameter, discard, is non-zero,
5390 ** then the page should be evicted from the cache. In this case SQLite 5645 ** then the page must be evicted from the cache.
5391 ** assumes that the next time the page is retrieved from the cache using 5646 ** ^If the discard parameter is
5392 ** the xFetch() method, it will be zeroed. If the discard parameter is 5647 ** zero, then the page may be discarded or retained at the discretion of
5393 ** zero, then the page is considered to be unpinned. The cache implementation 5648 ** page cache implementation. ^The page cache implementation
5394 ** may choose to evict unpinned pages at any time. 5649 ** may choose to evict unpinned pages at any time.
5395 ** 5650 **
5396 ** The cache is not required to perform any reference counting. A single 5651 ** The cache must not perform any reference counting. A single
5397 ** call to xUnpin() unpins the page regardless of the number of prior calls 5652 ** call to xUnpin() unpins the page regardless of the number of prior calls
5398 ** to xFetch(). 5653 ** to xFetch().
5399 ** 5654 **
5400 ** The xRekey() method is used to change the key value associated with the 5655 ** The xRekey() method is used to change the key value associated with the
5401 ** page passed as the second argument from oldKey to newKey. If the cache 5656 ** page passed as the second argument. If the cache
5402 ** previously contains an entry associated with newKey, it should be 5657 ** previously contains an entry associated with newKey, it must be
5403 ** discarded. Any prior cache entry associated with newKey is guaranteed not 5658 ** discarded. ^Any prior cache entry associated with newKey is guaranteed not
5404 ** to be pinned. 5659 ** to be pinned.
5405 ** 5660 **
5406 ** When SQLite calls the xTruncate() method, the cache must discard all 5661 ** When SQLite calls the xTruncate() method, the cache must discard all
5407 ** existing cache entries with page numbers (keys) greater than or equal 5662 ** existing cache entries with page numbers (keys) greater than or equal
5408 ** to the value of the iLimit parameter passed to xTruncate(). If any 5663 ** to the value of the iLimit parameter passed to xTruncate(). If any
5409 ** of these pages are pinned, they are implicitly unpinned, meaning that 5664 ** of these pages are pinned, they are implicitly unpinned, meaning that
5410 ** they can be safely discarded. 5665 ** they can be safely discarded.
5411 ** 5666 **
5412 ** The xDestroy() method is used to delete a cache allocated by xCreate(). 5667 ** ^The xDestroy() method is used to delete a cache allocated by xCreate().
5413 ** All resources associated with the specified cache should be freed. After 5668 ** All resources associated with the specified cache should be freed. ^After
5414 ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] 5669 ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
5415 ** handle invalid, and will not use it with any other sqlite3_pcache_methods 5670 ** handle invalid, and will not use it with any other sqlite3_pcache_methods
5416 ** functions. 5671 ** functions.
5417 */ 5672 */
5418 typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; 5673 typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
5419 struct sqlite3_pcache_methods { 5674 struct sqlite3_pcache_methods {
5420 void *pArg; 5675 void *pArg;
5421 int (*xInit)(void*); 5676 int (*xInit)(void*);
5422 void (*xShutdown)(void*); 5677 void (*xShutdown)(void*);
5423 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); 5678 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
5424 void (*xCachesize)(sqlite3_pcache*, int nCachesize); 5679 void (*xCachesize)(sqlite3_pcache*, int nCachesize);
5425 int (*xPagecount)(sqlite3_pcache*); 5680 int (*xPagecount)(sqlite3_pcache*);
5426 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 5681 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
5427 void (*xUnpin)(sqlite3_pcache*, void*, int discard); 5682 void (*xUnpin)(sqlite3_pcache*, void*, int discard);
5428 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); 5683 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
5429 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 5684 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
5430 void (*xDestroy)(sqlite3_pcache*); 5685 void (*xDestroy)(sqlite3_pcache*);
5431 }; 5686 };
5432 5687
5433 /* 5688 /*
5434 ** CAPI3REF: Online Backup Object 5689 ** CAPI3REF: Online Backup Object
5435 ** EXPERIMENTAL
5436 ** 5690 **
5437 ** The sqlite3_backup object records state information about an ongoing 5691 ** The sqlite3_backup object records state information about an ongoing
5438 ** online backup operation. The sqlite3_backup object is created by 5692 ** online backup operation. ^The sqlite3_backup object is created by
5439 ** a call to [sqlite3_backup_init()] and is destroyed by a call to 5693 ** a call to [sqlite3_backup_init()] and is destroyed by a call to
5440 ** [sqlite3_backup_finish()]. 5694 ** [sqlite3_backup_finish()].
5441 ** 5695 **
5442 ** See Also: [Using the SQLite Online Backup API] 5696 ** See Also: [Using the SQLite Online Backup API]
5443 */ 5697 */
5444 typedef struct sqlite3_backup sqlite3_backup; 5698 typedef struct sqlite3_backup sqlite3_backup;
5445 5699
5446 /* 5700 /*
5447 ** CAPI3REF: Online Backup API. 5701 ** CAPI3REF: Online Backup API.
5448 ** EXPERIMENTAL
5449 ** 5702 **
5450 ** This API is used to overwrite the contents of one database with that 5703 ** The backup API copies the content of one database into another.
5451 ** of another. It is useful either for creating backups of databases or 5704 ** It is useful either for creating backups of databases or
5452 ** for copying in-memory databases to or from persistent files. 5705 ** for copying in-memory databases to or from persistent files.
5453 ** 5706 **
5454 ** See Also: [Using the SQLite Online Backup API] 5707 ** See Also: [Using the SQLite Online Backup API]
5455 ** 5708 **
5456 ** Exclusive access is required to the destination database for the 5709 ** ^Exclusive access is required to the destination database for the
5457 ** duration of the operation. However the source database is only 5710 ** duration of the operation. ^However the source database is only
5458 ** read-locked while it is actually being read, it is not locked 5711 ** read-locked while it is actually being read; it is not locked
5459 ** continuously for the entire operation. Thus, the backup may be 5712 ** continuously for the entire backup operation. ^Thus, the backup may be
5460 ** performed on a live database without preventing other users from 5713 ** performed on a live source database without preventing other users from
5461 ** writing to the database for an extended period of time. 5714 ** reading or writing to the source database while the backup is underway.
5462 ** 5715 **
5463 ** To perform a backup operation: 5716 ** ^(To perform a backup operation:
5464 ** <ol> 5717 ** <ol>
5465 ** <li><b>sqlite3_backup_init()</b> is called once to initialize the 5718 ** <li><b>sqlite3_backup_init()</b> is called once to initialize the
5466 ** backup, 5719 ** backup,
5467 ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer 5720 ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
5468 ** the data between the two databases, and finally 5721 ** the data between the two databases, and finally
5469 ** <li><b>sqlite3_backup_finish()</b> is called to release all resources 5722 ** <li><b>sqlite3_backup_finish()</b> is called to release all resources
5470 ** associated with the backup operation. 5723 ** associated with the backup operation.
5471 ** </ol> 5724 ** </ol>)^
5472 ** There should be exactly one call to sqlite3_backup_finish() for each 5725 ** There should be exactly one call to sqlite3_backup_finish() for each
5473 ** successful call to sqlite3_backup_init(). 5726 ** successful call to sqlite3_backup_init().
5474 ** 5727 **
5475 ** <b>sqlite3_backup_init()</b> 5728 ** <b>sqlite3_backup_init()</b>
5476 ** 5729 **
5477 ** The first two arguments passed to [sqlite3_backup_init()] are the database 5730 ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
5478 ** handle associated with the destination database and the database name 5731 ** [database connection] associated with the destination database
5479 ** used to attach the destination database to the handle. The database name 5732 ** and the database name, respectively.
5480 ** is "main" for the main database, "temp" for the temporary database, or 5733 ** ^The database name is "main" for the main database, "temp" for the
5481 ** the name specified as part of the [ATTACH] statement if the destination is 5734 ** temporary database, or the name specified after the AS keyword in
5482 ** an attached database. The third and fourth arguments passed to 5735 ** an [ATTACH] statement for an attached database.
5483 ** sqlite3_backup_init() identify the [database connection] 5736 ** ^The S and M arguments passed to
5484 ** and database name used 5737 ** sqlite3_backup_init(D,N,S,M) identify the [database connection]
5485 ** to access the source database. The values passed for the source and 5738 ** and database name of the source database, respectively.
5486 ** destination [database connection] parameters must not be the same. 5739 ** ^The source and destination [database connections] (parameters S and D)
5740 ** must be different or else sqlite3_backup_init(D,N,S,M) will file with
5741 ** an error.
5487 ** 5742 **
5488 ** If an error occurs within sqlite3_backup_init(), then NULL is returned 5743 ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
5489 ** and an error code and error message written into the [database connection] 5744 ** returned and an error code and error message are store3d in the
5490 ** passed as the first argument. They may be retrieved using the 5745 ** destination [database connection] D.
5491 ** [sqlite3_errcode()], [sqlite3_errmsg()], and [sqlite3_errmsg16()] functions. 5746 ** ^The error code and message for the failed call to sqlite3_backup_init()
5492 ** Otherwise, if successful, a pointer to an [sqlite3_backup] object is 5747 ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
5493 ** returned. This pointer may be used with the sqlite3_backup_step() and 5748 ** [sqlite3_errmsg16()] functions.
5749 ** ^A successful call to sqlite3_backup_init() returns a pointer to an
5750 ** [sqlite3_backup] object.
5751 ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
5494 ** sqlite3_backup_finish() functions to perform the specified backup 5752 ** sqlite3_backup_finish() functions to perform the specified backup
5495 ** operation. 5753 ** operation.
5496 ** 5754 **
5497 ** <b>sqlite3_backup_step()</b> 5755 ** <b>sqlite3_backup_step()</b>
5498 ** 5756 **
5499 ** Function [sqlite3_backup_step()] is used to copy up to nPage pages between 5757 ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
5500 ** the source and destination databases, where nPage is the value of the 5758 ** the source and destination databases specified by [sqlite3_backup] object B.
5501 ** second parameter passed to sqlite3_backup_step(). If nPage is a negative 5759 ** ^If N is negative, all remaining source pages are copied.
5502 ** value, all remaining source pages are copied. If the required pages are 5760 ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
5503 ** succesfully copied, but there are still more pages to copy before the 5761 ** are still more pages to be copied, then the function resturns [SQLITE_OK].
5504 ** backup is complete, it returns [SQLITE_OK]. If no error occured and there 5762 ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
5505 ** are no more pages to copy, then [SQLITE_DONE] is returned. If an error 5763 ** from source to destination, then it returns [SQLITE_DONE].
5506 ** occurs, then an SQLite error code is returned. As well as [SQLITE_OK] and 5764 ** ^If an error occurs while running sqlite3_backup_step(B,N),
5765 ** then an [error code] is returned. ^As well as [SQLITE_OK] and
5507 ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], 5766 ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
5508 ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an 5767 ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
5509 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. 5768 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
5510 ** 5769 **
5511 ** As well as the case where the destination database file was opened for 5770 ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
5512 ** read-only access, sqlite3_backup_step() may return [SQLITE_READONLY] if 5771 ** <ol>
5513 ** the destination is an in-memory database with a different page size 5772 ** <li> the destination database was opened read-only, or
5514 ** from the source database. 5773 ** <li> the destination database is using write-ahead-log journaling
5774 ** and the destination and source page sizes differ, or
5775 ** <li> The destination database is an in-memory database and the
5776 ** destination and source page sizes differ.
5777 ** </ol>)^
5515 ** 5778 **
5516 ** If sqlite3_backup_step() cannot obtain a required file-system lock, then 5779 ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
5517 ** the [sqlite3_busy_handler | busy-handler function] 5780 ** the [sqlite3_busy_handler | busy-handler function]
5518 ** is invoked (if one is specified). If the 5781 ** is invoked (if one is specified). ^If the
5519 ** busy-handler returns non-zero before the lock is available, then 5782 ** busy-handler returns non-zero before the lock is available, then
5520 ** [SQLITE_BUSY] is returned to the caller. In this case the call to 5783 ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
5521 ** sqlite3_backup_step() can be retried later. If the source 5784 ** sqlite3_backup_step() can be retried later. ^If the source
5522 ** [database connection] 5785 ** [database connection]
5523 ** is being used to write to the source database when sqlite3_backup_step() 5786 ** is being used to write to the source database when sqlite3_backup_step()
5524 ** is called, then [SQLITE_LOCKED] is returned immediately. Again, in this 5787 ** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
5525 ** case the call to sqlite3_backup_step() can be retried later on. If 5788 ** case the call to sqlite3_backup_step() can be retried later on. ^(If
5526 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or 5789 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
5527 ** [SQLITE_READONLY] is returned, then 5790 ** [SQLITE_READONLY] is returned, then
5528 ** there is no point in retrying the call to sqlite3_backup_step(). These 5791 ** there is no point in retrying the call to sqlite3_backup_step(). These
5529 ** errors are considered fatal. At this point the application must accept 5792 ** errors are considered fatal.)^ The application must accept
5530 ** that the backup operation has failed and pass the backup operation handle 5793 ** that the backup operation has failed and pass the backup operation handle
5531 ** to the sqlite3_backup_finish() to release associated resources. 5794 ** to the sqlite3_backup_finish() to release associated resources.
5532 ** 5795 **
5533 ** Following the first call to sqlite3_backup_step(), an exclusive lock is 5796 ** ^The first call to sqlite3_backup_step() obtains an exclusive lock
5534 ** obtained on the destination file. It is not released until either 5797 ** on the destination file. ^The exclusive lock is not released until either
5535 ** sqlite3_backup_finish() is called or the backup operation is complete 5798 ** sqlite3_backup_finish() is called or the backup operation is complete
5536 ** and sqlite3_backup_step() returns [SQLITE_DONE]. Additionally, each time 5799 ** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
5537 ** a call to sqlite3_backup_step() is made a [shared lock] is obtained on 5800 ** sqlite3_backup_step() obtains a [shared lock] on the source database that
5538 ** the source database file. This lock is released before the 5801 ** lasts for the duration of the sqlite3_backup_step() call.
5539 ** sqlite3_backup_step() call returns. Because the source database is not 5802 ** ^Because the source database is not locked between calls to
5540 ** locked between calls to sqlite3_backup_step(), it may be modified mid-way 5803 ** sqlite3_backup_step(), the source database may be modified mid-way
5541 ** through the backup procedure. If the source database is modified by an 5804 ** through the backup process. ^If the source database is modified by an
5542 ** external process or via a database connection other than the one being 5805 ** external process or via a database connection other than the one being
5543 ** used by the backup operation, then the backup will be transparently 5806 ** used by the backup operation, then the backup will be automatically
5544 ** restarted by the next call to sqlite3_backup_step(). If the source 5807 ** restarted by the next call to sqlite3_backup_step(). ^If the source
5545 ** database is modified by the using the same database connection as is used 5808 ** database is modified by the using the same database connection as is used
5546 ** by the backup operation, then the backup database is transparently 5809 ** by the backup operation, then the backup database is automatically
5547 ** updated at the same time. 5810 ** updated at the same time.
5548 ** 5811 **
5549 ** <b>sqlite3_backup_finish()</b> 5812 ** <b>sqlite3_backup_finish()</b>
5550 ** 5813 **
5551 ** Once sqlite3_backup_step() has returned [SQLITE_DONE], or when the 5814 ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
5552 ** application wishes to abandon the backup operation, the [sqlite3_backup] 5815 ** application wishes to abandon the backup operation, the application
5553 ** object should be passed to sqlite3_backup_finish(). This releases all 5816 ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
5554 ** resources associated with the backup operation. If sqlite3_backup_step() 5817 ** ^The sqlite3_backup_finish() interfaces releases all
5555 ** has not yet returned [SQLITE_DONE], then any active write-transaction on the 5818 ** resources associated with the [sqlite3_backup] object.
5556 ** destination database is rolled back. The [sqlite3_backup] object is invalid 5819 ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
5820 ** active write-transaction on the destination database is rolled back.
5821 ** The [sqlite3_backup] object is invalid
5557 ** and may not be used following a call to sqlite3_backup_finish(). 5822 ** and may not be used following a call to sqlite3_backup_finish().
5558 ** 5823 **
5559 ** The value returned by sqlite3_backup_finish is [SQLITE_OK] if no error 5824 ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
5560 ** occurred, regardless or whether or not sqlite3_backup_step() was called 5825 ** sqlite3_backup_step() errors occurred, regardless or whether or not
5561 ** a sufficient number of times to complete the backup operation. Or, if 5826 ** sqlite3_backup_step() completed.
5562 ** an out-of-memory condition or IO error occured during a call to 5827 ** ^If an out-of-memory condition or IO error occurred during any prior
5563 ** sqlite3_backup_step() then [SQLITE_NOMEM] or an 5828 ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
5564 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] error code 5829 ** sqlite3_backup_finish() returns the corresponding [error code].
5565 ** is returned. In this case the error code and an error message are
5566 ** written to the destination [database connection].
5567 ** 5830 **
5568 ** A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() is 5831 ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
5569 ** not a permanent error and does not affect the return value of 5832 ** is not a permanent error and does not affect the return value of
5570 ** sqlite3_backup_finish(). 5833 ** sqlite3_backup_finish().
5571 ** 5834 **
5572 ** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b> 5835 ** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b>
5573 ** 5836 **
5574 ** Each call to sqlite3_backup_step() sets two values stored internally 5837 ** ^Each call to sqlite3_backup_step() sets two values inside
5575 ** by an [sqlite3_backup] object. The number of pages still to be backed 5838 ** the [sqlite3_backup] object: the number of pages still to be backed
5576 ** up, which may be queried by sqlite3_backup_remaining(), and the total 5839 ** up and the total number of pages in the source database file.
5577 ** number of pages in the source database file, which may be queried by 5840 ** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces
5578 ** sqlite3_backup_pagecount(). 5841 ** retrieve these two values, respectively.
5579 ** 5842 **
5580 ** The values returned by these functions are only updated by 5843 ** ^The values returned by these functions are only updated by
5581 ** sqlite3_backup_step(). If the source database is modified during a backup 5844 ** sqlite3_backup_step(). ^If the source database is modified during a backup
5582 ** operation, then the values are not updated to account for any extra 5845 ** operation, then the values are not updated to account for any extra
5583 ** pages that need to be updated or the size of the source database file 5846 ** pages that need to be updated or the size of the source database file
5584 ** changing. 5847 ** changing.
5585 ** 5848 **
5586 ** <b>Concurrent Usage of Database Handles</b> 5849 ** <b>Concurrent Usage of Database Handles</b>
5587 ** 5850 **
5588 ** The source [database connection] may be used by the application for other 5851 ** ^The source [database connection] may be used by the application for other
5589 ** purposes while a backup operation is underway or being initialized. 5852 ** purposes while a backup operation is underway or being initialized.
5590 ** If SQLite is compiled and configured to support threadsafe database 5853 ** ^If SQLite is compiled and configured to support threadsafe database
5591 ** connections, then the source database connection may be used concurrently 5854 ** connections, then the source database connection may be used concurrently
5592 ** from within other threads. 5855 ** from within other threads.
5593 ** 5856 **
5594 ** However, the application must guarantee that the destination database 5857 ** However, the application must guarantee that the destination
5595 ** connection handle is not passed to any other API (by any thread) after 5858 ** [database connection] is not passed to any other API (by any thread) after
5596 ** sqlite3_backup_init() is called and before the corresponding call to 5859 ** sqlite3_backup_init() is called and before the corresponding call to
5597 ** sqlite3_backup_finish(). Unfortunately SQLite does not currently check 5860 ** sqlite3_backup_finish(). SQLite does not currently check to see
5598 ** for this, if the application does use the destination [database connection] 5861 ** if the application incorrectly accesses the destination [database connection]
5599 ** for some other purpose during a backup operation, things may appear to 5862 ** and so no error code is reported, but the operations may malfunction
5600 ** work correctly but in fact be subtly malfunctioning. Use of the 5863 ** nevertheless. Use of the destination database connection while a
5601 ** destination database connection while a backup is in progress might 5864 ** backup is in progress might also also cause a mutex deadlock.
5602 ** also cause a mutex deadlock.
5603 ** 5865 **
5604 ** Furthermore, if running in [shared cache mode], the application must 5866 ** If running in [shared cache mode], the application must
5605 ** guarantee that the shared cache used by the destination database 5867 ** guarantee that the shared cache used by the destination database
5606 ** is not accessed while the backup is running. In practice this means 5868 ** is not accessed while the backup is running. In practice this means
5607 ** that the application must guarantee that the file-system file being 5869 ** that the application must guarantee that the disk file being
5608 ** backed up to is not accessed by any connection within the process, 5870 ** backed up to is not accessed by any connection within the process,
5609 ** not just the specific connection that was passed to sqlite3_backup_init(). 5871 ** not just the specific connection that was passed to sqlite3_backup_init().
5610 ** 5872 **
5611 ** The [sqlite3_backup] object itself is partially threadsafe. Multiple 5873 ** The [sqlite3_backup] object itself is partially threadsafe. Multiple
5612 ** threads may safely make multiple concurrent calls to sqlite3_backup_step(). 5874 ** threads may safely make multiple concurrent calls to sqlite3_backup_step().
5613 ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() 5875 ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
5614 ** APIs are not strictly speaking threadsafe. If they are invoked at the 5876 ** APIs are not strictly speaking threadsafe. If they are invoked at the
5615 ** same time as another thread is invoking sqlite3_backup_step() it is 5877 ** same time as another thread is invoking sqlite3_backup_step() it is
5616 ** possible that they return invalid values. 5878 ** possible that they return invalid values.
5617 */ 5879 */
5618 SQLITE_API sqlite3_backup *sqlite3_backup_init( 5880 SQLITE_API sqlite3_backup *sqlite3_backup_init(
5619 sqlite3 *pDest, /* Destination database handle */ 5881 sqlite3 *pDest, /* Destination database handle */
5620 const char *zDestName, /* Destination database name */ 5882 const char *zDestName, /* Destination database name */
5621 sqlite3 *pSource, /* Source database handle */ 5883 sqlite3 *pSource, /* Source database handle */
5622 const char *zSourceName /* Source database name */ 5884 const char *zSourceName /* Source database name */
5623 ); 5885 );
5624 SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage); 5886 SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
5625 SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p); 5887 SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
5626 SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p); 5888 SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
5627 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p); 5889 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
5628 5890
5629 /* 5891 /*
5630 ** CAPI3REF: Unlock Notification 5892 ** CAPI3REF: Unlock Notification
5631 ** EXPERIMENTAL
5632 ** 5893 **
5633 ** When running in shared-cache mode, a database operation may fail with 5894 ** ^When running in shared-cache mode, a database operation may fail with
5634 ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or 5895 ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
5635 ** individual tables within the shared-cache cannot be obtained. See 5896 ** individual tables within the shared-cache cannot be obtained. See
5636 ** [SQLite Shared-Cache Mode] for a description of shared-cache locking. 5897 ** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
5637 ** This API may be used to register a callback that SQLite will invoke 5898 ** ^This API may be used to register a callback that SQLite will invoke
5638 ** when the connection currently holding the required lock relinquishes it. 5899 ** when the connection currently holding the required lock relinquishes it.
5639 ** This API is only available if the library was compiled with the 5900 ** ^This API is only available if the library was compiled with the
5640 ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. 5901 ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
5641 ** 5902 **
5642 ** See Also: [Using the SQLite Unlock Notification Feature]. 5903 ** See Also: [Using the SQLite Unlock Notification Feature].
5643 ** 5904 **
5644 ** Shared-cache locks are released when a database connection concludes 5905 ** ^Shared-cache locks are released when a database connection concludes
5645 ** its current transaction, either by committing it or rolling it back. 5906 ** its current transaction, either by committing it or rolling it back.
5646 ** 5907 **
5647 ** When a connection (known as the blocked connection) fails to obtain a 5908 ** ^When a connection (known as the blocked connection) fails to obtain a
5648 ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the 5909 ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
5649 ** identity of the database connection (the blocking connection) that 5910 ** identity of the database connection (the blocking connection) that
5650 ** has locked the required resource is stored internally. After an 5911 ** has locked the required resource is stored internally. ^After an
5651 ** application receives an SQLITE_LOCKED error, it may call the 5912 ** application receives an SQLITE_LOCKED error, it may call the
5652 ** sqlite3_unlock_notify() method with the blocked connection handle as 5913 ** sqlite3_unlock_notify() method with the blocked connection handle as
5653 ** the first argument to register for a callback that will be invoked 5914 ** the first argument to register for a callback that will be invoked
5654 ** when the blocking connections current transaction is concluded. The 5915 ** when the blocking connections current transaction is concluded. ^The
5655 ** callback is invoked from within the [sqlite3_step] or [sqlite3_close] 5916 ** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
5656 ** call that concludes the blocking connections transaction. 5917 ** call that concludes the blocking connections transaction.
5657 ** 5918 **
5658 ** If sqlite3_unlock_notify() is called in a multi-threaded application, 5919 ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
5659 ** there is a chance that the blocking connection will have already 5920 ** there is a chance that the blocking connection will have already
5660 ** concluded its transaction by the time sqlite3_unlock_notify() is invoked. 5921 ** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
5661 ** If this happens, then the specified callback is invoked immediately, 5922 ** If this happens, then the specified callback is invoked immediately,
5662 ** from within the call to sqlite3_unlock_notify(). 5923 ** from within the call to sqlite3_unlock_notify().)^
5663 ** 5924 **
5664 ** If the blocked connection is attempting to obtain a write-lock on a 5925 ** ^If the blocked connection is attempting to obtain a write-lock on a
5665 ** shared-cache table, and more than one other connection currently holds 5926 ** shared-cache table, and more than one other connection currently holds
5666 ** a read-lock on the same table, then SQLite arbitrarily selects one of 5927 ** a read-lock on the same table, then SQLite arbitrarily selects one of
5667 ** the other connections to use as the blocking connection. 5928 ** the other connections to use as the blocking connection.
5668 ** 5929 **
5669 ** There may be at most one unlock-notify callback registered by a 5930 ** ^(There may be at most one unlock-notify callback registered by a
5670 ** blocked connection. If sqlite3_unlock_notify() is called when the 5931 ** blocked connection. If sqlite3_unlock_notify() is called when the
5671 ** blocked connection already has a registered unlock-notify callback, 5932 ** blocked connection already has a registered unlock-notify callback,
5672 ** then the new callback replaces the old. If sqlite3_unlock_notify() is 5933 ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
5673 ** called with a NULL pointer as its second argument, then any existing 5934 ** called with a NULL pointer as its second argument, then any existing
5674 ** unlock-notify callback is cancelled. The blocked connections 5935 ** unlock-notify callback is canceled. ^The blocked connections
5675 ** unlock-notify callback may also be canceled by closing the blocked 5936 ** unlock-notify callback may also be canceled by closing the blocked
5676 ** connection using [sqlite3_close()]. 5937 ** connection using [sqlite3_close()].
5677 ** 5938 **
5678 ** The unlock-notify callback is not reentrant. If an application invokes 5939 ** The unlock-notify callback is not reentrant. If an application invokes
5679 ** any sqlite3_xxx API functions from within an unlock-notify callback, a 5940 ** any sqlite3_xxx API functions from within an unlock-notify callback, a
5680 ** crash or deadlock may be the result. 5941 ** crash or deadlock may be the result.
5681 ** 5942 **
5682 ** Unless deadlock is detected (see below), sqlite3_unlock_notify() always 5943 ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
5683 ** returns SQLITE_OK. 5944 ** returns SQLITE_OK.
5684 ** 5945 **
5685 ** <b>Callback Invocation Details</b> 5946 ** <b>Callback Invocation Details</b>
5686 ** 5947 **
5687 ** When an unlock-notify callback is registered, the application provides a 5948 ** When an unlock-notify callback is registered, the application provides a
5688 ** single void* pointer that is passed to the callback when it is invoked. 5949 ** single void* pointer that is passed to the callback when it is invoked.
5689 ** However, the signature of the callback function allows SQLite to pass 5950 ** However, the signature of the callback function allows SQLite to pass
5690 ** it an array of void* context pointers. The first argument passed to 5951 ** it an array of void* context pointers. The first argument passed to
5691 ** an unlock-notify callback is a pointer to an array of void* pointers, 5952 ** an unlock-notify callback is a pointer to an array of void* pointers,
5692 ** and the second is the number of entries in the array. 5953 ** and the second is the number of entries in the array.
5693 ** 5954 **
5694 ** When a blocking connections transaction is concluded, there may be 5955 ** When a blocking connections transaction is concluded, there may be
5695 ** more than one blocked connection that has registered for an unlock-notify 5956 ** more than one blocked connection that has registered for an unlock-notify
5696 ** callback. If two or more such blocked connections have specified the 5957 ** callback. ^If two or more such blocked connections have specified the
5697 ** same callback function, then instead of invoking the callback function 5958 ** same callback function, then instead of invoking the callback function
5698 ** multiple times, it is invoked once with the set of void* context pointers 5959 ** multiple times, it is invoked once with the set of void* context pointers
5699 ** specified by the blocked connections bundled together into an array. 5960 ** specified by the blocked connections bundled together into an array.
5700 ** This gives the application an opportunity to prioritize any actions 5961 ** This gives the application an opportunity to prioritize any actions
5701 ** related to the set of unblocked database connections. 5962 ** related to the set of unblocked database connections.
5702 ** 5963 **
5703 ** <b>Deadlock Detection</b> 5964 ** <b>Deadlock Detection</b>
5704 ** 5965 **
5705 ** Assuming that after registering for an unlock-notify callback a 5966 ** Assuming that after registering for an unlock-notify callback a
5706 ** database waits for the callback to be issued before taking any further 5967 ** database waits for the callback to be issued before taking any further
5707 ** action (a reasonable assumption), then using this API may cause the 5968 ** action (a reasonable assumption), then using this API may cause the
5708 ** application to deadlock. For example, if connection X is waiting for 5969 ** application to deadlock. For example, if connection X is waiting for
5709 ** connection Y's transaction to be concluded, and similarly connection 5970 ** connection Y's transaction to be concluded, and similarly connection
5710 ** Y is waiting on connection X's transaction, then neither connection 5971 ** Y is waiting on connection X's transaction, then neither connection
5711 ** will proceed and the system may remain deadlocked indefinitely. 5972 ** will proceed and the system may remain deadlocked indefinitely.
5712 ** 5973 **
5713 ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock 5974 ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
5714 ** detection. If a given call to sqlite3_unlock_notify() would put the 5975 ** detection. ^If a given call to sqlite3_unlock_notify() would put the
5715 ** system in a deadlocked state, then SQLITE_LOCKED is returned and no 5976 ** system in a deadlocked state, then SQLITE_LOCKED is returned and no
5716 ** unlock-notify callback is registered. The system is said to be in 5977 ** unlock-notify callback is registered. The system is said to be in
5717 ** a deadlocked state if connection A has registered for an unlock-notify 5978 ** a deadlocked state if connection A has registered for an unlock-notify
5718 ** callback on the conclusion of connection B's transaction, and connection 5979 ** callback on the conclusion of connection B's transaction, and connection
5719 ** B has itself registered for an unlock-notify callback when connection 5980 ** B has itself registered for an unlock-notify callback when connection
5720 ** A's transaction is concluded. Indirect deadlock is also detected, so 5981 ** A's transaction is concluded. ^Indirect deadlock is also detected, so
5721 ** the system is also considered to be deadlocked if connection B has 5982 ** the system is also considered to be deadlocked if connection B has
5722 ** registered for an unlock-notify callback on the conclusion of connection 5983 ** registered for an unlock-notify callback on the conclusion of connection
5723 ** C's transaction, where connection C is waiting on connection A. Any 5984 ** C's transaction, where connection C is waiting on connection A. ^Any
5724 ** number of levels of indirection are allowed. 5985 ** number of levels of indirection are allowed.
5725 ** 5986 **
5726 ** <b>The "DROP TABLE" Exception</b> 5987 ** <b>The "DROP TABLE" Exception</b>
5727 ** 5988 **
5728 ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost 5989 ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
5729 ** always appropriate to call sqlite3_unlock_notify(). There is however, 5990 ** always appropriate to call sqlite3_unlock_notify(). There is however,
5730 ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, 5991 ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
5731 ** SQLite checks if there are any currently executing SELECT statements 5992 ** SQLite checks if there are any currently executing SELECT statements
5732 ** that belong to the same connection. If there are, SQLITE_LOCKED is 5993 ** that belong to the same connection. If there are, SQLITE_LOCKED is
5733 ** returned. In this case there is no "blocking connection", so invoking 5994 ** returned. In this case there is no "blocking connection", so invoking
5734 ** sqlite3_unlock_notify() results in the unlock-notify callback being 5995 ** sqlite3_unlock_notify() results in the unlock-notify callback being
5735 ** invoked immediately. If the application then re-attempts the "DROP TABLE" 5996 ** invoked immediately. If the application then re-attempts the "DROP TABLE"
5736 ** or "DROP INDEX" query, an infinite loop might be the result. 5997 ** or "DROP INDEX" query, an infinite loop might be the result.
5737 ** 5998 **
5738 ** One way around this problem is to check the extended error code returned 5999 ** One way around this problem is to check the extended error code returned
5739 ** by an sqlite3_step() call. If there is a blocking connection, then the 6000 ** by an sqlite3_step() call. ^(If there is a blocking connection, then the
5740 ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in 6001 ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
5741 ** the special "DROP TABLE/INDEX" case, the extended error code is just 6002 ** the special "DROP TABLE/INDEX" case, the extended error code is just
5742 ** SQLITE_LOCKED. 6003 ** SQLITE_LOCKED.)^
5743 */ 6004 */
5744 SQLITE_API int sqlite3_unlock_notify( 6005 SQLITE_API int sqlite3_unlock_notify(
5745 sqlite3 *pBlocked, /* Waiting connection */ 6006 sqlite3 *pBlocked, /* Waiting connection */
5746 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ 6007 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
5747 void *pNotifyArg /* Argument to pass to xNotify */ 6008 void *pNotifyArg /* Argument to pass to xNotify */
5748 ); 6009 );
5749 6010
5750 6011
5751 /* 6012 /*
5752 ** CAPI3REF: String Comparison 6013 ** CAPI3REF: String Comparison
5753 ** EXPERIMENTAL
5754 ** 6014 **
5755 ** The [sqlite3_strnicmp()] API allows applications and extensions to 6015 ** ^The [sqlite3_strnicmp()] API allows applications and extensions to
5756 ** compare the contents of two buffers containing UTF-8 strings in a 6016 ** compare the contents of two buffers containing UTF-8 strings in a
5757 ** case-indendent fashion, using the same definition of case independence 6017 ** case-independent fashion, using the same definition of case independence
5758 ** that SQLite uses internally when comparing identifiers. 6018 ** that SQLite uses internally when comparing identifiers.
5759 */ 6019 */
5760 SQLITE_API int sqlite3_strnicmp(const char *, const char *, int); 6020 SQLITE_API int sqlite3_strnicmp(const char *, const char *, int);
5761 6021
5762 /* 6022 /*
6023 ** CAPI3REF: Error Logging Interface
6024 **
6025 ** ^The [sqlite3_log()] interface writes a message into the error log
6026 ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
6027 ** ^If logging is enabled, the zFormat string and subsequent arguments are
6028 ** used with [sqlite3_snprintf()] to generate the final output string.
6029 **
6030 ** The sqlite3_log() interface is intended for use by extensions such as
6031 ** virtual tables, collating functions, and SQL functions. While there is
6032 ** nothing to prevent an application from calling sqlite3_log(), doing so
6033 ** is considered bad form.
6034 **
6035 ** The zFormat string must not be NULL.
6036 **
6037 ** To avoid deadlocks and other threading problems, the sqlite3_log() routine
6038 ** will not use dynamically allocated memory. The log message is stored in
6039 ** a fixed-length buffer on the stack. If the log message is longer than
6040 ** a few hundred characters, it will be truncated to the length of the
6041 ** buffer.
6042 */
6043 SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
6044
6045 /*
6046 ** CAPI3REF: Write-Ahead Log Commit Hook
6047 **
6048 ** ^The [sqlite3_wal_hook()] function is used to register a callback that
6049 ** will be invoked each time a database connection commits data to a
6050 ** [write-ahead log] (i.e. whenever a transaction is committed in
6051 ** [journal_mode | journal_mode=WAL mode]).
6052 **
6053 ** ^The callback is invoked by SQLite after the commit has taken place and
6054 ** the associated write-lock on the database released, so the implementation
6055 ** may read, write or [checkpoint] the database as required.
6056 **
6057 ** ^The first parameter passed to the callback function when it is invoked
6058 ** is a copy of the third parameter passed to sqlite3_wal_hook() when
6059 ** registering the callback. ^The second is a copy of the database handle.
6060 ** ^The third parameter is the name of the database that was written to -
6061 ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
6062 ** is the number of pages currently in the write-ahead log file,
6063 ** including those that were just committed.
6064 **
6065 ** The callback function should normally return [SQLITE_OK]. ^If an error
6066 ** code is returned, that error will propagate back up through the
6067 ** SQLite code base to cause the statement that provoked the callback
6068 ** to report an error, though the commit will have still occurred. If the
6069 ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
6070 ** that does not correspond to any valid SQLite error code, the results
6071 ** are undefined.
6072 **
6073 ** A single database handle may have at most a single write-ahead log callback
6074 ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
6075 ** previously registered write-ahead log callback. ^Note that the
6076 ** [sqlite3_wal_autocheckpoint()] interface and the
6077 ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
6078 ** those overwrite any prior [sqlite3_wal_hook()] settings.
6079 */
6080 SQLITE_API void *sqlite3_wal_hook(
6081 sqlite3*,
6082 int(*)(void *,sqlite3*,const char*,int),
6083 void*
6084 );
6085
6086 /*
6087 ** CAPI3REF: Configure an auto-checkpoint
6088 **
6089 ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
6090 ** [sqlite3_wal_hook()] that causes any database on [database connection] D
6091 ** to automatically [checkpoint]
6092 ** after committing a transaction if there are N or
6093 ** more frames in the [write-ahead log] file. ^Passing zero or
6094 ** a negative value as the nFrame parameter disables automatic
6095 ** checkpoints entirely.
6096 **
6097 ** ^The callback registered by this function replaces any existing callback
6098 ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
6099 ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
6100 ** configured by this function.
6101 **
6102 ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
6103 ** from SQL.
6104 **
6105 ** ^Every new [database connection] defaults to having the auto-checkpoint
6106 ** enabled with a threshold of 1000 pages. The use of this interface
6107 ** is only necessary if the default setting is found to be suboptimal
6108 ** for a particular application.
6109 */
6110 SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
6111
6112 /*
6113 ** CAPI3REF: Checkpoint a database
6114 **
6115 ** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X
6116 ** on [database connection] D to be [checkpointed]. ^If X is NULL or an
6117 ** empty string, then a checkpoint is run on all databases of
6118 ** connection D. ^If the database connection D is not in
6119 ** [WAL | write-ahead log mode] then this interface is a harmless no-op.
6120 **
6121 ** ^The [wal_checkpoint pragma] can be used to invoke this interface
6122 ** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the
6123 ** [wal_autocheckpoint pragma] can be used to cause this interface to be
6124 ** run whenever the WAL reaches a certain size threshold.
6125 */
6126 SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
6127
6128 /*
5763 ** Undo the hack that converts floating point types to integer for 6129 ** Undo the hack that converts floating point types to integer for
5764 ** builds on processors without floating point support. 6130 ** builds on processors without floating point support.
5765 */ 6131 */
5766 #ifdef SQLITE_OMIT_FLOATING_POINT 6132 #ifdef SQLITE_OMIT_FLOATING_POINT
5767 # undef double 6133 # undef double
5768 #endif 6134 #endif
5769 6135
5770 #ifdef __cplusplus 6136 #ifdef __cplusplus
5771 } /* End of the 'extern "C"' block */ 6137 } /* End of the 'extern "C"' block */
5772 #endif 6138 #endif
5773 #endif 6139 #endif
5774 6140
6141 /*
6142 ** 2010 August 30
6143 **
6144 ** The author disclaims copyright to this source code. In place of
6145 ** a legal notice, here is a blessing:
6146 **
6147 ** May you do good and not evil.
6148 ** May you find forgiveness for yourself and forgive others.
6149 ** May you share freely, never taking more than you give.
6150 **
6151 *************************************************************************
6152 */
6153
6154 #ifndef _SQLITE3RTREE_H_
6155 #define _SQLITE3RTREE_H_
6156
6157
6158 #ifdef __cplusplus
6159 extern "C" {
6160 #endif
6161
6162 typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;
6163
6164 /*
6165 ** Register a geometry callback named zGeom that can be used as part of an
6166 ** R-Tree geometry query as follows:
6167 **
6168 ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
6169 */
6170 SQLITE_API int sqlite3_rtree_geometry_callback(
6171 sqlite3 *db,
6172 const char *zGeom,
6173 int (*xGeom)(sqlite3_rtree_geometry *, int nCoord, double *aCoord, int *pRes),
6174 void *pContext
6175 );
6176
6177
6178 /*
6179 ** A pointer to a structure of the following type is passed as the first
6180 ** argument to callbacks registered using rtree_geometry_callback().
6181 */
6182 struct sqlite3_rtree_geometry {
6183 void *pContext; /* Copy of pContext passed to s_r_g_c() */
6184 int nParam; /* Size of array aParam[] */
6185 double *aParam; /* Parameters passed to SQL geom function */
6186 void *pUser; /* Callback implementation user data */
6187 void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */
6188 };
6189
6190
6191 #ifdef __cplusplus
6192 } /* end of the 'extern "C"' block */
6193 #endif
6194
6195 #endif /* ifndef _SQLITE3RTREE_H_ */
6196
OLDNEW
« no previous file with comments | « third_party/sqlite/preprocessed/parse.c ('k') | third_party/sqlite/safe-tolower.patch » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698