OLD | NEW |
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 Loading... |
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.6.3" |
123 #define SQLITE_VERSION_NUMBER 3006018 | 111 #define SQLITE_VERSION_NUMBER 3007006 |
124 #define SQLITE_SOURCE_ID "2009-09-11 14:05:07 b084828a771ec40be85f07c590ca9
9de4f6c24ee" | 112 #define SQLITE_SOURCE_ID "2011-05-19 13:26:54 ed1da510a239ea767a01dc332b667
119fa3c908e" |
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 ** 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 /* Unknown opcode in sqlite3_file_control() */ |
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 Loading... |
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 */ |
| 485 |
| 486 /* Reserved: 0x00F00000 */ |
444 | 487 |
445 /* | 488 /* |
446 ** CAPI3REF: Device Characteristics {H10240} <H11120> | 489 ** CAPI3REF: Device Characteristics |
447 ** | 490 ** |
448 ** The xDeviceCapabilities method of the [sqlite3_io_methods] | 491 ** The xDeviceCharacteristics method of the [sqlite3_io_methods] |
449 ** object returns an integer which is a vector of the these | 492 ** object returns an integer which is a vector of the these |
450 ** bit values expressing I/O characteristics of the mass storage | 493 ** bit values expressing I/O characteristics of the mass storage |
451 ** device that holds the file that the [sqlite3_io_methods] | 494 ** device that holds the file that the [sqlite3_io_methods] |
452 ** refers to. | 495 ** refers to. |
453 ** | 496 ** |
454 ** The SQLITE_IOCAP_ATOMIC property means that all writes of | 497 ** The SQLITE_IOCAP_ATOMIC property means that all writes of |
455 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values | 498 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values |
456 ** mean that writes of blocks that are nnn bytes in size and | 499 ** mean that writes of blocks that are nnn bytes in size and |
457 ** are aligned to an address which is an integer multiple of | 500 ** are aligned to an address which is an integer multiple of |
458 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means | 501 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means |
459 ** that when data is appended to a file, the data is appended | 502 ** 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 | 503 ** first then the size of the file is extended, never the other |
461 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that | 504 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that |
462 ** information is written to disk in the same order as calls | 505 ** information is written to disk in the same order as calls |
463 ** to xWrite(). | 506 ** to xWrite(). |
464 */ | 507 */ |
465 #define SQLITE_IOCAP_ATOMIC 0x00000001 | 508 #define SQLITE_IOCAP_ATOMIC 0x00000001 |
466 #define SQLITE_IOCAP_ATOMIC512 0x00000002 | 509 #define SQLITE_IOCAP_ATOMIC512 0x00000002 |
467 #define SQLITE_IOCAP_ATOMIC1K 0x00000004 | 510 #define SQLITE_IOCAP_ATOMIC1K 0x00000004 |
468 #define SQLITE_IOCAP_ATOMIC2K 0x00000008 | 511 #define SQLITE_IOCAP_ATOMIC2K 0x00000008 |
469 #define SQLITE_IOCAP_ATOMIC4K 0x00000010 | 512 #define SQLITE_IOCAP_ATOMIC4K 0x00000010 |
470 #define SQLITE_IOCAP_ATOMIC8K 0x00000020 | 513 #define SQLITE_IOCAP_ATOMIC8K 0x00000020 |
471 #define SQLITE_IOCAP_ATOMIC16K 0x00000040 | 514 #define SQLITE_IOCAP_ATOMIC16K 0x00000040 |
472 #define SQLITE_IOCAP_ATOMIC32K 0x00000080 | 515 #define SQLITE_IOCAP_ATOMIC32K 0x00000080 |
473 #define SQLITE_IOCAP_ATOMIC64K 0x00000100 | 516 #define SQLITE_IOCAP_ATOMIC64K 0x00000100 |
474 #define SQLITE_IOCAP_SAFE_APPEND 0x00000200 | 517 #define SQLITE_IOCAP_SAFE_APPEND 0x00000200 |
475 #define SQLITE_IOCAP_SEQUENTIAL 0x00000400 | 518 #define SQLITE_IOCAP_SEQUENTIAL 0x00000400 |
| 519 #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 |
476 | 520 |
477 /* | 521 /* |
478 ** CAPI3REF: File Locking Levels {H10250} <H11120> <H11310> | 522 ** CAPI3REF: File Locking Levels |
479 ** | 523 ** |
480 ** SQLite uses one of these integer values as the second | 524 ** SQLite uses one of these integer values as the second |
481 ** argument to calls it makes to the xLock() and xUnlock() methods | 525 ** argument to calls it makes to the xLock() and xUnlock() methods |
482 ** of an [sqlite3_io_methods] object. | 526 ** of an [sqlite3_io_methods] object. |
483 */ | 527 */ |
484 #define SQLITE_LOCK_NONE 0 | 528 #define SQLITE_LOCK_NONE 0 |
485 #define SQLITE_LOCK_SHARED 1 | 529 #define SQLITE_LOCK_SHARED 1 |
486 #define SQLITE_LOCK_RESERVED 2 | 530 #define SQLITE_LOCK_RESERVED 2 |
487 #define SQLITE_LOCK_PENDING 3 | 531 #define SQLITE_LOCK_PENDING 3 |
488 #define SQLITE_LOCK_EXCLUSIVE 4 | 532 #define SQLITE_LOCK_EXCLUSIVE 4 |
489 | 533 |
490 /* | 534 /* |
491 ** CAPI3REF: Synchronization Type Flags {H10260} <H11120> | 535 ** CAPI3REF: Synchronization Type Flags |
492 ** | 536 ** |
493 ** When SQLite invokes the xSync() method of an | 537 ** When SQLite invokes the xSync() method of an |
494 ** [sqlite3_io_methods] object it uses a combination of | 538 ** [sqlite3_io_methods] object it uses a combination of |
495 ** these integer values as the second argument. | 539 ** these integer values as the second argument. |
496 ** | 540 ** |
497 ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the | 541 ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the |
498 ** sync operation only needs to flush data to mass storage. Inode | 542 ** 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 | 543 ** 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. | 544 ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. |
501 ** If the lower four bits equal SQLITE_SYNC_FULL, that means | 545 ** If the lower four bits equal SQLITE_SYNC_FULL, that means |
502 ** to use Mac OS X style fullsync instead of fsync(). | 546 ** to use Mac OS X style fullsync instead of fsync(). |
| 547 ** |
| 548 ** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags |
| 549 ** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL |
| 550 ** settings. The [synchronous pragma] determines when calls to the |
| 551 ** xSync VFS method occur and applies uniformly across all platforms. |
| 552 ** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how |
| 553 ** energetic or rigorous or forceful the sync operations are and |
| 554 ** only make a difference on Mac OSX for the default SQLite code. |
| 555 ** (Third-party VFS implementations might also make the distinction |
| 556 ** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the |
| 557 ** operating systems natively supported by SQLite, only Mac OSX |
| 558 ** cares about the difference.) |
503 */ | 559 */ |
504 #define SQLITE_SYNC_NORMAL 0x00002 | 560 #define SQLITE_SYNC_NORMAL 0x00002 |
505 #define SQLITE_SYNC_FULL 0x00003 | 561 #define SQLITE_SYNC_FULL 0x00003 |
506 #define SQLITE_SYNC_DATAONLY 0x00010 | 562 #define SQLITE_SYNC_DATAONLY 0x00010 |
507 | 563 |
508 /* | 564 /* |
509 ** CAPI3REF: OS Interface Open File Handle {H11110} <S20110> | 565 ** CAPI3REF: OS Interface Open File Handle |
510 ** | 566 ** |
511 ** An [sqlite3_file] object represents an open file in the | 567 ** An [sqlite3_file] object represents an open file in the |
512 ** [sqlite3_vfs | OS interface layer]. Individual OS interface | 568 ** [sqlite3_vfs | OS interface layer]. Individual OS interface |
513 ** implementations will | 569 ** implementations will |
514 ** want to subclass this object by appending additional fields | 570 ** want to subclass this object by appending additional fields |
515 ** for their own use. The pMethods entry is a pointer to an | 571 ** for their own use. The pMethods entry is a pointer to an |
516 ** [sqlite3_io_methods] object that defines methods for performing | 572 ** [sqlite3_io_methods] object that defines methods for performing |
517 ** I/O operations on the open file. | 573 ** I/O operations on the open file. |
518 */ | 574 */ |
519 typedef struct sqlite3_file sqlite3_file; | 575 typedef struct sqlite3_file sqlite3_file; |
520 struct sqlite3_file { | 576 struct sqlite3_file { |
521 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ | 577 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ |
522 }; | 578 }; |
523 | 579 |
524 /* | 580 /* |
525 ** CAPI3REF: OS Interface File Virtual Methods Object {H11120} <S20110> | 581 ** CAPI3REF: OS Interface File Virtual Methods Object |
526 ** | 582 ** |
527 ** Every file opened by the [sqlite3_vfs] xOpen method populates an | 583 ** Every file opened by the [sqlite3_vfs] xOpen method populates an |
528 ** [sqlite3_file] object (or, more commonly, a subclass of the | 584 ** [sqlite3_file] object (or, more commonly, a subclass of the |
529 ** [sqlite3_file] object) with a pointer to an instance of this object. | 585 ** [sqlite3_file] object) with a pointer to an instance of this object. |
530 ** This object defines the methods used to perform various operations | 586 ** This object defines the methods used to perform various operations |
531 ** against the open file represented by the [sqlite3_file] object. | 587 ** against the open file represented by the [sqlite3_file] object. |
532 ** | 588 ** |
533 ** If the xOpen method sets the sqlite3_file.pMethods element | 589 ** If the xOpen method sets the sqlite3_file.pMethods element |
534 ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method | 590 ** 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 | 591 ** may be invoked even if the xOpen reported that it failed. The |
(...skipping 25 matching lines...) Expand all Loading... |
561 ** [sqlite3_file_control()] interface. The second "op" argument is an | 617 ** [sqlite3_file_control()] interface. The second "op" argument is an |
562 ** integer opcode. The third argument is a generic pointer intended to | 618 ** integer opcode. The third argument is a generic pointer intended to |
563 ** point to a structure that may contain arguments or space in which to | 619 ** point to a structure that may contain arguments or space in which to |
564 ** write return values. Potential uses for xFileControl() might be | 620 ** write return values. Potential uses for xFileControl() might be |
565 ** functions to enable blocking locks with timeouts, to change the | 621 ** functions to enable blocking locks with timeouts, to change the |
566 ** locking strategy (for example to use dot-file locks), to inquire | 622 ** locking strategy (for example to use dot-file locks), to inquire |
567 ** about the status of a lock, or to break stale locks. The SQLite | 623 ** about the status of a lock, or to break stale locks. The SQLite |
568 ** core reserves all opcodes less than 100 for its own use. | 624 ** core reserves all opcodes less than 100 for its own use. |
569 ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. | 625 ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. |
570 ** Applications that define a custom xFileControl method should use opcodes | 626 ** Applications that define a custom xFileControl method should use opcodes |
571 ** greater than 100 to avoid conflicts. | 627 ** greater than 100 to avoid conflicts. VFS implementations should |
| 628 ** return [SQLITE_NOTFOUND] for file control opcodes that they do not |
| 629 ** recognize. |
572 ** | 630 ** |
573 ** The xSectorSize() method returns the sector size of the | 631 ** The xSectorSize() method returns the sector size of the |
574 ** device that underlies the file. The sector size is the | 632 ** device that underlies the file. The sector size is the |
575 ** minimum write that can be performed without disturbing | 633 ** minimum write that can be performed without disturbing |
576 ** other bytes in the file. The xDeviceCharacteristics() | 634 ** other bytes in the file. The xDeviceCharacteristics() |
577 ** method returns a bit vector describing behaviors of the | 635 ** method returns a bit vector describing behaviors of the |
578 ** underlying device: | 636 ** underlying device: |
579 ** | 637 ** |
580 ** <ul> | 638 ** <ul> |
581 ** <li> [SQLITE_IOCAP_ATOMIC] | 639 ** <li> [SQLITE_IOCAP_ATOMIC] |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
616 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); | 674 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); |
617 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); | 675 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); |
618 int (*xSync)(sqlite3_file*, int flags); | 676 int (*xSync)(sqlite3_file*, int flags); |
619 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); | 677 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); |
620 int (*xLock)(sqlite3_file*, int); | 678 int (*xLock)(sqlite3_file*, int); |
621 int (*xUnlock)(sqlite3_file*, int); | 679 int (*xUnlock)(sqlite3_file*, int); |
622 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); | 680 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); |
623 int (*xFileControl)(sqlite3_file*, int op, void *pArg); | 681 int (*xFileControl)(sqlite3_file*, int op, void *pArg); |
624 int (*xSectorSize)(sqlite3_file*); | 682 int (*xSectorSize)(sqlite3_file*); |
625 int (*xDeviceCharacteristics)(sqlite3_file*); | 683 int (*xDeviceCharacteristics)(sqlite3_file*); |
| 684 /* Methods above are valid for version 1 */ |
| 685 int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**); |
| 686 int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); |
| 687 void (*xShmBarrier)(sqlite3_file*); |
| 688 int (*xShmUnmap)(sqlite3_file*, int deleteFlag); |
| 689 /* Methods above are valid for version 2 */ |
626 /* Additional methods may be added in future releases */ | 690 /* Additional methods may be added in future releases */ |
627 }; | 691 }; |
628 | 692 |
629 /* | 693 /* |
630 ** CAPI3REF: Standard File Control Opcodes {H11310} <S30800> | 694 ** CAPI3REF: Standard File Control Opcodes |
631 ** | 695 ** |
632 ** These integer constants are opcodes for the xFileControl method | 696 ** These integer constants are opcodes for the xFileControl method |
633 ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] | 697 ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] |
634 ** interface. | 698 ** interface. |
635 ** | 699 ** |
636 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This | 700 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This |
637 ** opcode causes the xFileControl method to write the current state of | 701 ** opcode causes the xFileControl method to write the current state of |
638 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], | 702 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], |
639 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) | 703 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) |
640 ** into an integer that the pArg argument points to. This capability | 704 ** 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 | 705 ** is used during testing and only needs to be supported when SQLITE_TEST |
642 ** is defined. | 706 ** is defined. |
| 707 ** |
| 708 ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS |
| 709 ** layer a hint of how large the database file will grow to be during the |
| 710 ** current transaction. This hint is not guaranteed to be accurate but it |
| 711 ** is often close. The underlying VFS might choose to preallocate database |
| 712 ** file space based on this hint in order to help writes to the database |
| 713 ** file run faster. |
| 714 ** |
| 715 ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS |
| 716 ** extends and truncates the database file in chunks of a size specified |
| 717 ** by the user. The fourth argument to [sqlite3_file_control()] should |
| 718 ** point to an integer (type int) containing the new chunk-size to use |
| 719 ** for the nominated database. Allocating database file space in large |
| 720 ** chunks (say 1MB at a time), may reduce file-system fragmentation and |
| 721 ** improve performance on some systems. |
| 722 ** |
| 723 ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer |
| 724 ** to the [sqlite3_file] object associated with a particular database |
| 725 ** connection. See the [sqlite3_file_control()] documentation for |
| 726 ** additional information. |
| 727 ** |
| 728 ** ^(The [SQLITE_FCNTL_SYNC_OMITTED] opcode is generated internally by |
| 729 ** SQLite and sent to all VFSes in place of a call to the xSync method |
| 730 ** when the database connection has [PRAGMA synchronous] set to OFF.)^ |
| 731 ** Some specialized VFSes need this signal in order to operate correctly |
| 732 ** when [PRAGMA synchronous | PRAGMA synchronous=OFF] is set, but most |
| 733 ** VFSes do not need this signal and should silently ignore this opcode. |
| 734 ** Applications should not call [sqlite3_file_control()] with this |
| 735 ** opcode as doing so may disrupt the operation of the specialized VFSes |
| 736 ** that do require it. |
643 */ | 737 */ |
644 #define SQLITE_FCNTL_LOCKSTATE 1 | 738 #define SQLITE_FCNTL_LOCKSTATE 1 |
645 #define SQLITE_GET_LOCKPROXYFILE 2 | 739 #define SQLITE_GET_LOCKPROXYFILE 2 |
646 #define SQLITE_SET_LOCKPROXYFILE 3 | 740 #define SQLITE_SET_LOCKPROXYFILE 3 |
647 #define SQLITE_LAST_ERRNO 4 | 741 #define SQLITE_LAST_ERRNO 4 |
| 742 #define SQLITE_FCNTL_SIZE_HINT 5 |
| 743 #define SQLITE_FCNTL_CHUNK_SIZE 6 |
| 744 #define SQLITE_FCNTL_FILE_POINTER 7 |
| 745 #define SQLITE_FCNTL_SYNC_OMITTED 8 |
| 746 |
648 | 747 |
649 /* | 748 /* |
650 ** CAPI3REF: Mutex Handle {H17110} <S20130> | 749 ** CAPI3REF: Mutex Handle |
651 ** | 750 ** |
652 ** The mutex module within SQLite defines [sqlite3_mutex] to be an | 751 ** The mutex module within SQLite defines [sqlite3_mutex] to be an |
653 ** abstract type for a mutex object. The SQLite core never looks | 752 ** abstract type for a mutex object. The SQLite core never looks |
654 ** at the internal representation of an [sqlite3_mutex]. It only | 753 ** at the internal representation of an [sqlite3_mutex]. It only |
655 ** deals with pointers to the [sqlite3_mutex] object. | 754 ** deals with pointers to the [sqlite3_mutex] object. |
656 ** | 755 ** |
657 ** Mutexes are created using [sqlite3_mutex_alloc()]. | 756 ** Mutexes are created using [sqlite3_mutex_alloc()]. |
658 */ | 757 */ |
659 typedef struct sqlite3_mutex sqlite3_mutex; | 758 typedef struct sqlite3_mutex sqlite3_mutex; |
660 | 759 |
661 /* | 760 /* |
662 ** CAPI3REF: OS Interface Object {H11140} <S20100> | 761 ** CAPI3REF: OS Interface Object |
663 ** | 762 ** |
664 ** An instance of the sqlite3_vfs object defines the interface between | 763 ** An instance of the sqlite3_vfs object defines the interface between |
665 ** the SQLite core and the underlying operating system. The "vfs" | 764 ** the SQLite core and the underlying operating system. The "vfs" |
666 ** in the name of the object stands for "virtual file system". | 765 ** in the name of the object stands for "virtual file system". |
667 ** | 766 ** |
668 ** The value of the iVersion field is initially 1 but may be larger in | 767 ** 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 | 768 ** future versions of SQLite. Additional fields may be appended to this |
670 ** object when the iVersion value is increased. Note that the structure | 769 ** object when the iVersion value is increased. Note that the structure |
671 ** of the sqlite3_vfs object changes in the transaction between | 770 ** 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 | 771 ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not |
(...skipping 12 matching lines...) Expand all Loading... |
685 ** | 784 ** |
686 ** The pNext field is the only field in the sqlite3_vfs | 785 ** The pNext field is the only field in the sqlite3_vfs |
687 ** structure that SQLite will ever modify. SQLite will only access | 786 ** structure that SQLite will ever modify. SQLite will only access |
688 ** or modify this field while holding a particular static mutex. | 787 ** or modify this field while holding a particular static mutex. |
689 ** The application should never modify anything within the sqlite3_vfs | 788 ** The application should never modify anything within the sqlite3_vfs |
690 ** object once the object has been registered. | 789 ** object once the object has been registered. |
691 ** | 790 ** |
692 ** The zName field holds the name of the VFS module. The name must | 791 ** The zName field holds the name of the VFS module. The name must |
693 ** be unique across all VFS modules. | 792 ** be unique across all VFS modules. |
694 ** | 793 ** |
695 ** SQLite will guarantee that the zFilename parameter to xOpen | 794 ** ^SQLite guarantees that the zFilename parameter to xOpen |
696 ** is either a NULL pointer or string obtained | 795 ** is either a NULL pointer or string obtained |
697 ** from xFullPathname(). SQLite further guarantees that | 796 ** from xFullPathname() with an optional suffix added. |
| 797 ** ^If a suffix is added to the zFilename parameter, it will |
| 798 ** consist of a single "-" character followed by no more than |
| 799 ** 10 alphanumeric and/or "-" characters. |
| 800 ** ^SQLite further guarantees that |
698 ** the string will be valid and unchanged until xClose() is | 801 ** the string will be valid and unchanged until xClose() is |
699 ** called. Because of the previous sentence, | 802 ** called. Because of the previous sentence, |
700 ** the [sqlite3_file] can safely store a pointer to the | 803 ** the [sqlite3_file] can safely store a pointer to the |
701 ** filename if it needs to remember the filename for some reason. | 804 ** filename if it needs to remember the filename for some reason. |
702 ** If the zFilename parameter is xOpen is a NULL pointer then xOpen | 805 ** If the zFilename parameter to xOpen is a NULL pointer then xOpen |
703 ** must invent its own temporary name for the file. Whenever the | 806 ** must invent its own temporary name for the file. ^Whenever the |
704 ** xFilename parameter is NULL it will also be the case that the | 807 ** xFilename parameter is NULL it will also be the case that the |
705 ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. | 808 ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. |
706 ** | 809 ** |
707 ** The flags argument to xOpen() includes all bits set in | 810 ** The flags argument to xOpen() includes all bits set in |
708 ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] | 811 ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] |
709 ** or [sqlite3_open16()] is used, then flags includes at least | 812 ** or [sqlite3_open16()] is used, then flags includes at least |
710 ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. | 813 ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. |
711 ** If xOpen() opens a file read-only then it sets *pOutFlags to | 814 ** If xOpen() opens a file read-only then it sets *pOutFlags to |
712 ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. | 815 ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. |
713 ** | 816 ** |
714 ** SQLite will also add one of the following flags to the xOpen() | 817 ** ^(SQLite will also add one of the following flags to the xOpen() |
715 ** call, depending on the object being opened: | 818 ** call, depending on the object being opened: |
716 ** | 819 ** |
717 ** <ul> | 820 ** <ul> |
718 ** <li> [SQLITE_OPEN_MAIN_DB] | 821 ** <li> [SQLITE_OPEN_MAIN_DB] |
719 ** <li> [SQLITE_OPEN_MAIN_JOURNAL] | 822 ** <li> [SQLITE_OPEN_MAIN_JOURNAL] |
720 ** <li> [SQLITE_OPEN_TEMP_DB] | 823 ** <li> [SQLITE_OPEN_TEMP_DB] |
721 ** <li> [SQLITE_OPEN_TEMP_JOURNAL] | 824 ** <li> [SQLITE_OPEN_TEMP_JOURNAL] |
722 ** <li> [SQLITE_OPEN_TRANSIENT_DB] | 825 ** <li> [SQLITE_OPEN_TRANSIENT_DB] |
723 ** <li> [SQLITE_OPEN_SUBJOURNAL] | 826 ** <li> [SQLITE_OPEN_SUBJOURNAL] |
724 ** <li> [SQLITE_OPEN_MASTER_JOURNAL] | 827 ** <li> [SQLITE_OPEN_MASTER_JOURNAL] |
725 ** </ul> | 828 ** <li> [SQLITE_OPEN_WAL] |
| 829 ** </ul>)^ |
726 ** | 830 ** |
727 ** The file I/O implementation can use the object type flags to | 831 ** The file I/O implementation can use the object type flags to |
728 ** change the way it deals with files. For example, an application | 832 ** change the way it deals with files. For example, an application |
729 ** that does not care about crash recovery or rollback might make | 833 ** 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 | 834 ** 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 | 835 ** also be no-ops, and any attempt to read the journal would return |
732 ** SQLITE_IOERR. Or the implementation might recognize that a database | 836 ** SQLITE_IOERR. Or the implementation might recognize that a database |
733 ** file will be doing page-aligned sector reads and writes in a random | 837 ** file will be doing page-aligned sector reads and writes in a random |
734 ** order and set up its I/O subsystem accordingly. | 838 ** order and set up its I/O subsystem accordingly. |
735 ** | 839 ** |
736 ** SQLite might also add one of the following flags to the xOpen method: | 840 ** SQLite might also add one of the following flags to the xOpen method: |
737 ** | 841 ** |
738 ** <ul> | 842 ** <ul> |
739 ** <li> [SQLITE_OPEN_DELETEONCLOSE] | 843 ** <li> [SQLITE_OPEN_DELETEONCLOSE] |
740 ** <li> [SQLITE_OPEN_EXCLUSIVE] | 844 ** <li> [SQLITE_OPEN_EXCLUSIVE] |
741 ** </ul> | 845 ** </ul> |
742 ** | 846 ** |
743 ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be | 847 ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be |
744 ** deleted when it is closed. The [SQLITE_OPEN_DELETEONCLOSE] | 848 ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] |
745 ** will be set for TEMP databases, journals and for subjournals. | 849 ** will be set for TEMP databases and their journals, transient |
| 850 ** databases, and subjournals. |
746 ** | 851 ** |
747 ** The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction | 852 ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction |
748 ** with the [SQLITE_OPEN_CREATE] flag, which are both directly | 853 ** with the [SQLITE_OPEN_CREATE] flag, which are both directly |
749 ** analogous to the O_EXCL and O_CREAT flags of the POSIX open() | 854 ** analogous to the O_EXCL and O_CREAT flags of the POSIX open() |
750 ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the | 855 ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the |
751 ** SQLITE_OPEN_CREATE, is used to indicate that file should always | 856 ** SQLITE_OPEN_CREATE, is used to indicate that file should always |
752 ** be created, and that it is an error if it already exists. | 857 ** 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 | 858 ** It is <i>not</i> used to indicate the file should be opened |
754 ** for exclusive access. | 859 ** for exclusive access. |
755 ** | 860 ** |
756 ** At least szOsFile bytes of memory are allocated by SQLite | 861 ** ^At least szOsFile bytes of memory are allocated by SQLite |
757 ** to hold the [sqlite3_file] structure passed as the third | 862 ** to hold the [sqlite3_file] structure passed as the third |
758 ** argument to xOpen. The xOpen method does not have to | 863 ** argument to xOpen. The xOpen method does not have to |
759 ** allocate the structure; it should just fill it in. Note that | 864 ** allocate the structure; it should just fill it in. Note that |
760 ** the xOpen method must set the sqlite3_file.pMethods to either | 865 ** the xOpen method must set the sqlite3_file.pMethods to either |
761 ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do | 866 ** 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 | 867 ** 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 | 868 ** element will be valid after xOpen returns regardless of the success |
764 ** or failure of the xOpen call. | 869 ** or failure of the xOpen call. |
765 ** | 870 ** |
766 ** The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] | 871 ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] |
767 ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to | 872 ** 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] | 873 ** 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 | 874 ** to test whether a file is at least readable. The file can be a |
770 ** directory. | 875 ** directory. |
771 ** | 876 ** |
772 ** SQLite will always allocate at least mxPathname+1 bytes for the | 877 ** ^SQLite will always allocate at least mxPathname+1 bytes for the |
773 ** output buffer xFullPathname. The exact size of the output buffer | 878 ** output buffer xFullPathname. The exact size of the output buffer |
774 ** is also passed as a parameter to both methods. If the output buffer | 879 ** 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 | 880 ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is |
776 ** handled as a fatal error by SQLite, vfs implementations should endeavor | 881 ** handled as a fatal error by SQLite, vfs implementations should endeavor |
777 ** to prevent this by setting mxPathname to a sufficiently large value. | 882 ** to prevent this by setting mxPathname to a sufficiently large value. |
778 ** | 883 ** |
779 ** The xRandomness(), xSleep(), and xCurrentTime() interfaces | 884 ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() |
780 ** are not strictly a part of the filesystem, but they are | 885 ** interfaces are not strictly a part of the filesystem, but they are |
781 ** included in the VFS structure for completeness. | 886 ** included in the VFS structure for completeness. |
782 ** The xRandomness() function attempts to return nBytes bytes | 887 ** The xRandomness() function attempts to return nBytes bytes |
783 ** of good-quality randomness into zOut. The return value is | 888 ** of good-quality randomness into zOut. The return value is |
784 ** the actual number of bytes of randomness obtained. | 889 ** the actual number of bytes of randomness obtained. |
785 ** The xSleep() method causes the calling thread to sleep for at | 890 ** The xSleep() method causes the calling thread to sleep for at |
786 ** least the number of microseconds given. The xCurrentTime() | 891 ** least the number of microseconds given. ^The xCurrentTime() |
787 ** method returns a Julian Day Number for the current date and time. | 892 ** method returns a Julian Day Number for the current date and time as |
| 893 ** a floating point value. |
| 894 ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian |
| 895 ** Day Number multipled by 86400000 (the number of milliseconds in |
| 896 ** a 24-hour day). |
| 897 ** ^SQLite will use the xCurrentTimeInt64() method to get the current |
| 898 ** date and time if that method is available (if iVersion is 2 or |
| 899 ** greater and the function pointer is not NULL) and will fall back |
| 900 ** to xCurrentTime() if xCurrentTimeInt64() is unavailable. |
788 ** | 901 ** |
| 902 ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces |
| 903 ** are not used by the SQLite core. These optional interfaces are provided |
| 904 ** by some VFSes to facilitate testing of the VFS code. By overriding |
| 905 ** system calls with functions under its control, a test program can |
| 906 ** simulate faults and error conditions that would otherwise be difficult |
| 907 ** or impossible to induce. The set of system calls that can be overridden |
| 908 ** varies from one VFS to another, and from one version of the same VFS to the |
| 909 ** next. Applications that use these interfaces must be prepared for any |
| 910 ** or all of these interfaces to be NULL or for their behavior to change |
| 911 ** from one release to the next. Applications must not attempt to access |
| 912 ** any of these methods if the iVersion of the VFS is less than 3. |
789 */ | 913 */ |
790 typedef struct sqlite3_vfs sqlite3_vfs; | 914 typedef struct sqlite3_vfs sqlite3_vfs; |
| 915 typedef void (*sqlite3_syscall_ptr)(void); |
791 struct sqlite3_vfs { | 916 struct sqlite3_vfs { |
792 int iVersion; /* Structure version number */ | 917 int iVersion; /* Structure version number (currently 3) */ |
793 int szOsFile; /* Size of subclassed sqlite3_file */ | 918 int szOsFile; /* Size of subclassed sqlite3_file */ |
794 int mxPathname; /* Maximum file pathname length */ | 919 int mxPathname; /* Maximum file pathname length */ |
795 sqlite3_vfs *pNext; /* Next registered VFS */ | 920 sqlite3_vfs *pNext; /* Next registered VFS */ |
796 const char *zName; /* Name of this virtual file system */ | 921 const char *zName; /* Name of this virtual file system */ |
797 void *pAppData; /* Pointer to application-specific data */ | 922 void *pAppData; /* Pointer to application-specific data */ |
798 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, | 923 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, |
799 int flags, int *pOutFlags); | 924 int flags, int *pOutFlags); |
800 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); | 925 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); |
801 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); | 926 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); |
802 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); | 927 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); |
803 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); | 928 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); |
804 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); | 929 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); |
805 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); | 930 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); |
806 void (*xDlClose)(sqlite3_vfs*, void*); | 931 void (*xDlClose)(sqlite3_vfs*, void*); |
807 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); | 932 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); |
808 int (*xSleep)(sqlite3_vfs*, int microseconds); | 933 int (*xSleep)(sqlite3_vfs*, int microseconds); |
809 int (*xCurrentTime)(sqlite3_vfs*, double*); | 934 int (*xCurrentTime)(sqlite3_vfs*, double*); |
810 int (*xGetLastError)(sqlite3_vfs*, int, char *); | 935 int (*xGetLastError)(sqlite3_vfs*, int, char *); |
811 /* New fields may be appended in figure versions. The iVersion | 936 /* |
812 ** value will increment whenever this happens. */ | 937 ** The methods above are in version 1 of the sqlite_vfs object |
| 938 ** definition. Those that follow are added in version 2 or later |
| 939 */ |
| 940 int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*); |
| 941 /* |
| 942 ** The methods above are in versions 1 and 2 of the sqlite_vfs object. |
| 943 ** Those below are for version 3 and greater. |
| 944 */ |
| 945 int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr); |
| 946 sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName); |
| 947 const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); |
| 948 /* |
| 949 ** The methods above are in versions 1 through 3 of the sqlite_vfs object. |
| 950 ** New fields may be appended in figure versions. The iVersion |
| 951 ** value will increment whenever this happens. |
| 952 */ |
813 }; | 953 }; |
814 | 954 |
815 /* | 955 /* |
816 ** CAPI3REF: Flags for the xAccess VFS method {H11190} <H11140> | 956 ** CAPI3REF: Flags for the xAccess VFS method |
817 ** | 957 ** |
818 ** These integer constants can be used as the third parameter to | 958 ** These integer constants can be used as the third parameter to |
819 ** the xAccess method of an [sqlite3_vfs] object. {END} They determine | 959 ** the xAccess method of an [sqlite3_vfs] object. They determine |
820 ** what kind of permissions the xAccess method is looking for. | 960 ** what kind of permissions the xAccess method is looking for. |
821 ** With SQLITE_ACCESS_EXISTS, the xAccess method | 961 ** With SQLITE_ACCESS_EXISTS, the xAccess method |
822 ** simply checks whether the file exists. | 962 ** simply checks whether the file exists. |
823 ** With SQLITE_ACCESS_READWRITE, the xAccess method | 963 ** With SQLITE_ACCESS_READWRITE, the xAccess method |
824 ** checks whether the file is both readable and writable. | 964 ** checks whether the named directory is both readable and writable |
| 965 ** (in other words, if files can be added, removed, and renamed within |
| 966 ** the directory). |
| 967 ** The SQLITE_ACCESS_READWRITE constant is currently used only by the |
| 968 ** [temp_store_directory pragma], though this could change in a future |
| 969 ** release of SQLite. |
825 ** With SQLITE_ACCESS_READ, the xAccess method | 970 ** With SQLITE_ACCESS_READ, the xAccess method |
826 ** checks whether the file is readable. | 971 ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is |
| 972 ** currently unused, though it might be used in a future release of |
| 973 ** SQLite. |
827 */ | 974 */ |
828 #define SQLITE_ACCESS_EXISTS 0 | 975 #define SQLITE_ACCESS_EXISTS 0 |
829 #define SQLITE_ACCESS_READWRITE 1 | 976 #define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ |
830 #define SQLITE_ACCESS_READ 2 | 977 #define SQLITE_ACCESS_READ 2 /* Unused */ |
831 | 978 |
832 /* | 979 /* |
833 ** CAPI3REF: Initialize The SQLite Library {H10130} <S20000><S30100> | 980 ** CAPI3REF: Flags for the xShmLock VFS method |
834 ** | 981 ** |
835 ** The sqlite3_initialize() routine initializes the | 982 ** These integer constants define the various locking operations |
836 ** SQLite library. The sqlite3_shutdown() routine | 983 ** allowed by the xShmLock method of [sqlite3_io_methods]. The |
| 984 ** following are the only legal combinations of flags to the |
| 985 ** xShmLock method: |
| 986 ** |
| 987 ** <ul> |
| 988 ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED |
| 989 ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE |
| 990 ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED |
| 991 ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE |
| 992 ** </ul> |
| 993 ** |
| 994 ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as |
| 995 ** was given no the corresponding lock. |
| 996 ** |
| 997 ** The xShmLock method can transition between unlocked and SHARED or |
| 998 ** between unlocked and EXCLUSIVE. It cannot transition between SHARED |
| 999 ** and EXCLUSIVE. |
| 1000 */ |
| 1001 #define SQLITE_SHM_UNLOCK 1 |
| 1002 #define SQLITE_SHM_LOCK 2 |
| 1003 #define SQLITE_SHM_SHARED 4 |
| 1004 #define SQLITE_SHM_EXCLUSIVE 8 |
| 1005 |
| 1006 /* |
| 1007 ** CAPI3REF: Maximum xShmLock index |
| 1008 ** |
| 1009 ** The xShmLock method on [sqlite3_io_methods] may use values |
| 1010 ** between 0 and this upper bound as its "offset" argument. |
| 1011 ** The SQLite core will never attempt to acquire or release a |
| 1012 ** lock outside of this range |
| 1013 */ |
| 1014 #define SQLITE_SHM_NLOCK 8 |
| 1015 |
| 1016 |
| 1017 /* |
| 1018 ** CAPI3REF: Initialize The SQLite Library |
| 1019 ** |
| 1020 ** ^The sqlite3_initialize() routine initializes the |
| 1021 ** SQLite library. ^The sqlite3_shutdown() routine |
837 ** deallocates any resources that were allocated by sqlite3_initialize(). | 1022 ** deallocates any resources that were allocated by sqlite3_initialize(). |
| 1023 ** These routines are designed to aid in process initialization and |
| 1024 ** shutdown on embedded systems. Workstation applications using |
| 1025 ** SQLite normally do not need to invoke either of these routines. |
838 ** | 1026 ** |
839 ** A call to sqlite3_initialize() is an "effective" call if it is | 1027 ** A call to sqlite3_initialize() is an "effective" call if it is |
840 ** the first time sqlite3_initialize() is invoked during the lifetime of | 1028 ** 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 | 1029 ** the process, or if it is the first time sqlite3_initialize() is invoked |
842 ** following a call to sqlite3_shutdown(). Only an effective call | 1030 ** following a call to sqlite3_shutdown(). ^(Only an effective call |
843 ** of sqlite3_initialize() does any initialization. All other calls | 1031 ** of sqlite3_initialize() does any initialization. All other calls |
844 ** are harmless no-ops. | 1032 ** are harmless no-ops.)^ |
845 ** | 1033 ** |
846 ** A call to sqlite3_shutdown() is an "effective" call if it is the first | 1034 ** 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 | 1035 ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only |
848 ** an effective call to sqlite3_shutdown() does any deinitialization. | 1036 ** an effective call to sqlite3_shutdown() does any deinitialization. |
849 ** All other calls to sqlite3_shutdown() are harmless no-ops. | 1037 ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ |
850 ** | 1038 ** |
851 ** Among other things, sqlite3_initialize() shall invoke | 1039 ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() |
852 ** sqlite3_os_init(). Similarly, sqlite3_shutdown() | 1040 ** is not. The sqlite3_shutdown() interface must only be called from a |
853 ** shall invoke sqlite3_os_end(). | 1041 ** single thread. All open [database connections] must be closed and all |
| 1042 ** other SQLite resources must be deallocated prior to invoking |
| 1043 ** sqlite3_shutdown(). |
854 ** | 1044 ** |
855 ** The sqlite3_initialize() routine returns [SQLITE_OK] on success. | 1045 ** Among other things, ^sqlite3_initialize() will invoke |
856 ** If for some reason, sqlite3_initialize() is unable to initialize | 1046 ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() |
| 1047 ** will invoke sqlite3_os_end(). |
| 1048 ** |
| 1049 ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. |
| 1050 ** ^If for some reason, sqlite3_initialize() is unable to initialize |
857 ** the library (perhaps it is unable to allocate a needed resource such | 1051 ** 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]. | 1052 ** as a mutex) it returns an [error code] other than [SQLITE_OK]. |
859 ** | 1053 ** |
860 ** The sqlite3_initialize() routine is called internally by many other | 1054 ** ^The sqlite3_initialize() routine is called internally by many other |
861 ** SQLite interfaces so that an application usually does not need to | 1055 ** SQLite interfaces so that an application usually does not need to |
862 ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] | 1056 ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] |
863 ** calls sqlite3_initialize() so the SQLite library will be automatically | 1057 ** calls sqlite3_initialize() so the SQLite library will be automatically |
864 ** initialized when [sqlite3_open()] is called if it has not be initialized | 1058 ** initialized when [sqlite3_open()] is called if it has not be initialized |
865 ** already. However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] | 1059 ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] |
866 ** compile-time option, then the automatic calls to sqlite3_initialize() | 1060 ** compile-time option, then the automatic calls to sqlite3_initialize() |
867 ** are omitted and the application must call sqlite3_initialize() directly | 1061 ** are omitted and the application must call sqlite3_initialize() directly |
868 ** prior to using any other SQLite interface. For maximum portability, | 1062 ** prior to using any other SQLite interface. For maximum portability, |
869 ** it is recommended that applications always invoke sqlite3_initialize() | 1063 ** it is recommended that applications always invoke sqlite3_initialize() |
870 ** directly prior to using any other SQLite interface. Future releases | 1064 ** directly prior to using any other SQLite interface. Future releases |
871 ** of SQLite may require this. In other words, the behavior exhibited | 1065 ** of SQLite may require this. In other words, the behavior exhibited |
872 ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the | 1066 ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the |
873 ** default behavior in some future release of SQLite. | 1067 ** default behavior in some future release of SQLite. |
874 ** | 1068 ** |
875 ** The sqlite3_os_init() routine does operating-system specific | 1069 ** The sqlite3_os_init() routine does operating-system specific |
(...skipping 18 matching lines...) Expand all Loading... |
894 ** implementation of sqlite3_os_init() or sqlite3_os_end() | 1088 ** implementation of sqlite3_os_init() or sqlite3_os_end() |
895 ** must return [SQLITE_OK] on success and some other [error code] upon | 1089 ** must return [SQLITE_OK] on success and some other [error code] upon |
896 ** failure. | 1090 ** failure. |
897 */ | 1091 */ |
898 SQLITE_API int sqlite3_initialize(void); | 1092 SQLITE_API int sqlite3_initialize(void); |
899 SQLITE_API int sqlite3_shutdown(void); | 1093 SQLITE_API int sqlite3_shutdown(void); |
900 SQLITE_API int sqlite3_os_init(void); | 1094 SQLITE_API int sqlite3_os_init(void); |
901 SQLITE_API int sqlite3_os_end(void); | 1095 SQLITE_API int sqlite3_os_end(void); |
902 | 1096 |
903 /* | 1097 /* |
904 ** CAPI3REF: Configuring The SQLite Library {H14100} <S20000><S30200> | 1098 ** CAPI3REF: Configuring The SQLite Library |
905 ** EXPERIMENTAL | |
906 ** | 1099 ** |
907 ** The sqlite3_config() interface is used to make global configuration | 1100 ** The sqlite3_config() interface is used to make global configuration |
908 ** changes to SQLite in order to tune SQLite to the specific needs of | 1101 ** changes to SQLite in order to tune SQLite to the specific needs of |
909 ** the application. The default configuration is recommended for most | 1102 ** the application. The default configuration is recommended for most |
910 ** applications and so this routine is usually not necessary. It is | 1103 ** applications and so this routine is usually not necessary. It is |
911 ** provided to support rare applications with unusual needs. | 1104 ** provided to support rare applications with unusual needs. |
912 ** | 1105 ** |
913 ** The sqlite3_config() interface is not threadsafe. The application | 1106 ** The sqlite3_config() interface is not threadsafe. The application |
914 ** must insure that no other SQLite interfaces are invoked by other | 1107 ** must insure that no other SQLite interfaces are invoked by other |
915 ** threads while sqlite3_config() is running. Furthermore, sqlite3_config() | 1108 ** threads while sqlite3_config() is running. Furthermore, sqlite3_config() |
916 ** may only be invoked prior to library initialization using | 1109 ** may only be invoked prior to library initialization using |
917 ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. | 1110 ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. |
918 ** Note, however, that sqlite3_config() can be called as part of the | 1111 ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before |
| 1112 ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. |
| 1113 ** Note, however, that ^sqlite3_config() can be called as part of the |
919 ** implementation of an application-defined [sqlite3_os_init()]. | 1114 ** implementation of an application-defined [sqlite3_os_init()]. |
920 ** | 1115 ** |
921 ** The first argument to sqlite3_config() is an integer | 1116 ** The first argument to sqlite3_config() is an integer |
922 ** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines | 1117 ** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines |
923 ** what property of SQLite is to be configured. Subsequent arguments | 1118 ** what property of SQLite is to be configured. Subsequent arguments |
924 ** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option] | 1119 ** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option] |
925 ** in the first argument. | 1120 ** in the first argument. |
926 ** | 1121 ** |
927 ** When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. | 1122 ** ^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 | 1123 ** ^If the option is unknown or SQLite is unable to set the option |
929 ** then this routine returns a non-zero [error code]. | 1124 ** 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 */ | 1125 */ |
936 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_config(int, ...); | 1126 SQLITE_API int sqlite3_config(int, ...); |
937 | 1127 |
938 /* | 1128 /* |
939 ** CAPI3REF: Configure database connections {H14200} <S20000> | 1129 ** CAPI3REF: Configure database connections |
940 ** EXPERIMENTAL | |
941 ** | 1130 ** |
942 ** The sqlite3_db_config() interface is used to make configuration | 1131 ** The sqlite3_db_config() interface is used to make configuration |
943 ** changes to a [database connection]. The interface is similar to | 1132 ** changes to a [database connection]. The interface is similar to |
944 ** [sqlite3_config()] except that the changes apply to a single | 1133 ** [sqlite3_config()] except that the changes apply to a single |
945 ** [database connection] (specified in the first argument). The | 1134 ** [database connection] (specified in the first argument). |
946 ** sqlite3_db_config() interface can only be used immediately after | |
947 ** the database connection is created using [sqlite3_open()], | |
948 ** [sqlite3_open16()], or [sqlite3_open_v2()]. | |
949 ** | 1135 ** |
950 ** The second argument to sqlite3_db_config(D,V,...) is the | 1136 ** The second argument to sqlite3_db_config(D,V,...) is the |
951 ** configuration verb - an integer code that indicates what | 1137 ** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code |
952 ** aspect of the [database connection] is being configured. | 1138 ** that indicates what aspect of the [database connection] is being configured. |
953 ** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE]. | 1139 ** Subsequent arguments vary depending on the configuration verb. |
954 ** New verbs are likely to be added in future releases of SQLite. | |
955 ** Additional arguments depend on the verb. | |
956 ** | 1140 ** |
957 ** Requirements: | 1141 ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if |
958 ** [H14203] [H14206] [H14209] [H14212] [H14215] | 1142 ** the call is considered successful. |
959 */ | 1143 */ |
960 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_db_config(sqlite3*, int op, ...); | 1144 SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...); |
961 | 1145 |
962 /* | 1146 /* |
963 ** CAPI3REF: Memory Allocation Routines {H10155} <S20120> | 1147 ** CAPI3REF: Memory Allocation Routines |
964 ** EXPERIMENTAL | |
965 ** | 1148 ** |
966 ** An instance of this object defines the interface between SQLite | 1149 ** An instance of this object defines the interface between SQLite |
967 ** and low-level memory allocation routines. | 1150 ** and low-level memory allocation routines. |
968 ** | 1151 ** |
969 ** This object is used in only one place in the SQLite interface. | 1152 ** 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 | 1153 ** A pointer to an instance of this object is the argument to |
971 ** [sqlite3_config()] when the configuration option is | 1154 ** [sqlite3_config()] when the configuration option is |
972 ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. | 1155 ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. |
973 ** By creating an instance of this object | 1156 ** By creating an instance of this object |
974 ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) | 1157 ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) |
975 ** during configuration, an application can specify an alternative | 1158 ** during configuration, an application can specify an alternative |
976 ** memory allocation subsystem for SQLite to use for all of its | 1159 ** memory allocation subsystem for SQLite to use for all of its |
977 ** dynamic memory needs. | 1160 ** dynamic memory needs. |
978 ** | 1161 ** |
979 ** Note that SQLite comes with several [built-in memory allocators] | 1162 ** Note that SQLite comes with several [built-in memory allocators] |
980 ** that are perfectly adequate for the overwhelming majority of applications | 1163 ** that are perfectly adequate for the overwhelming majority of applications |
981 ** and that this object is only useful to a tiny minority of applications | 1164 ** and that this object is only useful to a tiny minority of applications |
982 ** with specialized memory allocation requirements. This object is | 1165 ** with specialized memory allocation requirements. This object is |
983 ** also used during testing of SQLite in order to specify an alternative | 1166 ** also used during testing of SQLite in order to specify an alternative |
984 ** memory allocator that simulates memory out-of-memory conditions in | 1167 ** memory allocator that simulates memory out-of-memory conditions in |
985 ** order to verify that SQLite recovers gracefully from such | 1168 ** order to verify that SQLite recovers gracefully from such |
986 ** conditions. | 1169 ** conditions. |
987 ** | 1170 ** |
988 ** The xMalloc and xFree methods must work like the | 1171 ** The xMalloc and xFree methods must work like the |
989 ** malloc() and free() functions from the standard C library. | 1172 ** malloc() and free() functions from the standard C library. |
990 ** The xRealloc method must work like realloc() from the standard C library | 1173 ** 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, | 1174 ** 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 | 1175 ** xRealloc must be a no-op - it must not perform any allocation or |
993 ** deallocation. SQLite guaranteeds that the second argument to | 1176 ** deallocation. ^SQLite guarantees that the second argument to |
994 ** xRealloc is always a value returned by a prior call to xRoundup. | 1177 ** xRealloc is always a value returned by a prior call to xRoundup. |
995 ** And so in cases where xRoundup always returns a positive number, | 1178 ** And so in cases where xRoundup always returns a positive number, |
996 ** xRealloc can perform exactly as the standard library realloc() and | 1179 ** xRealloc can perform exactly as the standard library realloc() and |
997 ** still be in compliance with this specification. | 1180 ** still be in compliance with this specification. |
998 ** | 1181 ** |
999 ** xSize should return the allocated size of a memory allocation | 1182 ** xSize should return the allocated size of a memory allocation |
1000 ** previously obtained from xMalloc or xRealloc. The allocated size | 1183 ** previously obtained from xMalloc or xRealloc. The allocated size |
1001 ** is always at least as big as the requested size but may be larger. | 1184 ** is always at least as big as the requested size but may be larger. |
1002 ** | 1185 ** |
1003 ** The xRoundup method returns what would be the allocated size of | 1186 ** The xRoundup method returns what would be the allocated size of |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1035 void (*xFree)(void*); /* Free a prior allocation */ | 1218 void (*xFree)(void*); /* Free a prior allocation */ |
1036 void *(*xRealloc)(void*,int); /* Resize an allocation */ | 1219 void *(*xRealloc)(void*,int); /* Resize an allocation */ |
1037 int (*xSize)(void*); /* Return the size of an allocation */ | 1220 int (*xSize)(void*); /* Return the size of an allocation */ |
1038 int (*xRoundup)(int); /* Round up request size to allocation size */ | 1221 int (*xRoundup)(int); /* Round up request size to allocation size */ |
1039 int (*xInit)(void*); /* Initialize the memory allocator */ | 1222 int (*xInit)(void*); /* Initialize the memory allocator */ |
1040 void (*xShutdown)(void*); /* Deinitialize the memory allocator */ | 1223 void (*xShutdown)(void*); /* Deinitialize the memory allocator */ |
1041 void *pAppData; /* Argument to xInit() and xShutdown() */ | 1224 void *pAppData; /* Argument to xInit() and xShutdown() */ |
1042 }; | 1225 }; |
1043 | 1226 |
1044 /* | 1227 /* |
1045 ** CAPI3REF: Configuration Options {H10160} <S20000> | 1228 ** CAPI3REF: Configuration Options |
1046 ** EXPERIMENTAL | |
1047 ** | 1229 ** |
1048 ** These constants are the available integer configuration options that | 1230 ** These constants are the available integer configuration options that |
1049 ** can be passed as the first argument to the [sqlite3_config()] interface. | 1231 ** can be passed as the first argument to the [sqlite3_config()] interface. |
1050 ** | 1232 ** |
1051 ** New configuration options may be added in future releases of SQLite. | 1233 ** New configuration options may be added in future releases of SQLite. |
1052 ** Existing configuration options might be discontinued. Applications | 1234 ** Existing configuration options might be discontinued. Applications |
1053 ** should check the return code from [sqlite3_config()] to make sure that | 1235 ** should check the return code from [sqlite3_config()] to make sure that |
1054 ** the call worked. The [sqlite3_config()] interface will return a | 1236 ** the call worked. The [sqlite3_config()] interface will return a |
1055 ** non-zero [error code] if a discontinued or unsupported configuration option | 1237 ** non-zero [error code] if a discontinued or unsupported configuration option |
1056 ** is invoked. | 1238 ** is invoked. |
1057 ** | 1239 ** |
1058 ** <dl> | 1240 ** <dl> |
1059 ** <dt>SQLITE_CONFIG_SINGLETHREAD</dt> | 1241 ** <dt>SQLITE_CONFIG_SINGLETHREAD</dt> |
1060 ** <dd>There are no arguments to this option. This option disables | 1242 ** <dd>There are no arguments to this option. ^This option sets the |
| 1243 ** [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 | 1244 ** all mutexing and puts SQLite into a mode where it can only be used |
1062 ** by a single thread.</dd> | 1245 ** by a single thread. ^If SQLite is compiled with |
| 1246 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1247 ** it is not possible to change the [threading mode] from its default |
| 1248 ** value of Single-thread and so [sqlite3_config()] will return |
| 1249 ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD |
| 1250 ** configuration option.</dd> |
1063 ** | 1251 ** |
1064 ** <dt>SQLITE_CONFIG_MULTITHREAD</dt> | 1252 ** <dt>SQLITE_CONFIG_MULTITHREAD</dt> |
1065 ** <dd>There are no arguments to this option. This option disables | 1253 ** <dd>There are no arguments to this option. ^This option sets the |
| 1254 ** [threading mode] to Multi-thread. In other words, it disables |
1066 ** mutexing on [database connection] and [prepared statement] objects. | 1255 ** mutexing on [database connection] and [prepared statement] objects. |
1067 ** The application is responsible for serializing access to | 1256 ** The application is responsible for serializing access to |
1068 ** [database connections] and [prepared statements]. But other mutexes | 1257 ** [database connections] and [prepared statements]. But other mutexes |
1069 ** are enabled so that SQLite will be safe to use in a multi-threaded | 1258 ** 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 | 1259 ** environment as long as no two threads attempt to use the same |
1071 ** [database connection] at the same time. See the [threading mode] | 1260 ** [database connection] at the same time. ^If SQLite is compiled with |
1072 ** documentation for additional information.</dd> | 1261 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1262 ** it is not possible to set the Multi-thread [threading mode] and |
| 1263 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the |
| 1264 ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> |
1073 ** | 1265 ** |
1074 ** <dt>SQLITE_CONFIG_SERIALIZED</dt> | 1266 ** <dt>SQLITE_CONFIG_SERIALIZED</dt> |
1075 ** <dd>There are no arguments to this option. This option enables | 1267 ** <dd>There are no arguments to this option. ^This option sets the |
| 1268 ** [threading mode] to Serialized. In other words, this option enables |
1076 ** all mutexes including the recursive | 1269 ** all mutexes including the recursive |
1077 ** mutexes on [database connection] and [prepared statement] objects. | 1270 ** mutexes on [database connection] and [prepared statement] objects. |
1078 ** In this mode (which is the default when SQLite is compiled with | 1271 ** In this mode (which is the default when SQLite is compiled with |
1079 ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access | 1272 ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access |
1080 ** to [database connections] and [prepared statements] so that the | 1273 ** to [database connections] and [prepared statements] so that the |
1081 ** application is free to use the same [database connection] or the | 1274 ** application is free to use the same [database connection] or the |
1082 ** same [prepared statement] in different threads at the same time. | 1275 ** same [prepared statement] in different threads at the same time. |
1083 ** See the [threading mode] documentation for additional information.</dd> | 1276 ** ^If SQLite is compiled with |
| 1277 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1278 ** it is not possible to set the Serialized [threading mode] and |
| 1279 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the |
| 1280 ** SQLITE_CONFIG_SERIALIZED configuration option.</dd> |
1084 ** | 1281 ** |
1085 ** <dt>SQLITE_CONFIG_MALLOC</dt> | 1282 ** <dt>SQLITE_CONFIG_MALLOC</dt> |
1086 ** <dd>This option takes a single argument which is a pointer to an | 1283 ** <dd> ^(This option takes a single argument which is a pointer to an |
1087 ** instance of the [sqlite3_mem_methods] structure. The argument specifies | 1284 ** instance of the [sqlite3_mem_methods] structure. The argument specifies |
1088 ** alternative low-level memory allocation routines to be used in place of | 1285 ** alternative low-level memory allocation routines to be used in place of |
1089 ** the memory allocation routines built into SQLite.</dd> | 1286 ** the memory allocation routines built into SQLite.)^ ^SQLite makes |
| 1287 ** its own private copy of the content of the [sqlite3_mem_methods] structure |
| 1288 ** before the [sqlite3_config()] call returns.</dd> |
1090 ** | 1289 ** |
1091 ** <dt>SQLITE_CONFIG_GETMALLOC</dt> | 1290 ** <dt>SQLITE_CONFIG_GETMALLOC</dt> |
1092 ** <dd>This option takes a single argument which is a pointer to an | 1291 ** <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] | 1292 ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] |
1094 ** structure is filled with the currently defined memory allocation routines. | 1293 ** structure is filled with the currently defined memory allocation routines.)^ |
1095 ** This option can be used to overload the default memory allocation | 1294 ** This option can be used to overload the default memory allocation |
1096 ** routines with a wrapper that simulations memory allocation failure or | 1295 ** routines with a wrapper that simulations memory allocation failure or |
1097 ** tracks memory usage, for example.</dd> | 1296 ** tracks memory usage, for example. </dd> |
1098 ** | 1297 ** |
1099 ** <dt>SQLITE_CONFIG_MEMSTATUS</dt> | 1298 ** <dt>SQLITE_CONFIG_MEMSTATUS</dt> |
1100 ** <dd>This option takes single argument of type int, interpreted as a | 1299 ** <dd> ^This option takes single argument of type int, interpreted as a |
1101 ** boolean, which enables or disables the collection of memory allocation | 1300 ** boolean, which enables or disables the collection of memory allocation |
1102 ** statistics. When disabled, the following SQLite interfaces become | 1301 ** statistics. ^(When memory allocation statistics are disabled, the |
1103 ** non-operational: | 1302 ** following SQLite interfaces become non-operational: |
1104 ** <ul> | 1303 ** <ul> |
1105 ** <li> [sqlite3_memory_used()] | 1304 ** <li> [sqlite3_memory_used()] |
1106 ** <li> [sqlite3_memory_highwater()] | 1305 ** <li> [sqlite3_memory_highwater()] |
1107 ** <li> [sqlite3_soft_heap_limit()] | 1306 ** <li> [sqlite3_soft_heap_limit64()] |
1108 ** <li> [sqlite3_status()] | 1307 ** <li> [sqlite3_status()] |
1109 ** </ul> | 1308 ** </ul>)^ |
| 1309 ** ^Memory allocation statistics are enabled by default unless SQLite is |
| 1310 ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory |
| 1311 ** allocation statistics are disabled by default. |
1110 ** </dd> | 1312 ** </dd> |
1111 ** | 1313 ** |
1112 ** <dt>SQLITE_CONFIG_SCRATCH</dt> | 1314 ** <dt>SQLITE_CONFIG_SCRATCH</dt> |
1113 ** <dd>This option specifies a static memory buffer that SQLite can use for | 1315 ** <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 | 1316 ** scratch memory. There are three arguments: A pointer an 8-byte |
1115 ** aligned memory buffer from which the scrach allocations will be | 1317 ** aligned memory buffer from which the scratch allocations will be |
1116 ** drawn, the size of each scratch allocation (sz), | 1318 ** drawn, the size of each scratch allocation (sz), |
1117 ** and the maximum number of scratch allocations (N). The sz | 1319 ** 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 | 1320 ** argument must be a multiple of 16. |
1119 ** larger than the actual scratch space required due to internal overhead. | 1321 ** 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. | 1322 ** of at least sz*N bytes of memory. |
1122 ** SQLite will use no more than one scratch buffer at once per thread, so | 1323 ** ^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 | 1324 ** 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. | 1325 ** ^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 | 1326 ** times the database page size. ^If SQLite needs needs additional |
1126 ** The btree balancer needs additional memory beyond what is provided by | 1327 ** scratch memory beyond what is provided by this configuration option, then |
1127 ** scratch buffers or if no scratch buffer space is specified, then SQLite | 1328 ** [sqlite3_malloc()] will be used to obtain the memory needed.</dd> |
1128 ** goes to [sqlite3_malloc()] to obtain the memory it needs.</dd> | |
1129 ** | 1329 ** |
1130 ** <dt>SQLITE_CONFIG_PAGECACHE</dt> | 1330 ** <dt>SQLITE_CONFIG_PAGECACHE</dt> |
1131 ** <dd>This option specifies a static memory buffer that SQLite can use for | 1331 ** <dd> ^This option specifies a static memory buffer that SQLite can use for |
1132 ** the database page cache with the default page cache implemenation. | 1332 ** the database page cache with the default page cache implemenation. |
1133 ** This configuration should not be used if an application-define page | 1333 ** This configuration should not be used if an application-define page |
1134 ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option. | 1334 ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option. |
1135 ** There are three arguments to this option: A pointer to 8-byte aligned | 1335 ** 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). | 1336 ** 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 | 1337 ** 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 | 1338 ** (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 | 1339 ** 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, | 1340 ** the host architecture. ^It is harmless, apart from the wasted memory, |
1141 ** to make sz a little too large. The first | 1341 ** to make sz a little too large. The first |
1142 ** argument should point to an allocation of at least sz*N bytes of memory. | 1342 ** 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 | 1343 ** ^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 | 1344 ** 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 | 1345 ** page cache memory is needed beyond what is provided by this option, then |
1146 ** SQLite goes to [sqlite3_malloc()] for the additional storage space. | 1346 ** SQLite goes to [sqlite3_malloc()] for the additional storage space. |
1147 ** The implementation might use one or more of the N buffers to hold | 1347 ** 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 | 1348 ** be aligned to an 8-byte boundary or subsequent behavior of SQLite |
1150 ** will be undefined.</dd> | 1349 ** will be undefined.</dd> |
1151 ** | 1350 ** |
1152 ** <dt>SQLITE_CONFIG_HEAP</dt> | 1351 ** <dt>SQLITE_CONFIG_HEAP</dt> |
1153 ** <dd>This option specifies a static memory buffer that SQLite will use | 1352 ** <dd> ^This option specifies a static memory buffer that SQLite will use |
1154 ** for all of its dynamic memory allocation needs beyond those provided | 1353 ** for all of its dynamic memory allocation needs beyond those provided |
1155 ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. | 1354 ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. |
1156 ** There are three arguments: An 8-byte aligned pointer to the memory, | 1355 ** 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. | 1356 ** 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 | 1357 ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts |
1159 ** to using its default memory allocator (the system malloc() implementation), | 1358 ** to using its default memory allocator (the system malloc() implementation), |
1160 ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. If the | 1359 ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the |
1161 ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or | 1360 ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or |
1162 ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory | 1361 ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory |
1163 ** allocator is engaged to handle all of SQLites memory allocation needs. | 1362 ** 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 | 1363 ** The first pointer (the memory pointer) must be aligned to an 8-byte |
1165 ** boundary or subsequent behavior of SQLite will be undefined.</dd> | 1364 ** boundary or subsequent behavior of SQLite will be undefined. |
| 1365 ** The minimum allocation size is capped at 2^12. Reasonable values |
| 1366 ** for the minimum allocation size are 2^5 through 2^8.</dd> |
1166 ** | 1367 ** |
1167 ** <dt>SQLITE_CONFIG_MUTEX</dt> | 1368 ** <dt>SQLITE_CONFIG_MUTEX</dt> |
1168 ** <dd>This option takes a single argument which is a pointer to an | 1369 ** <dd> ^(This option takes a single argument which is a pointer to an |
1169 ** instance of the [sqlite3_mutex_methods] structure. The argument specifies | 1370 ** instance of the [sqlite3_mutex_methods] structure. The argument specifies |
1170 ** alternative low-level mutex routines to be used in place | 1371 ** alternative low-level mutex routines to be used in place |
1171 ** the mutex routines built into SQLite.</dd> | 1372 ** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the |
| 1373 ** content of the [sqlite3_mutex_methods] structure before the call to |
| 1374 ** [sqlite3_config()] returns. ^If SQLite is compiled with |
| 1375 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1376 ** the entire mutexing subsystem is omitted from the build and hence calls to |
| 1377 ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will |
| 1378 ** return [SQLITE_ERROR].</dd> |
1172 ** | 1379 ** |
1173 ** <dt>SQLITE_CONFIG_GETMUTEX</dt> | 1380 ** <dt>SQLITE_CONFIG_GETMUTEX</dt> |
1174 ** <dd>This option takes a single argument which is a pointer to an | 1381 ** <dd> ^(This option takes a single argument which is a pointer to an |
1175 ** instance of the [sqlite3_mutex_methods] structure. The | 1382 ** instance of the [sqlite3_mutex_methods] structure. The |
1176 ** [sqlite3_mutex_methods] | 1383 ** [sqlite3_mutex_methods] |
1177 ** structure is filled with the currently defined mutex routines. | 1384 ** structure is filled with the currently defined mutex routines.)^ |
1178 ** This option can be used to overload the default mutex allocation | 1385 ** This option can be used to overload the default mutex allocation |
1179 ** routines with a wrapper used to track mutex usage for performance | 1386 ** routines with a wrapper used to track mutex usage for performance |
1180 ** profiling or testing, for example.</dd> | 1387 ** profiling or testing, for example. ^If SQLite is compiled with |
| 1388 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
| 1389 ** the entire mutexing subsystem is omitted from the build and hence calls to |
| 1390 ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will |
| 1391 ** return [SQLITE_ERROR].</dd> |
1181 ** | 1392 ** |
1182 ** <dt>SQLITE_CONFIG_LOOKASIDE</dt> | 1393 ** <dt>SQLITE_CONFIG_LOOKASIDE</dt> |
1183 ** <dd>This option takes two arguments that determine the default | 1394 ** <dd> ^(This option takes two arguments that determine the default |
1184 ** memory allocation lookaside optimization. The first argument is the | 1395 ** memory allocation for the lookaside memory allocator on each |
| 1396 ** [database connection]. The first argument is the |
1185 ** size of each lookaside buffer slot and the second is the number of | 1397 ** size of each lookaside buffer slot and the second is the number of |
1186 ** slots allocated to each database connection. This option sets the | 1398 ** slots allocated to each database connection.)^ ^(This option sets the |
1187 ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] | 1399 ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] |
1188 ** verb to [sqlite3_db_config()] can be used to change the lookaside | 1400 ** verb to [sqlite3_db_config()] can be used to change the lookaside |
1189 ** configuration on individual connections.</dd> | 1401 ** configuration on individual connections.)^ </dd> |
1190 ** | 1402 ** |
1191 ** <dt>SQLITE_CONFIG_PCACHE</dt> | 1403 ** <dt>SQLITE_CONFIG_PCACHE</dt> |
1192 ** <dd>This option takes a single argument which is a pointer to | 1404 ** <dd> ^(This option takes a single argument which is a pointer to |
1193 ** an [sqlite3_pcache_methods] object. This object specifies the interface | 1405 ** an [sqlite3_pcache_methods] object. This object specifies the interface |
1194 ** to a custom page cache implementation. SQLite makes a copy of the | 1406 ** to a custom page cache implementation.)^ ^SQLite makes a copy of the |
1195 ** object and uses it for page cache memory allocations.</dd> | 1407 ** object and uses it for page cache memory allocations.</dd> |
1196 ** | 1408 ** |
1197 ** <dt>SQLITE_CONFIG_GETPCACHE</dt> | 1409 ** <dt>SQLITE_CONFIG_GETPCACHE</dt> |
1198 ** <dd>This option takes a single argument which is a pointer to an | 1410 ** <dd> ^(This option takes a single argument which is a pointer to an |
1199 ** [sqlite3_pcache_methods] object. SQLite copies of the current | 1411 ** [sqlite3_pcache_methods] object. SQLite copies of the current |
1200 ** page cache implementation into that object.</dd> | 1412 ** page cache implementation into that object.)^ </dd> |
| 1413 ** |
| 1414 ** <dt>SQLITE_CONFIG_LOG</dt> |
| 1415 ** <dd> ^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a |
| 1416 ** function with a call signature of void(*)(void*,int,const char*), |
| 1417 ** and a pointer to void. ^If the function pointer is not NULL, it is |
| 1418 ** invoked by [sqlite3_log()] to process each logging event. ^If the |
| 1419 ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. |
| 1420 ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is |
| 1421 ** passed through as the first parameter to the application-defined logger |
| 1422 ** function whenever that function is invoked. ^The second parameter to |
| 1423 ** the logger function is a copy of the first parameter to the corresponding |
| 1424 ** [sqlite3_log()] call and is intended to be a [result code] or an |
| 1425 ** [extended result code]. ^The third parameter passed to the logger is |
| 1426 ** log message after formatting via [sqlite3_snprintf()]. |
| 1427 ** The SQLite logging interface is not reentrant; the logger function |
| 1428 ** supplied by the application must not invoke any SQLite interface. |
| 1429 ** In a multi-threaded application, the application-defined logger |
| 1430 ** function must be threadsafe. </dd> |
1201 ** | 1431 ** |
1202 ** </dl> | 1432 ** </dl> |
1203 */ | 1433 */ |
1204 #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ | 1434 #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ |
1205 #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ | 1435 #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ |
1206 #define SQLITE_CONFIG_SERIALIZED 3 /* nil */ | 1436 #define SQLITE_CONFIG_SERIALIZED 3 /* nil */ |
1207 #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ | 1437 #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ |
1208 #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ | 1438 #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ |
1209 #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ | 1439 #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ |
1210 #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ | 1440 #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ |
1211 #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ | 1441 #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ |
1212 #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ | 1442 #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ |
1213 #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ | 1443 #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ |
1214 #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ | 1444 #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ |
1215 /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ | 1445 /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ |
1216 #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ | 1446 #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ |
1217 #define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */ | 1447 #define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */ |
1218 #define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */ | 1448 #define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */ |
| 1449 #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ |
1219 | 1450 |
1220 /* | 1451 /* |
1221 ** CAPI3REF: Configuration Options {H10170} <S20000> | 1452 ** CAPI3REF: Database Connection Configuration Options |
1222 ** EXPERIMENTAL | |
1223 ** | 1453 ** |
1224 ** These constants are the available integer configuration options that | 1454 ** These constants are the available integer configuration options that |
1225 ** can be passed as the second argument to the [sqlite3_db_config()] interface. | 1455 ** can be passed as the second argument to the [sqlite3_db_config()] interface. |
1226 ** | 1456 ** |
1227 ** New configuration options may be added in future releases of SQLite. | 1457 ** New configuration options may be added in future releases of SQLite. |
1228 ** Existing configuration options might be discontinued. Applications | 1458 ** Existing configuration options might be discontinued. Applications |
1229 ** should check the return code from [sqlite3_db_config()] to make sure that | 1459 ** 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 | 1460 ** the call worked. ^The [sqlite3_db_config()] interface will return a |
1231 ** non-zero [error code] if a discontinued or unsupported configuration option | 1461 ** non-zero [error code] if a discontinued or unsupported configuration option |
1232 ** is invoked. | 1462 ** is invoked. |
1233 ** | 1463 ** |
1234 ** <dl> | 1464 ** <dl> |
1235 ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> | 1465 ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> |
1236 ** <dd>This option takes three additional arguments that determine the | 1466 ** <dd> ^This option takes three additional arguments that determine the |
1237 ** [lookaside memory allocator] configuration for the [database connection]. | 1467 ** [lookaside memory allocator] configuration for the [database connection]. |
1238 ** The first argument (the third parameter to [sqlite3_db_config()] is a | 1468 ** ^The first argument (the third parameter to [sqlite3_db_config()] is a |
1239 ** pointer to an memory buffer to use for lookaside memory. | 1469 ** pointer to a memory buffer to use for lookaside memory. |
1240 ** The first argument may be NULL in which case SQLite will allocate the | 1470 ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb |
1241 ** lookaside buffer itself using [sqlite3_malloc()]. The second argument is the | 1471 ** 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 | 1472 ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the |
| 1473 ** 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 | 1474 ** 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 | 1475 ** 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 | 1476 ** 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 | 1477 ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally |
1247 ** multiple of 8. See also: [SQLITE_CONFIG_LOOKASIDE]</dd> | 1478 ** rounded down to the next smaller multiple of 8. ^(The lookaside memory |
| 1479 ** configuration for a database connection can only be changed when that |
| 1480 ** connection is not currently using lookaside memory, or in other words |
| 1481 ** when the "current value" returned by |
| 1482 ** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. |
| 1483 ** Any attempt to change the lookaside memory configuration when lookaside |
| 1484 ** memory is in use leaves the configuration unchanged and returns |
| 1485 ** [SQLITE_BUSY].)^</dd> |
| 1486 ** |
| 1487 ** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> |
| 1488 ** <dd> ^This option is used to enable or disable the enforcement of |
| 1489 ** [foreign key constraints]. There should be two additional arguments. |
| 1490 ** The first argument is an integer which is 0 to disable FK enforcement, |
| 1491 ** positive to enable FK enforcement or negative to leave FK enforcement |
| 1492 ** unchanged. The second parameter is a pointer to an integer into which |
| 1493 ** is written 0 or 1 to indicate whether FK enforcement is off or on |
| 1494 ** following this call. The second parameter may be a NULL pointer, in |
| 1495 ** which case the FK enforcement setting is not reported back. </dd> |
| 1496 ** |
| 1497 ** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> |
| 1498 ** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. |
| 1499 ** There should be two additional arguments. |
| 1500 ** The first argument is an integer which is 0 to disable triggers, |
| 1501 ** positive to enable triggers or negative to leave the setting unchanged. |
| 1502 ** The second parameter is a pointer to an integer into which |
| 1503 ** is written 0 or 1 to indicate whether triggers are disabled or enabled |
| 1504 ** following this call. The second parameter may be a NULL pointer, in |
| 1505 ** which case the trigger setting is not reported back. </dd> |
1248 ** | 1506 ** |
1249 ** </dl> | 1507 ** </dl> |
1250 */ | 1508 */ |
1251 #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ | 1509 #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ |
| 1510 #define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ |
| 1511 #define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ |
1252 | 1512 |
1253 | 1513 |
1254 /* | 1514 /* |
1255 ** CAPI3REF: Enable Or Disable Extended Result Codes {H12200} <S10700> | 1515 ** CAPI3REF: Enable Or Disable Extended Result Codes |
1256 ** | 1516 ** |
1257 ** The sqlite3_extended_result_codes() routine enables or disables the | 1517 ** ^The sqlite3_extended_result_codes() routine enables or disables the |
1258 ** [extended result codes] feature of SQLite. The extended result | 1518 ** [extended result codes] feature of SQLite. ^The extended result |
1259 ** codes are disabled by default for historical compatibility considerations. | 1519 ** codes are disabled by default for historical compatibility. |
1260 ** | |
1261 ** Requirements: | |
1262 ** [H12201] [H12202] | |
1263 */ | 1520 */ |
1264 SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff); | 1521 SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff); |
1265 | 1522 |
1266 /* | 1523 /* |
1267 ** CAPI3REF: Last Insert Rowid {H12220} <S10700> | 1524 ** CAPI3REF: Last Insert Rowid |
1268 ** | 1525 ** |
1269 ** Each entry in an SQLite table has a unique 64-bit signed | 1526 ** ^Each entry in an SQLite table has a unique 64-bit signed |
1270 ** integer key called the [ROWID | "rowid"]. The rowid is always available | 1527 ** 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 | 1528 ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those |
1272 ** names are not also used by explicitly declared columns. If | 1529 ** names are not also used by explicitly declared columns. ^If |
1273 ** the table has a column of type [INTEGER PRIMARY KEY] then that column | 1530 ** the table has a column of type [INTEGER PRIMARY KEY] then that column |
1274 ** is another alias for the rowid. | 1531 ** is another alias for the rowid. |
1275 ** | 1532 ** |
1276 ** This routine returns the [rowid] of the most recent | 1533 ** ^This routine returns the [rowid] of the most recent |
1277 ** successful [INSERT] into the database from the [database connection] | 1534 ** successful [INSERT] into the database from the [database connection] |
1278 ** in the first argument. If no successful [INSERT]s | 1535 ** in the first argument. ^If no successful [INSERT]s |
1279 ** have ever occurred on that database connection, zero is returned. | 1536 ** have ever occurred on that database connection, zero is returned. |
1280 ** | 1537 ** |
1281 ** If an [INSERT] occurs within a trigger, then the [rowid] of the inserted | 1538 ** ^(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. | 1539 ** 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 | 1540 ** But once the trigger terminates, the value returned by this routine |
1284 ** reverts to the last value inserted before the trigger fired. | 1541 ** reverts to the last value inserted before the trigger fired.)^ |
1285 ** | 1542 ** |
1286 ** An [INSERT] that fails due to a constraint violation is not a | 1543 ** ^An [INSERT] that fails due to a constraint violation is not a |
1287 ** successful [INSERT] and does not change the value returned by this | 1544 ** successful [INSERT] and does not change the value returned by this |
1288 ** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, | 1545 ** 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 | 1546 ** and INSERT OR ABORT make no changes to the return value of this |
1290 ** routine when their insertion fails. When INSERT OR REPLACE | 1547 ** routine when their insertion fails. ^(When INSERT OR REPLACE |
1291 ** encounters a constraint violation, it does not fail. The | 1548 ** encounters a constraint violation, it does not fail. The |
1292 ** INSERT continues to completion after deleting rows that caused | 1549 ** INSERT continues to completion after deleting rows that caused |
1293 ** the constraint problem so INSERT OR REPLACE will always change | 1550 ** the constraint problem so INSERT OR REPLACE will always change |
1294 ** the return value of this interface. | 1551 ** the return value of this interface.)^ |
1295 ** | 1552 ** |
1296 ** For the purposes of this routine, an [INSERT] is considered to | 1553 ** ^For the purposes of this routine, an [INSERT] is considered to |
1297 ** be successful even if it is subsequently rolled back. | 1554 ** be successful even if it is subsequently rolled back. |
1298 ** | 1555 ** |
1299 ** Requirements: | 1556 ** This function is accessible to SQL statements via the |
1300 ** [H12221] [H12223] | 1557 ** [last_insert_rowid() SQL function]. |
1301 ** | 1558 ** |
1302 ** If a separate thread performs a new [INSERT] on the same | 1559 ** If a separate thread performs a new [INSERT] on the same |
1303 ** database connection while the [sqlite3_last_insert_rowid()] | 1560 ** database connection while the [sqlite3_last_insert_rowid()] |
1304 ** function is running and thus changes the last insert [rowid], | 1561 ** function is running and thus changes the last insert [rowid], |
1305 ** then the value returned by [sqlite3_last_insert_rowid()] is | 1562 ** then the value returned by [sqlite3_last_insert_rowid()] is |
1306 ** unpredictable and might not equal either the old or the new | 1563 ** unpredictable and might not equal either the old or the new |
1307 ** last insert [rowid]. | 1564 ** last insert [rowid]. |
1308 */ | 1565 */ |
1309 SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); | 1566 SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); |
1310 | 1567 |
1311 /* | 1568 /* |
1312 ** CAPI3REF: Count The Number Of Rows Modified {H12240} <S10600> | 1569 ** CAPI3REF: Count The Number Of Rows Modified |
1313 ** | 1570 ** |
1314 ** This function returns the number of database rows that were changed | 1571 ** ^This function returns the number of database rows that were changed |
1315 ** or inserted or deleted by the most recently completed SQL statement | 1572 ** or inserted or deleted by the most recently completed SQL statement |
1316 ** on the [database connection] specified by the first parameter. | 1573 ** on the [database connection] specified by the first parameter. |
1317 ** Only changes that are directly specified by the [INSERT], [UPDATE], | 1574 ** ^(Only changes that are directly specified by the [INSERT], [UPDATE], |
1318 ** or [DELETE] statement are counted. Auxiliary changes caused by | 1575 ** or [DELETE] statement are counted. Auxiliary changes caused by |
1319 ** triggers are not counted. Use the [sqlite3_total_changes()] function | 1576 ** triggers or [foreign key actions] are not counted.)^ Use the |
1320 ** to find the total number of changes including changes caused by triggers. | 1577 ** [sqlite3_total_changes()] function to find the total number of changes |
| 1578 ** including changes caused by triggers and foreign key actions. |
1321 ** | 1579 ** |
1322 ** Changes to a view that are simulated by an [INSTEAD OF trigger] | 1580 ** ^Changes to a view that are simulated by an [INSTEAD OF trigger] |
1323 ** are not counted. Only real table changes are counted. | 1581 ** are not counted. Only real table changes are counted. |
1324 ** | 1582 ** |
1325 ** A "row change" is a change to a single row of a single table | 1583 ** ^(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 | 1584 ** caused by an INSERT, DELETE, or UPDATE statement. Rows that |
1327 ** are changed as side effects of [REPLACE] constraint resolution, | 1585 ** are changed as side effects of [REPLACE] constraint resolution, |
1328 ** rollback, ABORT processing, [DROP TABLE], or by any other | 1586 ** rollback, ABORT processing, [DROP TABLE], or by any other |
1329 ** mechanisms do not count as direct row changes. | 1587 ** mechanisms do not count as direct row changes.)^ |
1330 ** | 1588 ** |
1331 ** A "trigger context" is a scope of execution that begins and | 1589 ** A "trigger context" is a scope of execution that begins and |
1332 ** ends with the script of a [CREATE TRIGGER | trigger]. | 1590 ** ends with the script of a [CREATE TRIGGER | trigger]. |
1333 ** Most SQL statements are | 1591 ** Most SQL statements are |
1334 ** evaluated outside of any trigger. This is the "top level" | 1592 ** evaluated outside of any trigger. This is the "top level" |
1335 ** trigger context. If a trigger fires from the top level, a | 1593 ** trigger context. If a trigger fires from the top level, a |
1336 ** new trigger context is entered for the duration of that one | 1594 ** new trigger context is entered for the duration of that one |
1337 ** trigger. Subtriggers create subcontexts for their duration. | 1595 ** trigger. Subtriggers create subcontexts for their duration. |
1338 ** | 1596 ** |
1339 ** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does | 1597 ** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does |
1340 ** not create a new trigger context. | 1598 ** not create a new trigger context. |
1341 ** | 1599 ** |
1342 ** This function returns the number of direct row changes in the | 1600 ** ^This function returns the number of direct row changes in the |
1343 ** most recent INSERT, UPDATE, or DELETE statement within the same | 1601 ** most recent INSERT, UPDATE, or DELETE statement within the same |
1344 ** trigger context. | 1602 ** trigger context. |
1345 ** | 1603 ** |
1346 ** Thus, when called from the top level, this function returns the | 1604 ** ^Thus, when called from the top level, this function returns the |
1347 ** number of changes in the most recent INSERT, UPDATE, or DELETE | 1605 ** 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, | 1606 ** 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 | 1607 ** the sqlite3_changes() interface can be called to find the number of |
1350 ** changes in the most recently completed INSERT, UPDATE, or DELETE | 1608 ** changes in the most recently completed INSERT, UPDATE, or DELETE |
1351 ** statement within the body of the same trigger. | 1609 ** statement within the body of the same trigger. |
1352 ** However, the number returned does not include changes | 1610 ** However, the number returned does not include changes |
1353 ** caused by subtriggers since those have their own context. | 1611 ** caused by subtriggers since those have their own context.)^ |
1354 ** | 1612 ** |
1355 ** See also the [sqlite3_total_changes()] interface and the | 1613 ** See also the [sqlite3_total_changes()] interface, the |
1356 ** [count_changes pragma]. | 1614 ** [count_changes pragma], and the [changes() SQL function]. |
1357 ** | |
1358 ** Requirements: | |
1359 ** [H12241] [H12243] | |
1360 ** | 1615 ** |
1361 ** If a separate thread makes changes on the same database connection | 1616 ** If a separate thread makes changes on the same database connection |
1362 ** while [sqlite3_changes()] is running then the value returned | 1617 ** while [sqlite3_changes()] is running then the value returned |
1363 ** is unpredictable and not meaningful. | 1618 ** is unpredictable and not meaningful. |
1364 */ | 1619 */ |
1365 SQLITE_API int sqlite3_changes(sqlite3*); | 1620 SQLITE_API int sqlite3_changes(sqlite3*); |
1366 | 1621 |
1367 /* | 1622 /* |
1368 ** CAPI3REF: Total Number Of Rows Modified {H12260} <S10600> | 1623 ** CAPI3REF: Total Number Of Rows Modified |
1369 ** | 1624 ** |
1370 ** This function returns the number of row changes caused by [INSERT], | 1625 ** ^This function returns the number of row changes caused by [INSERT], |
1371 ** [UPDATE] or [DELETE] statements since the [database connection] was opened. | 1626 ** [UPDATE] or [DELETE] statements since the [database connection] was opened. |
1372 ** The count includes all changes from all | 1627 ** ^(The count returned by sqlite3_total_changes() includes all changes |
1373 ** [CREATE TRIGGER | trigger] contexts. However, | 1628 ** from all [CREATE TRIGGER | trigger] contexts and changes made by |
| 1629 ** [foreign key actions]. However, |
1374 ** the count does not include changes used to implement [REPLACE] constraints, | 1630 ** the count does not include changes used to implement [REPLACE] constraints, |
1375 ** do rollbacks or ABORT processing, or [DROP TABLE] processing. The | 1631 ** do rollbacks or ABORT processing, or [DROP TABLE] processing. The |
1376 ** count does not include rows of views that fire an [INSTEAD OF trigger], | 1632 ** 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 | 1633 ** though if the INSTEAD OF trigger makes changes of its own, those changes |
1378 ** are counted. | 1634 ** are counted.)^ |
1379 ** The changes are counted as soon as the statement that makes them is | 1635 ** ^The sqlite3_total_changes() function counts the changes as soon as |
1380 ** completed (when the statement handle is passed to [sqlite3_reset()] or | 1636 ** the statement that makes them is completed (when the statement handle |
1381 ** [sqlite3_finalize()]). | 1637 ** is passed to [sqlite3_reset()] or [sqlite3_finalize()]). |
1382 ** | 1638 ** |
1383 ** See also the [sqlite3_changes()] interface and the | 1639 ** See also the [sqlite3_changes()] interface, the |
1384 ** [count_changes pragma]. | 1640 ** [count_changes pragma], and the [total_changes() SQL function]. |
1385 ** | |
1386 ** Requirements: | |
1387 ** [H12261] [H12263] | |
1388 ** | 1641 ** |
1389 ** If a separate thread makes changes on the same database connection | 1642 ** If a separate thread makes changes on the same database connection |
1390 ** while [sqlite3_total_changes()] is running then the value | 1643 ** while [sqlite3_total_changes()] is running then the value |
1391 ** returned is unpredictable and not meaningful. | 1644 ** returned is unpredictable and not meaningful. |
1392 */ | 1645 */ |
1393 SQLITE_API int sqlite3_total_changes(sqlite3*); | 1646 SQLITE_API int sqlite3_total_changes(sqlite3*); |
1394 | 1647 |
1395 /* | 1648 /* |
1396 ** CAPI3REF: Interrupt A Long-Running Query {H12270} <S30500> | 1649 ** CAPI3REF: Interrupt A Long-Running Query |
1397 ** | 1650 ** |
1398 ** This function causes any pending database operation to abort and | 1651 ** ^This function causes any pending database operation to abort and |
1399 ** return at its earliest opportunity. This routine is typically | 1652 ** return at its earliest opportunity. This routine is typically |
1400 ** called in response to a user action such as pressing "Cancel" | 1653 ** 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 | 1654 ** or Ctrl-C where the user wants a long query operation to halt |
1402 ** immediately. | 1655 ** immediately. |
1403 ** | 1656 ** |
1404 ** It is safe to call this routine from a thread different from the | 1657 ** ^It is safe to call this routine from a thread different from the |
1405 ** thread that is currently running the database operation. But it | 1658 ** thread that is currently running the database operation. But it |
1406 ** is not safe to call this routine with a [database connection] that | 1659 ** is not safe to call this routine with a [database connection] that |
1407 ** is closed or might close before sqlite3_interrupt() returns. | 1660 ** is closed or might close before sqlite3_interrupt() returns. |
1408 ** | 1661 ** |
1409 ** If an SQL operation is very nearly finished at the time when | 1662 ** ^If an SQL operation is very nearly finished at the time when |
1410 ** sqlite3_interrupt() is called, then it might not have an opportunity | 1663 ** sqlite3_interrupt() is called, then it might not have an opportunity |
1411 ** to be interrupted and might continue to completion. | 1664 ** to be interrupted and might continue to completion. |
1412 ** | 1665 ** |
1413 ** An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. | 1666 ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. |
1414 ** If the interrupted SQL operation is an INSERT, UPDATE, or DELETE | 1667 ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE |
1415 ** that is inside an explicit transaction, then the entire transaction | 1668 ** that is inside an explicit transaction, then the entire transaction |
1416 ** will be rolled back automatically. | 1669 ** will be rolled back automatically. |
1417 ** | 1670 ** |
1418 ** The sqlite3_interrupt(D) call is in effect until all currently running | 1671 ** ^The sqlite3_interrupt(D) call is in effect until all currently running |
1419 ** SQL statements on [database connection] D complete. Any new SQL statements | 1672 ** SQL statements on [database connection] D complete. ^Any new SQL statements |
1420 ** that are started after the sqlite3_interrupt() call and before the | 1673 ** that are started after the sqlite3_interrupt() call and before the |
1421 ** running statements reaches zero are interrupted as if they had been | 1674 ** running statements reaches zero are interrupted as if they had been |
1422 ** running prior to the sqlite3_interrupt() call. New SQL statements | 1675 ** running prior to the sqlite3_interrupt() call. ^New SQL statements |
1423 ** that are started after the running statement count reaches zero are | 1676 ** that are started after the running statement count reaches zero are |
1424 ** not effected by the sqlite3_interrupt(). | 1677 ** not effected by the sqlite3_interrupt(). |
1425 ** A call to sqlite3_interrupt(D) that occurs when there are no running | 1678 ** ^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 | 1679 ** SQL statements is a no-op and has no effect on SQL statements |
1427 ** that are started after the sqlite3_interrupt() call returns. | 1680 ** that are started after the sqlite3_interrupt() call returns. |
1428 ** | 1681 ** |
1429 ** Requirements: | |
1430 ** [H12271] [H12272] | |
1431 ** | |
1432 ** If the database connection closes while [sqlite3_interrupt()] | 1682 ** If the database connection closes while [sqlite3_interrupt()] |
1433 ** is running then bad things will likely happen. | 1683 ** is running then bad things will likely happen. |
1434 */ | 1684 */ |
1435 SQLITE_API void sqlite3_interrupt(sqlite3*); | 1685 SQLITE_API void sqlite3_interrupt(sqlite3*); |
1436 | 1686 |
1437 /* | 1687 /* |
1438 ** CAPI3REF: Determine If An SQL Statement Is Complete {H10510} <S70200> | 1688 ** CAPI3REF: Determine If An SQL Statement Is Complete |
1439 ** | 1689 ** |
1440 ** These routines are useful during command-line input to determine if the | 1690 ** These routines are useful during command-line input to determine if the |
1441 ** currently entered text seems to form a complete SQL statement or | 1691 ** currently entered text seems to form a complete SQL statement or |
1442 ** if additional input is needed before sending the text into | 1692 ** if additional input is needed before sending the text into |
1443 ** SQLite for parsing. These routines return 1 if the input string | 1693 ** 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 | 1694 ** 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 | 1695 ** 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 | 1696 ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within |
1447 ** string literals or quoted identifier names or comments are not | 1697 ** string literals or quoted identifier names or comments are not |
1448 ** independent tokens (they are part of the token in which they are | 1698 ** independent tokens (they are part of the token in which they are |
1449 ** embedded) and thus do not count as a statement terminator. Whitespace | 1699 ** embedded) and thus do not count as a statement terminator. ^Whitespace |
1450 ** and comments that follow the final semicolon are ignored. | 1700 ** and comments that follow the final semicolon are ignored. |
1451 ** | 1701 ** |
1452 ** These routines return 0 if the statement is incomplete. If a | 1702 ** ^These routines return 0 if the statement is incomplete. ^If a |
1453 ** memory allocation fails, then SQLITE_NOMEM is returned. | 1703 ** memory allocation fails, then SQLITE_NOMEM is returned. |
1454 ** | 1704 ** |
1455 ** These routines do not parse the SQL statements thus | 1705 ** ^These routines do not parse the SQL statements thus |
1456 ** will not detect syntactically incorrect SQL. | 1706 ** will not detect syntactically incorrect SQL. |
1457 ** | 1707 ** |
1458 ** If SQLite has not been initialized using [sqlite3_initialize()] prior | 1708 ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior |
1459 ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked | 1709 ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked |
1460 ** automatically by sqlite3_complete16(). If that initialization fails, | 1710 ** automatically by sqlite3_complete16(). If that initialization fails, |
1461 ** then the return value from sqlite3_complete16() will be non-zero | 1711 ** then the return value from sqlite3_complete16() will be non-zero |
1462 ** regardless of whether or not the input SQL is complete. | 1712 ** regardless of whether or not the input SQL is complete.)^ |
1463 ** | |
1464 ** Requirements: [H10511] [H10512] | |
1465 ** | 1713 ** |
1466 ** The input to [sqlite3_complete()] must be a zero-terminated | 1714 ** The input to [sqlite3_complete()] must be a zero-terminated |
1467 ** UTF-8 string. | 1715 ** UTF-8 string. |
1468 ** | 1716 ** |
1469 ** The input to [sqlite3_complete16()] must be a zero-terminated | 1717 ** The input to [sqlite3_complete16()] must be a zero-terminated |
1470 ** UTF-16 string in native byte order. | 1718 ** UTF-16 string in native byte order. |
1471 */ | 1719 */ |
1472 SQLITE_API int sqlite3_complete(const char *sql); | 1720 SQLITE_API int sqlite3_complete(const char *sql); |
1473 SQLITE_API int sqlite3_complete16(const void *sql); | 1721 SQLITE_API int sqlite3_complete16(const void *sql); |
1474 | 1722 |
1475 /* | 1723 /* |
1476 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {H12310} <S40400> | 1724 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors |
1477 ** | 1725 ** |
1478 ** This routine sets a callback function that might be invoked whenever | 1726 ** ^This routine sets a callback function that might be invoked whenever |
1479 ** an attempt is made to open a database table that another thread | 1727 ** an attempt is made to open a database table that another thread |
1480 ** or process has locked. | 1728 ** or process has locked. |
1481 ** | 1729 ** |
1482 ** If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] | 1730 ** ^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 | 1731 ** is returned immediately upon encountering the lock. ^If the busy callback |
1484 ** is not NULL, then the callback will be invoked with two arguments. | 1732 ** is not NULL, then the callback might be invoked with two arguments. |
1485 ** | 1733 ** |
1486 ** The first argument to the handler is a copy of the void* pointer which | 1734 ** ^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 | 1735 ** 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 | 1736 ** the busy handler callback is the number of times that the busy handler has |
1489 ** been invoked for this locking event. If the | 1737 ** been invoked for this locking event. ^If the |
1490 ** busy callback returns 0, then no additional attempts are made to | 1738 ** busy callback returns 0, then no additional attempts are made to |
1491 ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. | 1739 ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. |
1492 ** If the callback returns non-zero, then another attempt | 1740 ** ^If the callback returns non-zero, then another attempt |
1493 ** is made to open the database for reading and the cycle repeats. | 1741 ** is made to open the database for reading and the cycle repeats. |
1494 ** | 1742 ** |
1495 ** The presence of a busy handler does not guarantee that it will be invoked | 1743 ** 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 | 1744 ** 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] | 1745 ** 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. | 1746 ** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. |
1499 ** Consider a scenario where one process is holding a read lock that | 1747 ** Consider a scenario where one process is holding a read lock that |
1500 ** it is trying to promote to a reserved lock and | 1748 ** it is trying to promote to a reserved lock and |
1501 ** a second process is holding a reserved lock that it is trying | 1749 ** a second process is holding a reserved lock that it is trying |
1502 ** to promote to an exclusive lock. The first process cannot proceed | 1750 ** to promote to an exclusive lock. The first process cannot proceed |
1503 ** because it is blocked by the second and the second process cannot | 1751 ** because it is blocked by the second and the second process cannot |
1504 ** proceed because it is blocked by the first. If both processes | 1752 ** proceed because it is blocked by the first. If both processes |
1505 ** invoke the busy handlers, neither will make any progress. Therefore, | 1753 ** invoke the busy handlers, neither will make any progress. Therefore, |
1506 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this | 1754 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this |
1507 ** will induce the first process to release its read lock and allow | 1755 ** will induce the first process to release its read lock and allow |
1508 ** the second process to proceed. | 1756 ** the second process to proceed. |
1509 ** | 1757 ** |
1510 ** The default busy callback is NULL. | 1758 ** ^The default busy callback is NULL. |
1511 ** | 1759 ** |
1512 ** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] | 1760 ** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] |
1513 ** when SQLite is in the middle of a large transaction where all the | 1761 ** 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 | 1762 ** changes will not fit into the in-memory cache. SQLite will |
1515 ** already hold a RESERVED lock on the database file, but it needs | 1763 ** 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 | 1764 ** to promote this lock to EXCLUSIVE so that it can spill cache |
1517 ** pages into the database file without harm to concurrent | 1765 ** pages into the database file without harm to concurrent |
1518 ** readers. If it is unable to promote the lock, then the in-memory | 1766 ** 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 | 1767 ** cache will be left in an inconsistent state and so the error |
1520 ** code is promoted from the relatively benign [SQLITE_BUSY] to | 1768 ** code is promoted from the relatively benign [SQLITE_BUSY] to |
1521 ** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion | 1769 ** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion |
1522 ** forces an automatic rollback of the changes. See the | 1770 ** forces an automatic rollback of the changes. See the |
1523 ** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> | 1771 ** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> |
1524 ** CorruptionFollowingBusyError</a> wiki page for a discussion of why | 1772 ** CorruptionFollowingBusyError</a> wiki page for a discussion of why |
1525 ** this is important. | 1773 ** this is important. |
1526 ** | 1774 ** |
1527 ** There can only be a single busy handler defined for each | 1775 ** ^(There can only be a single busy handler defined for each |
1528 ** [database connection]. Setting a new busy handler clears any | 1776 ** [database connection]. Setting a new busy handler clears any |
1529 ** previously set handler. Note that calling [sqlite3_busy_timeout()] | 1777 ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] |
1530 ** will also set or clear the busy handler. | 1778 ** will also set or clear the busy handler. |
1531 ** | 1779 ** |
1532 ** The busy callback should not take any actions which modify the | 1780 ** The busy callback should not take any actions which modify the |
1533 ** database connection that invoked the busy handler. Any such actions | 1781 ** database connection that invoked the busy handler. Any such actions |
1534 ** result in undefined behavior. | 1782 ** result in undefined behavior. |
1535 ** | 1783 ** |
1536 ** Requirements: | |
1537 ** [H12311] [H12312] [H12314] [H12316] [H12318] | |
1538 ** | |
1539 ** A busy handler must not close the database connection | 1784 ** A busy handler must not close the database connection |
1540 ** or [prepared statement] that invoked the busy handler. | 1785 ** or [prepared statement] that invoked the busy handler. |
1541 */ | 1786 */ |
1542 SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); | 1787 SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); |
1543 | 1788 |
1544 /* | 1789 /* |
1545 ** CAPI3REF: Set A Busy Timeout {H12340} <S40410> | 1790 ** CAPI3REF: Set A Busy Timeout |
1546 ** | 1791 ** |
1547 ** This routine sets a [sqlite3_busy_handler | busy handler] that sleeps | 1792 ** ^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 | 1793 ** 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 | 1794 ** will sleep multiple times until at least "ms" milliseconds of sleeping |
1550 ** have accumulated. {H12343} After "ms" milliseconds of sleeping, | 1795 ** have accumulated. ^After at least "ms" milliseconds of sleeping, |
1551 ** the handler returns 0 which causes [sqlite3_step()] to return | 1796 ** the handler returns 0 which causes [sqlite3_step()] to return |
1552 ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. | 1797 ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. |
1553 ** | 1798 ** |
1554 ** Calling this routine with an argument less than or equal to zero | 1799 ** ^Calling this routine with an argument less than or equal to zero |
1555 ** turns off all busy handlers. | 1800 ** turns off all busy handlers. |
1556 ** | 1801 ** |
1557 ** There can only be a single busy handler for a particular | 1802 ** ^(There can only be a single busy handler for a particular |
1558 ** [database connection] any any given moment. If another busy handler | 1803 ** [database connection] any any given moment. If another busy handler |
1559 ** was defined (using [sqlite3_busy_handler()]) prior to calling | 1804 ** was defined (using [sqlite3_busy_handler()]) prior to calling |
1560 ** this routine, that other busy handler is cleared. | 1805 ** this routine, that other busy handler is cleared.)^ |
1561 ** | |
1562 ** Requirements: | |
1563 ** [H12341] [H12343] [H12344] | |
1564 */ | 1806 */ |
1565 SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); | 1807 SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); |
1566 | 1808 |
1567 /* | 1809 /* |
1568 ** CAPI3REF: Convenience Routines For Running Queries {H12370} <S10000> | 1810 ** CAPI3REF: Convenience Routines For Running Queries |
| 1811 ** |
| 1812 ** This is a legacy interface that is preserved for backwards compatibility. |
| 1813 ** Use of this interface is not recommended. |
1569 ** | 1814 ** |
1570 ** Definition: A <b>result table</b> is memory data structure created by the | 1815 ** Definition: A <b>result table</b> is memory data structure created by the |
1571 ** [sqlite3_get_table()] interface. A result table records the | 1816 ** [sqlite3_get_table()] interface. A result table records the |
1572 ** complete query results from one or more queries. | 1817 ** complete query results from one or more queries. |
1573 ** | 1818 ** |
1574 ** The table conceptually has a number of rows and columns. But | 1819 ** The table conceptually has a number of rows and columns. But |
1575 ** these numbers are not part of the result table itself. These | 1820 ** these numbers are not part of the result table itself. These |
1576 ** numbers are obtained separately. Let N be the number of rows | 1821 ** numbers are obtained separately. Let N be the number of rows |
1577 ** and M be the number of columns. | 1822 ** and M be the number of columns. |
1578 ** | 1823 ** |
1579 ** A result table is an array of pointers to zero-terminated UTF-8 strings. | 1824 ** 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 | 1825 ** 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. | 1826 ** to zero-terminated strings that contain the names of the columns. |
1582 ** The remaining entries all point to query results. NULL values result | 1827 ** 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 | 1828 ** in NULL pointers. All other values are in their UTF-8 zero-terminated |
1584 ** string representation as returned by [sqlite3_column_text()]. | 1829 ** string representation as returned by [sqlite3_column_text()]. |
1585 ** | 1830 ** |
1586 ** A result table might consist of one or more memory allocations. | 1831 ** 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()]. | 1832 ** It is not safe to pass a result table directly to [sqlite3_free()]. |
1588 ** A result table should be deallocated using [sqlite3_free_table()]. | 1833 ** A result table should be deallocated using [sqlite3_free_table()]. |
1589 ** | 1834 ** |
1590 ** As an example of the result table format, suppose a query result | 1835 ** ^(As an example of the result table format, suppose a query result |
1591 ** is as follows: | 1836 ** is as follows: |
1592 ** | 1837 ** |
1593 ** <blockquote><pre> | 1838 ** <blockquote><pre> |
1594 ** Name | Age | 1839 ** Name | Age |
1595 ** ----------------------- | 1840 ** ----------------------- |
1596 ** Alice | 43 | 1841 ** Alice | 43 |
1597 ** Bob | 28 | 1842 ** Bob | 28 |
1598 ** Cindy | 21 | 1843 ** Cindy | 21 |
1599 ** </pre></blockquote> | 1844 ** </pre></blockquote> |
1600 ** | 1845 ** |
1601 ** There are two column (M==2) and three rows (N==3). Thus the | 1846 ** 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 | 1847 ** result table has 8 entries. Suppose the result table is stored |
1603 ** in an array names azResult. Then azResult holds this content: | 1848 ** in an array names azResult. Then azResult holds this content: |
1604 ** | 1849 ** |
1605 ** <blockquote><pre> | 1850 ** <blockquote><pre> |
1606 ** azResult[0] = "Name"; | 1851 ** azResult[0] = "Name"; |
1607 ** azResult[1] = "Age"; | 1852 ** azResult[1] = "Age"; |
1608 ** azResult[2] = "Alice"; | 1853 ** azResult[2] = "Alice"; |
1609 ** azResult[3] = "43"; | 1854 ** azResult[3] = "43"; |
1610 ** azResult[4] = "Bob"; | 1855 ** azResult[4] = "Bob"; |
1611 ** azResult[5] = "28"; | 1856 ** azResult[5] = "28"; |
1612 ** azResult[6] = "Cindy"; | 1857 ** azResult[6] = "Cindy"; |
1613 ** azResult[7] = "21"; | 1858 ** azResult[7] = "21"; |
1614 ** </pre></blockquote> | 1859 ** </pre></blockquote>)^ |
1615 ** | 1860 ** |
1616 ** The sqlite3_get_table() function evaluates one or more | 1861 ** ^The sqlite3_get_table() function evaluates one or more |
1617 ** semicolon-separated SQL statements in the zero-terminated UTF-8 | 1862 ** semicolon-separated SQL statements in the zero-terminated UTF-8 |
1618 ** string of its 2nd parameter. It returns a result table to the | 1863 ** string of its 2nd parameter and returns a result table to the |
1619 ** pointer given in its 3rd parameter. | 1864 ** pointer given in its 3rd parameter. |
1620 ** | 1865 ** |
1621 ** After the calling function has finished using the result, it should | 1866 ** 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 | 1867 ** 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 | 1868 ** release the memory that was malloced. Because of the way the |
1624 ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling | 1869 ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling |
1625 ** function must not try to call [sqlite3_free()] directly. Only | 1870 ** function must not try to call [sqlite3_free()] directly. Only |
1626 ** [sqlite3_free_table()] is able to release the memory properly and safely. | 1871 ** [sqlite3_free_table()] is able to release the memory properly and safely. |
1627 ** | 1872 ** |
1628 ** The sqlite3_get_table() interface is implemented as a wrapper around | 1873 ** The sqlite3_get_table() interface is implemented as a wrapper around |
1629 ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access | 1874 ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access |
1630 ** to any internal data structures of SQLite. It uses only the public | 1875 ** to any internal data structures of SQLite. It uses only the public |
1631 ** interface defined here. As a consequence, errors that occur in the | 1876 ** interface defined here. As a consequence, errors that occur in the |
1632 ** wrapper layer outside of the internal [sqlite3_exec()] call are not | 1877 ** wrapper layer outside of the internal [sqlite3_exec()] call are not |
1633 ** reflected in subsequent calls to [sqlite3_errcode()] or [sqlite3_errmsg()]. | 1878 ** reflected in subsequent calls to [sqlite3_errcode()] or |
1634 ** | 1879 ** [sqlite3_errmsg()]. |
1635 ** Requirements: | |
1636 ** [H12371] [H12373] [H12374] [H12376] [H12379] [H12382] | |
1637 */ | 1880 */ |
1638 SQLITE_API int sqlite3_get_table( | 1881 SQLITE_API int sqlite3_get_table( |
1639 sqlite3 *db, /* An open database */ | 1882 sqlite3 *db, /* An open database */ |
1640 const char *zSql, /* SQL to be evaluated */ | 1883 const char *zSql, /* SQL to be evaluated */ |
1641 char ***pazResult, /* Results of the query */ | 1884 char ***pazResult, /* Results of the query */ |
1642 int *pnRow, /* Number of result rows written here */ | 1885 int *pnRow, /* Number of result rows written here */ |
1643 int *pnColumn, /* Number of result columns written here */ | 1886 int *pnColumn, /* Number of result columns written here */ |
1644 char **pzErrmsg /* Error msg written here */ | 1887 char **pzErrmsg /* Error msg written here */ |
1645 ); | 1888 ); |
1646 SQLITE_API void sqlite3_free_table(char **result); | 1889 SQLITE_API void sqlite3_free_table(char **result); |
1647 | 1890 |
1648 /* | 1891 /* |
1649 ** CAPI3REF: Formatted String Printing Functions {H17400} <S70000><S20000> | 1892 ** CAPI3REF: Formatted String Printing Functions |
1650 ** | 1893 ** |
1651 ** These routines are work-alikes of the "printf()" family of functions | 1894 ** These routines are work-alikes of the "printf()" family of functions |
1652 ** from the standard C library. | 1895 ** from the standard C library. |
1653 ** | 1896 ** |
1654 ** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their | 1897 ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their |
1655 ** results into memory obtained from [sqlite3_malloc()]. | 1898 ** results into memory obtained from [sqlite3_malloc()]. |
1656 ** The strings returned by these two routines should be | 1899 ** The strings returned by these two routines should be |
1657 ** released by [sqlite3_free()]. Both routines return a | 1900 ** released by [sqlite3_free()]. ^Both routines return a |
1658 ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough | 1901 ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough |
1659 ** memory to hold the resulting string. | 1902 ** memory to hold the resulting string. |
1660 ** | 1903 ** |
1661 ** In sqlite3_snprintf() routine is similar to "snprintf()" from | 1904 ** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from |
1662 ** the standard C library. The result is written into the | 1905 ** the standard C library. The result is written into the |
1663 ** buffer supplied as the second parameter whose size is given by | 1906 ** buffer supplied as the second parameter whose size is given by |
1664 ** the first parameter. Note that the order of the | 1907 ** the first parameter. Note that the order of the |
1665 ** first two parameters is reversed from snprintf(). This is an | 1908 ** first two parameters is reversed from snprintf().)^ This is an |
1666 ** historical accident that cannot be fixed without breaking | 1909 ** historical accident that cannot be fixed without breaking |
1667 ** backwards compatibility. Note also that sqlite3_snprintf() | 1910 ** backwards compatibility. ^(Note also that sqlite3_snprintf() |
1668 ** returns a pointer to its buffer instead of the number of | 1911 ** returns a pointer to its buffer instead of the number of |
1669 ** characters actually written into the buffer. We admit that | 1912 ** characters actually written into the buffer.)^ We admit that |
1670 ** the number of characters written would be a more useful return | 1913 ** the number of characters written would be a more useful return |
1671 ** value but we cannot change the implementation of sqlite3_snprintf() | 1914 ** value but we cannot change the implementation of sqlite3_snprintf() |
1672 ** now without breaking compatibility. | 1915 ** now without breaking compatibility. |
1673 ** | 1916 ** |
1674 ** As long as the buffer size is greater than zero, sqlite3_snprintf() | 1917 ** ^As long as the buffer size is greater than zero, sqlite3_snprintf() |
1675 ** guarantees that the buffer is always zero-terminated. The first | 1918 ** guarantees that the buffer is always zero-terminated. ^The first |
1676 ** parameter "n" is the total size of the buffer, including space for | 1919 ** parameter "n" is the total size of the buffer, including space for |
1677 ** the zero terminator. So the longest string that can be completely | 1920 ** the zero terminator. So the longest string that can be completely |
1678 ** written will be n-1 characters. | 1921 ** written will be n-1 characters. |
1679 ** | 1922 ** |
| 1923 ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). |
| 1924 ** |
1680 ** These routines all implement some additional formatting | 1925 ** These routines all implement some additional formatting |
1681 ** options that are useful for constructing SQL statements. | 1926 ** options that are useful for constructing SQL statements. |
1682 ** All of the usual printf() formatting options apply. In addition, there | 1927 ** All of the usual printf() formatting options apply. In addition, there |
1683 ** is are "%q", "%Q", and "%z" options. | 1928 ** is are "%q", "%Q", and "%z" options. |
1684 ** | 1929 ** |
1685 ** The %q option works like %s in that it substitutes a null-terminated | 1930 ** ^(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. | 1931 ** string from the argument list. But %q also doubles every '\'' character. |
1687 ** %q is designed for use inside a string literal. By doubling each '\'' | 1932 ** %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 | 1933 ** character it escapes that character and allows it to be inserted into |
1689 ** the string. | 1934 ** the string. |
1690 ** | 1935 ** |
1691 ** For example, assume the string variable zText contains text as follows: | 1936 ** For example, assume the string variable zText contains text as follows: |
1692 ** | 1937 ** |
1693 ** <blockquote><pre> | 1938 ** <blockquote><pre> |
1694 ** char *zText = "It's a happy day!"; | 1939 ** char *zText = "It's a happy day!"; |
1695 ** </pre></blockquote> | 1940 ** </pre></blockquote> |
1696 ** | 1941 ** |
1697 ** One can use this text in an SQL statement as follows: | 1942 ** One can use this text in an SQL statement as follows: |
(...skipping 14 matching lines...) Expand all Loading... |
1712 ** This is correct. Had we used %s instead of %q, the generated SQL | 1957 ** This is correct. Had we used %s instead of %q, the generated SQL |
1713 ** would have looked like this: | 1958 ** would have looked like this: |
1714 ** | 1959 ** |
1715 ** <blockquote><pre> | 1960 ** <blockquote><pre> |
1716 ** INSERT INTO table1 VALUES('It's a happy day!'); | 1961 ** INSERT INTO table1 VALUES('It's a happy day!'); |
1717 ** </pre></blockquote> | 1962 ** </pre></blockquote> |
1718 ** | 1963 ** |
1719 ** This second example is an SQL syntax error. As a general rule you should | 1964 ** 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. | 1965 ** always use %q instead of %s when inserting text into a string literal. |
1721 ** | 1966 ** |
1722 ** The %Q option works like %q except it also adds single quotes around | 1967 ** ^(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 | 1968 ** 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 | 1969 ** 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: | 1970 ** single quotes).)^ So, for example, one could say: |
1726 ** | 1971 ** |
1727 ** <blockquote><pre> | 1972 ** <blockquote><pre> |
1728 ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); | 1973 ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); |
1729 ** sqlite3_exec(db, zSQL, 0, 0, 0); | 1974 ** sqlite3_exec(db, zSQL, 0, 0, 0); |
1730 ** sqlite3_free(zSQL); | 1975 ** sqlite3_free(zSQL); |
1731 ** </pre></blockquote> | 1976 ** </pre></blockquote> |
1732 ** | 1977 ** |
1733 ** The code above will render a correct SQL statement in the zSQL | 1978 ** The code above will render a correct SQL statement in the zSQL |
1734 ** variable even if the zText variable is a NULL pointer. | 1979 ** variable even if the zText variable is a NULL pointer. |
1735 ** | 1980 ** |
1736 ** The "%z" formatting option works exactly like "%s" with the | 1981 ** ^(The "%z" formatting option works like "%s" but with the |
1737 ** addition that after the string has been read and copied into | 1982 ** addition that after the string has been read and copied into |
1738 ** the result, [sqlite3_free()] is called on the input string. {END} | 1983 ** the result, [sqlite3_free()] is called on the input string.)^ |
1739 ** | |
1740 ** Requirements: | |
1741 ** [H17403] [H17406] [H17407] | |
1742 */ | 1984 */ |
1743 SQLITE_API char *sqlite3_mprintf(const char*,...); | 1985 SQLITE_API char *sqlite3_mprintf(const char*,...); |
1744 SQLITE_API char *sqlite3_vmprintf(const char*, va_list); | 1986 SQLITE_API char *sqlite3_vmprintf(const char*, va_list); |
1745 SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...); | 1987 SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...); |
| 1988 SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list); |
1746 | 1989 |
1747 /* | 1990 /* |
1748 ** CAPI3REF: Memory Allocation Subsystem {H17300} <S20000> | 1991 ** CAPI3REF: Memory Allocation Subsystem |
1749 ** | 1992 ** |
1750 ** The SQLite core uses these three routines for all of its own | 1993 ** The SQLite core uses these three routines for all of its own |
1751 ** internal memory allocation needs. "Core" in the previous sentence | 1994 ** internal memory allocation needs. "Core" in the previous sentence |
1752 ** does not include operating-system specific VFS implementation. The | 1995 ** does not include operating-system specific VFS implementation. The |
1753 ** Windows VFS uses native malloc() and free() for some operations. | 1996 ** Windows VFS uses native malloc() and free() for some operations. |
1754 ** | 1997 ** |
1755 ** The sqlite3_malloc() routine returns a pointer to a block | 1998 ** ^The sqlite3_malloc() routine returns a pointer to a block |
1756 ** of memory at least N bytes in length, where N is the parameter. | 1999 ** of memory at least N bytes in length, where N is the parameter. |
1757 ** If sqlite3_malloc() is unable to obtain sufficient free | 2000 ** ^If sqlite3_malloc() is unable to obtain sufficient free |
1758 ** memory, it returns a NULL pointer. If the parameter N to | 2001 ** memory, it returns a NULL pointer. ^If the parameter N to |
1759 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns | 2002 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns |
1760 ** a NULL pointer. | 2003 ** a NULL pointer. |
1761 ** | 2004 ** |
1762 ** Calling sqlite3_free() with a pointer previously returned | 2005 ** ^Calling sqlite3_free() with a pointer previously returned |
1763 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so | 2006 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so |
1764 ** that it might be reused. The sqlite3_free() routine is | 2007 ** 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 | 2008 ** a no-op if is called with a NULL pointer. Passing a NULL pointer |
1766 ** to sqlite3_free() is harmless. After being freed, memory | 2009 ** to sqlite3_free() is harmless. After being freed, memory |
1767 ** should neither be read nor written. Even reading previously freed | 2010 ** should neither be read nor written. Even reading previously freed |
1768 ** memory might result in a segmentation fault or other severe error. | 2011 ** memory might result in a segmentation fault or other severe error. |
1769 ** Memory corruption, a segmentation fault, or other severe error | 2012 ** Memory corruption, a segmentation fault, or other severe error |
1770 ** might result if sqlite3_free() is called with a non-NULL pointer that | 2013 ** might result if sqlite3_free() is called with a non-NULL pointer that |
1771 ** was not obtained from sqlite3_malloc() or sqlite3_realloc(). | 2014 ** was not obtained from sqlite3_malloc() or sqlite3_realloc(). |
1772 ** | 2015 ** |
1773 ** The sqlite3_realloc() interface attempts to resize a | 2016 ** ^(The sqlite3_realloc() interface attempts to resize a |
1774 ** prior memory allocation to be at least N bytes, where N is the | 2017 ** 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 | 2018 ** second parameter. The memory allocation to be resized is the first |
1776 ** parameter. If the first parameter to sqlite3_realloc() | 2019 ** parameter.)^ ^ If the first parameter to sqlite3_realloc() |
1777 ** is a NULL pointer then its behavior is identical to calling | 2020 ** is a NULL pointer then its behavior is identical to calling |
1778 ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). | 2021 ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). |
1779 ** If the second parameter to sqlite3_realloc() is zero or | 2022 ** ^If the second parameter to sqlite3_realloc() is zero or |
1780 ** negative then the behavior is exactly the same as calling | 2023 ** negative then the behavior is exactly the same as calling |
1781 ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). | 2024 ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). |
1782 ** sqlite3_realloc() returns a pointer to a memory allocation | 2025 ** ^sqlite3_realloc() returns a pointer to a memory allocation |
1783 ** of at least N bytes in size or NULL if sufficient memory is unavailable. | 2026 ** 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 | 2027 ** ^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 | 2028 ** of the prior allocation are copied into the beginning of buffer returned |
1786 ** by sqlite3_realloc() and the prior allocation is freed. | 2029 ** by sqlite3_realloc() and the prior allocation is freed. |
1787 ** If sqlite3_realloc() returns NULL, then the prior allocation | 2030 ** ^If sqlite3_realloc() returns NULL, then the prior allocation |
1788 ** is not freed. | 2031 ** is not freed. |
1789 ** | 2032 ** |
1790 ** The memory returned by sqlite3_malloc() and sqlite3_realloc() | 2033 ** ^The memory returned by sqlite3_malloc() and sqlite3_realloc() |
1791 ** is always aligned to at least an 8 byte boundary. {END} | 2034 ** is always aligned to at least an 8 byte boundary, or to a |
1792 ** | 2035 ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time |
1793 ** The default implementation of the memory allocation subsystem uses | 2036 ** 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 ** | 2037 ** |
1802 ** In SQLite version 3.5.0 and 3.5.1, it was possible to define | 2038 ** 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 | 2039 ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in |
1804 ** implementation of these routines to be omitted. That capability | 2040 ** implementation of these routines to be omitted. That capability |
1805 ** is no longer provided. Only built-in memory allocators can be used. | 2041 ** is no longer provided. Only built-in memory allocators can be used. |
1806 ** | 2042 ** |
1807 ** The Windows OS interface layer calls | 2043 ** The Windows OS interface layer calls |
1808 ** the system malloc() and free() directly when converting | 2044 ** the system malloc() and free() directly when converting |
1809 ** filenames between the UTF-8 encoding used by SQLite | 2045 ** filenames between the UTF-8 encoding used by SQLite |
1810 ** and whatever filename encoding is used by the particular Windows | 2046 ** and whatever filename encoding is used by the particular Windows |
1811 ** installation. Memory allocation errors are detected, but | 2047 ** installation. Memory allocation errors are detected, but |
1812 ** they are reported back as [SQLITE_CANTOPEN] or | 2048 ** they are reported back as [SQLITE_CANTOPEN] or |
1813 ** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. | 2049 ** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. |
1814 ** | 2050 ** |
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()] | 2051 ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] |
1820 ** must be either NULL or else pointers obtained from a prior | 2052 ** must be either NULL or else pointers obtained from a prior |
1821 ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have | 2053 ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have |
1822 ** not yet been released. | 2054 ** not yet been released. |
1823 ** | 2055 ** |
1824 ** The application must not read or write any part of | 2056 ** The application must not read or write any part of |
1825 ** a block of memory after it has been released using | 2057 ** a block of memory after it has been released using |
1826 ** [sqlite3_free()] or [sqlite3_realloc()]. | 2058 ** [sqlite3_free()] or [sqlite3_realloc()]. |
1827 */ | 2059 */ |
1828 SQLITE_API void *sqlite3_malloc(int); | 2060 SQLITE_API void *sqlite3_malloc(int); |
1829 SQLITE_API void *sqlite3_realloc(void*, int); | 2061 SQLITE_API void *sqlite3_realloc(void*, int); |
1830 SQLITE_API void sqlite3_free(void*); | 2062 SQLITE_API void sqlite3_free(void*); |
1831 | 2063 |
1832 /* | 2064 /* |
1833 ** CAPI3REF: Memory Allocator Statistics {H17370} <S30210> | 2065 ** CAPI3REF: Memory Allocator Statistics |
1834 ** | 2066 ** |
1835 ** SQLite provides these two interfaces for reporting on the status | 2067 ** SQLite provides these two interfaces for reporting on the status |
1836 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] | 2068 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] |
1837 ** routines, which form the built-in memory allocation subsystem. | 2069 ** routines, which form the built-in memory allocation subsystem. |
1838 ** | 2070 ** |
1839 ** Requirements: | 2071 ** ^The [sqlite3_memory_used()] routine returns the number of bytes |
1840 ** [H17371] [H17373] [H17374] [H17375] | 2072 ** of memory currently outstanding (malloced but not freed). |
| 2073 ** ^The [sqlite3_memory_highwater()] routine returns the maximum |
| 2074 ** value of [sqlite3_memory_used()] since the high-water mark |
| 2075 ** was last reset. ^The values returned by [sqlite3_memory_used()] and |
| 2076 ** [sqlite3_memory_highwater()] include any overhead |
| 2077 ** added by SQLite in its implementation of [sqlite3_malloc()], |
| 2078 ** but not overhead added by the any underlying system library |
| 2079 ** routines that [sqlite3_malloc()] may call. |
| 2080 ** |
| 2081 ** ^The memory high-water mark is reset to the current value of |
| 2082 ** [sqlite3_memory_used()] if and only if the parameter to |
| 2083 ** [sqlite3_memory_highwater()] is true. ^The value returned |
| 2084 ** by [sqlite3_memory_highwater(1)] is the high-water mark |
| 2085 ** prior to the reset. |
1841 */ | 2086 */ |
1842 SQLITE_API sqlite3_int64 sqlite3_memory_used(void); | 2087 SQLITE_API sqlite3_int64 sqlite3_memory_used(void); |
1843 SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag); | 2088 SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag); |
1844 | 2089 |
1845 /* | 2090 /* |
1846 ** CAPI3REF: Pseudo-Random Number Generator {H17390} <S20000> | 2091 ** CAPI3REF: Pseudo-Random Number Generator |
1847 ** | 2092 ** |
1848 ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to | 2093 ** 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 | 2094 ** 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 | 2095 ** already uses the largest possible [ROWID]. The PRNG is also used for |
1851 ** the build-in random() and randomblob() SQL functions. This interface allows | 2096 ** the build-in random() and randomblob() SQL functions. This interface allows |
1852 ** applications to access the same PRNG for other purposes. | 2097 ** applications to access the same PRNG for other purposes. |
1853 ** | 2098 ** |
1854 ** A call to this routine stores N bytes of randomness into buffer P. | 2099 ** ^A call to this routine stores N bytes of randomness into buffer P. |
1855 ** | 2100 ** |
1856 ** The first time this routine is invoked (either internally or by | 2101 ** ^The first time this routine is invoked (either internally or by |
1857 ** the application) the PRNG is seeded using randomness obtained | 2102 ** the application) the PRNG is seeded using randomness obtained |
1858 ** from the xRandomness method of the default [sqlite3_vfs] object. | 2103 ** from the xRandomness method of the default [sqlite3_vfs] object. |
1859 ** On all subsequent invocations, the pseudo-randomness is generated | 2104 ** ^On all subsequent invocations, the pseudo-randomness is generated |
1860 ** internally and without recourse to the [sqlite3_vfs] xRandomness | 2105 ** internally and without recourse to the [sqlite3_vfs] xRandomness |
1861 ** method. | 2106 ** method. |
1862 ** | |
1863 ** Requirements: | |
1864 ** [H17392] | |
1865 */ | 2107 */ |
1866 SQLITE_API void sqlite3_randomness(int N, void *P); | 2108 SQLITE_API void sqlite3_randomness(int N, void *P); |
1867 | 2109 |
1868 /* | 2110 /* |
1869 ** CAPI3REF: Compile-Time Authorization Callbacks {H12500} <S70100> | 2111 ** CAPI3REF: Compile-Time Authorization Callbacks |
1870 ** | 2112 ** |
1871 ** This routine registers a authorizer callback with a particular | 2113 ** ^This routine registers an authorizer callback with a particular |
1872 ** [database connection], supplied in the first argument. | 2114 ** [database connection], supplied in the first argument. |
1873 ** The authorizer callback is invoked as SQL statements are being compiled | 2115 ** ^The authorizer callback is invoked as SQL statements are being compiled |
1874 ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], | 2116 ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], |
1875 ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various | 2117 ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various |
1876 ** points during the compilation process, as logic is being created | 2118 ** points during the compilation process, as logic is being created |
1877 ** to perform various actions, the authorizer callback is invoked to | 2119 ** to perform various actions, the authorizer callback is invoked to |
1878 ** see if those actions are allowed. The authorizer callback should | 2120 ** see if those actions are allowed. ^The authorizer callback should |
1879 ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the | 2121 ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the |
1880 ** specific action but allow the SQL statement to continue to be | 2122 ** specific action but allow the SQL statement to continue to be |
1881 ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be | 2123 ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be |
1882 ** rejected with an error. If the authorizer callback returns | 2124 ** rejected with an error. ^If the authorizer callback returns |
1883 ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] | 2125 ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] |
1884 ** then the [sqlite3_prepare_v2()] or equivalent call that triggered | 2126 ** then the [sqlite3_prepare_v2()] or equivalent call that triggered |
1885 ** the authorizer will fail with an error message. | 2127 ** the authorizer will fail with an error message. |
1886 ** | 2128 ** |
1887 ** When the callback returns [SQLITE_OK], that means the operation | 2129 ** When the callback returns [SQLITE_OK], that means the operation |
1888 ** requested is ok. When the callback returns [SQLITE_DENY], the | 2130 ** requested is ok. ^When the callback returns [SQLITE_DENY], the |
1889 ** [sqlite3_prepare_v2()] or equivalent call that triggered the | 2131 ** [sqlite3_prepare_v2()] or equivalent call that triggered the |
1890 ** authorizer will fail with an error message explaining that | 2132 ** authorizer will fail with an error message explaining that |
1891 ** access is denied. | 2133 ** access is denied. |
1892 ** | 2134 ** |
1893 ** The first parameter to the authorizer callback is a copy of the third | 2135 ** ^The first parameter to the authorizer callback is a copy of the third |
1894 ** parameter to the sqlite3_set_authorizer() interface. The second parameter | 2136 ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter |
1895 ** to the callback is an integer [SQLITE_COPY | action code] that specifies | 2137 ** to the callback is an integer [SQLITE_COPY | action code] that specifies |
1896 ** the particular action to be authorized. The third through sixth parameters | 2138 ** the particular action to be authorized. ^The third through sixth parameters |
1897 ** to the callback are zero-terminated strings that contain additional | 2139 ** to the callback are zero-terminated strings that contain additional |
1898 ** details about the action to be authorized. | 2140 ** details about the action to be authorized. |
1899 ** | 2141 ** |
1900 ** If the action code is [SQLITE_READ] | 2142 ** ^If the action code is [SQLITE_READ] |
1901 ** and the callback returns [SQLITE_IGNORE] then the | 2143 ** and the callback returns [SQLITE_IGNORE] then the |
1902 ** [prepared statement] statement is constructed to substitute | 2144 ** [prepared statement] statement is constructed to substitute |
1903 ** a NULL value in place of the table column that would have | 2145 ** a NULL value in place of the table column that would have |
1904 ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] | 2146 ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] |
1905 ** return can be used to deny an untrusted user access to individual | 2147 ** return can be used to deny an untrusted user access to individual |
1906 ** columns of a table. | 2148 ** columns of a table. |
1907 ** If the action code is [SQLITE_DELETE] and the callback returns | 2149 ** ^If the action code is [SQLITE_DELETE] and the callback returns |
1908 ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the | 2150 ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the |
1909 ** [truncate optimization] is disabled and all rows are deleted individually. | 2151 ** [truncate optimization] is disabled and all rows are deleted individually. |
1910 ** | 2152 ** |
1911 ** An authorizer is used when [sqlite3_prepare | preparing] | 2153 ** An authorizer is used when [sqlite3_prepare | preparing] |
1912 ** SQL statements from an untrusted source, to ensure that the SQL statements | 2154 ** 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 | 2155 ** 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 | 2156 ** try to execute malicious statements that damage the database. For |
1915 ** example, an application may allow a user to enter arbitrary | 2157 ** example, an application may allow a user to enter arbitrary |
1916 ** SQL queries for evaluation by a database. But the application does | 2158 ** 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 | 2159 ** 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 | 2160 ** database. An authorizer could then be put in place while the |
1919 ** user-entered SQL is being [sqlite3_prepare | prepared] that | 2161 ** user-entered SQL is being [sqlite3_prepare | prepared] that |
1920 ** disallows everything except [SELECT] statements. | 2162 ** disallows everything except [SELECT] statements. |
1921 ** | 2163 ** |
1922 ** Applications that need to process SQL from untrusted sources | 2164 ** Applications that need to process SQL from untrusted sources |
1923 ** might also consider lowering resource limits using [sqlite3_limit()] | 2165 ** might also consider lowering resource limits using [sqlite3_limit()] |
1924 ** and limiting database size using the [max_page_count] [PRAGMA] | 2166 ** and limiting database size using the [max_page_count] [PRAGMA] |
1925 ** in addition to using an authorizer. | 2167 ** in addition to using an authorizer. |
1926 ** | 2168 ** |
1927 ** Only a single authorizer can be in place on a database connection | 2169 ** ^(Only a single authorizer can be in place on a database connection |
1928 ** at a time. Each call to sqlite3_set_authorizer overrides the | 2170 ** at a time. Each call to sqlite3_set_authorizer overrides the |
1929 ** previous call. Disable the authorizer by installing a NULL callback. | 2171 ** previous call.)^ ^Disable the authorizer by installing a NULL callback. |
1930 ** The authorizer is disabled by default. | 2172 ** The authorizer is disabled by default. |
1931 ** | 2173 ** |
1932 ** The authorizer callback must not do anything that will modify | 2174 ** The authorizer callback must not do anything that will modify |
1933 ** the database connection that invoked the authorizer callback. | 2175 ** the database connection that invoked the authorizer callback. |
1934 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their | 2176 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
1935 ** database connections for the meaning of "modify" in this paragraph. | 2177 ** database connections for the meaning of "modify" in this paragraph. |
1936 ** | 2178 ** |
1937 ** When [sqlite3_prepare_v2()] is used to prepare a statement, the | 2179 ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the |
1938 ** statement might be re-prepared during [sqlite3_step()] due to a | 2180 ** statement might be re-prepared during [sqlite3_step()] due to a |
1939 ** schema change. Hence, the application should ensure that the | 2181 ** schema change. Hence, the application should ensure that the |
1940 ** correct authorizer callback remains in place during the [sqlite3_step()]. | 2182 ** correct authorizer callback remains in place during the [sqlite3_step()]. |
1941 ** | 2183 ** |
1942 ** Note that the authorizer callback is invoked only during | 2184 ** ^Note that the authorizer callback is invoked only during |
1943 ** [sqlite3_prepare()] or its variants. Authorization is not | 2185 ** [sqlite3_prepare()] or its variants. Authorization is not |
1944 ** performed during statement evaluation in [sqlite3_step()], unless | 2186 ** performed during statement evaluation in [sqlite3_step()], unless |
1945 ** as stated in the previous paragraph, sqlite3_step() invokes | 2187 ** as stated in the previous paragraph, sqlite3_step() invokes |
1946 ** sqlite3_prepare_v2() to reprepare a statement after a schema change. | 2188 ** 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 */ | 2189 */ |
1952 SQLITE_API int sqlite3_set_authorizer( | 2190 SQLITE_API int sqlite3_set_authorizer( |
1953 sqlite3*, | 2191 sqlite3*, |
1954 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), | 2192 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), |
1955 void *pUserData | 2193 void *pUserData |
1956 ); | 2194 ); |
1957 | 2195 |
1958 /* | 2196 /* |
1959 ** CAPI3REF: Authorizer Return Codes {H12590} <H12500> | 2197 ** CAPI3REF: Authorizer Return Codes |
1960 ** | 2198 ** |
1961 ** The [sqlite3_set_authorizer | authorizer callback function] must | 2199 ** The [sqlite3_set_authorizer | authorizer callback function] must |
1962 ** return either [SQLITE_OK] or one of these two constants in order | 2200 ** 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 | 2201 ** to signal SQLite whether or not the action is permitted. See the |
1964 ** [sqlite3_set_authorizer | authorizer documentation] for additional | 2202 ** [sqlite3_set_authorizer | authorizer documentation] for additional |
1965 ** information. | 2203 ** information. |
1966 */ | 2204 */ |
1967 #define SQLITE_DENY 1 /* Abort the SQL statement with an error */ | 2205 #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 */ | 2206 #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ |
1969 | 2207 |
1970 /* | 2208 /* |
1971 ** CAPI3REF: Authorizer Action Codes {H12550} <H12500> | 2209 ** CAPI3REF: Authorizer Action Codes |
1972 ** | 2210 ** |
1973 ** The [sqlite3_set_authorizer()] interface registers a callback function | 2211 ** The [sqlite3_set_authorizer()] interface registers a callback function |
1974 ** that is invoked to authorize certain SQL statement actions. The | 2212 ** that is invoked to authorize certain SQL statement actions. The |
1975 ** second parameter to the callback is an integer code that specifies | 2213 ** second parameter to the callback is an integer code that specifies |
1976 ** what action is being authorized. These are the integer action codes that | 2214 ** what action is being authorized. These are the integer action codes that |
1977 ** the authorizer callback may be passed. | 2215 ** the authorizer callback may be passed. |
1978 ** | 2216 ** |
1979 ** These action code values signify what kind of operation is to be | 2217 ** These action code values signify what kind of operation is to be |
1980 ** authorized. The 3rd and 4th parameters to the authorization | 2218 ** authorized. The 3rd and 4th parameters to the authorization |
1981 ** callback function will be parameters or NULL depending on which of these | 2219 ** 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 | 2220 ** codes is used as the second parameter. ^(The 5th parameter to the |
1983 ** authorizer callback is the name of the database ("main", "temp", | 2221 ** authorizer callback is the name of the database ("main", "temp", |
1984 ** etc.) if applicable. The 6th parameter to the authorizer callback | 2222 ** 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 | 2223 ** 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 | 2224 ** the access attempt or NULL if this access attempt is directly from |
1987 ** top-level SQL code. | 2225 ** top-level SQL code. |
1988 ** | |
1989 ** Requirements: | |
1990 ** [H12551] [H12552] [H12553] [H12554] | |
1991 */ | 2226 */ |
1992 /******************************************* 3rd ************ 4th ***********/ | 2227 /******************************************* 3rd ************ 4th ***********/ |
1993 #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ | 2228 #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ |
1994 #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ | 2229 #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ |
1995 #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ | 2230 #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ |
1996 #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ | 2231 #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ |
1997 #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ | 2232 #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ |
1998 #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ | 2233 #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ |
1999 #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ | 2234 #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ |
2000 #define SQLITE_CREATE_VIEW 8 /* View Name NULL */ | 2235 #define SQLITE_CREATE_VIEW 8 /* View Name NULL */ |
(...skipping 17 matching lines...) Expand all Loading... |
2018 #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ | 2253 #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ |
2019 #define SQLITE_REINDEX 27 /* Index Name NULL */ | 2254 #define SQLITE_REINDEX 27 /* Index Name NULL */ |
2020 #define SQLITE_ANALYZE 28 /* Table Name NULL */ | 2255 #define SQLITE_ANALYZE 28 /* Table Name NULL */ |
2021 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ | 2256 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ |
2022 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ | 2257 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ |
2023 #define SQLITE_FUNCTION 31 /* NULL Function Name */ | 2258 #define SQLITE_FUNCTION 31 /* NULL Function Name */ |
2024 #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ | 2259 #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ |
2025 #define SQLITE_COPY 0 /* No longer used */ | 2260 #define SQLITE_COPY 0 /* No longer used */ |
2026 | 2261 |
2027 /* | 2262 /* |
2028 ** CAPI3REF: Tracing And Profiling Functions {H12280} <S60400> | 2263 ** CAPI3REF: Tracing And Profiling Functions |
2029 ** EXPERIMENTAL | |
2030 ** | 2264 ** |
2031 ** These routines register callback functions that can be used for | 2265 ** These routines register callback functions that can be used for |
2032 ** tracing and profiling the execution of SQL statements. | 2266 ** tracing and profiling the execution of SQL statements. |
2033 ** | 2267 ** |
2034 ** The callback function registered by sqlite3_trace() is invoked at | 2268 ** ^The callback function registered by sqlite3_trace() is invoked at |
2035 ** various times when an SQL statement is being run by [sqlite3_step()]. | 2269 ** 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 | 2270 ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the |
2037 ** as the statement first begins executing. Additional callbacks occur | 2271 ** SQL statement text as the statement first begins executing. |
| 2272 ** ^(Additional sqlite3_trace() callbacks might occur |
2038 ** as each triggered subprogram is entered. The callbacks for triggers | 2273 ** as each triggered subprogram is entered. The callbacks for triggers |
2039 ** contain a UTF-8 SQL comment that identifies the trigger. | 2274 ** contain a UTF-8 SQL comment that identifies the trigger.)^ |
2040 ** | 2275 ** |
2041 ** The callback function registered by sqlite3_profile() is invoked | 2276 ** ^The callback function registered by sqlite3_profile() is invoked |
2042 ** as each SQL statement finishes. The profile callback contains | 2277 ** as each SQL statement finishes. ^The profile callback contains |
2043 ** the original statement text and an estimate of wall-clock time | 2278 ** the original statement text and an estimate of wall-clock time |
2044 ** of how long that statement took to run. | 2279 ** of how long that statement took to run. ^The profile callback |
2045 ** | 2280 ** time is in units of nanoseconds, however the current implementation |
2046 ** Requirements: | 2281 ** is only capable of millisecond resolution so the six least significant |
2047 ** [H12281] [H12282] [H12283] [H12284] [H12285] [H12287] [H12288] [H12289] | 2282 ** digits in the time are meaningless. Future versions of SQLite |
2048 ** [H12290] | 2283 ** might provide greater resolution on the profiler callback. The |
| 2284 ** sqlite3_profile() function is considered experimental and is |
| 2285 ** subject to change in future versions of SQLite. |
2049 */ | 2286 */ |
2050 SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_trace(sqlite3*, void(*xTrace)(void*
,const char*), void*); | 2287 SQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*
); |
2051 SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, | 2288 SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, |
2052 void(*xProfile)(void*,const char*,sqlite3_uint64), void*); | 2289 void(*xProfile)(void*,const char*,sqlite3_uint64), void*); |
2053 | 2290 |
2054 /* | 2291 /* |
2055 ** CAPI3REF: Query Progress Callbacks {H12910} <S60400> | 2292 ** CAPI3REF: Query Progress Callbacks |
2056 ** | 2293 ** |
2057 ** This routine configures a callback function - the | 2294 ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback |
2058 ** progress callback - that is invoked periodically during long | 2295 ** function X to be invoked periodically during long running calls to |
2059 ** running calls to [sqlite3_exec()], [sqlite3_step()] and | 2296 ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for |
2060 ** [sqlite3_get_table()]. An example use for this | 2297 ** database connection D. An example use for this |
2061 ** interface is to keep a GUI updated during a large query. | 2298 ** interface is to keep a GUI updated during a large query. |
2062 ** | 2299 ** |
2063 ** If the progress callback returns non-zero, the operation is | 2300 ** ^The parameter P is passed through as the only parameter to the |
| 2301 ** callback function X. ^The parameter N is the number of |
| 2302 ** [virtual machine instructions] that are evaluated between successive |
| 2303 ** invocations of the callback X. |
| 2304 ** |
| 2305 ** ^Only a single progress handler may be defined at one time per |
| 2306 ** [database connection]; setting a new progress handler cancels the |
| 2307 ** old one. ^Setting parameter X to NULL disables the progress handler. |
| 2308 ** ^The progress handler is also disabled by setting N to a value less |
| 2309 ** than 1. |
| 2310 ** |
| 2311 ** ^If the progress callback returns non-zero, the operation is |
2064 ** interrupted. This feature can be used to implement a | 2312 ** interrupted. This feature can be used to implement a |
2065 ** "Cancel" button on a GUI progress dialog box. | 2313 ** "Cancel" button on a GUI progress dialog box. |
2066 ** | 2314 ** |
2067 ** The progress handler must not do anything that will modify | 2315 ** The progress handler callback must not do anything that will modify |
2068 ** the database connection that invoked the progress handler. | 2316 ** the database connection that invoked the progress handler. |
2069 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their | 2317 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
2070 ** database connections for the meaning of "modify" in this paragraph. | 2318 ** database connections for the meaning of "modify" in this paragraph. |
2071 ** | 2319 ** |
2072 ** Requirements: | |
2073 ** [H12911] [H12912] [H12913] [H12914] [H12915] [H12916] [H12917] [H12918] | |
2074 ** | |
2075 */ | 2320 */ |
2076 SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); | 2321 SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); |
2077 | 2322 |
2078 /* | 2323 /* |
2079 ** CAPI3REF: Opening A New Database Connection {H12700} <S40200> | 2324 ** CAPI3REF: Opening A New Database Connection |
2080 ** | 2325 ** |
2081 ** These routines open an SQLite database file whose name is given by the | 2326 ** ^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 | 2327 ** 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 | 2328 ** 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 | 2329 ** order for sqlite3_open16(). ^(A [database connection] handle is usually |
2085 ** returned in *ppDb, even if an error occurs. The only exception is that | 2330 ** 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, | 2331 ** 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] | 2332 ** 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 | 2333 ** object.)^ ^(If the database is opened (and/or created) successfully, then |
2089 ** [SQLITE_OK] is returned. Otherwise an [error code] is returned. The | 2334 ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The |
2090 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain | 2335 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain |
2091 ** an English language description of the error. | 2336 ** an English language description of the error following a failure of any |
| 2337 ** of the sqlite3_open() routines. |
2092 ** | 2338 ** |
2093 ** The default encoding for the database will be UTF-8 if | 2339 ** ^The default encoding for the database will be UTF-8 if |
2094 ** sqlite3_open() or sqlite3_open_v2() is called and | 2340 ** sqlite3_open() or sqlite3_open_v2() is called and |
2095 ** UTF-16 in the native byte order if sqlite3_open16() is used. | 2341 ** UTF-16 in the native byte order if sqlite3_open16() is used. |
2096 ** | 2342 ** |
2097 ** Whether or not an error occurs when it is opened, resources | 2343 ** Whether or not an error occurs when it is opened, resources |
2098 ** associated with the [database connection] handle should be released by | 2344 ** associated with the [database connection] handle should be released by |
2099 ** passing it to [sqlite3_close()] when it is no longer required. | 2345 ** passing it to [sqlite3_close()] when it is no longer required. |
2100 ** | 2346 ** |
2101 ** The sqlite3_open_v2() interface works like sqlite3_open() | 2347 ** The sqlite3_open_v2() interface works like sqlite3_open() |
2102 ** except that it accepts two additional parameters for additional control | 2348 ** except that it accepts two additional parameters for additional control |
2103 ** over the new database connection. The flags parameter can take one of | 2349 ** over the new database connection. ^(The flags parameter to |
| 2350 ** sqlite3_open_v2() can take one of |
2104 ** the following three values, optionally combined with the | 2351 ** the following three values, optionally combined with the |
2105 ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], | 2352 ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], |
2106 ** and/or [SQLITE_OPEN_PRIVATECACHE] flags: | 2353 ** and/or [SQLITE_OPEN_PRIVATECACHE] flags:)^ |
2107 ** | 2354 ** |
2108 ** <dl> | 2355 ** <dl> |
2109 ** <dt>[SQLITE_OPEN_READONLY]</dt> | 2356 ** ^(<dt>[SQLITE_OPEN_READONLY]</dt> |
2110 ** <dd>The database is opened in read-only mode. If the database does not | 2357 ** <dd>The database is opened in read-only mode. If the database does not |
2111 ** already exist, an error is returned.</dd> | 2358 ** already exist, an error is returned.</dd>)^ |
2112 ** | 2359 ** |
2113 ** <dt>[SQLITE_OPEN_READWRITE]</dt> | 2360 ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> |
2114 ** <dd>The database is opened for reading and writing if possible, or reading | 2361 ** <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 | 2362 ** 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> | 2363 ** case the database must already exist, otherwise an error is returned.</dd>)^ |
2117 ** | 2364 ** |
2118 ** <dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> | 2365 ** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> |
2119 ** <dd>The database is opened for reading and writing, and is creates it if | 2366 ** <dd>The database is opened for reading and writing, and is created if |
2120 ** it does not already exist. This is the behavior that is always used for | 2367 ** it does not already exist. This is the behavior that is always used for |
2121 ** sqlite3_open() and sqlite3_open16().</dd> | 2368 ** sqlite3_open() and sqlite3_open16().</dd>)^ |
2122 ** </dl> | 2369 ** </dl> |
2123 ** | 2370 ** |
2124 ** If the 3rd parameter to sqlite3_open_v2() is not one of the | 2371 ** 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 | 2372 ** combinations shown above or one of the combinations shown above combined |
2126 ** with the [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], | 2373 ** with the [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], |
2127 ** [SQLITE_OPEN_SHAREDCACHE] and/or [SQLITE_OPEN_SHAREDCACHE] flags, | 2374 ** [SQLITE_OPEN_SHAREDCACHE] and/or [SQLITE_OPEN_PRIVATECACHE] flags, |
2128 ** then the behavior is undefined. | 2375 ** then the behavior is undefined. |
2129 ** | 2376 ** |
2130 ** If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection | 2377 ** ^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 | 2378 ** 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 | 2379 ** 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 | 2380 ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens |
2134 ** in the serialized [threading mode] unless single-thread was | 2381 ** in the serialized [threading mode] unless single-thread was |
2135 ** previously selected at compile-time or start-time. | 2382 ** previously selected at compile-time or start-time. |
2136 ** The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be | 2383 ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be |
2137 ** eligible to use [shared cache mode], regardless of whether or not shared | 2384 ** eligible to use [shared cache mode], regardless of whether or not shared |
2138 ** cache is enabled using [sqlite3_enable_shared_cache()]. The | 2385 ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The |
2139 ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not | 2386 ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not |
2140 ** participate in [shared cache mode] even if it is enabled. | 2387 ** participate in [shared cache mode] even if it is enabled. |
2141 ** | 2388 ** |
2142 ** If the filename is ":memory:", then a private, temporary in-memory database | 2389 ** ^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 | 2390 ** is created for the connection. ^This in-memory database will vanish when |
2144 ** the database connection is closed. Future versions of SQLite might | 2391 ** the database connection is closed. Future versions of SQLite might |
2145 ** make use of additional special filenames that begin with the ":" character. | 2392 ** make use of additional special filenames that begin with the ":" character. |
2146 ** It is recommended that when a database filename actually does begin with | 2393 ** 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 | 2394 ** a ":" character you should prefix the filename with a pathname such as |
2148 ** "./" to avoid ambiguity. | 2395 ** "./" to avoid ambiguity. |
2149 ** | 2396 ** |
2150 ** If the filename is an empty string, then a private, temporary | 2397 ** ^If the filename is an empty string, then a private, temporary |
2151 ** on-disk database will be created. This private database will be | 2398 ** on-disk database will be created. ^This private database will be |
2152 ** automatically deleted as soon as the database connection is closed. | 2399 ** automatically deleted as soon as the database connection is closed. |
2153 ** | 2400 ** |
2154 ** The fourth parameter to sqlite3_open_v2() is the name of the | 2401 ** ^The fourth parameter to sqlite3_open_v2() is the name of the |
2155 ** [sqlite3_vfs] object that defines the operating system interface that | 2402 ** [sqlite3_vfs] object that defines the operating system interface that |
2156 ** the new database connection should use. If the fourth parameter is | 2403 ** the new database connection should use. ^If the fourth parameter is |
2157 ** a NULL pointer then the default [sqlite3_vfs] object is used. | 2404 ** a NULL pointer then the default [sqlite3_vfs] object is used. |
2158 ** | 2405 ** |
2159 ** <b>Note to Windows users:</b> The encoding used for the filename argument | 2406 ** <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 | 2407 ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever |
2161 ** codepage is currently defined. Filenames containing international | 2408 ** codepage is currently defined. Filenames containing international |
2162 ** characters must be converted to UTF-8 prior to passing them into | 2409 ** characters must be converted to UTF-8 prior to passing them into |
2163 ** sqlite3_open() or sqlite3_open_v2(). | 2410 ** 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 */ | 2411 */ |
2169 SQLITE_API int sqlite3_open( | 2412 SQLITE_API int sqlite3_open( |
2170 const char *filename, /* Database filename (UTF-8) */ | 2413 const char *filename, /* Database filename (UTF-8) */ |
2171 sqlite3 **ppDb /* OUT: SQLite db handle */ | 2414 sqlite3 **ppDb /* OUT: SQLite db handle */ |
2172 ); | 2415 ); |
2173 SQLITE_API int sqlite3_open16( | 2416 SQLITE_API int sqlite3_open16( |
2174 const void *filename, /* Database filename (UTF-16) */ | 2417 const void *filename, /* Database filename (UTF-16) */ |
2175 sqlite3 **ppDb /* OUT: SQLite db handle */ | 2418 sqlite3 **ppDb /* OUT: SQLite db handle */ |
2176 ); | 2419 ); |
2177 SQLITE_API int sqlite3_open_v2( | 2420 SQLITE_API int sqlite3_open_v2( |
2178 const char *filename, /* Database filename (UTF-8) */ | 2421 const char *filename, /* Database filename (UTF-8) */ |
2179 sqlite3 **ppDb, /* OUT: SQLite db handle */ | 2422 sqlite3 **ppDb, /* OUT: SQLite db handle */ |
2180 int flags, /* Flags */ | 2423 int flags, /* Flags */ |
2181 const char *zVfs /* Name of VFS module to use */ | 2424 const char *zVfs /* Name of VFS module to use */ |
2182 ); | 2425 ); |
2183 | 2426 |
2184 /* | 2427 /* |
2185 ** CAPI3REF: Error Codes And Messages {H12800} <S60200> | 2428 ** CAPI3REF: Error Codes And Messages |
2186 ** | 2429 ** |
2187 ** The sqlite3_errcode() interface returns the numeric [result code] or | 2430 ** ^The sqlite3_errcode() interface returns the numeric [result code] or |
2188 ** [extended result code] for the most recent failed sqlite3_* API call | 2431 ** [extended result code] for the most recent failed sqlite3_* API call |
2189 ** associated with a [database connection]. If a prior API call failed | 2432 ** associated with a [database connection]. If a prior API call failed |
2190 ** but the most recent API call succeeded, the return value from | 2433 ** but the most recent API call succeeded, the return value from |
2191 ** sqlite3_errcode() is undefined. The sqlite3_extended_errcode() | 2434 ** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode() |
2192 ** interface is the same except that it always returns the | 2435 ** interface is the same except that it always returns the |
2193 ** [extended result code] even when extended result codes are | 2436 ** [extended result code] even when extended result codes are |
2194 ** disabled. | 2437 ** disabled. |
2195 ** | 2438 ** |
2196 ** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language | 2439 ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language |
2197 ** text that describes the error, as either UTF-8 or UTF-16 respectively. | 2440 ** text that describes the error, as either UTF-8 or UTF-16 respectively. |
2198 ** Memory to hold the error message string is managed internally. | 2441 ** ^(Memory to hold the error message string is managed internally. |
2199 ** The application does not need to worry about freeing the result. | 2442 ** The application does not need to worry about freeing the result. |
2200 ** However, the error string might be overwritten or deallocated by | 2443 ** However, the error string might be overwritten or deallocated by |
2201 ** subsequent calls to other SQLite interface functions. | 2444 ** subsequent calls to other SQLite interface functions.)^ |
2202 ** | 2445 ** |
2203 ** When the serialized [threading mode] is in use, it might be the | 2446 ** 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 | 2447 ** 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. | 2448 ** the time of the first error and the call to these interfaces. |
2206 ** When that happens, the second error will be reported since these | 2449 ** When that happens, the second error will be reported since these |
2207 ** interfaces always report the most recent result. To avoid | 2450 ** interfaces always report the most recent result. To avoid |
2208 ** this, each thread can obtain exclusive use of the [database connection] D | 2451 ** this, each thread can obtain exclusive use of the [database connection] D |
2209 ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning | 2452 ** 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 | 2453 ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after |
2211 ** all calls to the interfaces listed here are completed. | 2454 ** all calls to the interfaces listed here are completed. |
2212 ** | 2455 ** |
2213 ** If an interface fails with SQLITE_MISUSE, that means the interface | 2456 ** If an interface fails with SQLITE_MISUSE, that means the interface |
2214 ** was invoked incorrectly by the application. In that case, the | 2457 ** was invoked incorrectly by the application. In that case, the |
2215 ** error code and message may or may not be set. | 2458 ** error code and message may or may not be set. |
2216 ** | |
2217 ** Requirements: | |
2218 ** [H12801] [H12802] [H12803] [H12807] [H12808] [H12809] | |
2219 */ | 2459 */ |
2220 SQLITE_API int sqlite3_errcode(sqlite3 *db); | 2460 SQLITE_API int sqlite3_errcode(sqlite3 *db); |
2221 SQLITE_API int sqlite3_extended_errcode(sqlite3 *db); | 2461 SQLITE_API int sqlite3_extended_errcode(sqlite3 *db); |
2222 SQLITE_API const char *sqlite3_errmsg(sqlite3*); | 2462 SQLITE_API const char *sqlite3_errmsg(sqlite3*); |
2223 SQLITE_API const void *sqlite3_errmsg16(sqlite3*); | 2463 SQLITE_API const void *sqlite3_errmsg16(sqlite3*); |
2224 | 2464 |
2225 /* | 2465 /* |
2226 ** CAPI3REF: SQL Statement Object {H13000} <H13010> | 2466 ** CAPI3REF: SQL Statement Object |
2227 ** KEYWORDS: {prepared statement} {prepared statements} | 2467 ** KEYWORDS: {prepared statement} {prepared statements} |
2228 ** | 2468 ** |
2229 ** An instance of this object represents a single SQL statement. | 2469 ** An instance of this object represents a single SQL statement. |
2230 ** This object is variously known as a "prepared statement" or a | 2470 ** This object is variously known as a "prepared statement" or a |
2231 ** "compiled SQL statement" or simply as a "statement". | 2471 ** "compiled SQL statement" or simply as a "statement". |
2232 ** | 2472 ** |
2233 ** The life of a statement object goes something like this: | 2473 ** The life of a statement object goes something like this: |
2234 ** | 2474 ** |
2235 ** <ol> | 2475 ** <ol> |
2236 ** <li> Create the object using [sqlite3_prepare_v2()] or a related | 2476 ** <li> Create the object using [sqlite3_prepare_v2()] or a related |
2237 ** function. | 2477 ** function. |
2238 ** <li> Bind values to [host parameters] using the sqlite3_bind_*() | 2478 ** <li> Bind values to [host parameters] using the sqlite3_bind_*() |
2239 ** interfaces. | 2479 ** interfaces. |
2240 ** <li> Run the SQL by calling [sqlite3_step()] one or more times. | 2480 ** <li> Run the SQL by calling [sqlite3_step()] one or more times. |
2241 ** <li> Reset the statement using [sqlite3_reset()] then go back | 2481 ** <li> Reset the statement using [sqlite3_reset()] then go back |
2242 ** to step 2. Do this zero or more times. | 2482 ** to step 2. Do this zero or more times. |
2243 ** <li> Destroy the object using [sqlite3_finalize()]. | 2483 ** <li> Destroy the object using [sqlite3_finalize()]. |
2244 ** </ol> | 2484 ** </ol> |
2245 ** | 2485 ** |
2246 ** Refer to documentation on individual methods above for additional | 2486 ** Refer to documentation on individual methods above for additional |
2247 ** information. | 2487 ** information. |
2248 */ | 2488 */ |
2249 typedef struct sqlite3_stmt sqlite3_stmt; | 2489 typedef struct sqlite3_stmt sqlite3_stmt; |
2250 | 2490 |
2251 /* | 2491 /* |
2252 ** CAPI3REF: Run-time Limits {H12760} <S20600> | 2492 ** CAPI3REF: Run-time Limits |
2253 ** | 2493 ** |
2254 ** This interface allows the size of various constructs to be limited | 2494 ** ^(This interface allows the size of various constructs to be limited |
2255 ** on a connection by connection basis. The first parameter is the | 2495 ** on a connection by connection basis. The first parameter is the |
2256 ** [database connection] whose limit is to be set or queried. The | 2496 ** [database connection] whose limit is to be set or queried. The |
2257 ** second parameter is one of the [limit categories] that define a | 2497 ** second parameter is one of the [limit categories] that define a |
2258 ** class of constructs to be size limited. The third parameter is the | 2498 ** class of constructs to be size limited. The third parameter is the |
2259 ** new limit for that construct. The function returns the old limit. | 2499 ** new limit for that construct.)^ |
2260 ** | 2500 ** |
2261 ** If the new limit is a negative number, the limit is unchanged. | 2501 ** ^If the new limit is a negative number, the limit is unchanged. |
2262 ** For the limit category of SQLITE_LIMIT_XYZ there is a | 2502 ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a |
2263 ** [limits | hard upper bound] | 2503 ** [limits | hard upper bound] |
2264 ** set by a compile-time C preprocessor macro named | 2504 ** set at compile-time by a C preprocessor macro called |
2265 ** [limits | SQLITE_MAX_XYZ]. | 2505 ** [limits | SQLITE_MAX_<i>NAME</i>]. |
2266 ** (The "_LIMIT_" in the name is changed to "_MAX_".) | 2506 ** (The "_LIMIT_" in the name is changed to "_MAX_".))^ |
2267 ** Attempts to increase a limit above its hard upper bound are | 2507 ** ^Attempts to increase a limit above its hard upper bound are |
2268 ** silently truncated to the hard upper limit. | 2508 ** silently truncated to the hard upper bound. |
2269 ** | 2509 ** |
2270 ** Run time limits are intended for use in applications that manage | 2510 ** ^Regardless of whether or not the limit was changed, the |
| 2511 ** [sqlite3_limit()] interface returns the prior value of the limit. |
| 2512 ** ^Hence, to find the current value of a limit without changing it, |
| 2513 ** simply invoke this interface with the third parameter set to -1. |
| 2514 ** |
| 2515 ** Run-time limits are intended for use in applications that manage |
2271 ** both their own internal database and also databases that are controlled | 2516 ** both their own internal database and also databases that are controlled |
2272 ** by untrusted external sources. An example application might be a | 2517 ** by untrusted external sources. An example application might be a |
2273 ** web browser that has its own databases for storing history and | 2518 ** web browser that has its own databases for storing history and |
2274 ** separate databases controlled by JavaScript applications downloaded | 2519 ** separate databases controlled by JavaScript applications downloaded |
2275 ** off the Internet. The internal databases can be given the | 2520 ** off the Internet. The internal databases can be given the |
2276 ** large, default limits. Databases managed by external sources can | 2521 ** large, default limits. Databases managed by external sources can |
2277 ** be given much smaller limits designed to prevent a denial of service | 2522 ** be given much smaller limits designed to prevent a denial of service |
2278 ** attack. Developers might also want to use the [sqlite3_set_authorizer()] | 2523 ** attack. Developers might also want to use the [sqlite3_set_authorizer()] |
2279 ** interface to further control untrusted SQL. The size of the database | 2524 ** interface to further control untrusted SQL. The size of the database |
2280 ** created by an untrusted script can be contained using the | 2525 ** created by an untrusted script can be contained using the |
2281 ** [max_page_count] [PRAGMA]. | 2526 ** [max_page_count] [PRAGMA]. |
2282 ** | 2527 ** |
2283 ** New run-time limit categories may be added in future releases. | 2528 ** New run-time limit categories may be added in future releases. |
2284 ** | |
2285 ** Requirements: | |
2286 ** [H12762] [H12766] [H12769] | |
2287 */ | 2529 */ |
2288 SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal); | 2530 SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal); |
2289 | 2531 |
2290 /* | 2532 /* |
2291 ** CAPI3REF: Run-Time Limit Categories {H12790} <H12760> | 2533 ** CAPI3REF: Run-Time Limit Categories |
2292 ** KEYWORDS: {limit category} {limit categories} | 2534 ** KEYWORDS: {limit category} {*limit categories} |
2293 ** | 2535 ** |
2294 ** These constants define various performance limits | 2536 ** These constants define various performance limits |
2295 ** that can be lowered at run-time using [sqlite3_limit()]. | 2537 ** that can be lowered at run-time using [sqlite3_limit()]. |
2296 ** The synopsis of the meanings of the various limits is shown below. | 2538 ** The synopsis of the meanings of the various limits is shown below. |
2297 ** Additional information is available at [limits | Limits in SQLite]. | 2539 ** Additional information is available at [limits | Limits in SQLite]. |
2298 ** | 2540 ** |
2299 ** <dl> | 2541 ** <dl> |
2300 ** <dt>SQLITE_LIMIT_LENGTH</dt> | 2542 ** ^(<dt>SQLITE_LIMIT_LENGTH</dt> |
2301 ** <dd>The maximum size of any string or BLOB or table row.<dd> | 2543 ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^ |
2302 ** | 2544 ** |
2303 ** <dt>SQLITE_LIMIT_SQL_LENGTH</dt> | 2545 ** ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> |
2304 ** <dd>The maximum length of an SQL statement.</dd> | 2546 ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ |
2305 ** | 2547 ** |
2306 ** <dt>SQLITE_LIMIT_COLUMN</dt> | 2548 ** ^(<dt>SQLITE_LIMIT_COLUMN</dt> |
2307 ** <dd>The maximum number of columns in a table definition or in the | 2549 ** <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 | 2550 ** 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> | 2551 ** or in an ORDER BY or GROUP BY clause.</dd>)^ |
2310 ** | 2552 ** |
2311 ** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt> | 2553 ** ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> |
2312 ** <dd>The maximum depth of the parse tree on any expression.</dd> | 2554 ** <dd>The maximum depth of the parse tree on any expression.</dd>)^ |
2313 ** | 2555 ** |
2314 ** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> | 2556 ** ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> |
2315 ** <dd>The maximum number of terms in a compound SELECT statement.</dd> | 2557 ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ |
2316 ** | 2558 ** |
2317 ** <dt>SQLITE_LIMIT_VDBE_OP</dt> | 2559 ** ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> |
2318 ** <dd>The maximum number of instructions in a virtual machine program | 2560 ** <dd>The maximum number of instructions in a virtual machine program |
2319 ** used to implement an SQL statement.</dd> | 2561 ** used to implement an SQL statement. This limit is not currently |
| 2562 ** enforced, though that might be added in some future release of |
| 2563 ** SQLite.</dd>)^ |
2320 ** | 2564 ** |
2321 ** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt> | 2565 ** ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> |
2322 ** <dd>The maximum number of arguments on a function.</dd> | 2566 ** <dd>The maximum number of arguments on a function.</dd>)^ |
2323 ** | 2567 ** |
2324 ** <dt>SQLITE_LIMIT_ATTACHED</dt> | 2568 ** ^(<dt>SQLITE_LIMIT_ATTACHED</dt> |
2325 ** <dd>The maximum number of [ATTACH | attached databases].</dd> | 2569 ** <dd>The maximum number of [ATTACH | attached databases].)^</dd> |
2326 ** | 2570 ** |
2327 ** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> | 2571 ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> |
2328 ** <dd>The maximum length of the pattern argument to the [LIKE] or | 2572 ** <dd>The maximum length of the pattern argument to the [LIKE] or |
2329 ** [GLOB] operators.</dd> | 2573 ** [GLOB] operators.</dd>)^ |
2330 ** | 2574 ** |
2331 ** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> | 2575 ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> |
2332 ** <dd>The maximum number of variables in an SQL statement that can | 2576 ** <dd>The maximum index number of any [parameter] in an SQL statement.)^ |
2333 ** be bound.</dd> | |
2334 ** | 2577 ** |
2335 ** <dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> | 2578 ** ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> |
2336 ** <dd>The maximum depth of recursion for triggers.</dd> | 2579 ** <dd>The maximum depth of recursion for triggers.</dd>)^ |
2337 ** </dl> | 2580 ** </dl> |
2338 */ | 2581 */ |
2339 #define SQLITE_LIMIT_LENGTH 0 | 2582 #define SQLITE_LIMIT_LENGTH 0 |
2340 #define SQLITE_LIMIT_SQL_LENGTH 1 | 2583 #define SQLITE_LIMIT_SQL_LENGTH 1 |
2341 #define SQLITE_LIMIT_COLUMN 2 | 2584 #define SQLITE_LIMIT_COLUMN 2 |
2342 #define SQLITE_LIMIT_EXPR_DEPTH 3 | 2585 #define SQLITE_LIMIT_EXPR_DEPTH 3 |
2343 #define SQLITE_LIMIT_COMPOUND_SELECT 4 | 2586 #define SQLITE_LIMIT_COMPOUND_SELECT 4 |
2344 #define SQLITE_LIMIT_VDBE_OP 5 | 2587 #define SQLITE_LIMIT_VDBE_OP 5 |
2345 #define SQLITE_LIMIT_FUNCTION_ARG 6 | 2588 #define SQLITE_LIMIT_FUNCTION_ARG 6 |
2346 #define SQLITE_LIMIT_ATTACHED 7 | 2589 #define SQLITE_LIMIT_ATTACHED 7 |
2347 #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 | 2590 #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 |
2348 #define SQLITE_LIMIT_VARIABLE_NUMBER 9 | 2591 #define SQLITE_LIMIT_VARIABLE_NUMBER 9 |
2349 #define SQLITE_LIMIT_TRIGGER_DEPTH 10 | 2592 #define SQLITE_LIMIT_TRIGGER_DEPTH 10 |
2350 | 2593 |
2351 /* | 2594 /* |
2352 ** CAPI3REF: Compiling An SQL Statement {H13010} <S10000> | 2595 ** CAPI3REF: Compiling An SQL Statement |
2353 ** KEYWORDS: {SQL statement compiler} | 2596 ** KEYWORDS: {SQL statement compiler} |
2354 ** | 2597 ** |
2355 ** To execute an SQL query, it must first be compiled into a byte-code | 2598 ** To execute an SQL query, it must first be compiled into a byte-code |
2356 ** program using one of these routines. | 2599 ** program using one of these routines. |
2357 ** | 2600 ** |
2358 ** The first argument, "db", is a [database connection] obtained from a | 2601 ** The first argument, "db", is a [database connection] obtained from a |
2359 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or | 2602 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or |
2360 ** [sqlite3_open16()]. The database connection must not have been closed. | 2603 ** [sqlite3_open16()]. The database connection must not have been closed. |
2361 ** | 2604 ** |
2362 ** The second argument, "zSql", is the statement to be compiled, encoded | 2605 ** 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() | 2606 ** 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() | 2607 ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() |
2365 ** use UTF-16. | 2608 ** use UTF-16. |
2366 ** | 2609 ** |
2367 ** If the nByte argument is less than zero, then zSql is read up to the | 2610 ** ^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 | 2611 ** 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 | 2612 ** 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 | 2613 ** zSql string ends at either the first '\000' or '\u0000' character or |
2371 ** the nByte-th byte, whichever comes first. If the caller knows | 2614 ** the nByte-th byte, whichever comes first. If the caller knows |
2372 ** that the supplied string is nul-terminated, then there is a small | 2615 ** that the supplied string is nul-terminated, then there is a small |
2373 ** performance advantage to be gained by passing an nByte parameter that | 2616 ** 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> | 2617 ** is equal to the number of bytes in the input string <i>including</i> |
2375 ** the nul-terminator bytes. | 2618 ** the nul-terminator bytes. |
2376 ** | 2619 ** |
2377 ** If pzTail is not NULL then *pzTail is made to point to the first byte | 2620 ** ^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 | 2621 ** 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 | 2622 ** compile the first statement in zSql, so *pzTail is left pointing to |
2380 ** what remains uncompiled. | 2623 ** what remains uncompiled. |
2381 ** | 2624 ** |
2382 ** *ppStmt is left pointing to a compiled [prepared statement] that can be | 2625 ** ^*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 | 2626 ** 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 | 2627 ** 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. | 2628 ** string or a comment) then *ppStmt is set to NULL. |
2386 ** The calling procedure is responsible for deleting the compiled | 2629 ** The calling procedure is responsible for deleting the compiled |
2387 ** SQL statement using [sqlite3_finalize()] after it has finished with it. | 2630 ** SQL statement using [sqlite3_finalize()] after it has finished with it. |
2388 ** ppStmt may not be NULL. | 2631 ** ppStmt may not be NULL. |
2389 ** | 2632 ** |
2390 ** On success, [SQLITE_OK] is returned, otherwise an [error code] is returned. | 2633 ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; |
| 2634 ** otherwise an [error code] is returned. |
2391 ** | 2635 ** |
2392 ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are | 2636 ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are |
2393 ** recommended for all new programs. The two older interfaces are retained | 2637 ** recommended for all new programs. The two older interfaces are retained |
2394 ** for backwards compatibility, but their use is discouraged. | 2638 ** for backwards compatibility, but their use is discouraged. |
2395 ** In the "v2" interfaces, the prepared statement | 2639 ** ^In the "v2" interfaces, the prepared statement |
2396 ** that is returned (the [sqlite3_stmt] object) contains a copy of the | 2640 ** that is returned (the [sqlite3_stmt] object) contains a copy of the |
2397 ** original SQL text. This causes the [sqlite3_step()] interface to | 2641 ** original SQL text. This causes the [sqlite3_step()] interface to |
2398 ** behave a differently in two ways: | 2642 ** behave differently in three ways: |
2399 ** | 2643 ** |
2400 ** <ol> | 2644 ** <ol> |
2401 ** <li> | 2645 ** <li> |
2402 ** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it | 2646 ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it |
2403 ** always used to do, [sqlite3_step()] will automatically recompile the SQL | 2647 ** 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 | 2648 ** 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> | 2649 ** </li> |
2411 ** | 2650 ** |
2412 ** <li> | 2651 ** <li> |
2413 ** When an error occurs, [sqlite3_step()] will return one of the detailed | 2652 ** ^When an error occurs, [sqlite3_step()] will return one of the detailed |
2414 ** [error codes] or [extended error codes]. The legacy behavior was that | 2653 ** [error codes] or [extended error codes]. ^The legacy behavior was that |
2415 ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code | 2654 ** [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 | 2655 ** 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 | 2656 ** 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. | 2657 ** interfaces, the underlying reason for the error is returned immediately. |
2419 ** </li> | 2658 ** </li> |
| 2659 ** |
| 2660 ** <li> |
| 2661 ** ^If the specific value bound to [parameter | host parameter] in the |
| 2662 ** WHERE clause might influence the choice of query plan for a statement, |
| 2663 ** then the statement will be automatically recompiled, as if there had been |
| 2664 ** a schema change, on the first [sqlite3_step()] call following any change |
| 2665 ** to the [sqlite3_bind_text | bindings] of that [parameter]. |
| 2666 ** ^The specific value of WHERE-clause [parameter] might influence the |
| 2667 ** choice of query plan if the parameter is the left-hand side of a [LIKE] |
| 2668 ** or [GLOB] operator or if the parameter is compared to an indexed column |
| 2669 ** and the [SQLITE_ENABLE_STAT2] compile-time option is enabled. |
| 2670 ** the |
| 2671 ** </li> |
2420 ** </ol> | 2672 ** </ol> |
2421 ** | |
2422 ** Requirements: | |
2423 ** [H13011] [H13012] [H13013] [H13014] [H13015] [H13016] [H13019] [H13021] | |
2424 ** | |
2425 */ | 2673 */ |
2426 SQLITE_API int sqlite3_prepare( | 2674 SQLITE_API int sqlite3_prepare( |
2427 sqlite3 *db, /* Database handle */ | 2675 sqlite3 *db, /* Database handle */ |
2428 const char *zSql, /* SQL statement, UTF-8 encoded */ | 2676 const char *zSql, /* SQL statement, UTF-8 encoded */ |
2429 int nByte, /* Maximum length of zSql in bytes. */ | 2677 int nByte, /* Maximum length of zSql in bytes. */ |
2430 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | 2678 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
2431 const char **pzTail /* OUT: Pointer to unused portion of zSql */ | 2679 const char **pzTail /* OUT: Pointer to unused portion of zSql */ |
2432 ); | 2680 ); |
2433 SQLITE_API int sqlite3_prepare_v2( | 2681 SQLITE_API int sqlite3_prepare_v2( |
2434 sqlite3 *db, /* Database handle */ | 2682 sqlite3 *db, /* Database handle */ |
(...skipping 11 matching lines...) Expand all Loading... |
2446 ); | 2694 ); |
2447 SQLITE_API int sqlite3_prepare16_v2( | 2695 SQLITE_API int sqlite3_prepare16_v2( |
2448 sqlite3 *db, /* Database handle */ | 2696 sqlite3 *db, /* Database handle */ |
2449 const void *zSql, /* SQL statement, UTF-16 encoded */ | 2697 const void *zSql, /* SQL statement, UTF-16 encoded */ |
2450 int nByte, /* Maximum length of zSql in bytes. */ | 2698 int nByte, /* Maximum length of zSql in bytes. */ |
2451 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | 2699 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
2452 const void **pzTail /* OUT: Pointer to unused portion of zSql */ | 2700 const void **pzTail /* OUT: Pointer to unused portion of zSql */ |
2453 ); | 2701 ); |
2454 | 2702 |
2455 /* | 2703 /* |
2456 ** CAPI3REF: Retrieving Statement SQL {H13100} <H13000> | 2704 ** CAPI3REF: Retrieving Statement SQL |
2457 ** | 2705 ** |
2458 ** This interface can be used to retrieve a saved copy of the original | 2706 ** ^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 | 2707 ** SQL text used to create a [prepared statement] if that statement was |
2460 ** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. | 2708 ** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. |
2461 ** | |
2462 ** Requirements: | |
2463 ** [H13101] [H13102] [H13103] | |
2464 */ | 2709 */ |
2465 SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); | 2710 SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); |
2466 | 2711 |
2467 /* | 2712 /* |
2468 ** CAPI3REF: Dynamically Typed Value Object {H15000} <S20200> | 2713 ** CAPI3REF: Determine If An SQL Statement Writes The Database |
| 2714 ** |
| 2715 ** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if |
| 2716 ** and only if the [prepared statement] X makes no direct changes to |
| 2717 ** the content of the database file. |
| 2718 ** |
| 2719 ** Note that [application-defined SQL functions] or |
| 2720 ** [virtual tables] might change the database indirectly as a side effect. |
| 2721 ** ^(For example, if an application defines a function "eval()" that |
| 2722 ** calls [sqlite3_exec()], then the following SQL statement would |
| 2723 ** change the database file through side-effects: |
| 2724 ** |
| 2725 ** <blockquote><pre> |
| 2726 ** SELECT eval('DELETE FROM t1') FROM t2; |
| 2727 ** </pre></blockquote> |
| 2728 ** |
| 2729 ** But because the [SELECT] statement does not change the database file |
| 2730 ** directly, sqlite3_stmt_readonly() would still return true.)^ |
| 2731 ** |
| 2732 ** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], |
| 2733 ** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, |
| 2734 ** since the statements themselves do not actually modify the database but |
| 2735 ** rather they control the timing of when other statements modify the |
| 2736 ** database. ^The [ATTACH] and [DETACH] statements also cause |
| 2737 ** sqlite3_stmt_readonly() to return true since, while those statements |
| 2738 ** change the configuration of a database connection, they do not make |
| 2739 ** changes to the content of the database files on disk. |
| 2740 */ |
| 2741 SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); |
| 2742 |
| 2743 /* |
| 2744 ** CAPI3REF: Dynamically Typed Value Object |
2469 ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} | 2745 ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} |
2470 ** | 2746 ** |
2471 ** SQLite uses the sqlite3_value object to represent all values | 2747 ** SQLite uses the sqlite3_value object to represent all values |
2472 ** that can be stored in a database table. SQLite uses dynamic typing | 2748 ** that can be stored in a database table. SQLite uses dynamic typing |
2473 ** for the values it stores. Values stored in sqlite3_value objects | 2749 ** for the values it stores. ^Values stored in sqlite3_value objects |
2474 ** can be integers, floating point values, strings, BLOBs, or NULL. | 2750 ** can be integers, floating point values, strings, BLOBs, or NULL. |
2475 ** | 2751 ** |
2476 ** An sqlite3_value object may be either "protected" or "unprotected". | 2752 ** An sqlite3_value object may be either "protected" or "unprotected". |
2477 ** Some interfaces require a protected sqlite3_value. Other interfaces | 2753 ** Some interfaces require a protected sqlite3_value. Other interfaces |
2478 ** will accept either a protected or an unprotected sqlite3_value. | 2754 ** will accept either a protected or an unprotected sqlite3_value. |
2479 ** Every interface that accepts sqlite3_value arguments specifies | 2755 ** Every interface that accepts sqlite3_value arguments specifies |
2480 ** whether or not it requires a protected sqlite3_value. | 2756 ** whether or not it requires a protected sqlite3_value. |
2481 ** | 2757 ** |
2482 ** The terms "protected" and "unprotected" refer to whether or not | 2758 ** The terms "protected" and "unprotected" refer to whether or not |
2483 ** a mutex is held. A internal mutex is held for a protected | 2759 ** a mutex is held. An internal mutex is held for a protected |
2484 ** sqlite3_value object but no mutex is held for an unprotected | 2760 ** sqlite3_value object but no mutex is held for an unprotected |
2485 ** sqlite3_value object. If SQLite is compiled to be single-threaded | 2761 ** sqlite3_value object. If SQLite is compiled to be single-threaded |
2486 ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) | 2762 ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) |
2487 ** or if SQLite is run in one of reduced mutex modes | 2763 ** or if SQLite is run in one of reduced mutex modes |
2488 ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] | 2764 ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] |
2489 ** then there is no distinction between protected and unprotected | 2765 ** then there is no distinction between protected and unprotected |
2490 ** sqlite3_value objects and they can be used interchangeably. However, | 2766 ** sqlite3_value objects and they can be used interchangeably. However, |
2491 ** for maximum code portability it is recommended that applications | 2767 ** for maximum code portability it is recommended that applications |
2492 ** still make the distinction between between protected and unprotected | 2768 ** still make the distinction between protected and unprotected |
2493 ** sqlite3_value objects even when not strictly required. | 2769 ** sqlite3_value objects even when not strictly required. |
2494 ** | 2770 ** |
2495 ** The sqlite3_value objects that are passed as parameters into the | 2771 ** ^The sqlite3_value objects that are passed as parameters into the |
2496 ** implementation of [application-defined SQL functions] are protected. | 2772 ** implementation of [application-defined SQL functions] are protected. |
2497 ** The sqlite3_value object returned by | 2773 ** ^The sqlite3_value object returned by |
2498 ** [sqlite3_column_value()] is unprotected. | 2774 ** [sqlite3_column_value()] is unprotected. |
2499 ** Unprotected sqlite3_value objects may only be used with | 2775 ** Unprotected sqlite3_value objects may only be used with |
2500 ** [sqlite3_result_value()] and [sqlite3_bind_value()]. | 2776 ** [sqlite3_result_value()] and [sqlite3_bind_value()]. |
2501 ** The [sqlite3_value_blob | sqlite3_value_type()] family of | 2777 ** The [sqlite3_value_blob | sqlite3_value_type()] family of |
2502 ** interfaces require protected sqlite3_value objects. | 2778 ** interfaces require protected sqlite3_value objects. |
2503 */ | 2779 */ |
2504 typedef struct Mem sqlite3_value; | 2780 typedef struct Mem sqlite3_value; |
2505 | 2781 |
2506 /* | 2782 /* |
2507 ** CAPI3REF: SQL Function Context Object {H16001} <S20200> | 2783 ** CAPI3REF: SQL Function Context Object |
2508 ** | 2784 ** |
2509 ** The context in which an SQL function executes is stored in an | 2785 ** The context in which an SQL function executes is stored in an |
2510 ** sqlite3_context object. A pointer to an sqlite3_context object | 2786 ** sqlite3_context object. ^A pointer to an sqlite3_context object |
2511 ** is always first parameter to [application-defined SQL functions]. | 2787 ** is always first parameter to [application-defined SQL functions]. |
2512 ** The application-defined SQL function implementation will pass this | 2788 ** The application-defined SQL function implementation will pass this |
2513 ** pointer through into calls to [sqlite3_result_int | sqlite3_result()], | 2789 ** pointer through into calls to [sqlite3_result_int | sqlite3_result()], |
2514 ** [sqlite3_aggregate_context()], [sqlite3_user_data()], | 2790 ** [sqlite3_aggregate_context()], [sqlite3_user_data()], |
2515 ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], | 2791 ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], |
2516 ** and/or [sqlite3_set_auxdata()]. | 2792 ** and/or [sqlite3_set_auxdata()]. |
2517 */ | 2793 */ |
2518 typedef struct sqlite3_context sqlite3_context; | 2794 typedef struct sqlite3_context sqlite3_context; |
2519 | 2795 |
2520 /* | 2796 /* |
2521 ** CAPI3REF: Binding Values To Prepared Statements {H13500} <S70300> | 2797 ** CAPI3REF: Binding Values To Prepared Statements |
2522 ** KEYWORDS: {host parameter} {host parameters} {host parameter name} | 2798 ** KEYWORDS: {host parameter} {host parameters} {host parameter name} |
2523 ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} | 2799 ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} |
2524 ** | 2800 ** |
2525 ** In the SQL strings input to [sqlite3_prepare_v2()] and its variants, | 2801 ** ^(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 | 2802 ** literals may be replaced by a [parameter] that matches one of following |
2527 ** templates: | 2803 ** templates: |
2528 ** | 2804 ** |
2529 ** <ul> | 2805 ** <ul> |
2530 ** <li> ? | 2806 ** <li> ? |
2531 ** <li> ?NNN | 2807 ** <li> ?NNN |
2532 ** <li> :VVV | 2808 ** <li> :VVV |
2533 ** <li> @VVV | 2809 ** <li> @VVV |
2534 ** <li> $VVV | 2810 ** <li> $VVV |
2535 ** </ul> | 2811 ** </ul> |
2536 ** | 2812 ** |
2537 ** In the templates above, NNN represents an integer literal, | 2813 ** In the templates above, NNN represents an integer literal, |
2538 ** and VVV represents an alphanumeric identifer. The values of these | 2814 ** and VVV represents an alphanumeric identifier.)^ ^The values of these |
2539 ** parameters (also called "host parameter names" or "SQL parameters") | 2815 ** parameters (also called "host parameter names" or "SQL parameters") |
2540 ** can be set using the sqlite3_bind_*() routines defined here. | 2816 ** can be set using the sqlite3_bind_*() routines defined here. |
2541 ** | 2817 ** |
2542 ** The first argument to the sqlite3_bind_*() routines is always | 2818 ** ^The first argument to the sqlite3_bind_*() routines is always |
2543 ** a pointer to the [sqlite3_stmt] object returned from | 2819 ** a pointer to the [sqlite3_stmt] object returned from |
2544 ** [sqlite3_prepare_v2()] or its variants. | 2820 ** [sqlite3_prepare_v2()] or its variants. |
2545 ** | 2821 ** |
2546 ** The second argument is the index of the SQL parameter to be set. | 2822 ** ^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 | 2823 ** ^The leftmost SQL parameter has an index of 1. ^When the same named |
2548 ** SQL parameter is used more than once, second and subsequent | 2824 ** SQL parameter is used more than once, second and subsequent |
2549 ** occurrences have the same index as the first occurrence. | 2825 ** occurrences have the same index as the first occurrence. |
2550 ** The index for named parameters can be looked up using the | 2826 ** ^The index for named parameters can be looked up using the |
2551 ** [sqlite3_bind_parameter_index()] API if desired. The index | 2827 ** [sqlite3_bind_parameter_index()] API if desired. ^The index |
2552 ** for "?NNN" parameters is the value of NNN. | 2828 ** for "?NNN" parameters is the value of NNN. |
2553 ** The NNN value must be between 1 and the [sqlite3_limit()] | 2829 ** ^The NNN value must be between 1 and the [sqlite3_limit()] |
2554 ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). | 2830 ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). |
2555 ** | 2831 ** |
2556 ** The third argument is the value to bind to the parameter. | 2832 ** ^The third argument is the value to bind to the parameter. |
2557 ** | 2833 ** |
2558 ** In those routines that have a fourth argument, its value is the | 2834 ** ^(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 | 2835 ** 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. | 2836 ** 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 | 2837 ** ^If the fourth parameter is negative, the length of the string is |
2562 ** the number of bytes up to the first zero terminator. | 2838 ** the number of bytes up to the first zero terminator. |
2563 ** | 2839 ** |
2564 ** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and | 2840 ** ^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 | 2841 ** 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 | 2842 ** string after SQLite has finished with it. ^The destructor is called |
| 2843 ** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(), |
| 2844 ** sqlite3_bind_text(), or sqlite3_bind_text16() fails. |
| 2845 ** ^If the fifth argument is |
2567 ** the special value [SQLITE_STATIC], then SQLite assumes that the | 2846 ** the special value [SQLITE_STATIC], then SQLite assumes that the |
2568 ** information is in static, unmanaged space and does not need to be freed. | 2847 ** information is in static, unmanaged space and does not need to be freed. |
2569 ** If the fifth argument has the value [SQLITE_TRANSIENT], then | 2848 ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then |
2570 ** SQLite makes its own private copy of the data immediately, before | 2849 ** SQLite makes its own private copy of the data immediately, before |
2571 ** the sqlite3_bind_*() routine returns. | 2850 ** the sqlite3_bind_*() routine returns. |
2572 ** | 2851 ** |
2573 ** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that | 2852 ** ^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 | 2853 ** 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. | 2854 ** (just an integer to hold its size) while it is being processed. |
2576 ** Zeroblobs are intended to serve as placeholders for BLOBs whose | 2855 ** Zeroblobs are intended to serve as placeholders for BLOBs whose |
2577 ** content is later written using | 2856 ** content is later written using |
2578 ** [sqlite3_blob_open | incremental BLOB I/O] routines. | 2857 ** [sqlite3_blob_open | incremental BLOB I/O] routines. |
2579 ** A negative value for the zeroblob results in a zero-length BLOB. | 2858 ** ^A negative value for the zeroblob results in a zero-length BLOB. |
2580 ** | 2859 ** |
2581 ** The sqlite3_bind_*() routines must be called after | 2860 ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer |
2582 ** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and | 2861 ** for the [prepared statement] or with a prepared statement for which |
2583 ** before [sqlite3_step()]. | 2862 ** [sqlite3_step()] has been called more recently than [sqlite3_reset()], |
2584 ** Bindings are not cleared by the [sqlite3_reset()] routine. | 2863 ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() |
2585 ** Unbound parameters are interpreted as NULL. | 2864 ** routine is passed a [prepared statement] that has been finalized, the |
| 2865 ** result is undefined and probably harmful. |
2586 ** | 2866 ** |
2587 ** These routines return [SQLITE_OK] on success or an error code if | 2867 ** ^Bindings are not cleared by the [sqlite3_reset()] routine. |
2588 ** anything goes wrong. [SQLITE_RANGE] is returned if the parameter | 2868 ** ^Unbound parameters are interpreted as NULL. |
2589 ** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails. | 2869 ** |
2590 ** [SQLITE_MISUSE] might be returned if these routines are called on a | 2870 ** ^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. | 2871 ** [error code] if anything goes wrong. |
2592 ** Detection of misuse is unreliable. Applications should not depend | 2872 ** ^[SQLITE_RANGE] is returned if the parameter |
2593 ** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a | 2873 ** 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 ** | 2874 ** |
2597 ** See also: [sqlite3_bind_parameter_count()], | 2875 ** See also: [sqlite3_bind_parameter_count()], |
2598 ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. | 2876 ** [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 */ | 2877 */ |
2605 SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)
(void*)); | 2878 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); | 2879 SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); |
2607 SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); | 2880 SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); |
2608 SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); | 2881 SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); |
2609 SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); | 2882 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*)); | 2883 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*)); | 2884 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*); | 2885 SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); |
2613 SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); | 2886 SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); |
2614 | 2887 |
2615 /* | 2888 /* |
2616 ** CAPI3REF: Number Of SQL Parameters {H13600} <S70300> | 2889 ** CAPI3REF: Number Of SQL Parameters |
2617 ** | 2890 ** |
2618 ** This routine can be used to find the number of [SQL parameters] | 2891 ** ^This routine can be used to find the number of [SQL parameters] |
2619 ** in a [prepared statement]. SQL parameters are tokens of the | 2892 ** in a [prepared statement]. SQL parameters are tokens of the |
2620 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as | 2893 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as |
2621 ** placeholders for values that are [sqlite3_bind_blob | bound] | 2894 ** placeholders for values that are [sqlite3_bind_blob | bound] |
2622 ** to the parameters at a later time. | 2895 ** to the parameters at a later time. |
2623 ** | 2896 ** |
2624 ** This routine actually returns the index of the largest (rightmost) | 2897 ** ^(This routine actually returns the index of the largest (rightmost) |
2625 ** parameter. For all forms except ?NNN, this will correspond to the | 2898 ** parameter. For all forms except ?NNN, this will correspond to the |
2626 ** number of unique parameters. If parameters of the ?NNN are used, | 2899 ** number of unique parameters. If parameters of the ?NNN form are used, |
2627 ** there may be gaps in the list. | 2900 ** there may be gaps in the list.)^ |
2628 ** | 2901 ** |
2629 ** See also: [sqlite3_bind_blob|sqlite3_bind()], | 2902 ** See also: [sqlite3_bind_blob|sqlite3_bind()], |
2630 ** [sqlite3_bind_parameter_name()], and | 2903 ** [sqlite3_bind_parameter_name()], and |
2631 ** [sqlite3_bind_parameter_index()]. | 2904 ** [sqlite3_bind_parameter_index()]. |
2632 ** | |
2633 ** Requirements: | |
2634 ** [H13601] | |
2635 */ | 2905 */ |
2636 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*); | 2906 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*); |
2637 | 2907 |
2638 /* | 2908 /* |
2639 ** CAPI3REF: Name Of A Host Parameter {H13620} <S70300> | 2909 ** CAPI3REF: Name Of A Host Parameter |
2640 ** | 2910 ** |
2641 ** This routine returns a pointer to the name of the n-th | 2911 ** ^The sqlite3_bind_parameter_name(P,N) interface returns |
2642 ** [SQL parameter] in a [prepared statement]. | 2912 ** 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" | 2913 ** ^(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" | 2914 ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" |
2645 ** respectively. | 2915 ** respectively. |
2646 ** In other words, the initial ":" or "$" or "@" or "?" | 2916 ** In other words, the initial ":" or "$" or "@" or "?" |
2647 ** is included as part of the name. | 2917 ** is included as part of the name.)^ |
2648 ** Parameters of the form "?" without a following integer have no name | 2918 ** ^Parameters of the form "?" without a following integer have no name |
2649 ** and are also referred to as "anonymous parameters". | 2919 ** and are referred to as "nameless" or "anonymous parameters". |
2650 ** | 2920 ** |
2651 ** The first host parameter has an index of 1, not 0. | 2921 ** ^The first host parameter has an index of 1, not 0. |
2652 ** | 2922 ** |
2653 ** If the value n is out of range or if the n-th parameter is | 2923 ** ^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 | 2924 ** nameless, then NULL is returned. ^The returned string is |
2655 ** always in UTF-8 encoding even if the named parameter was | 2925 ** always in UTF-8 encoding even if the named parameter was |
2656 ** originally specified as UTF-16 in [sqlite3_prepare16()] or | 2926 ** originally specified as UTF-16 in [sqlite3_prepare16()] or |
2657 ** [sqlite3_prepare16_v2()]. | 2927 ** [sqlite3_prepare16_v2()]. |
2658 ** | 2928 ** |
2659 ** See also: [sqlite3_bind_blob|sqlite3_bind()], | 2929 ** See also: [sqlite3_bind_blob|sqlite3_bind()], |
2660 ** [sqlite3_bind_parameter_count()], and | 2930 ** [sqlite3_bind_parameter_count()], and |
2661 ** [sqlite3_bind_parameter_index()]. | 2931 ** [sqlite3_bind_parameter_index()]. |
2662 ** | |
2663 ** Requirements: | |
2664 ** [H13621] | |
2665 */ | 2932 */ |
2666 SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); | 2933 SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); |
2667 | 2934 |
2668 /* | 2935 /* |
2669 ** CAPI3REF: Index Of A Parameter With A Given Name {H13640} <S70300> | 2936 ** CAPI3REF: Index Of A Parameter With A Given Name |
2670 ** | 2937 ** |
2671 ** Return the index of an SQL parameter given its name. The | 2938 ** ^Return the index of an SQL parameter given its name. ^The |
2672 ** index value returned is suitable for use as the second | 2939 ** index value returned is suitable for use as the second |
2673 ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero | 2940 ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero |
2674 ** is returned if no matching parameter is found. The parameter | 2941 ** is returned if no matching parameter is found. ^The parameter |
2675 ** name must be given in UTF-8 even if the original statement | 2942 ** name must be given in UTF-8 even if the original statement |
2676 ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. | 2943 ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. |
2677 ** | 2944 ** |
2678 ** See also: [sqlite3_bind_blob|sqlite3_bind()], | 2945 ** See also: [sqlite3_bind_blob|sqlite3_bind()], |
2679 ** [sqlite3_bind_parameter_count()], and | 2946 ** [sqlite3_bind_parameter_count()], and |
2680 ** [sqlite3_bind_parameter_index()]. | 2947 ** [sqlite3_bind_parameter_index()]. |
2681 ** | |
2682 ** Requirements: | |
2683 ** [H13641] | |
2684 */ | 2948 */ |
2685 SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); | 2949 SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); |
2686 | 2950 |
2687 /* | 2951 /* |
2688 ** CAPI3REF: Reset All Bindings On A Prepared Statement {H13660} <S70300> | 2952 ** CAPI3REF: Reset All Bindings On A Prepared Statement |
2689 ** | 2953 ** |
2690 ** Contrary to the intuition of many, [sqlite3_reset()] does not reset | 2954 ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset |
2691 ** the [sqlite3_bind_blob | bindings] on a [prepared statement]. | 2955 ** the [sqlite3_bind_blob | bindings] on a [prepared statement]. |
2692 ** Use this routine to reset all host parameters to NULL. | 2956 ** ^Use this routine to reset all host parameters to NULL. |
2693 ** | |
2694 ** Requirements: | |
2695 ** [H13661] | |
2696 */ | 2957 */ |
2697 SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*); | 2958 SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*); |
2698 | 2959 |
2699 /* | 2960 /* |
2700 ** CAPI3REF: Number Of Columns In A Result Set {H13710} <S10700> | 2961 ** CAPI3REF: Number Of Columns In A Result Set |
2701 ** | 2962 ** |
2702 ** Return the number of columns in the result set returned by the | 2963 ** ^Return the number of columns in the result set returned by the |
2703 ** [prepared statement]. This routine returns 0 if pStmt is an SQL | 2964 ** [prepared statement]. ^This routine returns 0 if pStmt is an SQL |
2704 ** statement that does not return data (for example an [UPDATE]). | 2965 ** statement that does not return data (for example an [UPDATE]). |
2705 ** | 2966 ** |
2706 ** Requirements: | 2967 ** See also: [sqlite3_data_count()] |
2707 ** [H13711] | |
2708 */ | 2968 */ |
2709 SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt); | 2969 SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt); |
2710 | 2970 |
2711 /* | 2971 /* |
2712 ** CAPI3REF: Column Names In A Result Set {H13720} <S10700> | 2972 ** CAPI3REF: Column Names In A Result Set |
2713 ** | 2973 ** |
2714 ** These routines return the name assigned to a particular column | 2974 ** ^These routines return the name assigned to a particular column |
2715 ** in the result set of a [SELECT] statement. The sqlite3_column_name() | 2975 ** in the result set of a [SELECT] statement. ^The sqlite3_column_name() |
2716 ** interface returns a pointer to a zero-terminated UTF-8 string | 2976 ** interface returns a pointer to a zero-terminated UTF-8 string |
2717 ** and sqlite3_column_name16() returns a pointer to a zero-terminated | 2977 ** and sqlite3_column_name16() returns a pointer to a zero-terminated |
2718 ** UTF-16 string. The first parameter is the [prepared statement] | 2978 ** UTF-16 string. ^The first parameter is the [prepared statement] |
2719 ** that implements the [SELECT] statement. The second parameter is the | 2979 ** that implements the [SELECT] statement. ^The second parameter is the |
2720 ** column number. The leftmost column is number 0. | 2980 ** column number. ^The leftmost column is number 0. |
2721 ** | 2981 ** |
2722 ** The returned string pointer is valid until either the [prepared statement] | 2982 ** ^The returned string pointer is valid until either the [prepared statement] |
2723 ** is destroyed by [sqlite3_finalize()] or until the next call to | 2983 ** is destroyed by [sqlite3_finalize()] or until the statement is automatically |
| 2984 ** reprepared by the first call to [sqlite3_step()] for a particular run |
| 2985 ** or until the next call to |
2724 ** sqlite3_column_name() or sqlite3_column_name16() on the same column. | 2986 ** sqlite3_column_name() or sqlite3_column_name16() on the same column. |
2725 ** | 2987 ** |
2726 ** If sqlite3_malloc() fails during the processing of either routine | 2988 ** ^If sqlite3_malloc() fails during the processing of either routine |
2727 ** (for example during a conversion from UTF-8 to UTF-16) then a | 2989 ** (for example during a conversion from UTF-8 to UTF-16) then a |
2728 ** NULL pointer is returned. | 2990 ** NULL pointer is returned. |
2729 ** | 2991 ** |
2730 ** The name of a result column is the value of the "AS" clause for | 2992 ** ^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 | 2993 ** 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 | 2994 ** then the name of the column is unspecified and may change from |
2733 ** one release of SQLite to the next. | 2995 ** one release of SQLite to the next. |
2734 ** | |
2735 ** Requirements: | |
2736 ** [H13721] [H13723] [H13724] [H13725] [H13726] [H13727] | |
2737 */ | 2996 */ |
2738 SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N); | 2997 SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N); |
2739 SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N); | 2998 SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N); |
2740 | 2999 |
2741 /* | 3000 /* |
2742 ** CAPI3REF: Source Of Data In A Query Result {H13740} <S10700> | 3001 ** CAPI3REF: Source Of Data In A Query Result |
2743 ** | 3002 ** |
2744 ** These routines provide a means to determine what column of what | 3003 ** ^These routines provide a means to determine the database, table, and |
2745 ** table in which database a result of a [SELECT] statement comes from. | 3004 ** 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 | 3005 ** [SELECT] statement. |
2747 ** either a UTF-8 or UTF-16 string. The _database_ routines return | 3006 ** ^The name of the database or table or column can be returned as |
| 3007 ** either a UTF-8 or UTF-16 string. ^The _database_ routines return |
2748 ** the database name, the _table_ routines return the table name, and | 3008 ** the database name, the _table_ routines return the table name, and |
2749 ** the origin_ routines return the column name. | 3009 ** the origin_ routines return the column name. |
2750 ** The returned string is valid until the [prepared statement] is destroyed | 3010 ** ^The returned string is valid until the [prepared statement] is destroyed |
2751 ** using [sqlite3_finalize()] or until the same information is requested | 3011 ** using [sqlite3_finalize()] or until the statement is automatically |
| 3012 ** reprepared by the first call to [sqlite3_step()] for a particular run |
| 3013 ** or until the same information is requested |
2752 ** again in a different encoding. | 3014 ** again in a different encoding. |
2753 ** | 3015 ** |
2754 ** The names returned are the original un-aliased names of the | 3016 ** ^The names returned are the original un-aliased names of the |
2755 ** database, table, and column. | 3017 ** database, table, and column. |
2756 ** | 3018 ** |
2757 ** The first argument to the following calls is a [prepared statement]. | 3019 ** ^The first argument to these interfaces is a [prepared statement]. |
2758 ** These functions return information about the Nth column returned by | 3020 ** ^These functions return information about the Nth result column returned by |
2759 ** the statement, where N is the second function argument. | 3021 ** the statement, where N is the second function argument. |
| 3022 ** ^The left-most column is column 0 for these routines. |
2760 ** | 3023 ** |
2761 ** If the Nth column returned by the statement is an expression or | 3024 ** ^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 | 3025 ** 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 | 3026 ** NULL. ^These routine might also return NULL if a memory allocation error |
2764 ** occurs. Otherwise, they return the name of the attached database, table | 3027 ** occurs. ^Otherwise, they return the name of the attached database, table, |
2765 ** and column that query result column was extracted from. | 3028 ** or column that query result column was extracted from. |
2766 ** | 3029 ** |
2767 ** As with all other SQLite APIs, those postfixed with "16" return | 3030 ** ^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} | 3031 ** UTF-16 encoded strings and the other functions return UTF-8. |
2769 ** | 3032 ** |
2770 ** These APIs are only available if the library was compiled with the | 3033 ** ^These APIs are only available if the library was compiled with the |
2771 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. | 3034 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. |
2772 ** | 3035 ** |
2773 ** {A13751} | |
2774 ** If two or more threads call one or more of these routines against the same | 3036 ** 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 | 3037 ** prepared statement and column at the same time then the results are |
2776 ** undefined. | 3038 ** undefined. |
2777 ** | 3039 ** |
2778 ** Requirements: | |
2779 ** [H13741] [H13742] [H13743] [H13744] [H13745] [H13746] [H13748] | |
2780 ** | |
2781 ** If two or more threads call one or more | 3040 ** If two or more threads call one or more |
2782 ** [sqlite3_column_database_name | column metadata interfaces] | 3041 ** [sqlite3_column_database_name | column metadata interfaces] |
2783 ** for the same [prepared statement] and result column | 3042 ** for the same [prepared statement] and result column |
2784 ** at the same time then the results are undefined. | 3043 ** at the same time then the results are undefined. |
2785 */ | 3044 */ |
2786 SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int); | 3045 SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int); |
2787 SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int); | 3046 SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int); |
2788 SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int); | 3047 SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int); |
2789 SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int); | 3048 SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int); |
2790 SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int); | 3049 SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int); |
2791 SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); | 3050 SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); |
2792 | 3051 |
2793 /* | 3052 /* |
2794 ** CAPI3REF: Declared Datatype Of A Query Result {H13760} <S10700> | 3053 ** CAPI3REF: Declared Datatype Of A Query Result |
2795 ** | 3054 ** |
2796 ** The first parameter is a [prepared statement]. | 3055 ** ^(The first parameter is a [prepared statement]. |
2797 ** If this statement is a [SELECT] statement and the Nth column of the | 3056 ** 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 | 3057 ** returned result set of that [SELECT] is a table column (not an |
2799 ** expression or subquery) then the declared type of the table | 3058 ** expression or subquery) then the declared type of the table |
2800 ** column is returned. If the Nth column of the result set is an | 3059 ** column is returned.)^ ^If the Nth column of the result set is an |
2801 ** expression or subquery, then a NULL pointer is returned. | 3060 ** expression or subquery, then a NULL pointer is returned. |
2802 ** The returned string is always UTF-8 encoded. {END} | 3061 ** ^The returned string is always UTF-8 encoded. |
2803 ** | 3062 ** |
2804 ** For example, given the database schema: | 3063 ** ^(For example, given the database schema: |
2805 ** | 3064 ** |
2806 ** CREATE TABLE t1(c1 VARIANT); | 3065 ** CREATE TABLE t1(c1 VARIANT); |
2807 ** | 3066 ** |
2808 ** and the following statement to be compiled: | 3067 ** and the following statement to be compiled: |
2809 ** | 3068 ** |
2810 ** SELECT c1 + 1, c1 FROM t1; | 3069 ** SELECT c1 + 1, c1 FROM t1; |
2811 ** | 3070 ** |
2812 ** this routine would return the string "VARIANT" for the second result | 3071 ** 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). | 3072 ** column (i==1), and a NULL pointer for the first result column (i==0).)^ |
2814 ** | 3073 ** |
2815 ** SQLite uses dynamic run-time typing. So just because a column | 3074 ** ^SQLite uses dynamic run-time typing. ^So just because a column |
2816 ** is declared to contain a particular type does not mean that the | 3075 ** 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 | 3076 ** data stored in that column is of the declared type. SQLite is |
2818 ** strongly typed, but the typing is dynamic not static. Type | 3077 ** strongly typed, but the typing is dynamic not static. ^Type |
2819 ** is associated with individual values, not with the containers | 3078 ** is associated with individual values, not with the containers |
2820 ** used to hold those values. | 3079 ** used to hold those values. |
2821 ** | |
2822 ** Requirements: | |
2823 ** [H13761] [H13762] [H13763] | |
2824 */ | 3080 */ |
2825 SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int); | 3081 SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int); |
2826 SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int); | 3082 SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int); |
2827 | 3083 |
2828 /* | 3084 /* |
2829 ** CAPI3REF: Evaluate An SQL Statement {H13200} <S10000> | 3085 ** CAPI3REF: Evaluate An SQL Statement |
2830 ** | 3086 ** |
2831 ** After a [prepared statement] has been prepared using either | 3087 ** After a [prepared statement] has been prepared using either |
2832 ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy | 3088 ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy |
2833 ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function | 3089 ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function |
2834 ** must be called one or more times to evaluate the statement. | 3090 ** must be called one or more times to evaluate the statement. |
2835 ** | 3091 ** |
2836 ** The details of the behavior of the sqlite3_step() interface depend | 3092 ** The details of the behavior of the sqlite3_step() interface depend |
2837 ** on whether the statement was prepared using the newer "v2" interface | 3093 ** on whether the statement was prepared using the newer "v2" interface |
2838 ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy | 3094 ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy |
2839 ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the | 3095 ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the |
2840 ** new "v2" interface is recommended for new applications but the legacy | 3096 ** new "v2" interface is recommended for new applications but the legacy |
2841 ** interface will continue to be supported. | 3097 ** interface will continue to be supported. |
2842 ** | 3098 ** |
2843 ** In the legacy interface, the return value will be either [SQLITE_BUSY], | 3099 ** ^In the legacy interface, the return value will be either [SQLITE_BUSY], |
2844 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. | 3100 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. |
2845 ** With the "v2" interface, any of the other [result codes] or | 3101 ** ^With the "v2" interface, any of the other [result codes] or |
2846 ** [extended result codes] might be returned as well. | 3102 ** [extended result codes] might be returned as well. |
2847 ** | 3103 ** |
2848 ** [SQLITE_BUSY] means that the database engine was unable to acquire the | 3104 ** ^[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] | 3105 ** 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 | 3106 ** 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 | 3107 ** statement. If the statement is not a [COMMIT] and occurs within a |
2852 ** explicit transaction then you should rollback the transaction before | 3108 ** explicit transaction then you should rollback the transaction before |
2853 ** continuing. | 3109 ** continuing. |
2854 ** | 3110 ** |
2855 ** [SQLITE_DONE] means that the statement has finished executing | 3111 ** ^[SQLITE_DONE] means that the statement has finished executing |
2856 ** successfully. sqlite3_step() should not be called again on this virtual | 3112 ** successfully. sqlite3_step() should not be called again on this virtual |
2857 ** machine without first calling [sqlite3_reset()] to reset the virtual | 3113 ** machine without first calling [sqlite3_reset()] to reset the virtual |
2858 ** machine back to its initial state. | 3114 ** machine back to its initial state. |
2859 ** | 3115 ** |
2860 ** If the SQL statement being executed returns any data, then [SQLITE_ROW] | 3116 ** ^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 | 3117 ** 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]. | 3118 ** caller. The values may be accessed using the [column access functions]. |
2863 ** sqlite3_step() is called again to retrieve the next row of data. | 3119 ** sqlite3_step() is called again to retrieve the next row of data. |
2864 ** | 3120 ** |
2865 ** [SQLITE_ERROR] means that a run-time error (such as a constraint | 3121 ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint |
2866 ** violation) has occurred. sqlite3_step() should not be called again on | 3122 ** violation) has occurred. sqlite3_step() should not be called again on |
2867 ** the VM. More information may be found by calling [sqlite3_errmsg()]. | 3123 ** the VM. More information may be found by calling [sqlite3_errmsg()]. |
2868 ** With the legacy interface, a more specific error code (for example, | 3124 ** ^With the legacy interface, a more specific error code (for example, |
2869 ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) | 3125 ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) |
2870 ** can be obtained by calling [sqlite3_reset()] on the | 3126 ** can be obtained by calling [sqlite3_reset()] on the |
2871 ** [prepared statement]. In the "v2" interface, | 3127 ** [prepared statement]. ^In the "v2" interface, |
2872 ** the more specific error code is returned directly by sqlite3_step(). | 3128 ** the more specific error code is returned directly by sqlite3_step(). |
2873 ** | 3129 ** |
2874 ** [SQLITE_MISUSE] means that the this routine was called inappropriately. | 3130 ** [SQLITE_MISUSE] means that the this routine was called inappropriately. |
2875 ** Perhaps it was called on a [prepared statement] that has | 3131 ** Perhaps it was called on a [prepared statement] that has |
2876 ** already been [sqlite3_finalize | finalized] or on one that had | 3132 ** already been [sqlite3_finalize | finalized] or on one that had |
2877 ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could | 3133 ** 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 | 3134 ** be the case that the same database connection is being used by two or |
2879 ** more threads at the same moment in time. | 3135 ** more threads at the same moment in time. |
2880 ** | 3136 ** |
| 3137 ** For all versions of SQLite up to and including 3.6.23.1, a call to |
| 3138 ** [sqlite3_reset()] was required after sqlite3_step() returned anything |
| 3139 ** other than [SQLITE_ROW] before any subsequent invocation of |
| 3140 ** sqlite3_step(). Failure to reset the prepared statement using |
| 3141 ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from |
| 3142 ** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began |
| 3143 ** calling [sqlite3_reset()] automatically in this circumstance rather |
| 3144 ** than returning [SQLITE_MISUSE]. This is not considered a compatibility |
| 3145 ** break because any application that ever receives an SQLITE_MISUSE error |
| 3146 ** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option |
| 3147 ** can be used to restore the legacy behavior. |
| 3148 ** |
2881 ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() | 3149 ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() |
2882 ** API always returns a generic error code, [SQLITE_ERROR], following any | 3150 ** API always returns a generic error code, [SQLITE_ERROR], following any |
2883 ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call | 3151 ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call |
2884 ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the | 3152 ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the |
2885 ** specific [error codes] that better describes the error. | 3153 ** specific [error codes] that better describes the error. |
2886 ** We admit that this is a goofy design. The problem has been fixed | 3154 ** 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 | 3155 ** with the "v2" interface. If you prepare all of your SQL statements |
2888 ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead | 3156 ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead |
2889 ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, | 3157 ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, |
2890 ** then the more specific [error codes] are returned directly | 3158 ** then the more specific [error codes] are returned directly |
2891 ** by sqlite3_step(). The use of the "v2" interface is recommended. | 3159 ** by sqlite3_step(). The use of the "v2" interface is recommended. |
2892 ** | |
2893 ** Requirements: | |
2894 ** [H13202] [H15304] [H15306] [H15308] [H15310] | |
2895 */ | 3160 */ |
2896 SQLITE_API int sqlite3_step(sqlite3_stmt*); | 3161 SQLITE_API int sqlite3_step(sqlite3_stmt*); |
2897 | 3162 |
2898 /* | 3163 /* |
2899 ** CAPI3REF: Number of columns in a result set {H13770} <S10700> | 3164 ** CAPI3REF: Number of columns in a result set |
2900 ** | 3165 ** |
2901 ** Returns the number of values in the current row of the result set. | 3166 ** ^The sqlite3_data_count(P) interface returns the number of columns in the |
| 3167 ** current row of the result set of [prepared statement] P. |
| 3168 ** ^If prepared statement P does not have results ready to return |
| 3169 ** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of |
| 3170 ** interfaces) then sqlite3_data_count(P) returns 0. |
| 3171 ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. |
2902 ** | 3172 ** |
2903 ** Requirements: | 3173 ** See also: [sqlite3_column_count()] |
2904 ** [H13771] [H13772] | |
2905 */ | 3174 */ |
2906 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt); | 3175 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt); |
2907 | 3176 |
2908 /* | 3177 /* |
2909 ** CAPI3REF: Fundamental Datatypes {H10265} <S10110><S10120> | 3178 ** CAPI3REF: Fundamental Datatypes |
2910 ** KEYWORDS: SQLITE_TEXT | 3179 ** KEYWORDS: SQLITE_TEXT |
2911 ** | 3180 ** |
2912 ** {H10266} Every value in SQLite has one of five fundamental datatypes: | 3181 ** ^(Every value in SQLite has one of five fundamental datatypes: |
2913 ** | 3182 ** |
2914 ** <ul> | 3183 ** <ul> |
2915 ** <li> 64-bit signed integer | 3184 ** <li> 64-bit signed integer |
2916 ** <li> 64-bit IEEE floating point number | 3185 ** <li> 64-bit IEEE floating point number |
2917 ** <li> string | 3186 ** <li> string |
2918 ** <li> BLOB | 3187 ** <li> BLOB |
2919 ** <li> NULL | 3188 ** <li> NULL |
2920 ** </ul> {END} | 3189 ** </ul>)^ |
2921 ** | 3190 ** |
2922 ** These constants are codes for each of those types. | 3191 ** These constants are codes for each of those types. |
2923 ** | 3192 ** |
2924 ** Note that the SQLITE_TEXT constant was also used in SQLite version 2 | 3193 ** Note that the SQLITE_TEXT constant was also used in SQLite version 2 |
2925 ** for a completely different meaning. Software that links against both | 3194 ** for a completely different meaning. Software that links against both |
2926 ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not | 3195 ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not |
2927 ** SQLITE_TEXT. | 3196 ** SQLITE_TEXT. |
2928 */ | 3197 */ |
2929 #define SQLITE_INTEGER 1 | 3198 #define SQLITE_INTEGER 1 |
2930 #define SQLITE_FLOAT 2 | 3199 #define SQLITE_FLOAT 2 |
2931 #define SQLITE_BLOB 4 | 3200 #define SQLITE_BLOB 4 |
2932 #define SQLITE_NULL 5 | 3201 #define SQLITE_NULL 5 |
2933 #ifdef SQLITE_TEXT | 3202 #ifdef SQLITE_TEXT |
2934 # undef SQLITE_TEXT | 3203 # undef SQLITE_TEXT |
2935 #else | 3204 #else |
2936 # define SQLITE_TEXT 3 | 3205 # define SQLITE_TEXT 3 |
2937 #endif | 3206 #endif |
2938 #define SQLITE3_TEXT 3 | 3207 #define SQLITE3_TEXT 3 |
2939 | 3208 |
2940 /* | 3209 /* |
2941 ** CAPI3REF: Result Values From A Query {H13800} <S10700> | 3210 ** CAPI3REF: Result Values From A Query |
2942 ** KEYWORDS: {column access functions} | 3211 ** KEYWORDS: {column access functions} |
2943 ** | 3212 ** |
2944 ** These routines form the "result set query" interface. | 3213 ** These routines form the "result set" interface. |
2945 ** | 3214 ** |
2946 ** These routines return information about a single column of the current | 3215 ** ^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 | 3216 ** 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*] | 3217 ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] |
2949 ** that was returned from [sqlite3_prepare_v2()] or one of its variants) | 3218 ** 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 | 3219 ** 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. | 3220 ** should be returned. ^The leftmost column of the result set has the index 0. |
| 3221 ** ^The number of columns in the result can be determined using |
| 3222 ** [sqlite3_column_count()]. |
2952 ** | 3223 ** |
2953 ** If the SQL statement does not currently point to a valid row, or if the | 3224 ** 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. | 3225 ** column index is out of range, the result is undefined. |
2955 ** These routines may only be called when the most recent call to | 3226 ** These routines may only be called when the most recent call to |
2956 ** [sqlite3_step()] has returned [SQLITE_ROW] and neither | 3227 ** [sqlite3_step()] has returned [SQLITE_ROW] and neither |
2957 ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. | 3228 ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. |
2958 ** If any of these routines are called after [sqlite3_reset()] or | 3229 ** If any of these routines are called after [sqlite3_reset()] or |
2959 ** [sqlite3_finalize()] or after [sqlite3_step()] has returned | 3230 ** [sqlite3_finalize()] or after [sqlite3_step()] has returned |
2960 ** something other than [SQLITE_ROW], the results are undefined. | 3231 ** something other than [SQLITE_ROW], the results are undefined. |
2961 ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] | 3232 ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] |
2962 ** are called from a different thread while any of these routines | 3233 ** are called from a different thread while any of these routines |
2963 ** are pending, then the results are undefined. | 3234 ** are pending, then the results are undefined. |
2964 ** | 3235 ** |
2965 ** The sqlite3_column_type() routine returns the | 3236 ** ^The sqlite3_column_type() routine returns the |
2966 ** [SQLITE_INTEGER | datatype code] for the initial data type | 3237 ** [SQLITE_INTEGER | datatype code] for the initial data type |
2967 ** of the result column. The returned value is one of [SQLITE_INTEGER], | 3238 ** of the result column. ^The returned value is one of [SQLITE_INTEGER], |
2968 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value | 3239 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value |
2969 ** returned by sqlite3_column_type() is only meaningful if no type | 3240 ** returned by sqlite3_column_type() is only meaningful if no type |
2970 ** conversions have occurred as described below. After a type conversion, | 3241 ** conversions have occurred as described below. After a type conversion, |
2971 ** the value returned by sqlite3_column_type() is undefined. Future | 3242 ** the value returned by sqlite3_column_type() is undefined. Future |
2972 ** versions of SQLite may change the behavior of sqlite3_column_type() | 3243 ** versions of SQLite may change the behavior of sqlite3_column_type() |
2973 ** following a type conversion. | 3244 ** following a type conversion. |
2974 ** | 3245 ** |
2975 ** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() | 3246 ** ^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. | 3247 ** 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 | 3248 ** ^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. | 3249 ** 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 | 3250 ** ^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 | 3251 ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns |
2981 ** the number of bytes in that string. | 3252 ** the number of bytes in that string. |
2982 ** The value returned does not include the zero terminator at the end | 3253 ** ^If the result is NULL, then sqlite3_column_bytes() returns zero. |
2983 ** of the string. For clarity: the value returned is the number of | 3254 ** |
| 3255 ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16() |
| 3256 ** routine returns the number of bytes in that BLOB or string. |
| 3257 ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts |
| 3258 ** the string to UTF-16 and then returns the number of bytes. |
| 3259 ** ^If the result is a numeric value then sqlite3_column_bytes16() uses |
| 3260 ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns |
| 3261 ** the number of bytes in that string. |
| 3262 ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. |
| 3263 ** |
| 3264 ** ^The values returned by [sqlite3_column_bytes()] and |
| 3265 ** [sqlite3_column_bytes16()] do not include the zero terminators at the end |
| 3266 ** of the string. ^For clarity: the values returned by |
| 3267 ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of |
2984 ** bytes in the string, not the number of characters. | 3268 ** bytes in the string, not the number of characters. |
2985 ** | 3269 ** |
2986 ** Strings returned by sqlite3_column_text() and sqlite3_column_text16(), | 3270 ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), |
2987 ** even empty strings, are always zero terminated. The return | 3271 ** even empty strings, are always zero terminated. ^The return |
2988 ** value from sqlite3_column_blob() for a zero-length BLOB is an arbitrary | 3272 ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. |
2989 ** pointer, possibly even a NULL pointer. | |
2990 ** | 3273 ** |
2991 ** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes() | 3274 ** ^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 | 3275 ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object |
2997 ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. | 3276 ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. |
2998 ** If the [unprotected sqlite3_value] object returned by | 3277 ** If the [unprotected sqlite3_value] object returned by |
2999 ** [sqlite3_column_value()] is used in any other way, including calls | 3278 ** [sqlite3_column_value()] is used in any other way, including calls |
3000 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()], | 3279 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()], |
3001 ** or [sqlite3_value_bytes()], then the behavior is undefined. | 3280 ** or [sqlite3_value_bytes()], then the behavior is undefined. |
3002 ** | 3281 ** |
3003 ** These routines attempt to convert the value where appropriate. For | 3282 ** These routines attempt to convert the value where appropriate. ^For |
3004 ** example, if the internal representation is FLOAT and a text result | 3283 ** example, if the internal representation is FLOAT and a text result |
3005 ** is requested, [sqlite3_snprintf()] is used internally to perform the | 3284 ** is requested, [sqlite3_snprintf()] is used internally to perform the |
3006 ** conversion automatically. The following table details the conversions | 3285 ** conversion automatically. ^(The following table details the conversions |
3007 ** that are applied: | 3286 ** that are applied: |
3008 ** | 3287 ** |
3009 ** <blockquote> | 3288 ** <blockquote> |
3010 ** <table border="1"> | 3289 ** <table border="1"> |
3011 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion | 3290 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion |
3012 ** | 3291 ** |
3013 ** <tr><td> NULL <td> INTEGER <td> Result is 0 | 3292 ** <tr><td> NULL <td> INTEGER <td> Result is 0 |
3014 ** <tr><td> NULL <td> FLOAT <td> Result is 0.0 | 3293 ** <tr><td> NULL <td> FLOAT <td> Result is 0.0 |
3015 ** <tr><td> NULL <td> TEXT <td> Result is NULL pointer | 3294 ** <tr><td> NULL <td> TEXT <td> Result is NULL pointer |
3016 ** <tr><td> NULL <td> BLOB <td> Result is NULL pointer | 3295 ** <tr><td> NULL <td> BLOB <td> Result is NULL pointer |
3017 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float | 3296 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float |
3018 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer | 3297 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer |
3019 ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT | 3298 ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT |
3020 ** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer | 3299 ** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer |
3021 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float | 3300 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float |
3022 ** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT | 3301 ** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT |
3023 ** <tr><td> TEXT <td> INTEGER <td> Use atoi() | 3302 ** <tr><td> TEXT <td> INTEGER <td> Use atoi() |
3024 ** <tr><td> TEXT <td> FLOAT <td> Use atof() | 3303 ** <tr><td> TEXT <td> FLOAT <td> Use atof() |
3025 ** <tr><td> TEXT <td> BLOB <td> No change | 3304 ** <tr><td> TEXT <td> BLOB <td> No change |
3026 ** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() | 3305 ** <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() | 3306 ** <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 | 3307 ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed |
3029 ** </table> | 3308 ** </table> |
3030 ** </blockquote> | 3309 ** </blockquote>)^ |
3031 ** | 3310 ** |
3032 ** The table above makes reference to standard C library functions atoi() | 3311 ** The table above makes reference to standard C library functions atoi() |
3033 ** and atof(). SQLite does not really use these functions. It has its | 3312 ** and atof(). SQLite does not really use these functions. It has its |
3034 ** own equivalent internal routines. The atoi() and atof() names are | 3313 ** own equivalent internal routines. The atoi() and atof() names are |
3035 ** used in the table for brevity and because they are familiar to most | 3314 ** used in the table for brevity and because they are familiar to most |
3036 ** C programmers. | 3315 ** C programmers. |
3037 ** | 3316 ** |
3038 ** Note that when type conversions occur, pointers returned by prior | 3317 ** Note that when type conversions occur, pointers returned by prior |
3039 ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or | 3318 ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or |
3040 ** sqlite3_column_text16() may be invalidated. | 3319 ** sqlite3_column_text16() may be invalidated. |
3041 ** Type conversions and pointer invalidations might occur | 3320 ** Type conversions and pointer invalidations might occur |
3042 ** in the following cases: | 3321 ** in the following cases: |
3043 ** | 3322 ** |
3044 ** <ul> | 3323 ** <ul> |
3045 ** <li> The initial content is a BLOB and sqlite3_column_text() or | 3324 ** <li> The initial content is a BLOB and sqlite3_column_text() or |
3046 ** sqlite3_column_text16() is called. A zero-terminator might | 3325 ** sqlite3_column_text16() is called. A zero-terminator might |
3047 ** need to be added to the string.</li> | 3326 ** need to be added to the string.</li> |
3048 ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or | 3327 ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or |
3049 ** sqlite3_column_text16() is called. The content must be converted | 3328 ** sqlite3_column_text16() is called. The content must be converted |
3050 ** to UTF-16.</li> | 3329 ** to UTF-16.</li> |
3051 ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or | 3330 ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or |
3052 ** sqlite3_column_text() is called. The content must be converted | 3331 ** sqlite3_column_text() is called. The content must be converted |
3053 ** to UTF-8.</li> | 3332 ** to UTF-8.</li> |
3054 ** </ul> | 3333 ** </ul> |
3055 ** | 3334 ** |
3056 ** Conversions between UTF-16be and UTF-16le are always done in place and do | 3335 ** ^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 | 3336 ** 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 | 3337 ** 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 | 3338 ** 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. | 3339 ** are not possible and in those cases prior pointers are invalidated. |
3061 ** | 3340 ** |
3062 ** The safest and easiest to remember policy is to invoke these routines | 3341 ** The safest and easiest to remember policy is to invoke these routines |
3063 ** in one of the following ways: | 3342 ** in one of the following ways: |
3064 ** | 3343 ** |
3065 ** <ul> | 3344 ** <ul> |
3066 ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> | 3345 ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> |
3067 ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> | 3346 ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> |
3068 ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> | 3347 ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> |
3069 ** </ul> | 3348 ** </ul> |
3070 ** | 3349 ** |
3071 ** In other words, you should call sqlite3_column_text(), | 3350 ** In other words, you should call sqlite3_column_text(), |
3072 ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result | 3351 ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result |
3073 ** into the desired format, then invoke sqlite3_column_bytes() or | 3352 ** 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 | 3353 ** 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 | 3354 ** to sqlite3_column_text() or sqlite3_column_blob() with calls to |
3076 ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() | 3355 ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() |
3077 ** with calls to sqlite3_column_bytes(). | 3356 ** with calls to sqlite3_column_bytes(). |
3078 ** | 3357 ** |
3079 ** The pointers returned are valid until a type conversion occurs as | 3358 ** ^The pointers returned are valid until a type conversion occurs as |
3080 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or | 3359 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or |
3081 ** [sqlite3_finalize()] is called. The memory space used to hold strings | 3360 ** [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 | 3361 ** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned |
3083 ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into | 3362 ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into |
3084 ** [sqlite3_free()]. | 3363 ** [sqlite3_free()]. |
3085 ** | 3364 ** |
3086 ** If a memory allocation error occurs during the evaluation of any | 3365 ** ^(If a memory allocation error occurs during the evaluation of any |
3087 ** of these routines, a default value is returned. The default value | 3366 ** 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 | 3367 ** is either the integer 0, the floating point number 0.0, or a NULL |
3089 ** pointer. Subsequent calls to [sqlite3_errcode()] will return | 3368 ** pointer. Subsequent calls to [sqlite3_errcode()] will return |
3090 ** [SQLITE_NOMEM]. | 3369 ** [SQLITE_NOMEM].)^ |
3091 ** | |
3092 ** Requirements: | |
3093 ** [H13803] [H13806] [H13809] [H13812] [H13815] [H13818] [H13821] [H13824] | |
3094 ** [H13827] [H13830] | |
3095 */ | 3370 */ |
3096 SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); | 3371 SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); |
3097 SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); | 3372 SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); |
3098 SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); | 3373 SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); |
3099 SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); | 3374 SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); |
3100 SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); | 3375 SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); |
3101 SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); | 3376 SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); |
3102 SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); | 3377 SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); |
3103 SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); | 3378 SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); |
3104 SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); | 3379 SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); |
3105 SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); | 3380 SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); |
3106 | 3381 |
3107 /* | 3382 /* |
3108 ** CAPI3REF: Destroy A Prepared Statement Object {H13300} <S70300><S30100> | 3383 ** CAPI3REF: Destroy A Prepared Statement Object |
3109 ** | 3384 ** |
3110 ** The sqlite3_finalize() function is called to delete a [prepared statement]. | 3385 ** ^The sqlite3_finalize() function is called to delete a [prepared statement]. |
3111 ** If the statement was executed successfully or not executed at all, then | 3386 ** ^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 | 3387 ** or if the statement is never been evaluated, then sqlite3_finalize() returns |
3113 ** [error code] or [extended error code] is returned. | 3388 ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then |
| 3389 ** sqlite3_finalize(S) returns the appropriate [error code] or |
| 3390 ** [extended error code]. |
3114 ** | 3391 ** |
3115 ** This routine can be called at any point during the execution of the | 3392 ** ^The sqlite3_finalize(S) routine can be called at any point during |
3116 ** [prepared statement]. If the virtual machine has not | 3393 ** the life cycle of [prepared statement] S: |
3117 ** completed execution when this routine is called, that is like | 3394 ** before statement S is ever evaluated, after |
3118 ** encountering an error or an [sqlite3_interrupt | interrupt]. | 3395 ** one or more calls to [sqlite3_reset()], or after any call |
3119 ** Incomplete updates may be rolled back and transactions canceled, | 3396 ** to [sqlite3_step()] regardless of whether or not the statement has |
3120 ** depending on the circumstances, and the | 3397 ** completed execution. |
3121 ** [error code] returned will be [SQLITE_ABORT]. | |
3122 ** | 3398 ** |
3123 ** Requirements: | 3399 ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op. |
3124 ** [H11302] [H11304] | 3400 ** |
| 3401 ** The application must finalize every [prepared statement] in order to avoid |
| 3402 ** resource leaks. It is a grievous error for the application to try to use |
| 3403 ** a prepared statement after it has been finalized. Any use of a prepared |
| 3404 ** statement after it has been finalized can result in undefined and |
| 3405 ** undesirable behavior such as segfaults and heap corruption. |
3125 */ | 3406 */ |
3126 SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt); | 3407 SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt); |
3127 | 3408 |
3128 /* | 3409 /* |
3129 ** CAPI3REF: Reset A Prepared Statement Object {H13330} <S70300> | 3410 ** CAPI3REF: Reset A Prepared Statement Object |
3130 ** | 3411 ** |
3131 ** The sqlite3_reset() function is called to reset a [prepared statement] | 3412 ** The sqlite3_reset() function is called to reset a [prepared statement] |
3132 ** object back to its initial state, ready to be re-executed. | 3413 ** object back to its initial state, ready to be re-executed. |
3133 ** Any SQL statement variables that had values bound to them using | 3414 ** ^Any SQL statement variables that had values bound to them using |
3134 ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. | 3415 ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. |
3135 ** Use [sqlite3_clear_bindings()] to reset the bindings. | 3416 ** Use [sqlite3_clear_bindings()] to reset the bindings. |
3136 ** | 3417 ** |
3137 ** {H11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S | 3418 ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S |
3138 ** back to the beginning of its program. | 3419 ** back to the beginning of its program. |
3139 ** | 3420 ** |
3140 ** {H11334} If the most recent call to [sqlite3_step(S)] for the | 3421 ** ^If the most recent call to [sqlite3_step(S)] for the |
3141 ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], | 3422 ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], |
3142 ** or if [sqlite3_step(S)] has never before been called on S, | 3423 ** or if [sqlite3_step(S)] has never before been called on S, |
3143 ** then [sqlite3_reset(S)] returns [SQLITE_OK]. | 3424 ** then [sqlite3_reset(S)] returns [SQLITE_OK]. |
3144 ** | 3425 ** |
3145 ** {H11336} If the most recent call to [sqlite3_step(S)] for the | 3426 ** ^If the most recent call to [sqlite3_step(S)] for the |
3146 ** [prepared statement] S indicated an error, then | 3427 ** [prepared statement] S indicated an error, then |
3147 ** [sqlite3_reset(S)] returns an appropriate [error code]. | 3428 ** [sqlite3_reset(S)] returns an appropriate [error code]. |
3148 ** | 3429 ** |
3149 ** {H11338} The [sqlite3_reset(S)] interface does not change the values | 3430 ** ^The [sqlite3_reset(S)] interface does not change the values |
3150 ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. | 3431 ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. |
3151 */ | 3432 */ |
3152 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); | 3433 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); |
3153 | 3434 |
3154 /* | 3435 /* |
3155 ** CAPI3REF: Create Or Redefine SQL Functions {H16100} <S20200> | 3436 ** CAPI3REF: Create Or Redefine SQL Functions |
3156 ** KEYWORDS: {function creation routines} | 3437 ** KEYWORDS: {function creation routines} |
3157 ** KEYWORDS: {application-defined SQL function} | 3438 ** KEYWORDS: {application-defined SQL function} |
3158 ** KEYWORDS: {application-defined SQL functions} | 3439 ** KEYWORDS: {application-defined SQL functions} |
3159 ** | 3440 ** |
3160 ** These two functions (collectively known as "function creation routines") | 3441 ** ^These functions (collectively known as "function creation routines") |
3161 ** are used to add SQL functions or aggregates or to redefine the behavior | 3442 ** 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 | 3443 ** of existing SQL functions or aggregates. The only differences between |
3163 ** two is that the second parameter, the name of the (scalar) function or | 3444 ** these routines are the text encoding expected for |
3164 ** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16 | 3445 ** the second parameter (the name of the function being created) |
3165 ** for sqlite3_create_function16(). | 3446 ** and the presence or absence of a destructor callback for |
| 3447 ** the application data pointer. |
3166 ** | 3448 ** |
3167 ** The first parameter is the [database connection] to which the SQL | 3449 ** ^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 | 3450 ** function is to be added. ^If an application uses more than one database |
3169 ** connection internally, then SQL functions must be added individually to | 3451 ** connection then application-defined SQL functions must be added |
3170 ** each database connection. | 3452 ** to each database connection separately. |
3171 ** | 3453 ** |
3172 ** The second parameter is the name of the SQL function to be created or | 3454 ** ^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 | 3455 ** 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 | 3456 ** representation, exclusive of the zero-terminator. ^Note that the name |
3175 ** characters. Any attempt to create a function with a longer name | 3457 ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. |
3176 ** will result in [SQLITE_ERROR] being returned. | 3458 ** ^Any attempt to create a function with a longer name |
| 3459 ** will result in [SQLITE_MISUSE] being returned. |
3177 ** | 3460 ** |
3178 ** The third parameter (nArg) | 3461 ** ^The third parameter (nArg) |
3179 ** is the number of arguments that the SQL function or | 3462 ** is the number of arguments that the SQL function or |
3180 ** aggregate takes. If this parameter is -1, then the SQL function or | 3463 ** 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 | 3464 ** aggregate may take any number of arguments between 0 and the limit |
3182 ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third | 3465 ** 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 | 3466 ** parameter is less than -1 or greater than 127 then the behavior is |
3184 ** undefined. | 3467 ** undefined. |
3185 ** | 3468 ** |
3186 ** The fourth parameter, eTextRep, specifies what | 3469 ** ^The fourth parameter, eTextRep, specifies what |
3187 ** [SQLITE_UTF8 | text encoding] this SQL function prefers for | 3470 ** [SQLITE_UTF8 | text encoding] this SQL function prefers for |
3188 ** its parameters. Any SQL function implementation should be able to work | 3471 ** 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 | 3472 ** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be |
3190 ** more efficient with one encoding than another. An application may | 3473 ** more efficient with one encoding than another. ^An application may |
3191 ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple | 3474 ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple |
3192 ** times with the same function but with different values of eTextRep. | 3475 ** times with the same function but with different values of eTextRep. |
3193 ** When multiple implementations of the same function are available, SQLite | 3476 ** ^When multiple implementations of the same function are available, SQLite |
3194 ** will pick the one that involves the least amount of data conversion. | 3477 ** 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 | 3478 ** 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]. | 3479 ** encoding is used, then the fourth argument should be [SQLITE_ANY]. |
3197 ** | 3480 ** |
3198 ** The fifth parameter is an arbitrary pointer. The implementation of the | 3481 ** ^(The fifth parameter is an arbitrary pointer. The implementation of the |
3199 ** function can gain access to this pointer using [sqlite3_user_data()]. | 3482 ** function can gain access to this pointer using [sqlite3_user_data()].)^ |
3200 ** | 3483 ** |
3201 ** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are | 3484 ** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are |
3202 ** pointers to C-language functions that implement the SQL function or | 3485 ** pointers to C-language functions that implement the SQL function or |
3203 ** aggregate. A scalar SQL function requires an implementation of the xFunc | 3486 ** aggregate. ^A scalar SQL function requires an implementation of the xFunc |
3204 ** callback only, NULL pointers should be passed as the xStep and xFinal | 3487 ** callback only; NULL pointers must be passed as the xStep and xFinal |
3205 ** parameters. An aggregate SQL function requires an implementation of xStep | 3488 ** parameters. ^An aggregate SQL function requires an implementation of xStep |
3206 ** and xFinal and NULL should be passed for xFunc. To delete an existing | 3489 ** 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. | 3490 ** SQL function or aggregate, pass NULL pointers for all three function |
| 3491 ** callbacks. |
3208 ** | 3492 ** |
3209 ** It is permitted to register multiple implementations of the same | 3493 ** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL, |
| 3494 ** then it is destructor for the application data pointer. |
| 3495 ** The destructor is invoked when the function is deleted, either by being |
| 3496 ** overloaded or when the database connection closes.)^ |
| 3497 ** ^The destructor is also invoked if the call to |
| 3498 ** sqlite3_create_function_v2() fails. |
| 3499 ** ^When the destructor callback of the tenth parameter is invoked, it |
| 3500 ** is passed a single argument which is a copy of the application data |
| 3501 ** pointer which was the fifth parameter to sqlite3_create_function_v2(). |
| 3502 ** |
| 3503 ** ^It is permitted to register multiple implementations of the same |
3210 ** functions with the same name but with either differing numbers of | 3504 ** functions with the same name but with either differing numbers of |
3211 ** arguments or differing preferred text encodings. SQLite will use | 3505 ** arguments or differing preferred text encodings. ^SQLite will use |
3212 ** the implementation that most closely matches the way in which the | 3506 ** the implementation that most closely matches the way in which the |
3213 ** SQL function is used. A function implementation with a non-negative | 3507 ** SQL function is used. ^A function implementation with a non-negative |
3214 ** nArg parameter is a better match than a function implementation with | 3508 ** nArg parameter is a better match than a function implementation with |
3215 ** a negative nArg. A function where the preferred text encoding | 3509 ** a negative nArg. ^A function where the preferred text encoding |
3216 ** matches the database encoding is a better | 3510 ** matches the database encoding is a better |
3217 ** match than a function where the encoding is different. | 3511 ** match than a function where the encoding is different. |
3218 ** A function where the encoding difference is between UTF16le and UTF16be | 3512 ** ^A function where the encoding difference is between UTF16le and UTF16be |
3219 ** is a closer match than a function where the encoding difference is | 3513 ** is a closer match than a function where the encoding difference is |
3220 ** between UTF8 and UTF16. | 3514 ** between UTF8 and UTF16. |
3221 ** | 3515 ** |
3222 ** Built-in functions may be overloaded by new application-defined functions. | 3516 ** ^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 ** | 3517 ** |
3229 ** An application-defined function is permitted to call other | 3518 ** ^An application-defined function is permitted to call other |
3230 ** SQLite interfaces. However, such calls must not | 3519 ** SQLite interfaces. However, such calls must not |
3231 ** close the database connection nor finalize or reset the prepared | 3520 ** close the database connection nor finalize or reset the prepared |
3232 ** statement in which the function is running. | 3521 ** 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 */ | 3522 */ |
3238 SQLITE_API int sqlite3_create_function( | 3523 SQLITE_API int sqlite3_create_function( |
3239 sqlite3 *db, | 3524 sqlite3 *db, |
3240 const char *zFunctionName, | 3525 const char *zFunctionName, |
3241 int nArg, | 3526 int nArg, |
3242 int eTextRep, | 3527 int eTextRep, |
3243 void *pApp, | 3528 void *pApp, |
3244 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), | 3529 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), |
3245 void (*xStep)(sqlite3_context*,int,sqlite3_value**), | 3530 void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
3246 void (*xFinal)(sqlite3_context*) | 3531 void (*xFinal)(sqlite3_context*) |
3247 ); | 3532 ); |
3248 SQLITE_API int sqlite3_create_function16( | 3533 SQLITE_API int sqlite3_create_function16( |
3249 sqlite3 *db, | 3534 sqlite3 *db, |
3250 const void *zFunctionName, | 3535 const void *zFunctionName, |
3251 int nArg, | 3536 int nArg, |
3252 int eTextRep, | 3537 int eTextRep, |
3253 void *pApp, | 3538 void *pApp, |
3254 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), | 3539 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), |
3255 void (*xStep)(sqlite3_context*,int,sqlite3_value**), | 3540 void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
3256 void (*xFinal)(sqlite3_context*) | 3541 void (*xFinal)(sqlite3_context*) |
3257 ); | 3542 ); |
| 3543 SQLITE_API int sqlite3_create_function_v2( |
| 3544 sqlite3 *db, |
| 3545 const char *zFunctionName, |
| 3546 int nArg, |
| 3547 int eTextRep, |
| 3548 void *pApp, |
| 3549 void (*xFunc)(sqlite3_context*,int,sqlite3_value**), |
| 3550 void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
| 3551 void (*xFinal)(sqlite3_context*), |
| 3552 void(*xDestroy)(void*) |
| 3553 ); |
3258 | 3554 |
3259 /* | 3555 /* |
3260 ** CAPI3REF: Text Encodings {H10267} <S50200> <H16100> | 3556 ** CAPI3REF: Text Encodings |
3261 ** | 3557 ** |
3262 ** These constant define integer codes that represent the various | 3558 ** These constant define integer codes that represent the various |
3263 ** text encodings supported by SQLite. | 3559 ** text encodings supported by SQLite. |
3264 */ | 3560 */ |
3265 #define SQLITE_UTF8 1 | 3561 #define SQLITE_UTF8 1 |
3266 #define SQLITE_UTF16LE 2 | 3562 #define SQLITE_UTF16LE 2 |
3267 #define SQLITE_UTF16BE 3 | 3563 #define SQLITE_UTF16BE 3 |
3268 #define SQLITE_UTF16 4 /* Use native byte order */ | 3564 #define SQLITE_UTF16 4 /* Use native byte order */ |
3269 #define SQLITE_ANY 5 /* sqlite3_create_function only */ | 3565 #define SQLITE_ANY 5 /* sqlite3_create_function only */ |
3270 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ | 3566 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ |
(...skipping 11 matching lines...) Expand all Loading... |
3282 #ifndef SQLITE_OMIT_DEPRECATED | 3578 #ifndef SQLITE_OMIT_DEPRECATED |
3283 SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); | 3579 SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); |
3284 SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); | 3580 SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); |
3285 SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite
3_stmt*); | 3581 SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite
3_stmt*); |
3286 SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); | 3582 SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); |
3287 SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); | 3583 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); | 3584 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int6
4,int),void*,sqlite3_int64); |
3289 #endif | 3585 #endif |
3290 | 3586 |
3291 /* | 3587 /* |
3292 ** CAPI3REF: Obtaining SQL Function Parameter Values {H15100} <S20200> | 3588 ** CAPI3REF: Obtaining SQL Function Parameter Values |
3293 ** | 3589 ** |
3294 ** The C-language implementation of SQL functions and aggregates uses | 3590 ** The C-language implementation of SQL functions and aggregates uses |
3295 ** this set of interface routines to access the parameter values on | 3591 ** this set of interface routines to access the parameter values on |
3296 ** the function or aggregate. | 3592 ** the function or aggregate. |
3297 ** | 3593 ** |
3298 ** The xFunc (for scalar functions) or xStep (for aggregates) parameters | 3594 ** The xFunc (for scalar functions) or xStep (for aggregates) parameters |
3299 ** to [sqlite3_create_function()] and [sqlite3_create_function16()] | 3595 ** to [sqlite3_create_function()] and [sqlite3_create_function16()] |
3300 ** define callbacks that implement the SQL functions and aggregates. | 3596 ** define callbacks that implement the SQL functions and aggregates. |
3301 ** The 4th parameter to these callbacks is an array of pointers to | 3597 ** The 3rd parameter to these callbacks is an array of pointers to |
3302 ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for | 3598 ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for |
3303 ** each parameter to the SQL function. These routines are used to | 3599 ** each parameter to the SQL function. These routines are used to |
3304 ** extract values from the [sqlite3_value] objects. | 3600 ** extract values from the [sqlite3_value] objects. |
3305 ** | 3601 ** |
3306 ** These routines work only with [protected sqlite3_value] objects. | 3602 ** These routines work only with [protected sqlite3_value] objects. |
3307 ** Any attempt to use these routines on an [unprotected sqlite3_value] | 3603 ** Any attempt to use these routines on an [unprotected sqlite3_value] |
3308 ** object results in undefined behavior. | 3604 ** object results in undefined behavior. |
3309 ** | 3605 ** |
3310 ** These routines work just like the corresponding [column access functions] | 3606 ** ^These routines work just like the corresponding [column access functions] |
3311 ** except that these routines take a single [protected sqlite3_value] object | 3607 ** except that these routines take a single [protected sqlite3_value] object |
3312 ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. | 3608 ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. |
3313 ** | 3609 ** |
3314 ** The sqlite3_value_text16() interface extracts a UTF-16 string | 3610 ** ^The sqlite3_value_text16() interface extracts a UTF-16 string |
3315 ** in the native byte-order of the host machine. The | 3611 ** in the native byte-order of the host machine. ^The |
3316 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces | 3612 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces |
3317 ** extract UTF-16 strings as big-endian and little-endian respectively. | 3613 ** extract UTF-16 strings as big-endian and little-endian respectively. |
3318 ** | 3614 ** |
3319 ** The sqlite3_value_numeric_type() interface attempts to apply | 3615 ** ^(The sqlite3_value_numeric_type() interface attempts to apply |
3320 ** numeric affinity to the value. This means that an attempt is | 3616 ** numeric affinity to the value. This means that an attempt is |
3321 ** made to convert the value to an integer or floating point. If | 3617 ** made to convert the value to an integer or floating point. If |
3322 ** such a conversion is possible without loss of information (in other | 3618 ** such a conversion is possible without loss of information (in other |
3323 ** words, if the value is a string that looks like a number) | 3619 ** words, if the value is a string that looks like a number) |
3324 ** then the conversion is performed. Otherwise no conversion occurs. | 3620 ** then the conversion is performed. Otherwise no conversion occurs. |
3325 ** The [SQLITE_INTEGER | datatype] after conversion is returned. | 3621 ** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ |
3326 ** | 3622 ** |
3327 ** Please pay particular attention to the fact that the pointer returned | 3623 ** Please pay particular attention to the fact that the pointer returned |
3328 ** from [sqlite3_value_blob()], [sqlite3_value_text()], or | 3624 ** from [sqlite3_value_blob()], [sqlite3_value_text()], or |
3329 ** [sqlite3_value_text16()] can be invalidated by a subsequent call to | 3625 ** [sqlite3_value_text16()] can be invalidated by a subsequent call to |
3330 ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], | 3626 ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], |
3331 ** or [sqlite3_value_text16()]. | 3627 ** or [sqlite3_value_text16()]. |
3332 ** | 3628 ** |
3333 ** These routines must be called from the same thread as | 3629 ** These routines must be called from the same thread as |
3334 ** the SQL function that supplied the [sqlite3_value*] parameters. | 3630 ** 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 */ | 3631 */ |
3340 SQLITE_API const void *sqlite3_value_blob(sqlite3_value*); | 3632 SQLITE_API const void *sqlite3_value_blob(sqlite3_value*); |
3341 SQLITE_API int sqlite3_value_bytes(sqlite3_value*); | 3633 SQLITE_API int sqlite3_value_bytes(sqlite3_value*); |
3342 SQLITE_API int sqlite3_value_bytes16(sqlite3_value*); | 3634 SQLITE_API int sqlite3_value_bytes16(sqlite3_value*); |
3343 SQLITE_API double sqlite3_value_double(sqlite3_value*); | 3635 SQLITE_API double sqlite3_value_double(sqlite3_value*); |
3344 SQLITE_API int sqlite3_value_int(sqlite3_value*); | 3636 SQLITE_API int sqlite3_value_int(sqlite3_value*); |
3345 SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); | 3637 SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); |
3346 SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); | 3638 SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); |
3347 SQLITE_API const void *sqlite3_value_text16(sqlite3_value*); | 3639 SQLITE_API const void *sqlite3_value_text16(sqlite3_value*); |
3348 SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); | 3640 SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); |
3349 SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); | 3641 SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); |
3350 SQLITE_API int sqlite3_value_type(sqlite3_value*); | 3642 SQLITE_API int sqlite3_value_type(sqlite3_value*); |
3351 SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); | 3643 SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); |
3352 | 3644 |
3353 /* | 3645 /* |
3354 ** CAPI3REF: Obtain Aggregate Function Context {H16210} <S20200> | 3646 ** CAPI3REF: Obtain Aggregate Function Context |
3355 ** | 3647 ** |
3356 ** The implementation of aggregate SQL functions use this routine to allocate | 3648 ** Implementations of aggregate SQL functions use this |
3357 ** a structure for storing their state. | 3649 ** routine to allocate memory for storing their state. |
3358 ** | 3650 ** |
3359 ** The first time the sqlite3_aggregate_context() routine is called for a | 3651 ** ^The first time the sqlite3_aggregate_context(C,N) routine is called |
3360 ** particular aggregate, SQLite allocates nBytes of memory, zeroes out that | 3652 ** for a particular aggregate function, SQLite |
3361 ** memory, and returns a pointer to it. On second and subsequent calls to | 3653 ** allocates N of memory, zeroes out that memory, and returns a pointer |
3362 ** sqlite3_aggregate_context() for the same aggregate function index, | 3654 ** to the new memory. ^On second and subsequent calls to |
3363 ** the same buffer is returned. The implementation of the aggregate can use | 3655 ** sqlite3_aggregate_context() for the same aggregate function instance, |
3364 ** the returned buffer to accumulate data. | 3656 ** the same buffer is returned. Sqlite3_aggregate_context() is normally |
| 3657 ** called once for each invocation of the xStep callback and then one |
| 3658 ** last time when the xFinal callback is invoked. ^(When no rows match |
| 3659 ** an aggregate query, the xStep() callback of the aggregate function |
| 3660 ** implementation is never called and xFinal() is called exactly once. |
| 3661 ** In those cases, sqlite3_aggregate_context() might be called for the |
| 3662 ** first time from within xFinal().)^ |
3365 ** | 3663 ** |
3366 ** SQLite automatically frees the allocated buffer when the aggregate | 3664 ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is |
3367 ** query concludes. | 3665 ** less than or equal to zero or if a memory allocate error occurs. |
3368 ** | 3666 ** |
3369 ** The first parameter should be a copy of the | 3667 ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is |
| 3668 ** determined by the N parameter on first successful call. Changing the |
| 3669 ** value of N in subsequent call to sqlite3_aggregate_context() within |
| 3670 ** the same aggregate function instance will not resize the memory |
| 3671 ** allocation.)^ |
| 3672 ** |
| 3673 ** ^SQLite automatically frees the memory allocated by |
| 3674 ** sqlite3_aggregate_context() when the aggregate query concludes. |
| 3675 ** |
| 3676 ** The first parameter must be a copy of the |
3370 ** [sqlite3_context | SQL function context] that is the first parameter | 3677 ** [sqlite3_context | SQL function context] that is the first parameter |
3371 ** to the callback routine that implements the aggregate function. | 3678 ** to the xStep or xFinal callback routine that implements the aggregate |
| 3679 ** function. |
3372 ** | 3680 ** |
3373 ** This routine must be called from the same thread in which | 3681 ** This routine must be called from the same thread in which |
3374 ** the aggregate SQL function is running. | 3682 ** the aggregate SQL function is running. |
3375 ** | |
3376 ** Requirements: | |
3377 ** [H16211] [H16213] [H16215] [H16217] | |
3378 */ | 3683 */ |
3379 SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); | 3684 SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); |
3380 | 3685 |
3381 /* | 3686 /* |
3382 ** CAPI3REF: User Data For Functions {H16240} <S20200> | 3687 ** CAPI3REF: User Data For Functions |
3383 ** | 3688 ** |
3384 ** The sqlite3_user_data() interface returns a copy of | 3689 ** ^The sqlite3_user_data() interface returns a copy of |
3385 ** the pointer that was the pUserData parameter (the 5th parameter) | 3690 ** the pointer that was the pUserData parameter (the 5th parameter) |
3386 ** of the [sqlite3_create_function()] | 3691 ** of the [sqlite3_create_function()] |
3387 ** and [sqlite3_create_function16()] routines that originally | 3692 ** and [sqlite3_create_function16()] routines that originally |
3388 ** registered the application defined function. {END} | 3693 ** registered the application defined function. |
3389 ** | 3694 ** |
3390 ** This routine must be called from the same thread in which | 3695 ** This routine must be called from the same thread in which |
3391 ** the application-defined function is running. | 3696 ** the application-defined function is running. |
3392 ** | |
3393 ** Requirements: | |
3394 ** [H16243] | |
3395 */ | 3697 */ |
3396 SQLITE_API void *sqlite3_user_data(sqlite3_context*); | 3698 SQLITE_API void *sqlite3_user_data(sqlite3_context*); |
3397 | 3699 |
3398 /* | 3700 /* |
3399 ** CAPI3REF: Database Connection For Functions {H16250} <S60600><S20200> | 3701 ** CAPI3REF: Database Connection For Functions |
3400 ** | 3702 ** |
3401 ** The sqlite3_context_db_handle() interface returns a copy of | 3703 ** ^The sqlite3_context_db_handle() interface returns a copy of |
3402 ** the pointer to the [database connection] (the 1st parameter) | 3704 ** the pointer to the [database connection] (the 1st parameter) |
3403 ** of the [sqlite3_create_function()] | 3705 ** of the [sqlite3_create_function()] |
3404 ** and [sqlite3_create_function16()] routines that originally | 3706 ** and [sqlite3_create_function16()] routines that originally |
3405 ** registered the application defined function. | 3707 ** registered the application defined function. |
3406 ** | |
3407 ** Requirements: | |
3408 ** [H16253] | |
3409 */ | 3708 */ |
3410 SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*); | 3709 SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*); |
3411 | 3710 |
3412 /* | 3711 /* |
3413 ** CAPI3REF: Function Auxiliary Data {H16270} <S20200> | 3712 ** CAPI3REF: Function Auxiliary Data |
3414 ** | 3713 ** |
3415 ** The following two functions may be used by scalar SQL functions to | 3714 ** 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 | 3715 ** associate metadata with argument values. If the same value is passed to |
3417 ** multiple invocations of the same SQL function during query execution, under | 3716 ** multiple invocations of the same SQL function during query execution, under |
3418 ** some circumstances the associated metadata may be preserved. This may | 3717 ** some circumstances the associated metadata may be preserved. This may |
3419 ** be used, for example, to add a regular-expression matching scalar | 3718 ** be used, for example, to add a regular-expression matching scalar |
3420 ** function. The compiled version of the regular expression is stored as | 3719 ** function. The compiled version of the regular expression is stored as |
3421 ** metadata associated with the SQL value passed as the regular expression | 3720 ** metadata associated with the SQL value passed as the regular expression |
3422 ** pattern. The compiled regular expression can be reused on multiple | 3721 ** pattern. The compiled regular expression can be reused on multiple |
3423 ** invocations of the same function so that the original pattern string | 3722 ** invocations of the same function so that the original pattern string |
3424 ** does not need to be recompiled on each invocation. | 3723 ** does not need to be recompiled on each invocation. |
3425 ** | 3724 ** |
3426 ** The sqlite3_get_auxdata() interface returns a pointer to the metadata | 3725 ** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata |
3427 ** associated by the sqlite3_set_auxdata() function with the Nth argument | 3726 ** associated by the sqlite3_set_auxdata() function with the Nth argument |
3428 ** value to the application-defined function. If no metadata has been ever | 3727 ** 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 | 3728 ** been set for the Nth argument of the function, or if the corresponding |
3430 ** function parameter has changed since the meta-data was set, | 3729 ** function parameter has changed since the meta-data was set, |
3431 ** then sqlite3_get_auxdata() returns a NULL pointer. | 3730 ** then sqlite3_get_auxdata() returns a NULL pointer. |
3432 ** | 3731 ** |
3433 ** The sqlite3_set_auxdata() interface saves the metadata | 3732 ** ^The sqlite3_set_auxdata() interface saves the metadata |
3434 ** pointed to by its 3rd parameter as the metadata for the N-th | 3733 ** pointed to by its 3rd parameter as the metadata for the N-th |
3435 ** argument of the application-defined function. Subsequent | 3734 ** argument of the application-defined function. Subsequent |
3436 ** calls to sqlite3_get_auxdata() might return this data, if it has | 3735 ** calls to sqlite3_get_auxdata() might return this data, if it has |
3437 ** not been destroyed. | 3736 ** not been destroyed. |
3438 ** If it is not NULL, SQLite will invoke the destructor | 3737 ** ^If it is not NULL, SQLite will invoke the destructor |
3439 ** function given by the 4th parameter to sqlite3_set_auxdata() on | 3738 ** function given by the 4th parameter to sqlite3_set_auxdata() on |
3440 ** the metadata when the corresponding function parameter changes | 3739 ** the metadata when the corresponding function parameter changes |
3441 ** or when the SQL statement completes, whichever comes first. | 3740 ** or when the SQL statement completes, whichever comes first. |
3442 ** | 3741 ** |
3443 ** SQLite is free to call the destructor and drop metadata on any | 3742 ** 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 | 3743 ** parameter of any function at any time. ^The only guarantee is that |
3445 ** the destructor will be called before the metadata is dropped. | 3744 ** the destructor will be called before the metadata is dropped. |
3446 ** | 3745 ** |
3447 ** In practice, metadata is preserved between function calls for | 3746 ** ^(In practice, metadata is preserved between function calls for |
3448 ** expressions that are constant at compile time. This includes literal | 3747 ** expressions that are constant at compile time. This includes literal |
3449 ** values and SQL variables. | 3748 ** values and [parameters].)^ |
3450 ** | 3749 ** |
3451 ** These routines must be called from the same thread in which | 3750 ** These routines must be called from the same thread in which |
3452 ** the SQL function is running. | 3751 ** the SQL function is running. |
3453 ** | |
3454 ** Requirements: | |
3455 ** [H16272] [H16274] [H16276] [H16277] [H16278] [H16279] | |
3456 */ | 3752 */ |
3457 SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N); | 3753 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*)); | 3754 SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(voi
d*)); |
3459 | 3755 |
3460 | 3756 |
3461 /* | 3757 /* |
3462 ** CAPI3REF: Constants Defining Special Destructor Behavior {H10280} <S30100> | 3758 ** CAPI3REF: Constants Defining Special Destructor Behavior |
3463 ** | 3759 ** |
3464 ** These are special values for the destructor that is passed in as the | 3760 ** 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 | 3761 ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor |
3466 ** argument is SQLITE_STATIC, it means that the content pointer is constant | 3762 ** 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 | 3763 ** and will never change. It does not need to be destroyed. ^The |
3468 ** SQLITE_TRANSIENT value means that the content will likely change in | 3764 ** 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 | 3765 ** the near future and that SQLite should make its own private copy of |
3470 ** the content before returning. | 3766 ** the content before returning. |
3471 ** | 3767 ** |
3472 ** The typedef is necessary to work around problems in certain | 3768 ** The typedef is necessary to work around problems in certain |
3473 ** C++ compilers. See ticket #2191. | 3769 ** C++ compilers. See ticket #2191. |
3474 */ | 3770 */ |
3475 typedef void (*sqlite3_destructor_type)(void*); | 3771 typedef void (*sqlite3_destructor_type)(void*); |
3476 #define SQLITE_STATIC ((sqlite3_destructor_type)0) | 3772 #define SQLITE_STATIC ((sqlite3_destructor_type)0) |
3477 #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) | 3773 #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) |
3478 | 3774 |
3479 /* | 3775 /* |
3480 ** CAPI3REF: Setting The Result Of An SQL Function {H16400} <S20200> | 3776 ** CAPI3REF: Setting The Result Of An SQL Function |
3481 ** | 3777 ** |
3482 ** These routines are used by the xFunc or xFinal callbacks that | 3778 ** These routines are used by the xFunc or xFinal callbacks that |
3483 ** implement SQL functions and aggregates. See | 3779 ** implement SQL functions and aggregates. See |
3484 ** [sqlite3_create_function()] and [sqlite3_create_function16()] | 3780 ** [sqlite3_create_function()] and [sqlite3_create_function16()] |
3485 ** for additional information. | 3781 ** for additional information. |
3486 ** | 3782 ** |
3487 ** These functions work very much like the [parameter binding] family of | 3783 ** These functions work very much like the [parameter binding] family of |
3488 ** functions used to bind values to host parameters in prepared statements. | 3784 ** functions used to bind values to host parameters in prepared statements. |
3489 ** Refer to the [SQL parameter] documentation for additional information. | 3785 ** Refer to the [SQL parameter] documentation for additional information. |
3490 ** | 3786 ** |
3491 ** The sqlite3_result_blob() interface sets the result from | 3787 ** ^The sqlite3_result_blob() interface sets the result from |
3492 ** an application-defined function to be the BLOB whose content is pointed | 3788 ** 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 | 3789 ** to by the second parameter and which is N bytes long where N is the |
3494 ** third parameter. | 3790 ** third parameter. |
3495 ** | 3791 ** |
3496 ** The sqlite3_result_zeroblob() interfaces set the result of | 3792 ** ^The sqlite3_result_zeroblob() interfaces set the result of |
3497 ** the application-defined function to be a BLOB containing all zero | 3793 ** 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. | 3794 ** bytes and N bytes in size, where N is the value of the 2nd parameter. |
3499 ** | 3795 ** |
3500 ** The sqlite3_result_double() interface sets the result from | 3796 ** ^The sqlite3_result_double() interface sets the result from |
3501 ** an application-defined function to be a floating point value specified | 3797 ** an application-defined function to be a floating point value specified |
3502 ** by its 2nd argument. | 3798 ** by its 2nd argument. |
3503 ** | 3799 ** |
3504 ** The sqlite3_result_error() and sqlite3_result_error16() functions | 3800 ** ^The sqlite3_result_error() and sqlite3_result_error16() functions |
3505 ** cause the implemented SQL function to throw an exception. | 3801 ** cause the implemented SQL function to throw an exception. |
3506 ** SQLite uses the string pointed to by the | 3802 ** ^SQLite uses the string pointed to by the |
3507 ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() | 3803 ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() |
3508 ** as the text of an error message. SQLite interprets the error | 3804 ** as the text of an error message. ^SQLite interprets the error |
3509 ** message string from sqlite3_result_error() as UTF-8. SQLite | 3805 ** message string from sqlite3_result_error() as UTF-8. ^SQLite |
3510 ** interprets the string from sqlite3_result_error16() as UTF-16 in native | 3806 ** interprets the string from sqlite3_result_error16() as UTF-16 in native |
3511 ** byte order. If the third parameter to sqlite3_result_error() | 3807 ** byte order. ^If the third parameter to sqlite3_result_error() |
3512 ** or sqlite3_result_error16() is negative then SQLite takes as the error | 3808 ** or sqlite3_result_error16() is negative then SQLite takes as the error |
3513 ** message all text up through the first zero character. | 3809 ** message all text up through the first zero character. |
3514 ** If the third parameter to sqlite3_result_error() or | 3810 ** ^If the third parameter to sqlite3_result_error() or |
3515 ** sqlite3_result_error16() is non-negative then SQLite takes that many | 3811 ** sqlite3_result_error16() is non-negative then SQLite takes that many |
3516 ** bytes (not characters) from the 2nd parameter as the error message. | 3812 ** bytes (not characters) from the 2nd parameter as the error message. |
3517 ** The sqlite3_result_error() and sqlite3_result_error16() | 3813 ** ^The sqlite3_result_error() and sqlite3_result_error16() |
3518 ** routines make a private copy of the error message text before | 3814 ** routines make a private copy of the error message text before |
3519 ** they return. Hence, the calling function can deallocate or | 3815 ** they return. Hence, the calling function can deallocate or |
3520 ** modify the text after they return without harm. | 3816 ** modify the text after they return without harm. |
3521 ** The sqlite3_result_error_code() function changes the error code | 3817 ** ^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, | 3818 ** 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() | 3819 ** 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. | 3820 ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. |
3525 ** | 3821 ** |
3526 ** The sqlite3_result_toobig() interface causes SQLite to throw an error | 3822 ** ^The sqlite3_result_toobig() interface causes SQLite to throw an error |
3527 ** indicating that a string or BLOB is to long to represent. | 3823 ** indicating that a string or BLOB is too long to represent. |
3528 ** | 3824 ** |
3529 ** The sqlite3_result_nomem() interface causes SQLite to throw an error | 3825 ** ^The sqlite3_result_nomem() interface causes SQLite to throw an error |
3530 ** indicating that a memory allocation failed. | 3826 ** indicating that a memory allocation failed. |
3531 ** | 3827 ** |
3532 ** The sqlite3_result_int() interface sets the return value | 3828 ** ^The sqlite3_result_int() interface sets the return value |
3533 ** of the application-defined function to be the 32-bit signed integer | 3829 ** of the application-defined function to be the 32-bit signed integer |
3534 ** value given in the 2nd argument. | 3830 ** value given in the 2nd argument. |
3535 ** The sqlite3_result_int64() interface sets the return value | 3831 ** ^The sqlite3_result_int64() interface sets the return value |
3536 ** of the application-defined function to be the 64-bit signed integer | 3832 ** of the application-defined function to be the 64-bit signed integer |
3537 ** value given in the 2nd argument. | 3833 ** value given in the 2nd argument. |
3538 ** | 3834 ** |
3539 ** The sqlite3_result_null() interface sets the return value | 3835 ** ^The sqlite3_result_null() interface sets the return value |
3540 ** of the application-defined function to be NULL. | 3836 ** of the application-defined function to be NULL. |
3541 ** | 3837 ** |
3542 ** The sqlite3_result_text(), sqlite3_result_text16(), | 3838 ** ^The sqlite3_result_text(), sqlite3_result_text16(), |
3543 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces | 3839 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces |
3544 ** set the return value of the application-defined function to be | 3840 ** 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, | 3841 ** 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. | 3842 ** UTF-16 little endian, or UTF-16 big endian, respectively. |
3547 ** SQLite takes the text result from the application from | 3843 ** ^SQLite takes the text result from the application from |
3548 ** the 2nd parameter of the sqlite3_result_text* interfaces. | 3844 ** the 2nd parameter of the sqlite3_result_text* interfaces. |
3549 ** If the 3rd parameter to the sqlite3_result_text* interfaces | 3845 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces |
3550 ** is negative, then SQLite takes result text from the 2nd parameter | 3846 ** is negative, then SQLite takes result text from the 2nd parameter |
3551 ** through the first zero character. | 3847 ** through the first zero character. |
3552 ** If the 3rd parameter to the sqlite3_result_text* interfaces | 3848 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces |
3553 ** is non-negative, then as many bytes (not characters) of the text | 3849 ** 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 | 3850 ** pointed to by the 2nd parameter are taken as the application-defined |
3555 ** function result. | 3851 ** function result. |
3556 ** If the 4th parameter to the sqlite3_result_text* interfaces | 3852 ** ^If the 4th parameter to the sqlite3_result_text* interfaces |
3557 ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that | 3853 ** 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 | 3854 ** function as the destructor on the text or BLOB result when it has |
3559 ** finished using that result. | 3855 ** finished using that result. |
3560 ** If the 4th parameter to the sqlite3_result_text* interfaces or to | 3856 ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to |
3561 ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite | 3857 ** 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 | 3858 ** 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 | 3859 ** copy the content of the parameter nor call a destructor on the content |
3564 ** when it has finished using that result. | 3860 ** when it has finished using that result. |
3565 ** If the 4th parameter to the sqlite3_result_text* interfaces | 3861 ** ^If the 4th parameter to the sqlite3_result_text* interfaces |
3566 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT | 3862 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT |
3567 ** then SQLite makes a copy of the result into space obtained from | 3863 ** then SQLite makes a copy of the result into space obtained from |
3568 ** from [sqlite3_malloc()] before it returns. | 3864 ** from [sqlite3_malloc()] before it returns. |
3569 ** | 3865 ** |
3570 ** The sqlite3_result_value() interface sets the result of | 3866 ** ^The sqlite3_result_value() interface sets the result of |
3571 ** the application-defined function to be a copy the | 3867 ** the application-defined function to be a copy the |
3572 ** [unprotected sqlite3_value] object specified by the 2nd parameter. The | 3868 ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The |
3573 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value] | 3869 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value] |
3574 ** so that the [sqlite3_value] specified in the parameter may change or | 3870 ** so that the [sqlite3_value] specified in the parameter may change or |
3575 ** be deallocated after sqlite3_result_value() returns without harm. | 3871 ** be deallocated after sqlite3_result_value() returns without harm. |
3576 ** A [protected sqlite3_value] object may always be used where an | 3872 ** ^A [protected sqlite3_value] object may always be used where an |
3577 ** [unprotected sqlite3_value] object is required, so either | 3873 ** [unprotected sqlite3_value] object is required, so either |
3578 ** kind of [sqlite3_value] object can be used with this interface. | 3874 ** kind of [sqlite3_value] object can be used with this interface. |
3579 ** | 3875 ** |
3580 ** If these routines are called from within the different thread | 3876 ** If these routines are called from within the different thread |
3581 ** than the one containing the application-defined function that received | 3877 ** than the one containing the application-defined function that received |
3582 ** the [sqlite3_context] pointer, the results are undefined. | 3878 ** 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 */ | 3879 */ |
3589 SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(
void*)); | 3880 SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(
void*)); |
3590 SQLITE_API void sqlite3_result_double(sqlite3_context*, double); | 3881 SQLITE_API void sqlite3_result_double(sqlite3_context*, double); |
3591 SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); | 3882 SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); |
3592 SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); | 3883 SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); |
3593 SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*); | 3884 SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*); |
3594 SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*); | 3885 SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*); |
3595 SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int); | 3886 SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int); |
3596 SQLITE_API void sqlite3_result_int(sqlite3_context*, int); | 3887 SQLITE_API void sqlite3_result_int(sqlite3_context*, int); |
3597 SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); | 3888 SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); |
3598 SQLITE_API void sqlite3_result_null(sqlite3_context*); | 3889 SQLITE_API void sqlite3_result_null(sqlite3_context*); |
3599 SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(
void*)); | 3890 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*)); | 3891 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*)); | 3892 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*)); | 3893 SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(
*)(void*)); |
3603 SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); | 3894 SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); |
3604 SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); | 3895 SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); |
3605 | 3896 |
3606 /* | 3897 /* |
3607 ** CAPI3REF: Define New Collating Sequences {H16600} <S20300> | 3898 ** CAPI3REF: Define New Collating Sequences |
3608 ** | 3899 ** |
3609 ** These functions are used to add new collation sequences to the | 3900 ** ^These functions add, remove, or modify a [collation] associated |
3610 ** [database connection] specified as the first argument. | 3901 ** with the [database connection] specified as the first argument. |
3611 ** | 3902 ** |
3612 ** The name of the new collation sequence is specified as a UTF-8 string | 3903 ** ^The name of the collation is a UTF-8 string |
3613 ** for sqlite3_create_collation() and sqlite3_create_collation_v2() | 3904 ** for sqlite3_create_collation() and sqlite3_create_collation_v2() |
3614 ** and a UTF-16 string for sqlite3_create_collation16(). In all cases | 3905 ** and a UTF-16 string in native byte order for sqlite3_create_collation16(). |
3615 ** the name is passed as the second function argument. | 3906 ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are |
| 3907 ** considered to be the same name. |
3616 ** | 3908 ** |
3617 ** The third argument may be one of the constants [SQLITE_UTF8], | 3909 ** ^(The third argument (eTextRep) must be one of the constants: |
3618 ** [SQLITE_UTF16LE], or [SQLITE_UTF16BE], indicating that the user-supplied | 3910 ** <ul> |
3619 ** routine expects to be passed pointers to strings encoded using UTF-8, | 3911 ** <li> [SQLITE_UTF8], |
3620 ** UTF-16 little-endian, or UTF-16 big-endian, respectively. The | 3912 ** <li> [SQLITE_UTF16LE], |
3621 ** third argument might also be [SQLITE_UTF16] to indicate that the routine | 3913 ** <li> [SQLITE_UTF16BE], |
3622 ** expects pointers to be UTF-16 strings in the native byte order, or the | 3914 ** <li> [SQLITE_UTF16], or |
3623 ** argument can be [SQLITE_UTF16_ALIGNED] if the | 3915 ** <li> [SQLITE_UTF16_ALIGNED]. |
3624 ** the routine expects pointers to 16-bit word aligned strings | 3916 ** </ul>)^ |
3625 ** of UTF-16 in the native byte order. | 3917 ** ^The eTextRep argument determines the encoding of strings passed |
| 3918 ** to the collating function callback, xCallback. |
| 3919 ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep |
| 3920 ** force strings to be UTF16 with native byte order. |
| 3921 ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin |
| 3922 ** on an even byte address. |
3626 ** | 3923 ** |
3627 ** A pointer to the user supplied routine must be passed as the fifth | 3924 ** ^The fourth argument, pArg, is an application data pointer that is passed |
3628 ** argument. If it is NULL, this is the same as deleting the collation | 3925 ** 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 ** | 3926 ** |
3634 ** The remaining arguments to the application-supplied routine are two strings, | 3927 ** ^The fifth argument, xCallback, is a pointer to the collating function. |
3635 ** each represented by a (length, data) pair and encoded in the encoding | 3928 ** ^Multiple collating functions can be registered using the same name but |
3636 ** that was passed as the third argument when the collation sequence was | 3929 ** with different eTextRep parameters and SQLite will use whichever |
3637 ** registered. {END} The application defined collation routine should | 3930 ** function requires the least amount of data transformation. |
3638 ** return negative, zero or positive if the first string is less than, | 3931 ** ^If the xCallback argument is NULL then the collating function is |
3639 ** equal to, or greater than the second string. i.e. (STRING1 - STRING2). | 3932 ** deleted. ^When all collating functions having the same name are deleted, |
| 3933 ** that collation is no longer usable. |
3640 ** | 3934 ** |
3641 ** The sqlite3_create_collation_v2() works like sqlite3_create_collation() | 3935 ** ^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 | 3936 ** application data pointer and with two strings in the encoding specified |
3643 ** the collation. The destructor is called when the collation is | 3937 ** by the eTextRep argument. The collating function must return an |
3644 ** destroyed and is passed a copy of the fourth parameter void* pointer | 3938 ** integer that is negative, zero, or positive |
3645 ** of the sqlite3_create_collation_v2(). | 3939 ** 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 | 3940 ** respectively. A collating function must always return the same answer |
3647 ** collation creation functions or when the [database connection] is closed | 3941 ** given the same inputs. If two or more collating functions are registered |
3648 ** using [sqlite3_close()]. | 3942 ** to the same collation name (using different eTextRep values) then all |
| 3943 ** must give an equivalent answer when invoked with equivalent strings. |
| 3944 ** The collating function must obey the following properties for all |
| 3945 ** strings A, B, and C: |
| 3946 ** |
| 3947 ** <ol> |
| 3948 ** <li> If A==B then B==A. |
| 3949 ** <li> If A==B and B==C then A==C. |
| 3950 ** <li> If A<B THEN B>A. |
| 3951 ** <li> If A<B and B<C then A<C. |
| 3952 ** </ol> |
| 3953 ** |
| 3954 ** If a collating function fails any of the above constraints and that |
| 3955 ** collating function is registered and used, then the behavior of SQLite |
| 3956 ** is undefined. |
| 3957 ** |
| 3958 ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() |
| 3959 ** with the addition that the xDestroy callback is invoked on pArg when |
| 3960 ** the collating function is deleted. |
| 3961 ** ^Collating functions are deleted when they are overridden by later |
| 3962 ** calls to the collation creation functions or when the |
| 3963 ** [database connection] is closed using [sqlite3_close()]. |
| 3964 ** |
| 3965 ** ^The xDestroy callback is <u>not</u> called if the |
| 3966 ** sqlite3_create_collation_v2() function fails. Applications that invoke |
| 3967 ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should |
| 3968 ** check the return code and dispose of the application data pointer |
| 3969 ** themselves rather than expecting SQLite to deal with it for them. |
| 3970 ** This is different from every other SQLite interface. The inconsistency |
| 3971 ** is unfortunate but cannot be changed without breaking backwards |
| 3972 ** compatibility. |
3649 ** | 3973 ** |
3650 ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. | 3974 ** 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 */ | 3975 */ |
3656 SQLITE_API int sqlite3_create_collation( | 3976 SQLITE_API int sqlite3_create_collation( |
3657 sqlite3*, | 3977 sqlite3*, |
3658 const char *zName, | 3978 const char *zName, |
3659 int eTextRep, | 3979 int eTextRep, |
3660 void*, | 3980 void *pArg, |
3661 int(*xCompare)(void*,int,const void*,int,const void*) | 3981 int(*xCompare)(void*,int,const void*,int,const void*) |
3662 ); | 3982 ); |
3663 SQLITE_API int sqlite3_create_collation_v2( | 3983 SQLITE_API int sqlite3_create_collation_v2( |
3664 sqlite3*, | 3984 sqlite3*, |
3665 const char *zName, | 3985 const char *zName, |
3666 int eTextRep, | 3986 int eTextRep, |
3667 void*, | 3987 void *pArg, |
3668 int(*xCompare)(void*,int,const void*,int,const void*), | 3988 int(*xCompare)(void*,int,const void*,int,const void*), |
3669 void(*xDestroy)(void*) | 3989 void(*xDestroy)(void*) |
3670 ); | 3990 ); |
3671 SQLITE_API int sqlite3_create_collation16( | 3991 SQLITE_API int sqlite3_create_collation16( |
3672 sqlite3*, | 3992 sqlite3*, |
3673 const void *zName, | 3993 const void *zName, |
3674 int eTextRep, | 3994 int eTextRep, |
3675 void*, | 3995 void *pArg, |
3676 int(*xCompare)(void*,int,const void*,int,const void*) | 3996 int(*xCompare)(void*,int,const void*,int,const void*) |
3677 ); | 3997 ); |
3678 | 3998 |
3679 /* | 3999 /* |
3680 ** CAPI3REF: Collation Needed Callbacks {H16700} <S20300> | 4000 ** CAPI3REF: Collation Needed Callbacks |
3681 ** | 4001 ** |
3682 ** To avoid having to register all collation sequences before a database | 4002 ** ^To avoid having to register all collation sequences before a database |
3683 ** can be used, a single callback function may be registered with the | 4003 ** can be used, a single callback function may be registered with the |
3684 ** [database connection] to be called whenever an undefined collation | 4004 ** [database connection] to be invoked whenever an undefined collation |
3685 ** sequence is required. | 4005 ** sequence is required. |
3686 ** | 4006 ** |
3687 ** If the function is registered using the sqlite3_collation_needed() API, | 4007 ** ^If the function is registered using the sqlite3_collation_needed() API, |
3688 ** then it is passed the names of undefined collation sequences as strings | 4008 ** then it is passed the names of undefined collation sequences as strings |
3689 ** encoded in UTF-8. {H16703} If sqlite3_collation_needed16() is used, | 4009 ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, |
3690 ** the names are passed as UTF-16 in machine native byte order. | 4010 ** the names are passed as UTF-16 in machine native byte order. |
3691 ** A call to either function replaces any existing callback. | 4011 ** ^A call to either function replaces the existing collation-needed callback. |
3692 ** | 4012 ** |
3693 ** When the callback is invoked, the first argument passed is a copy | 4013 ** ^(When the callback is invoked, the first argument passed is a copy |
3694 ** of the second argument to sqlite3_collation_needed() or | 4014 ** of the second argument to sqlite3_collation_needed() or |
3695 ** sqlite3_collation_needed16(). The second argument is the database | 4015 ** sqlite3_collation_needed16(). The second argument is the database |
3696 ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], | 4016 ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], |
3697 ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation | 4017 ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation |
3698 ** sequence function required. The fourth parameter is the name of the | 4018 ** sequence function required. The fourth parameter is the name of the |
3699 ** required collation sequence. | 4019 ** required collation sequence.)^ |
3700 ** | 4020 ** |
3701 ** The callback function should register the desired collation using | 4021 ** The callback function should register the desired collation using |
3702 ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or | 4022 ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or |
3703 ** [sqlite3_create_collation_v2()]. | 4023 ** [sqlite3_create_collation_v2()]. |
3704 ** | |
3705 ** Requirements: | |
3706 ** [H16702] [H16704] [H16706] | |
3707 */ | 4024 */ |
3708 SQLITE_API int sqlite3_collation_needed( | 4025 SQLITE_API int sqlite3_collation_needed( |
3709 sqlite3*, | 4026 sqlite3*, |
3710 void*, | 4027 void*, |
3711 void(*)(void*,sqlite3*,int eTextRep,const char*) | 4028 void(*)(void*,sqlite3*,int eTextRep,const char*) |
3712 ); | 4029 ); |
3713 SQLITE_API int sqlite3_collation_needed16( | 4030 SQLITE_API int sqlite3_collation_needed16( |
3714 sqlite3*, | 4031 sqlite3*, |
3715 void*, | 4032 void*, |
3716 void(*)(void*,sqlite3*,int eTextRep,const void*) | 4033 void(*)(void*,sqlite3*,int eTextRep,const void*) |
3717 ); | 4034 ); |
3718 | 4035 |
| 4036 #ifdef SQLITE_HAS_CODEC |
3719 /* | 4037 /* |
3720 ** Specify the key for an encrypted database. This routine should be | 4038 ** Specify the key for an encrypted database. This routine should be |
3721 ** called right after sqlite3_open(). | 4039 ** called right after sqlite3_open(). |
3722 ** | 4040 ** |
3723 ** The code to implement this API is not available in the public release | 4041 ** The code to implement this API is not available in the public release |
3724 ** of SQLite. | 4042 ** of SQLite. |
3725 */ | 4043 */ |
3726 SQLITE_API int sqlite3_key( | 4044 SQLITE_API int sqlite3_key( |
3727 sqlite3 *db, /* Database to be rekeyed */ | 4045 sqlite3 *db, /* Database to be rekeyed */ |
3728 const void *pKey, int nKey /* The key */ | 4046 const void *pKey, int nKey /* The key */ |
3729 ); | 4047 ); |
3730 | 4048 |
3731 /* | 4049 /* |
3732 ** Change the key on an open database. If the current database is not | 4050 ** 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 | 4051 ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the |
3734 ** database is decrypted. | 4052 ** database is decrypted. |
3735 ** | 4053 ** |
3736 ** The code to implement this API is not available in the public release | 4054 ** The code to implement this API is not available in the public release |
3737 ** of SQLite. | 4055 ** of SQLite. |
3738 */ | 4056 */ |
3739 SQLITE_API int sqlite3_rekey( | 4057 SQLITE_API int sqlite3_rekey( |
3740 sqlite3 *db, /* Database to be rekeyed */ | 4058 sqlite3 *db, /* Database to be rekeyed */ |
3741 const void *pKey, int nKey /* The new key */ | 4059 const void *pKey, int nKey /* The new key */ |
3742 ); | 4060 ); |
3743 | 4061 |
3744 /* | 4062 /* |
3745 ** CAPI3REF: Suspend Execution For A Short Time {H10530} <S40410> | 4063 ** Specify the activation key for a SEE database. Unless |
| 4064 ** activated, none of the SEE routines will work. |
| 4065 */ |
| 4066 SQLITE_API void sqlite3_activate_see( |
| 4067 const char *zPassPhrase /* Activation phrase */ |
| 4068 ); |
| 4069 #endif |
| 4070 |
| 4071 #ifdef SQLITE_ENABLE_CEROD |
| 4072 /* |
| 4073 ** Specify the activation key for a CEROD database. Unless |
| 4074 ** activated, none of the CEROD routines will work. |
| 4075 */ |
| 4076 SQLITE_API void sqlite3_activate_cerod( |
| 4077 const char *zPassPhrase /* Activation phrase */ |
| 4078 ); |
| 4079 #endif |
| 4080 |
| 4081 /* |
| 4082 ** CAPI3REF: Suspend Execution For A Short Time |
3746 ** | 4083 ** |
3747 ** The sqlite3_sleep() function causes the current thread to suspend execution | 4084 ** The sqlite3_sleep() function causes the current thread to suspend execution |
3748 ** for at least a number of milliseconds specified in its parameter. | 4085 ** for at least a number of milliseconds specified in its parameter. |
3749 ** | 4086 ** |
3750 ** If the operating system does not support sleep requests with | 4087 ** If the operating system does not support sleep requests with |
3751 ** millisecond time resolution, then the time will be rounded up to | 4088 ** millisecond time resolution, then the time will be rounded up to |
3752 ** the nearest second. The number of milliseconds of sleep actually | 4089 ** the nearest second. The number of milliseconds of sleep actually |
3753 ** requested from the operating system is returned. | 4090 ** requested from the operating system is returned. |
3754 ** | 4091 ** |
3755 ** SQLite implements this interface by calling the xSleep() | 4092 ** ^SQLite implements this interface by calling the xSleep() |
3756 ** method of the default [sqlite3_vfs] object. | 4093 ** method of the default [sqlite3_vfs] object. If the xSleep() method |
3757 ** | 4094 ** of the default VFS is not implemented correctly, or not implemented at |
3758 ** Requirements: [H10533] [H10536] | 4095 ** all, then the behavior of sqlite3_sleep() may deviate from the description |
| 4096 ** in the previous paragraphs. |
3759 */ | 4097 */ |
3760 SQLITE_API int sqlite3_sleep(int); | 4098 SQLITE_API int sqlite3_sleep(int); |
3761 | 4099 |
3762 /* | 4100 /* |
3763 ** CAPI3REF: Name Of The Folder Holding Temporary Files {H10310} <S20000> | 4101 ** CAPI3REF: Name Of The Folder Holding Temporary Files |
3764 ** | 4102 ** |
3765 ** If this global variable is made to point to a string which is | 4103 ** ^(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 | 4104 ** 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 | 4105 ** created by SQLite when using a built-in [sqlite3_vfs | VFS] |
| 4106 ** will be placed in that directory.)^ ^If this variable |
3768 ** is a NULL pointer, then SQLite performs a search for an appropriate | 4107 ** is a NULL pointer, then SQLite performs a search for an appropriate |
3769 ** temporary file directory. | 4108 ** temporary file directory. |
3770 ** | 4109 ** |
3771 ** It is not safe to read or modify this variable in more than one | 4110 ** 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 | 4111 ** 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 | 4112 ** if a [database connection] is being used at the same time in a separate |
3774 ** thread. | 4113 ** thread. |
3775 ** It is intended that this variable be set once | 4114 ** It is intended that this variable be set once |
3776 ** as part of process initialization and before any SQLite interface | 4115 ** as part of process initialization and before any SQLite interface |
3777 ** routines have been called and that this variable remain unchanged | 4116 ** routines have been called and that this variable remain unchanged |
3778 ** thereafter. | 4117 ** thereafter. |
3779 ** | 4118 ** |
3780 ** The [temp_store_directory pragma] may modify this variable and cause | 4119 ** ^The [temp_store_directory pragma] may modify this variable and cause |
3781 ** it to point to memory obtained from [sqlite3_malloc]. Furthermore, | 4120 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, |
3782 ** the [temp_store_directory pragma] always assumes that any string | 4121 ** the [temp_store_directory pragma] always assumes that any string |
3783 ** that this variable points to is held in memory obtained from | 4122 ** that this variable points to is held in memory obtained from |
3784 ** [sqlite3_malloc] and the pragma may attempt to free that memory | 4123 ** [sqlite3_malloc] and the pragma may attempt to free that memory |
3785 ** using [sqlite3_free]. | 4124 ** using [sqlite3_free]. |
3786 ** Hence, if this variable is modified directly, either it should be | 4125 ** Hence, if this variable is modified directly, either it should be |
3787 ** made NULL or made to point to memory obtained from [sqlite3_malloc] | 4126 ** 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. | 4127 ** or else the use of the [temp_store_directory pragma] should be avoided. |
3789 */ | 4128 */ |
3790 SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; | 4129 SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; |
3791 | 4130 |
3792 /* | 4131 /* |
3793 ** CAPI3REF: Test For Auto-Commit Mode {H12930} <S60200> | 4132 ** CAPI3REF: Test For Auto-Commit Mode |
3794 ** KEYWORDS: {autocommit mode} | 4133 ** KEYWORDS: {autocommit mode} |
3795 ** | 4134 ** |
3796 ** The sqlite3_get_autocommit() interface returns non-zero or | 4135 ** ^The sqlite3_get_autocommit() interface returns non-zero or |
3797 ** zero if the given database connection is or is not in autocommit mode, | 4136 ** zero if the given database connection is or is not in autocommit mode, |
3798 ** respectively. Autocommit mode is on by default. | 4137 ** respectively. ^Autocommit mode is on by default. |
3799 ** Autocommit mode is disabled by a [BEGIN] statement. | 4138 ** ^Autocommit mode is disabled by a [BEGIN] statement. |
3800 ** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. | 4139 ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. |
3801 ** | 4140 ** |
3802 ** If certain kinds of errors occur on a statement within a multi-statement | 4141 ** If certain kinds of errors occur on a statement within a multi-statement |
3803 ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], | 4142 ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], |
3804 ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the | 4143 ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the |
3805 ** transaction might be rolled back automatically. The only way to | 4144 ** transaction might be rolled back automatically. The only way to |
3806 ** find out whether SQLite automatically rolled back the transaction after | 4145 ** find out whether SQLite automatically rolled back the transaction after |
3807 ** an error is to use this function. | 4146 ** an error is to use this function. |
3808 ** | 4147 ** |
3809 ** If another thread changes the autocommit status of the database | 4148 ** If another thread changes the autocommit status of the database |
3810 ** connection while this routine is running, then the return value | 4149 ** connection while this routine is running, then the return value |
3811 ** is undefined. | 4150 ** is undefined. |
3812 ** | |
3813 ** Requirements: [H12931] [H12932] [H12933] [H12934] | |
3814 */ | 4151 */ |
3815 SQLITE_API int sqlite3_get_autocommit(sqlite3*); | 4152 SQLITE_API int sqlite3_get_autocommit(sqlite3*); |
3816 | 4153 |
3817 /* | 4154 /* |
3818 ** CAPI3REF: Find The Database Handle Of A Prepared Statement {H13120} <S60600> | 4155 ** CAPI3REF: Find The Database Handle Of A Prepared Statement |
3819 ** | 4156 ** |
3820 ** The sqlite3_db_handle interface returns the [database connection] handle | 4157 ** ^The sqlite3_db_handle interface returns the [database connection] handle |
3821 ** to which a [prepared statement] belongs. The [database connection] | 4158 ** 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 | 4159 ** returned by sqlite3_db_handle is the same [database connection] |
| 4160 ** that was the first argument |
3823 ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to | 4161 ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to |
3824 ** create the statement in the first place. | 4162 ** create the statement in the first place. |
3825 ** | |
3826 ** Requirements: [H13123] | |
3827 */ | 4163 */ |
3828 SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*); | 4164 SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*); |
3829 | 4165 |
3830 /* | 4166 /* |
3831 ** CAPI3REF: Find the next prepared statement {H13140} <S60600> | 4167 ** CAPI3REF: Find the next prepared statement |
3832 ** | 4168 ** |
3833 ** This interface returns a pointer to the next [prepared statement] after | 4169 ** ^This interface returns a pointer to the next [prepared statement] after |
3834 ** pStmt associated with the [database connection] pDb. If pStmt is NULL | 4170 ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL |
3835 ** then this interface returns a pointer to the first prepared statement | 4171 ** then this interface returns a pointer to the first prepared statement |
3836 ** associated with the database connection pDb. If no prepared statement | 4172 ** associated with the database connection pDb. ^If no prepared statement |
3837 ** satisfies the conditions of this routine, it returns NULL. | 4173 ** satisfies the conditions of this routine, it returns NULL. |
3838 ** | 4174 ** |
3839 ** The [database connection] pointer D in a call to | 4175 ** The [database connection] pointer D in a call to |
3840 ** [sqlite3_next_stmt(D,S)] must refer to an open database | 4176 ** [sqlite3_next_stmt(D,S)] must refer to an open database |
3841 ** connection and in particular must not be a NULL pointer. | 4177 ** connection and in particular must not be a NULL pointer. |
3842 ** | |
3843 ** Requirements: [H13143] [H13146] [H13149] [H13152] | |
3844 */ | 4178 */ |
3845 SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); | 4179 SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); |
3846 | 4180 |
3847 /* | 4181 /* |
3848 ** CAPI3REF: Commit And Rollback Notification Callbacks {H12950} <S60400> | 4182 ** CAPI3REF: Commit And Rollback Notification Callbacks |
3849 ** | 4183 ** |
3850 ** The sqlite3_commit_hook() interface registers a callback | 4184 ** ^The sqlite3_commit_hook() interface registers a callback |
3851 ** function to be invoked whenever a transaction is [COMMIT | committed]. | 4185 ** function to be invoked whenever a transaction is [COMMIT | committed]. |
3852 ** Any callback set by a previous call to sqlite3_commit_hook() | 4186 ** ^Any callback set by a previous call to sqlite3_commit_hook() |
3853 ** for the same database connection is overridden. | 4187 ** for the same database connection is overridden. |
3854 ** The sqlite3_rollback_hook() interface registers a callback | 4188 ** ^The sqlite3_rollback_hook() interface registers a callback |
3855 ** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. | 4189 ** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. |
3856 ** Any callback set by a previous call to sqlite3_commit_hook() | 4190 ** ^Any callback set by a previous call to sqlite3_rollback_hook() |
3857 ** for the same database connection is overridden. | 4191 ** for the same database connection is overridden. |
3858 ** The pArg argument is passed through to the callback. | 4192 ** ^The pArg argument is passed through to the callback. |
3859 ** If the callback on a commit hook function returns non-zero, | 4193 ** ^If the callback on a commit hook function returns non-zero, |
3860 ** then the commit is converted into a rollback. | 4194 ** then the commit is converted into a rollback. |
3861 ** | 4195 ** |
3862 ** If another function was previously registered, its | 4196 ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions |
3863 ** pArg value is returned. Otherwise NULL is returned. | 4197 ** return the P argument from the previous call of the same function |
| 4198 ** on the same [database connection] D, or NULL for |
| 4199 ** the first call for each function on D. |
3864 ** | 4200 ** |
3865 ** The callback implementation must not do anything that will modify | 4201 ** The callback implementation must not do anything that will modify |
3866 ** the database connection that invoked the callback. Any actions | 4202 ** the database connection that invoked the callback. Any actions |
3867 ** to modify the database connection must be deferred until after the | 4203 ** to modify the database connection must be deferred until after the |
3868 ** completion of the [sqlite3_step()] call that triggered the commit | 4204 ** completion of the [sqlite3_step()] call that triggered the commit |
3869 ** or rollback hook in the first place. | 4205 ** or rollback hook in the first place. |
3870 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their | 4206 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
3871 ** database connections for the meaning of "modify" in this paragraph. | 4207 ** database connections for the meaning of "modify" in this paragraph. |
3872 ** | 4208 ** |
3873 ** Registering a NULL function disables the callback. | 4209 ** ^Registering a NULL function disables the callback. |
3874 ** | 4210 ** |
3875 ** When the commit hook callback routine returns zero, the [COMMIT] | 4211 ** ^When the commit hook callback routine returns zero, the [COMMIT] |
3876 ** operation is allowed to continue normally. If the commit hook | 4212 ** operation is allowed to continue normally. ^If the commit hook |
3877 ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. | 4213 ** 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 | 4214 ** ^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. | 4215 ** hook returning non-zero, just as it would be with any other rollback. |
3880 ** | 4216 ** |
3881 ** For the purposes of this API, a transaction is said to have been | 4217 ** ^For the purposes of this API, a transaction is said to have been |
3882 ** rolled back if an explicit "ROLLBACK" statement is executed, or | 4218 ** rolled back if an explicit "ROLLBACK" statement is executed, or |
3883 ** an error or constraint causes an implicit rollback to occur. | 4219 ** an error or constraint causes an implicit rollback to occur. |
3884 ** The rollback callback is not invoked if a transaction is | 4220 ** ^The rollback callback is not invoked if a transaction is |
3885 ** automatically rolled back because the database connection is closed. | 4221 ** 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 ** | 4222 ** |
3890 ** See also the [sqlite3_update_hook()] interface. | 4223 ** See also the [sqlite3_update_hook()] interface. |
3891 ** | |
3892 ** Requirements: | |
3893 ** [H12951] [H12952] [H12953] [H12954] [H12955] | |
3894 ** [H12961] [H12962] [H12963] [H12964] | |
3895 */ | 4224 */ |
3896 SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); | 4225 SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); |
3897 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); | 4226 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); |
3898 | 4227 |
3899 /* | 4228 /* |
3900 ** CAPI3REF: Data Change Notification Callbacks {H12970} <S60400> | 4229 ** CAPI3REF: Data Change Notification Callbacks |
3901 ** | 4230 ** |
3902 ** The sqlite3_update_hook() interface registers a callback function | 4231 ** ^The sqlite3_update_hook() interface registers a callback function |
3903 ** with the [database connection] identified by the first argument | 4232 ** with the [database connection] identified by the first argument |
3904 ** to be invoked whenever a row is updated, inserted or deleted. | 4233 ** to be invoked whenever a row is updated, inserted or deleted. |
3905 ** Any callback set by a previous call to this function | 4234 ** ^Any callback set by a previous call to this function |
3906 ** for the same database connection is overridden. | 4235 ** for the same database connection is overridden. |
3907 ** | 4236 ** |
3908 ** The second argument is a pointer to the function to invoke when a | 4237 ** ^The second argument is a pointer to the function to invoke when a |
3909 ** row is updated, inserted or deleted. | 4238 ** row is updated, inserted or deleted. |
3910 ** The first argument to the callback is a copy of the third argument | 4239 ** ^The first argument to the callback is a copy of the third argument |
3911 ** to sqlite3_update_hook(). | 4240 ** to sqlite3_update_hook(). |
3912 ** The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], | 4241 ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], |
3913 ** or [SQLITE_UPDATE], depending on the operation that caused the callback | 4242 ** or [SQLITE_UPDATE], depending on the operation that caused the callback |
3914 ** to be invoked. | 4243 ** to be invoked. |
3915 ** The third and fourth arguments to the callback contain pointers to the | 4244 ** ^The third and fourth arguments to the callback contain pointers to the |
3916 ** database and table name containing the affected row. | 4245 ** database and table name containing the affected row. |
3917 ** The final callback parameter is the [rowid] of the row. | 4246 ** ^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. | 4247 ** ^In the case of an update, this is the [rowid] after the update takes place. |
3919 ** | 4248 ** |
3920 ** The update hook is not invoked when internal system tables are | 4249 ** ^(The update hook is not invoked when internal system tables are |
3921 ** modified (i.e. sqlite_master and sqlite_sequence). | 4250 ** modified (i.e. sqlite_master and sqlite_sequence).)^ |
3922 ** | 4251 ** |
3923 ** In the current implementation, the update hook | 4252 ** ^In the current implementation, the update hook |
3924 ** is not invoked when duplication rows are deleted because of an | 4253 ** is not invoked when duplication rows are deleted because of an |
3925 ** [ON CONFLICT | ON CONFLICT REPLACE] clause. Nor is the update hook | 4254 ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook |
3926 ** invoked when rows are deleted using the [truncate optimization]. | 4255 ** invoked when rows are deleted using the [truncate optimization]. |
3927 ** The exceptions defined in this paragraph might change in a future | 4256 ** The exceptions defined in this paragraph might change in a future |
3928 ** release of SQLite. | 4257 ** release of SQLite. |
3929 ** | 4258 ** |
3930 ** The update hook implementation must not do anything that will modify | 4259 ** The update hook implementation must not do anything that will modify |
3931 ** the database connection that invoked the update hook. Any actions | 4260 ** the database connection that invoked the update hook. Any actions |
3932 ** to modify the database connection must be deferred until after the | 4261 ** to modify the database connection must be deferred until after the |
3933 ** completion of the [sqlite3_step()] call that triggered the update hook. | 4262 ** completion of the [sqlite3_step()] call that triggered the update hook. |
3934 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their | 4263 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
3935 ** database connections for the meaning of "modify" in this paragraph. | 4264 ** database connections for the meaning of "modify" in this paragraph. |
3936 ** | 4265 ** |
3937 ** If another function was previously registered, its pArg value | 4266 ** ^The sqlite3_update_hook(D,C,P) function |
3938 ** is returned. Otherwise NULL is returned. | 4267 ** returns the P argument from the previous call |
| 4268 ** on the same [database connection] D, or NULL for |
| 4269 ** the first call on D. |
3939 ** | 4270 ** |
3940 ** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] | 4271 ** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] |
3941 ** interfaces. | 4272 ** interfaces. |
3942 ** | |
3943 ** Requirements: | |
3944 ** [H12971] [H12973] [H12975] [H12977] [H12979] [H12981] [H12983] [H12986] | |
3945 */ | 4273 */ |
3946 SQLITE_API void *sqlite3_update_hook( | 4274 SQLITE_API void *sqlite3_update_hook( |
3947 sqlite3*, | 4275 sqlite3*, |
3948 void(*)(void *,int ,char const *,char const *,sqlite3_int64), | 4276 void(*)(void *,int ,char const *,char const *,sqlite3_int64), |
3949 void* | 4277 void* |
3950 ); | 4278 ); |
3951 | 4279 |
3952 /* | 4280 /* |
3953 ** CAPI3REF: Enable Or Disable Shared Pager Cache {H10330} <S30900> | 4281 ** CAPI3REF: Enable Or Disable Shared Pager Cache |
3954 ** KEYWORDS: {shared cache} | 4282 ** KEYWORDS: {shared cache} |
3955 ** | 4283 ** |
3956 ** This routine enables or disables the sharing of the database cache | 4284 ** ^(This routine enables or disables the sharing of the database cache |
3957 ** and schema data structures between [database connection | connections] | 4285 ** and schema data structures between [database connection | connections] |
3958 ** to the same database. Sharing is enabled if the argument is true | 4286 ** to the same database. Sharing is enabled if the argument is true |
3959 ** and disabled if the argument is false. | 4287 ** and disabled if the argument is false.)^ |
3960 ** | 4288 ** |
3961 ** Cache sharing is enabled and disabled for an entire process. | 4289 ** ^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, | 4290 ** 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. | 4291 ** sharing was enabled or disabled for each thread separately. |
3964 ** | 4292 ** |
3965 ** The cache sharing mode set by this interface effects all subsequent | 4293 ** ^(The cache sharing mode set by this interface effects all subsequent |
3966 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. | 4294 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. |
3967 ** Existing database connections continue use the sharing mode | 4295 ** Existing database connections continue use the sharing mode |
3968 ** that was in effect at the time they were opened. | 4296 ** that was in effect at the time they were opened.)^ |
3969 ** | 4297 ** |
3970 ** Virtual tables cannot be used with a shared cache. When shared | 4298 ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled |
3971 ** cache is enabled, the [sqlite3_create_module()] API used to register | 4299 ** successfully. An [error code] is returned otherwise.)^ |
3972 ** virtual tables will always return an error. | |
3973 ** | 4300 ** |
3974 ** This routine returns [SQLITE_OK] if shared cache was enabled or disabled | 4301 ** ^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 | 4302 ** future releases of SQLite. Applications that care about shared |
3979 ** cache setting should set it explicitly. | 4303 ** cache setting should set it explicitly. |
3980 ** | 4304 ** |
3981 ** See Also: [SQLite Shared-Cache Mode] | 4305 ** See Also: [SQLite Shared-Cache Mode] |
3982 ** | |
3983 ** Requirements: [H10331] [H10336] [H10337] [H10339] | |
3984 */ | 4306 */ |
3985 SQLITE_API int sqlite3_enable_shared_cache(int); | 4307 SQLITE_API int sqlite3_enable_shared_cache(int); |
3986 | 4308 |
3987 /* | 4309 /* |
3988 ** CAPI3REF: Attempt To Free Heap Memory {H17340} <S30220> | 4310 ** CAPI3REF: Attempt To Free Heap Memory |
3989 ** | 4311 ** |
3990 ** The sqlite3_release_memory() interface attempts to free N bytes | 4312 ** ^The sqlite3_release_memory() interface attempts to free N bytes |
3991 ** of heap memory by deallocating non-essential memory allocations | 4313 ** of heap memory by deallocating non-essential memory allocations |
3992 ** held by the database library. {END} Memory used to cache database | 4314 ** held by the database library. Memory used to cache database |
3993 ** pages to improve performance is an example of non-essential memory. | 4315 ** pages to improve performance is an example of non-essential memory. |
3994 ** sqlite3_release_memory() returns the number of bytes actually freed, | 4316 ** ^sqlite3_release_memory() returns the number of bytes actually freed, |
3995 ** which might be more or less than the amount requested. | 4317 ** which might be more or less than the amount requested. |
3996 ** | 4318 ** ^The sqlite3_release_memory() routine is a no-op returning zero |
3997 ** Requirements: [H17341] [H17342] | 4319 ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. |
3998 */ | 4320 */ |
3999 SQLITE_API int sqlite3_release_memory(int); | 4321 SQLITE_API int sqlite3_release_memory(int); |
4000 | 4322 |
4001 /* | 4323 /* |
4002 ** CAPI3REF: Impose A Limit On Heap Size {H17350} <S30220> | 4324 ** CAPI3REF: Impose A Limit On Heap Size |
4003 ** | 4325 ** |
4004 ** The sqlite3_soft_heap_limit() interface places a "soft" limit | 4326 ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the |
4005 ** on the amount of heap memory that may be allocated by SQLite. | 4327 ** 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 | 4328 ** ^SQLite strives to keep heap memory utilization below the soft heap |
4007 ** soft heap limit, [sqlite3_release_memory()] is invoked one or | 4329 ** 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. | 4330 ** as heap memory usages approaches the limit. |
| 4331 ** ^The soft heap limit is "soft" because even though SQLite strives to stay |
| 4332 ** below the limit, it will exceed the limit rather than generate |
| 4333 ** an [SQLITE_NOMEM] error. In other words, the soft heap limit |
| 4334 ** is advisory only. |
4009 ** | 4335 ** |
4010 ** The limit is called "soft", because if [sqlite3_release_memory()] | 4336 ** ^The return value from sqlite3_soft_heap_limit64() is the size of |
4011 ** cannot free sufficient memory to prevent the limit from being exceeded, | 4337 ** 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. | 4338 ** then no change is made to the soft heap limit. Hence, the current |
| 4339 ** size of the soft heap limit can be determined by invoking |
| 4340 ** sqlite3_soft_heap_limit64() with a negative argument. |
4013 ** | 4341 ** |
4014 ** A negative or zero value for N means that there is no soft heap limit and | 4342 ** ^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 ** | 4343 ** |
4018 ** SQLite makes a best effort to honor the soft heap limit. | 4344 ** ^(The soft heap limit is not enforced in the current implementation |
4019 ** But if the soft heap limit cannot be honored, execution will | 4345 ** 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 ** | 4346 ** |
4023 ** Prior to SQLite version 3.5.0, this routine only constrained the memory | 4347 ** <ul> |
4024 ** allocated by a single thread - the same thread in which this routine | 4348 ** <li> The soft heap limit is set to zero. |
4025 ** runs. Beginning with SQLite version 3.5.0, the soft heap limit is | 4349 ** <li> Memory accounting is disabled using a combination of the |
4026 ** applied to all threads. The value specified for the soft heap limit | 4350 ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and |
4027 ** is an upper bound on the total memory allocation for all threads. In | 4351 ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. |
4028 ** version 3.5.0 there is no mechanism for limiting the heap usage for | 4352 ** <li> An alternative page cache implementation is specified using |
4029 ** individual threads. | 4353 ** [sqlite3_config]([SQLITE_CONFIG_PCACHE],...). |
| 4354 ** <li> The page cache allocates from its own memory pool supplied |
| 4355 ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than |
| 4356 ** from the heap. |
| 4357 ** </ul>)^ |
4030 ** | 4358 ** |
4031 ** Requirements: | 4359 ** Beginning with SQLite version 3.7.3, the soft heap limit is enforced |
4032 ** [H16351] [H16352] [H16353] [H16354] [H16355] [H16358] | 4360 ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT] |
| 4361 ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT], |
| 4362 ** the soft heap limit is enforced on every memory allocation. Without |
| 4363 ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced |
| 4364 ** when memory is allocated by the page cache. Testing suggests that because |
| 4365 ** the page cache is the predominate memory user in SQLite, most |
| 4366 ** applications will achieve adequate soft heap limit enforcement without |
| 4367 ** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT]. |
| 4368 ** |
| 4369 ** The circumstances under which SQLite will enforce the soft heap limit may |
| 4370 ** changes in future releases of SQLite. |
4033 */ | 4371 */ |
4034 SQLITE_API void sqlite3_soft_heap_limit(int); | 4372 SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); |
4035 | 4373 |
4036 /* | 4374 /* |
4037 ** CAPI3REF: Extract Metadata About A Column Of A Table {H12850} <S60300> | 4375 ** CAPI3REF: Deprecated Soft Heap Limit Interface |
| 4376 ** DEPRECATED |
4038 ** | 4377 ** |
4039 ** This routine returns metadata about a specific column of a specific | 4378 ** This is a deprecated version of the [sqlite3_soft_heap_limit64()] |
| 4379 ** interface. This routine is provided for historical compatibility |
| 4380 ** only. All new applications should use the |
| 4381 ** [sqlite3_soft_heap_limit64()] interface rather than this one. |
| 4382 */ |
| 4383 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N); |
| 4384 |
| 4385 |
| 4386 /* |
| 4387 ** CAPI3REF: Extract Metadata About A Column Of A Table |
| 4388 ** |
| 4389 ** ^This routine returns metadata about a specific column of a specific |
4040 ** database table accessible using the [database connection] handle | 4390 ** database table accessible using the [database connection] handle |
4041 ** passed as the first function argument. | 4391 ** passed as the first function argument. |
4042 ** | 4392 ** |
4043 ** The column is identified by the second, third and fourth parameters to | 4393 ** ^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 | 4394 ** this function. ^The second parameter is either the name of the database |
4045 ** (i.e. "main", "temp" or an attached database) containing the specified | 4395 ** (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 | 4396 ** 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 | 4397 ** for the table using the same algorithm used by the database engine to |
4048 ** resolve unqualified table references. | 4398 ** resolve unqualified table references. |
4049 ** | 4399 ** |
4050 ** The third and fourth parameters to this function are the table and column | 4400 ** ^The third and fourth parameters to this function are the table and column |
4051 ** name of the desired column, respectively. Neither of these parameters | 4401 ** name of the desired column, respectively. Neither of these parameters |
4052 ** may be NULL. | 4402 ** may be NULL. |
4053 ** | 4403 ** |
4054 ** Metadata is returned by writing to the memory locations passed as the 5th | 4404 ** ^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 | 4405 ** and subsequent parameters to this function. ^Any of these arguments may be |
4056 ** NULL, in which case the corresponding element of metadata is omitted. | 4406 ** NULL, in which case the corresponding element of metadata is omitted. |
4057 ** | 4407 ** |
4058 ** <blockquote> | 4408 ** ^(<blockquote> |
4059 ** <table border="1"> | 4409 ** <table border="1"> |
4060 ** <tr><th> Parameter <th> Output<br>Type <th> Description | 4410 ** <tr><th> Parameter <th> Output<br>Type <th> Description |
4061 ** | 4411 ** |
4062 ** <tr><td> 5th <td> const char* <td> Data type | 4412 ** <tr><td> 5th <td> const char* <td> Data type |
4063 ** <tr><td> 6th <td> const char* <td> Name of default collation sequence | 4413 ** <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 | 4414 ** <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 | 4415 ** <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] | 4416 ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] |
4067 ** </table> | 4417 ** </table> |
4068 ** </blockquote> | 4418 ** </blockquote>)^ |
4069 ** | 4419 ** |
4070 ** The memory pointed to by the character pointers returned for the | 4420 ** ^The memory pointed to by the character pointers returned for the |
4071 ** declaration type and collation sequence is valid only until the next | 4421 ** declaration type and collation sequence is valid only until the next |
4072 ** call to any SQLite API function. | 4422 ** call to any SQLite API function. |
4073 ** | 4423 ** |
4074 ** If the specified table is actually a view, an [error code] is returned. | 4424 ** ^If the specified table is actually a view, an [error code] is returned. |
4075 ** | 4425 ** |
4076 ** If the specified column is "rowid", "oid" or "_rowid_" and an | 4426 ** ^If the specified column is "rowid", "oid" or "_rowid_" and an |
4077 ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output | 4427 ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output |
4078 ** parameters are set for the explicitly declared column. If there is no | 4428 ** parameters are set for the explicitly declared column. ^(If there is no |
4079 ** explicitly declared [INTEGER PRIMARY KEY] column, then the output | 4429 ** explicitly declared [INTEGER PRIMARY KEY] column, then the output |
4080 ** parameters are set as follows: | 4430 ** parameters are set as follows: |
4081 ** | 4431 ** |
4082 ** <pre> | 4432 ** <pre> |
4083 ** data type: "INTEGER" | 4433 ** data type: "INTEGER" |
4084 ** collation sequence: "BINARY" | 4434 ** collation sequence: "BINARY" |
4085 ** not null: 0 | 4435 ** not null: 0 |
4086 ** primary key: 1 | 4436 ** primary key: 1 |
4087 ** auto increment: 0 | 4437 ** auto increment: 0 |
4088 ** </pre> | 4438 ** </pre>)^ |
4089 ** | 4439 ** |
4090 ** This function may load one or more schemas from database files. If an | 4440 ** ^(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 | 4441 ** 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 | 4442 ** cannot be found, an [error code] is returned and an error message left |
4093 ** in the [database connection] (to be retrieved using sqlite3_errmsg()). | 4443 ** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^ |
4094 ** | 4444 ** |
4095 ** This API is only available if the library was compiled with the | 4445 ** ^This API is only available if the library was compiled with the |
4096 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. | 4446 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. |
4097 */ | 4447 */ |
4098 SQLITE_API int sqlite3_table_column_metadata( | 4448 SQLITE_API int sqlite3_table_column_metadata( |
4099 sqlite3 *db, /* Connection handle */ | 4449 sqlite3 *db, /* Connection handle */ |
4100 const char *zDbName, /* Database name or NULL */ | 4450 const char *zDbName, /* Database name or NULL */ |
4101 const char *zTableName, /* Table name */ | 4451 const char *zTableName, /* Table name */ |
4102 const char *zColumnName, /* Column name */ | 4452 const char *zColumnName, /* Column name */ |
4103 char const **pzDataType, /* OUTPUT: Declared data type */ | 4453 char const **pzDataType, /* OUTPUT: Declared data type */ |
4104 char const **pzCollSeq, /* OUTPUT: Collation sequence name */ | 4454 char const **pzCollSeq, /* OUTPUT: Collation sequence name */ |
4105 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ | 4455 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ |
4106 int *pPrimaryKey, /* OUTPUT: True if column part of PK */ | 4456 int *pPrimaryKey, /* OUTPUT: True if column part of PK */ |
4107 int *pAutoinc /* OUTPUT: True if column is auto-increment */ | 4457 int *pAutoinc /* OUTPUT: True if column is auto-increment */ |
4108 ); | 4458 ); |
4109 | 4459 |
4110 /* | 4460 /* |
4111 ** CAPI3REF: Load An Extension {H12600} <S20500> | 4461 ** CAPI3REF: Load An Extension |
4112 ** | 4462 ** |
4113 ** This interface loads an SQLite extension library from the named file. | 4463 ** ^This interface loads an SQLite extension library from the named file. |
4114 ** | 4464 ** |
4115 ** {H12601} The sqlite3_load_extension() interface attempts to load an | 4465 ** ^The sqlite3_load_extension() interface attempts to load an |
4116 ** SQLite extension library contained in the file zFile. | 4466 ** SQLite extension library contained in the file zFile. |
4117 ** | 4467 ** |
4118 ** {H12602} The entry point is zProc. | 4468 ** ^The entry point is zProc. |
| 4469 ** ^zProc may be 0, in which case the name of the entry point |
| 4470 ** defaults to "sqlite3_extension_init". |
| 4471 ** ^The sqlite3_load_extension() interface returns |
| 4472 ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. |
| 4473 ** ^If an error occurs and pzErrMsg is not 0, then the |
| 4474 ** [sqlite3_load_extension()] interface shall attempt to |
| 4475 ** fill *pzErrMsg with error message text stored in memory |
| 4476 ** obtained from [sqlite3_malloc()]. The calling function |
| 4477 ** should free this memory by calling [sqlite3_free()]. |
4119 ** | 4478 ** |
4120 ** {H12603} zProc may be 0, in which case the name of the entry point | 4479 ** ^Extension loading must be enabled using |
4121 ** defaults to "sqlite3_extension_init". | 4480 ** [sqlite3_enable_load_extension()] prior to calling this API, |
| 4481 ** otherwise an error will be returned. |
4122 ** | 4482 ** |
4123 ** {H12604} The sqlite3_load_extension() interface shall return | 4483 ** 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 */ | 4484 */ |
4136 SQLITE_API int sqlite3_load_extension( | 4485 SQLITE_API int sqlite3_load_extension( |
4137 sqlite3 *db, /* Load the extension into this database connection */ | 4486 sqlite3 *db, /* Load the extension into this database connection */ |
4138 const char *zFile, /* Name of the shared library containing extension */ | 4487 const char *zFile, /* Name of the shared library containing extension */ |
4139 const char *zProc, /* Entry point. Derived from zFile if 0 */ | 4488 const char *zProc, /* Entry point. Derived from zFile if 0 */ |
4140 char **pzErrMsg /* Put error message here if not 0 */ | 4489 char **pzErrMsg /* Put error message here if not 0 */ |
4141 ); | 4490 ); |
4142 | 4491 |
4143 /* | 4492 /* |
4144 ** CAPI3REF: Enable Or Disable Extension Loading {H12620} <S20500> | 4493 ** CAPI3REF: Enable Or Disable Extension Loading |
4145 ** | 4494 ** |
4146 ** So as not to open security holes in older applications that are | 4495 ** ^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 | 4496 ** unprepared to deal with extension loading, and as a means of disabling |
4148 ** extension loading while evaluating user-entered SQL, the following API | 4497 ** extension loading while evaluating user-entered SQL, the following API |
4149 ** is provided to turn the [sqlite3_load_extension()] mechanism on and off. | 4498 ** is provided to turn the [sqlite3_load_extension()] mechanism on and off. |
4150 ** | 4499 ** |
4151 ** Extension loading is off by default. See ticket #1863. | 4500 ** ^Extension loading is off by default. See ticket #1863. |
4152 ** | 4501 ** ^Call the sqlite3_enable_load_extension() routine with onoff==1 |
4153 ** {H12621} Call the sqlite3_enable_load_extension() routine with onoff==1 | 4502 ** 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 | 4503 ** it back off again. |
4155 ** it back off again. | |
4156 ** | |
4157 ** {H12622} Extension loading is off by default. | |
4158 */ | 4504 */ |
4159 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); | 4505 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); |
4160 | 4506 |
4161 /* | 4507 /* |
4162 ** CAPI3REF: Automatically Load An Extensions {H12640} <S20500> | 4508 ** CAPI3REF: Automatically Load Statically Linked Extensions |
4163 ** | 4509 ** |
4164 ** This API can be invoked at program startup in order to register | 4510 ** ^This interface causes the xEntryPoint() function to be invoked for |
4165 ** one or more statically linked extensions that will be available | 4511 ** each new [database connection] that is created. The idea here is that |
4166 ** to all new [database connections]. {END} | 4512 ** xEntryPoint() is the entry point for a statically linked SQLite extension |
| 4513 ** that is to be automatically loaded into all new database connections. |
4167 ** | 4514 ** |
4168 ** This routine stores a pointer to the extension in an array that is | 4515 ** ^(Even though the function prototype shows that xEntryPoint() takes |
4169 ** obtained from [sqlite3_malloc()]. If you run a memory leak checker | 4516 ** no arguments and returns void, SQLite invokes xEntryPoint() with three |
4170 ** on your program and it reports a leak because of this array, invoke | 4517 ** arguments and expects and integer result as if the signature of the |
4171 ** [sqlite3_reset_auto_extension()] prior to shutdown to free the memory. | 4518 ** entry point where as follows: |
4172 ** | 4519 ** |
4173 ** {H12641} This function registers an extension entry point that is | 4520 ** <blockquote><pre> |
4174 ** automatically invoked whenever a new [database connection] | 4521 ** int xEntryPoint( |
4175 ** is opened using [sqlite3_open()], [sqlite3_open16()], | 4522 ** sqlite3 *db, |
4176 ** or [sqlite3_open_v2()]. | 4523 ** const char **pzErrMsg, |
| 4524 ** const struct sqlite3_api_routines *pThunk |
| 4525 ** ); |
| 4526 ** </pre></blockquote>)^ |
4177 ** | 4527 ** |
4178 ** {H12642} Duplicate extensions are detected so calling this routine | 4528 ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg |
4179 ** multiple times with the same extension is harmless. | 4529 ** point to an appropriate error message (obtained from [sqlite3_mprintf()]) |
| 4530 ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg |
| 4531 ** is NULL before calling the xEntryPoint(). ^SQLite will invoke |
| 4532 ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any |
| 4533 ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], |
| 4534 ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. |
4180 ** | 4535 ** |
4181 ** {H12643} This routine stores a pointer to the extension in an array | 4536 ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already |
4182 ** that is obtained from [sqlite3_malloc()]. | 4537 ** on the list of automatic extensions is a harmless no-op. ^No entry point |
| 4538 ** will be called more than once for each database connection that is opened. |
4183 ** | 4539 ** |
4184 ** {H12644} Automatic extensions apply across all threads. | 4540 ** See also: [sqlite3_reset_auto_extension()]. |
4185 */ | 4541 */ |
4186 SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void)); | 4542 SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void)); |
4187 | 4543 |
4188 /* | 4544 /* |
4189 ** CAPI3REF: Reset Automatic Extension Loading {H12660} <S20500> | 4545 ** CAPI3REF: Reset Automatic Extension Loading |
4190 ** | 4546 ** |
4191 ** This function disables all previously registered automatic | 4547 ** ^This interface disables all automatic extensions previously |
4192 ** extensions. {END} It undoes the effect of all prior | 4548 ** 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 */ | 4549 */ |
4200 SQLITE_API void sqlite3_reset_auto_extension(void); | 4550 SQLITE_API void sqlite3_reset_auto_extension(void); |
4201 | 4551 |
4202 /* | 4552 /* |
4203 ****** EXPERIMENTAL - subject to change without notice ************** | |
4204 ** | |
4205 ** The interface to the virtual-table mechanism is currently considered | 4553 ** The interface to the virtual-table mechanism is currently considered |
4206 ** to be experimental. The interface might change in incompatible ways. | 4554 ** 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. | 4555 ** If this is a problem for you, do not use the interface at this time. |
4208 ** | 4556 ** |
4209 ** When the virtual-table mechanism stabilizes, we will declare the | 4557 ** When the virtual-table mechanism stabilizes, we will declare the |
4210 ** interface fixed, support it indefinitely, and remove this comment. | 4558 ** interface fixed, support it indefinitely, and remove this comment. |
4211 */ | 4559 */ |
4212 | 4560 |
4213 /* | 4561 /* |
4214 ** Structures used by the virtual table interface | 4562 ** Structures used by the virtual table interface |
4215 */ | 4563 */ |
4216 typedef struct sqlite3_vtab sqlite3_vtab; | 4564 typedef struct sqlite3_vtab sqlite3_vtab; |
4217 typedef struct sqlite3_index_info sqlite3_index_info; | 4565 typedef struct sqlite3_index_info sqlite3_index_info; |
4218 typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; | 4566 typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; |
4219 typedef struct sqlite3_module sqlite3_module; | 4567 typedef struct sqlite3_module sqlite3_module; |
4220 | 4568 |
4221 /* | 4569 /* |
4222 ** CAPI3REF: Virtual Table Object {H18000} <S20400> | 4570 ** CAPI3REF: Virtual Table Object |
4223 ** KEYWORDS: sqlite3_module {virtual table module} | 4571 ** KEYWORDS: sqlite3_module {virtual table module} |
4224 ** EXPERIMENTAL | |
4225 ** | 4572 ** |
4226 ** This structure, sometimes called a a "virtual table module", | 4573 ** This structure, sometimes called a "virtual table module", |
4227 ** defines the implementation of a [virtual tables]. | 4574 ** defines the implementation of a [virtual tables]. |
4228 ** This structure consists mostly of methods for the module. | 4575 ** This structure consists mostly of methods for the module. |
4229 ** | 4576 ** |
4230 ** A virtual table module is created by filling in a persistent | 4577 ** ^A virtual table module is created by filling in a persistent |
4231 ** instance of this structure and passing a pointer to that instance | 4578 ** instance of this structure and passing a pointer to that instance |
4232 ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. | 4579 ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. |
4233 ** The registration remains valid until it is replaced by a different | 4580 ** ^The registration remains valid until it is replaced by a different |
4234 ** module or until the [database connection] closes. The content | 4581 ** module or until the [database connection] closes. The content |
4235 ** of this structure must not change while it is registered with | 4582 ** of this structure must not change while it is registered with |
4236 ** any database connection. | 4583 ** any database connection. |
4237 */ | 4584 */ |
4238 struct sqlite3_module { | 4585 struct sqlite3_module { |
4239 int iVersion; | 4586 int iVersion; |
4240 int (*xCreate)(sqlite3*, void *pAux, | 4587 int (*xCreate)(sqlite3*, void *pAux, |
4241 int argc, const char *const*argv, | 4588 int argc, const char *const*argv, |
4242 sqlite3_vtab **ppVTab, char**); | 4589 sqlite3_vtab **ppVTab, char**); |
4243 int (*xConnect)(sqlite3*, void *pAux, | 4590 int (*xConnect)(sqlite3*, void *pAux, |
(...skipping 15 matching lines...) Expand all Loading... |
4259 int (*xSync)(sqlite3_vtab *pVTab); | 4606 int (*xSync)(sqlite3_vtab *pVTab); |
4260 int (*xCommit)(sqlite3_vtab *pVTab); | 4607 int (*xCommit)(sqlite3_vtab *pVTab); |
4261 int (*xRollback)(sqlite3_vtab *pVTab); | 4608 int (*xRollback)(sqlite3_vtab *pVTab); |
4262 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, | 4609 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, |
4263 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), | 4610 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), |
4264 void **ppArg); | 4611 void **ppArg); |
4265 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); | 4612 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); |
4266 }; | 4613 }; |
4267 | 4614 |
4268 /* | 4615 /* |
4269 ** CAPI3REF: Virtual Table Indexing Information {H18100} <S20400> | 4616 ** CAPI3REF: Virtual Table Indexing Information |
4270 ** KEYWORDS: sqlite3_index_info | 4617 ** KEYWORDS: sqlite3_index_info |
4271 ** EXPERIMENTAL | |
4272 ** | 4618 ** |
4273 ** The sqlite3_index_info structure and its substructures is used to | 4619 ** The sqlite3_index_info structure and its substructures is used as part |
| 4620 ** of the [virtual table] interface to |
4274 ** pass information into and receive the reply from the [xBestIndex] | 4621 ** pass information into and receive the reply from the [xBestIndex] |
4275 ** method of a [virtual table module]. The fields under **Inputs** are the | 4622 ** method of a [virtual table module]. The fields under **Inputs** are the |
4276 ** inputs to xBestIndex and are read-only. xBestIndex inserts its | 4623 ** inputs to xBestIndex and are read-only. xBestIndex inserts its |
4277 ** results into the **Outputs** fields. | 4624 ** results into the **Outputs** fields. |
4278 ** | 4625 ** |
4279 ** The aConstraint[] array records WHERE clause constraints of the form: | 4626 ** ^(The aConstraint[] array records WHERE clause constraints of the form: |
4280 ** | 4627 ** |
4281 ** <pre>column OP expr</pre> | 4628 ** <blockquote>column OP expr</blockquote> |
4282 ** | 4629 ** |
4283 ** where OP is =, <, <=, >, or >=. The particular operator is | 4630 ** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is |
4284 ** stored in aConstraint[].op. The index of the column is stored in | 4631 ** stored in aConstraint[].op using one of the |
4285 ** aConstraint[].iColumn. aConstraint[].usable is TRUE if the | 4632 ** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ |
| 4633 ** ^(The index of the column is stored in |
| 4634 ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the |
4286 ** expr on the right-hand side can be evaluated (and thus the constraint | 4635 ** expr on the right-hand side can be evaluated (and thus the constraint |
4287 ** is usable) and false if it cannot. | 4636 ** is usable) and false if it cannot.)^ |
4288 ** | 4637 ** |
4289 ** The optimizer automatically inverts terms of the form "expr OP column" | 4638 ** ^The optimizer automatically inverts terms of the form "expr OP column" |
4290 ** and makes other simplifications to the WHERE clause in an attempt to | 4639 ** 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. | 4640 ** 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 | 4641 ** ^The aConstraint[] array only reports WHERE clause terms that are |
4293 ** form that refer to the particular virtual table being queried. | 4642 ** relevant to the particular virtual table being queried. |
4294 ** | 4643 ** |
4295 ** Information about the ORDER BY clause is stored in aOrderBy[]. | 4644 ** ^Information about the ORDER BY clause is stored in aOrderBy[]. |
4296 ** Each term of aOrderBy records a column of the ORDER BY clause. | 4645 ** ^Each term of aOrderBy records a column of the ORDER BY clause. |
4297 ** | 4646 ** |
4298 ** The [xBestIndex] method must fill aConstraintUsage[] with information | 4647 ** The [xBestIndex] method must fill aConstraintUsage[] with information |
4299 ** about what parameters to pass to xFilter. If argvIndex>0 then | 4648 ** about what parameters to pass to xFilter. ^If argvIndex>0 then |
4300 ** the right-hand side of the corresponding aConstraint[] is evaluated | 4649 ** the right-hand side of the corresponding aConstraint[] is evaluated |
4301 ** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit | 4650 ** 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 | 4651 ** is true, then the constraint is assumed to be fully handled by the |
4303 ** virtual table and is not checked again by SQLite. | 4652 ** virtual table and is not checked again by SQLite.)^ |
4304 ** | 4653 ** |
4305 ** The idxNum and idxPtr values are recorded and passed into the | 4654 ** ^The idxNum and idxPtr values are recorded and passed into the |
4306 ** [xFilter] method. | 4655 ** [xFilter] method. |
4307 ** [sqlite3_free()] is used to free idxPtr if and only iff | 4656 ** ^[sqlite3_free()] is used to free idxPtr if and only if |
4308 ** needToFreeIdxPtr is true. | 4657 ** needToFreeIdxPtr is true. |
4309 ** | 4658 ** |
4310 ** The orderByConsumed means that output from [xFilter]/[xNext] will occur in | 4659 ** ^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 | 4660 ** the correct order to satisfy the ORDER BY clause so that no separate |
4312 ** sorting step is required. | 4661 ** sorting step is required. |
4313 ** | 4662 ** |
4314 ** The estimatedCost value is an estimate of the cost of doing the | 4663 ** ^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 | 4664 ** 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 | 4665 ** a cost of N. A binary search of a table of N entries should have a |
4317 ** cost of approximately log(N). | 4666 ** cost of approximately log(N). |
4318 */ | 4667 */ |
4319 struct sqlite3_index_info { | 4668 struct sqlite3_index_info { |
4320 /* Inputs */ | 4669 /* Inputs */ |
4321 int nConstraint; /* Number of entries in aConstraint */ | 4670 int nConstraint; /* Number of entries in aConstraint */ |
4322 struct sqlite3_index_constraint { | 4671 struct sqlite3_index_constraint { |
4323 int iColumn; /* Column on left-hand side of constraint */ | 4672 int iColumn; /* Column on left-hand side of constraint */ |
4324 unsigned char op; /* Constraint operator */ | 4673 unsigned char op; /* Constraint operator */ |
4325 unsigned char usable; /* True if this constraint is usable */ | 4674 unsigned char usable; /* True if this constraint is usable */ |
4326 int iTermOffset; /* Used internally - xBestIndex should ignore */ | 4675 int iTermOffset; /* Used internally - xBestIndex should ignore */ |
4327 } *aConstraint; /* Table of WHERE clause constraints */ | 4676 } *aConstraint; /* Table of WHERE clause constraints */ |
4328 int nOrderBy; /* Number of terms in the ORDER BY clause */ | 4677 int nOrderBy; /* Number of terms in the ORDER BY clause */ |
4329 struct sqlite3_index_orderby { | 4678 struct sqlite3_index_orderby { |
4330 int iColumn; /* Column number */ | 4679 int iColumn; /* Column number */ |
4331 unsigned char desc; /* True for DESC. False for ASC. */ | 4680 unsigned char desc; /* True for DESC. False for ASC. */ |
4332 } *aOrderBy; /* The ORDER BY clause */ | 4681 } *aOrderBy; /* The ORDER BY clause */ |
4333 /* Outputs */ | 4682 /* Outputs */ |
4334 struct sqlite3_index_constraint_usage { | 4683 struct sqlite3_index_constraint_usage { |
4335 int argvIndex; /* if >0, constraint is part of argv to xFilter */ | 4684 int argvIndex; /* if >0, constraint is part of argv to xFilter */ |
4336 unsigned char omit; /* Do not code a test for this constraint */ | 4685 unsigned char omit; /* Do not code a test for this constraint */ |
4337 } *aConstraintUsage; | 4686 } *aConstraintUsage; |
4338 int idxNum; /* Number used to identify the index */ | 4687 int idxNum; /* Number used to identify the index */ |
4339 char *idxStr; /* String, possibly obtained from sqlite3_malloc */ | 4688 char *idxStr; /* String, possibly obtained from sqlite3_malloc */ |
4340 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ | 4689 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ |
4341 int orderByConsumed; /* True if output is already ordered */ | 4690 int orderByConsumed; /* True if output is already ordered */ |
4342 double estimatedCost; /* Estimated cost of using this index */ | 4691 double estimatedCost; /* Estimated cost of using this index */ |
4343 }; | 4692 }; |
| 4693 |
| 4694 /* Begin preload-cache.patch for Chromium */ |
| 4695 /* |
| 4696 ** Preload the databases into the pager cache, up to the maximum size of the |
| 4697 ** pager cache. |
| 4698 ** |
| 4699 ** For a database to be loaded successfully, the pager must be active. That is, |
| 4700 ** there must be an open statement on that database. See sqlite3pager_loadall |
| 4701 ** |
| 4702 ** There might be many databases attached to the given connection. We iterate |
| 4703 ** them all and try to load them. If none are loadable successfully, we return |
| 4704 ** an error. Otherwise, we return OK. |
| 4705 */ |
| 4706 SQLITE_API int sqlite3_preload(sqlite3 *db); |
| 4707 /* End preload-cache.patch for Chromium */ |
| 4708 |
| 4709 /* |
| 4710 ** CAPI3REF: Virtual Table Constraint Operator Codes |
| 4711 ** |
| 4712 ** These macros defined the allowed values for the |
| 4713 ** [sqlite3_index_info].aConstraint[].op field. Each value represents |
| 4714 ** an operator that is part of a constraint term in the wHERE clause of |
| 4715 ** a query that uses a [virtual table]. |
| 4716 */ |
4344 #define SQLITE_INDEX_CONSTRAINT_EQ 2 | 4717 #define SQLITE_INDEX_CONSTRAINT_EQ 2 |
4345 #define SQLITE_INDEX_CONSTRAINT_GT 4 | 4718 #define SQLITE_INDEX_CONSTRAINT_GT 4 |
4346 #define SQLITE_INDEX_CONSTRAINT_LE 8 | 4719 #define SQLITE_INDEX_CONSTRAINT_LE 8 |
4347 #define SQLITE_INDEX_CONSTRAINT_LT 16 | 4720 #define SQLITE_INDEX_CONSTRAINT_LT 16 |
4348 #define SQLITE_INDEX_CONSTRAINT_GE 32 | 4721 #define SQLITE_INDEX_CONSTRAINT_GE 32 |
4349 #define SQLITE_INDEX_CONSTRAINT_MATCH 64 | 4722 #define SQLITE_INDEX_CONSTRAINT_MATCH 64 |
4350 | 4723 |
4351 /* | 4724 /* |
4352 ** CAPI3REF: Register A Virtual Table Implementation {H18200} <S20400> | 4725 ** CAPI3REF: Register A Virtual Table Implementation |
4353 ** EXPERIMENTAL | |
4354 ** | 4726 ** |
4355 ** This routine is used to register a new [virtual table module] name. | 4727 ** ^These routines are used to register a new [virtual table module] name. |
4356 ** Module names must be registered before | 4728 ** ^Module names must be registered before |
4357 ** creating a new [virtual table] using the module, or before using a | 4729 ** creating a new [virtual table] using the module and before using a |
4358 ** preexisting [virtual table] for the module. | 4730 ** preexisting [virtual table] for the module. |
4359 ** | 4731 ** |
4360 ** The module name is registered on the [database connection] specified | 4732 ** ^The module name is registered on the [database connection] specified |
4361 ** by the first parameter. The name of the module is given by the | 4733 ** by the first parameter. ^The name of the module is given by the |
4362 ** second parameter. The third parameter is a pointer to | 4734 ** second parameter. ^The third parameter is a pointer to |
4363 ** the implementation of the [virtual table module]. The fourth | 4735 ** the implementation of the [virtual table module]. ^The fourth |
4364 ** parameter is an arbitrary client data pointer that is passed through | 4736 ** parameter is an arbitrary client data pointer that is passed through |
4365 ** into the [xCreate] and [xConnect] methods of the virtual table module | 4737 ** into the [xCreate] and [xConnect] methods of the virtual table module |
4366 ** when a new virtual table is be being created or reinitialized. | 4738 ** when a new virtual table is be being created or reinitialized. |
4367 ** | 4739 ** |
4368 ** This interface has exactly the same effect as calling | 4740 ** ^The sqlite3_create_module_v2() interface has a fifth parameter which |
4369 ** [sqlite3_create_module_v2()] with a NULL client data destructor. | 4741 ** is a pointer to a destructor for the pClientData. ^SQLite will |
| 4742 ** invoke the destructor function (if it is not NULL) when SQLite |
| 4743 ** no longer needs the pClientData pointer. ^The destructor will also |
| 4744 ** be invoked if the call to sqlite3_create_module_v2() fails. |
| 4745 ** ^The sqlite3_create_module() |
| 4746 ** interface is equivalent to sqlite3_create_module_v2() with a NULL |
| 4747 ** destructor. |
4370 */ | 4748 */ |
4371 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_create_module( | 4749 SQLITE_API int sqlite3_create_module( |
4372 sqlite3 *db, /* SQLite connection to register module with */ | 4750 sqlite3 *db, /* SQLite connection to register module with */ |
4373 const char *zName, /* Name of the module */ | 4751 const char *zName, /* Name of the module */ |
4374 const sqlite3_module *p, /* Methods for the module */ | 4752 const sqlite3_module *p, /* Methods for the module */ |
4375 void *pClientData /* Client data for xCreate/xConnect */ | 4753 void *pClientData /* Client data for xCreate/xConnect */ |
4376 ); | 4754 ); |
4377 | 4755 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 */ | 4756 sqlite3 *db, /* SQLite connection to register module with */ |
4390 const char *zName, /* Name of the module */ | 4757 const char *zName, /* Name of the module */ |
4391 const sqlite3_module *p, /* Methods for the module */ | 4758 const sqlite3_module *p, /* Methods for the module */ |
4392 void *pClientData, /* Client data for xCreate/xConnect */ | 4759 void *pClientData, /* Client data for xCreate/xConnect */ |
4393 void(*xDestroy)(void*) /* Module destructor function */ | 4760 void(*xDestroy)(void*) /* Module destructor function */ |
4394 ); | 4761 ); |
4395 | 4762 |
4396 /* | 4763 /* |
4397 ** CAPI3REF: Virtual Table Instance Object {H18010} <S20400> | 4764 ** CAPI3REF: Virtual Table Instance Object |
4398 ** KEYWORDS: sqlite3_vtab | 4765 ** KEYWORDS: sqlite3_vtab |
4399 ** EXPERIMENTAL | |
4400 ** | 4766 ** |
4401 ** Every [virtual table module] implementation uses a subclass | 4767 ** Every [virtual table module] implementation uses a subclass |
4402 ** of the following structure to describe a particular instance | 4768 ** of this object to describe a particular instance |
4403 ** of the [virtual table]. Each subclass will | 4769 ** of the [virtual table]. Each subclass will |
4404 ** be tailored to the specific needs of the module implementation. | 4770 ** be tailored to the specific needs of the module implementation. |
4405 ** The purpose of this superclass is to define certain fields that are | 4771 ** The purpose of this superclass is to define certain fields that are |
4406 ** common to all module implementations. | 4772 ** common to all module implementations. |
4407 ** | 4773 ** |
4408 ** Virtual tables methods can set an error message by assigning a | 4774 ** ^Virtual tables methods can set an error message by assigning a |
4409 ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should | 4775 ** 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()] | 4776 ** 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 | 4777 ** 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 | 4778 ** is delivered up to the client application, the string will be automatically |
4413 ** freed by sqlite3_free() and the zErrMsg field will be zeroed. | 4779 ** freed by sqlite3_free() and the zErrMsg field will be zeroed. |
4414 */ | 4780 */ |
4415 struct sqlite3_vtab { | 4781 struct sqlite3_vtab { |
4416 const sqlite3_module *pModule; /* The module for this virtual table */ | 4782 const sqlite3_module *pModule; /* The module for this virtual table */ |
4417 int nRef; /* NO LONGER USED */ | 4783 int nRef; /* NO LONGER USED */ |
4418 char *zErrMsg; /* Error message from sqlite3_mprintf() */ | 4784 char *zErrMsg; /* Error message from sqlite3_mprintf() */ |
4419 /* Virtual table implementations will typically add additional fields */ | 4785 /* Virtual table implementations will typically add additional fields */ |
4420 }; | 4786 }; |
4421 | 4787 |
4422 /* | 4788 /* |
4423 ** CAPI3REF: Virtual Table Cursor Object {H18020} <S20400> | 4789 ** CAPI3REF: Virtual Table Cursor Object |
4424 ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} | 4790 ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} |
4425 ** EXPERIMENTAL | |
4426 ** | 4791 ** |
4427 ** Every [virtual table module] implementation uses a subclass of the | 4792 ** Every [virtual table module] implementation uses a subclass of the |
4428 ** following structure to describe cursors that point into the | 4793 ** following structure to describe cursors that point into the |
4429 ** [virtual table] and are used | 4794 ** [virtual table] and are used |
4430 ** to loop through the virtual table. Cursors are created using the | 4795 ** to loop through the virtual table. Cursors are created using the |
4431 ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed | 4796 ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed |
4432 ** by the [sqlite3_module.xClose | xClose] method. Cussors are used | 4797 ** by the [sqlite3_module.xClose | xClose] method. Cursors are used |
4433 ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods | 4798 ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods |
4434 ** of the module. Each module implementation will define | 4799 ** of the module. Each module implementation will define |
4435 ** the content of a cursor structure to suit its own needs. | 4800 ** the content of a cursor structure to suit its own needs. |
4436 ** | 4801 ** |
4437 ** This superclass exists in order to define fields of the cursor that | 4802 ** This superclass exists in order to define fields of the cursor that |
4438 ** are common to all implementations. | 4803 ** are common to all implementations. |
4439 */ | 4804 */ |
4440 struct sqlite3_vtab_cursor { | 4805 struct sqlite3_vtab_cursor { |
4441 sqlite3_vtab *pVtab; /* Virtual table of this cursor */ | 4806 sqlite3_vtab *pVtab; /* Virtual table of this cursor */ |
4442 /* Virtual table implementations will typically add additional fields */ | 4807 /* Virtual table implementations will typically add additional fields */ |
4443 }; | 4808 }; |
4444 | 4809 |
4445 /* | 4810 /* |
4446 ** CAPI3REF: Declare The Schema Of A Virtual Table {H18280} <S20400> | 4811 ** CAPI3REF: Declare The Schema Of A Virtual Table |
4447 ** EXPERIMENTAL | |
4448 ** | 4812 ** |
4449 ** The [xCreate] and [xConnect] methods of a | 4813 ** ^The [xCreate] and [xConnect] methods of a |
4450 ** [virtual table module] call this interface | 4814 ** [virtual table module] call this interface |
4451 ** to declare the format (the names and datatypes of the columns) of | 4815 ** to declare the format (the names and datatypes of the columns) of |
4452 ** the virtual tables they implement. | 4816 ** the virtual tables they implement. |
4453 */ | 4817 */ |
4454 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_declare_vtab(sqlite3*, const char *zS
QL); | 4818 SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL); |
4455 | 4819 |
4456 /* | 4820 /* |
4457 ** CAPI3REF: Overload A Function For A Virtual Table {H18300} <S20400> | 4821 ** CAPI3REF: Overload A Function For A Virtual Table |
4458 ** EXPERIMENTAL | |
4459 ** | 4822 ** |
4460 ** Virtual tables can provide alternative implementations of functions | 4823 ** ^(Virtual tables can provide alternative implementations of functions |
4461 ** using the [xFindFunction] method of the [virtual table module]. | 4824 ** using the [xFindFunction] method of the [virtual table module]. |
4462 ** But global versions of those functions | 4825 ** But global versions of those functions |
4463 ** must exist in order to be overloaded. | 4826 ** must exist in order to be overloaded.)^ |
4464 ** | 4827 ** |
4465 ** This API makes sure a global version of a function with a particular | 4828 ** ^(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 | 4829 ** name and number of parameters exists. If no such function exists |
4467 ** before this API is called, a new function is created. The implementation | 4830 ** 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 | 4831 ** 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 | 4832 ** the new function is not good for anything by itself. Its only |
4470 ** purpose is to be a placeholder function that can be overloaded | 4833 ** purpose is to be a placeholder function that can be overloaded |
4471 ** by a [virtual table]. | 4834 ** by a [virtual table]. |
4472 */ | 4835 */ |
4473 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_overload_function(sqlite3*, const cha
r *zFuncName, int nArg); | 4836 SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nA
rg); |
4474 | 4837 |
4475 /* | 4838 /* |
4476 ** The interface to the virtual-table mechanism defined above (back up | 4839 ** The interface to the virtual-table mechanism defined above (back up |
4477 ** to a comment remarkably similar to this one) is currently considered | 4840 ** to a comment remarkably similar to this one) is currently considered |
4478 ** to be experimental. The interface might change in incompatible ways. | 4841 ** 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. | 4842 ** If this is a problem for you, do not use the interface at this time. |
4480 ** | 4843 ** |
4481 ** When the virtual-table mechanism stabilizes, we will declare the | 4844 ** When the virtual-table mechanism stabilizes, we will declare the |
4482 ** interface fixed, support it indefinitely, and remove this comment. | 4845 ** interface fixed, support it indefinitely, and remove this comment. |
4483 ** | |
4484 ****** EXPERIMENTAL - subject to change without notice ************** | |
4485 */ | 4846 */ |
4486 | 4847 |
4487 /* | 4848 /* |
4488 ** CAPI3REF: A Handle To An Open BLOB {H17800} <S30230> | 4849 ** CAPI3REF: A Handle To An Open BLOB |
4489 ** KEYWORDS: {BLOB handle} {BLOB handles} | 4850 ** KEYWORDS: {BLOB handle} {BLOB handles} |
4490 ** | 4851 ** |
4491 ** An instance of this object represents an open BLOB on which | 4852 ** An instance of this object represents an open BLOB on which |
4492 ** [sqlite3_blob_open | incremental BLOB I/O] can be performed. | 4853 ** [sqlite3_blob_open | incremental BLOB I/O] can be performed. |
4493 ** Objects of this type are created by [sqlite3_blob_open()] | 4854 ** ^Objects of this type are created by [sqlite3_blob_open()] |
4494 ** and destroyed by [sqlite3_blob_close()]. | 4855 ** and destroyed by [sqlite3_blob_close()]. |
4495 ** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces | 4856 ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces |
4496 ** can be used to read or write small subsections of the BLOB. | 4857 ** 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. | 4858 ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. |
4498 */ | 4859 */ |
4499 typedef struct sqlite3_blob sqlite3_blob; | 4860 typedef struct sqlite3_blob sqlite3_blob; |
4500 | 4861 |
4501 /* | 4862 /* |
4502 ** CAPI3REF: Open A BLOB For Incremental I/O {H17810} <S30230> | 4863 ** CAPI3REF: Open A BLOB For Incremental I/O |
4503 ** | 4864 ** |
4504 ** This interfaces opens a [BLOB handle | handle] to the BLOB located | 4865 ** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located |
4505 ** in row iRow, column zColumn, table zTable in database zDb; | 4866 ** in row iRow, column zColumn, table zTable in database zDb; |
4506 ** in other words, the same BLOB that would be selected by: | 4867 ** in other words, the same BLOB that would be selected by: |
4507 ** | 4868 ** |
4508 ** <pre> | 4869 ** <pre> |
4509 ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; | 4870 ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; |
4510 ** </pre> {END} | 4871 ** </pre>)^ |
4511 ** | 4872 ** |
4512 ** If the flags parameter is non-zero, then the BLOB is opened for read | 4873 ** ^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. | 4874 ** and write access. ^If it is zero, the BLOB is opened for read access. |
| 4875 ** ^It is not possible to open a column that is part of an index or primary |
| 4876 ** key for writing. ^If [foreign key constraints] are enabled, it is |
| 4877 ** not possible to open a column that is part of a [child key] for writing. |
4514 ** | 4878 ** |
4515 ** Note that the database name is not the filename that contains | 4879 ** ^Note that the database name is not the filename that contains |
4516 ** the database but rather the symbolic name of the database that | 4880 ** the database but rather the symbolic name of the database that |
4517 ** is assigned when the database is connected using [ATTACH]. | 4881 ** appears after the AS keyword when the database is connected using [ATTACH]. |
4518 ** For the main database file, the database name is "main". | 4882 ** ^For the main database file, the database name is "main". |
4519 ** For TEMP tables, the database name is "temp". | 4883 ** ^For TEMP tables, the database name is "temp". |
4520 ** | 4884 ** |
4521 ** On success, [SQLITE_OK] is returned and the new [BLOB handle] is written | 4885 ** ^(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 | 4886 ** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set |
4523 ** to be a null pointer. | 4887 ** to be a null pointer.)^ |
4524 ** This function sets the [database connection] error code and message | 4888 ** ^This function sets the [database connection] error code and message |
4525 ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related | 4889 ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related |
4526 ** functions. Note that the *ppBlob variable is always initialized in a | 4890 ** functions. ^Note that the *ppBlob variable is always initialized in a |
4527 ** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob | 4891 ** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob |
4528 ** regardless of the success or failure of this routine. | 4892 ** regardless of the success or failure of this routine. |
4529 ** | 4893 ** |
4530 ** If the row that a BLOB handle points to is modified by an | 4894 ** ^(If the row that a BLOB handle points to is modified by an |
4531 ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects | 4895 ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects |
4532 ** then the BLOB handle is marked as "expired". | 4896 ** then the BLOB handle is marked as "expired". |
4533 ** This is true if any column of the row is changed, even a column | 4897 ** 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. | 4898 ** other than the one the BLOB handle is open on.)^ |
4535 ** Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for | 4899 ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for |
4536 ** a expired BLOB handle fail with an return code of [SQLITE_ABORT]. | 4900 ** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. |
4537 ** Changes written into a BLOB prior to the BLOB expiring are not | 4901 ** ^(Changes written into a BLOB prior to the BLOB expiring are not |
4538 ** rollback by the expiration of the BLOB. Such changes will eventually | 4902 ** rolled back by the expiration of the BLOB. Such changes will eventually |
4539 ** commit if the transaction continues to completion. | 4903 ** commit if the transaction continues to completion.)^ |
4540 ** | 4904 ** |
4541 ** Use the [sqlite3_blob_bytes()] interface to determine the size of | 4905 ** ^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 | 4906 ** 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 | 4907 ** interface. Use the [UPDATE] SQL command to change the size of a |
4544 ** blob. | 4908 ** blob. |
4545 ** | 4909 ** |
4546 ** The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces | 4910 ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces |
4547 ** and the built-in [zeroblob] SQL function can be used, if desired, | 4911 ** 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 | 4912 ** to create an empty, zero-filled blob in which to read or write using |
4549 ** this interface. | 4913 ** this interface. |
4550 ** | 4914 ** |
4551 ** To avoid a resource leak, every open [BLOB handle] should eventually | 4915 ** To avoid a resource leak, every open [BLOB handle] should eventually |
4552 ** be released by a call to [sqlite3_blob_close()]. | 4916 ** be released by a call to [sqlite3_blob_close()]. |
4553 ** | |
4554 ** Requirements: | |
4555 ** [H17813] [H17814] [H17816] [H17819] [H17821] [H17824] | |
4556 */ | 4917 */ |
4557 SQLITE_API int sqlite3_blob_open( | 4918 SQLITE_API int sqlite3_blob_open( |
4558 sqlite3*, | 4919 sqlite3*, |
4559 const char *zDb, | 4920 const char *zDb, |
4560 const char *zTable, | 4921 const char *zTable, |
4561 const char *zColumn, | 4922 const char *zColumn, |
4562 sqlite3_int64 iRow, | 4923 sqlite3_int64 iRow, |
4563 int flags, | 4924 int flags, |
4564 sqlite3_blob **ppBlob | 4925 sqlite3_blob **ppBlob |
4565 ); | 4926 ); |
4566 | 4927 |
4567 /* | 4928 /* |
4568 ** CAPI3REF: Close A BLOB Handle {H17830} <S30230> | 4929 ** CAPI3REF: Move a BLOB Handle to a New Row |
4569 ** | 4930 ** |
4570 ** Closes an open [BLOB handle]. | 4931 ** ^This function is used to move an existing blob handle so that it points |
| 4932 ** to a different row of the same database table. ^The new row is identified |
| 4933 ** by the rowid value passed as the second argument. Only the row can be |
| 4934 ** changed. ^The database, table and column on which the blob handle is open |
| 4935 ** remain the same. Moving an existing blob handle to a new row can be |
| 4936 ** faster than closing the existing handle and opening a new one. |
4571 ** | 4937 ** |
4572 ** Closing a BLOB shall cause the current transaction to commit | 4938 ** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - |
| 4939 ** it must exist and there must be either a blob or text value stored in |
| 4940 ** the nominated column.)^ ^If the new row is not present in the table, or if |
| 4941 ** it does not contain a blob or text value, or if another error occurs, an |
| 4942 ** SQLite error code is returned and the blob handle is considered aborted. |
| 4943 ** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or |
| 4944 ** [sqlite3_blob_reopen()] on an aborted blob handle immediately return |
| 4945 ** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle |
| 4946 ** always returns zero. |
| 4947 ** |
| 4948 ** ^This function sets the database handle error code and message. |
| 4949 */ |
| 4950 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_i
nt64); |
| 4951 |
| 4952 /* |
| 4953 ** CAPI3REF: Close A BLOB Handle |
| 4954 ** |
| 4955 ** ^Closes an open [BLOB handle]. |
| 4956 ** |
| 4957 ** ^Closing a BLOB shall cause the current transaction to commit |
4573 ** if there are no other BLOBs, no pending prepared statements, and the | 4958 ** if there are no other BLOBs, no pending prepared statements, and the |
4574 ** database connection is in [autocommit mode]. | 4959 ** database connection is in [autocommit mode]. |
4575 ** If any writes were made to the BLOB, they might be held in cache | 4960 ** ^If any writes were made to the BLOB, they might be held in cache |
4576 ** until the close operation if they will fit. | 4961 ** until the close operation if they will fit. |
4577 ** | 4962 ** |
4578 ** Closing the BLOB often forces the changes | 4963 ** ^(Closing the BLOB often forces the changes |
4579 ** out to disk and so if any I/O errors occur, they will likely occur | 4964 ** 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 | 4965 ** at the time when the BLOB is closed. Any errors that occur during |
4581 ** closing are reported as a non-zero return value. | 4966 ** closing are reported as a non-zero return value.)^ |
4582 ** | 4967 ** |
4583 ** The BLOB is closed unconditionally. Even if this routine returns | 4968 ** ^(The BLOB is closed unconditionally. Even if this routine returns |
4584 ** an error code, the BLOB is still closed. | 4969 ** an error code, the BLOB is still closed.)^ |
4585 ** | 4970 ** |
4586 ** Calling this routine with a null pointer (which as would be returned | 4971 ** ^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. | 4972 ** by a failed call to [sqlite3_blob_open()]) is a harmless no-op. |
4588 ** | |
4589 ** Requirements: | |
4590 ** [H17833] [H17836] [H17839] | |
4591 */ | 4973 */ |
4592 SQLITE_API int sqlite3_blob_close(sqlite3_blob *); | 4974 SQLITE_API int sqlite3_blob_close(sqlite3_blob *); |
4593 | 4975 |
4594 /* | 4976 /* |
4595 ** CAPI3REF: Return The Size Of An Open BLOB {H17840} <S30230> | 4977 ** CAPI3REF: Return The Size Of An Open BLOB |
4596 ** | 4978 ** |
4597 ** Returns the size in bytes of the BLOB accessible via the | 4979 ** ^Returns the size in bytes of the BLOB accessible via the |
4598 ** successfully opened [BLOB handle] in its only argument. The | 4980 ** successfully opened [BLOB handle] in its only argument. ^The |
4599 ** incremental blob I/O routines can only read or overwriting existing | 4981 ** incremental blob I/O routines can only read or overwriting existing |
4600 ** blob content; they cannot change the size of a blob. | 4982 ** blob content; they cannot change the size of a blob. |
4601 ** | 4983 ** |
4602 ** This routine only works on a [BLOB handle] which has been created | 4984 ** 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 | 4985 ** 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 | 4986 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
4605 ** to this routine results in undefined and probably undesirable behavior. | 4987 ** to this routine results in undefined and probably undesirable behavior. |
4606 ** | |
4607 ** Requirements: | |
4608 ** [H17843] | |
4609 */ | 4988 */ |
4610 SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *); | 4989 SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *); |
4611 | 4990 |
4612 /* | 4991 /* |
4613 ** CAPI3REF: Read Data From A BLOB Incrementally {H17850} <S30230> | 4992 ** CAPI3REF: Read Data From A BLOB Incrementally |
4614 ** | 4993 ** |
4615 ** This function is used to read data from an open [BLOB handle] into a | 4994 ** ^(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 | 4995 ** caller-supplied buffer. N bytes of data are copied into buffer Z |
4617 ** from the open BLOB, starting at offset iOffset. | 4996 ** from the open BLOB, starting at offset iOffset.)^ |
4618 ** | 4997 ** |
4619 ** If offset iOffset is less than N bytes from the end of the BLOB, | 4998 ** ^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 | 4999 ** [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. | 5000 ** 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) | 5001 ** ^The size of the blob (and hence the maximum value of N+iOffset) |
4623 ** can be determined using the [sqlite3_blob_bytes()] interface. | 5002 ** can be determined using the [sqlite3_blob_bytes()] interface. |
4624 ** | 5003 ** |
4625 ** An attempt to read from an expired [BLOB handle] fails with an | 5004 ** ^An attempt to read from an expired [BLOB handle] fails with an |
4626 ** error code of [SQLITE_ABORT]. | 5005 ** error code of [SQLITE_ABORT]. |
4627 ** | 5006 ** |
4628 ** On success, SQLITE_OK is returned. | 5007 ** ^(On success, sqlite3_blob_read() returns SQLITE_OK. |
4629 ** Otherwise, an [error code] or an [extended error code] is returned. | 5008 ** Otherwise, an [error code] or an [extended error code] is returned.)^ |
4630 ** | 5009 ** |
4631 ** This routine only works on a [BLOB handle] which has been created | 5010 ** 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 | 5011 ** 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 | 5012 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
4634 ** to this routine results in undefined and probably undesirable behavior. | 5013 ** to this routine results in undefined and probably undesirable behavior. |
4635 ** | 5014 ** |
4636 ** See also: [sqlite3_blob_write()]. | 5015 ** See also: [sqlite3_blob_write()]. |
4637 ** | |
4638 ** Requirements: | |
4639 ** [H17853] [H17856] [H17859] [H17862] [H17863] [H17865] [H17868] | |
4640 */ | 5016 */ |
4641 SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); | 5017 SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); |
4642 | 5018 |
4643 /* | 5019 /* |
4644 ** CAPI3REF: Write Data Into A BLOB Incrementally {H17870} <S30230> | 5020 ** CAPI3REF: Write Data Into A BLOB Incrementally |
4645 ** | 5021 ** |
4646 ** This function is used to write data into an open [BLOB handle] from a | 5022 ** ^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 | 5023 ** caller-supplied buffer. ^N bytes of data are copied from the buffer Z |
4648 ** into the open BLOB, starting at offset iOffset. | 5024 ** into the open BLOB, starting at offset iOffset. |
4649 ** | 5025 ** |
4650 ** If the [BLOB handle] passed as the first argument was not opened for | 5026 ** ^If the [BLOB handle] passed as the first argument was not opened for |
4651 ** writing (the flags parameter to [sqlite3_blob_open()] was zero), | 5027 ** writing (the flags parameter to [sqlite3_blob_open()] was zero), |
4652 ** this function returns [SQLITE_READONLY]. | 5028 ** this function returns [SQLITE_READONLY]. |
4653 ** | 5029 ** |
4654 ** This function may only modify the contents of the BLOB; it is | 5030 ** ^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. | 5031 ** 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, | 5032 ** ^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 | 5033 ** [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. | 5034 ** 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) | 5035 ** The size of the BLOB (and hence the maximum value of N+iOffset) |
4660 ** can be determined using the [sqlite3_blob_bytes()] interface. | 5036 ** can be determined using the [sqlite3_blob_bytes()] interface. |
4661 ** | 5037 ** |
4662 ** An attempt to write to an expired [BLOB handle] fails with an | 5038 ** ^An attempt to write to an expired [BLOB handle] fails with an |
4663 ** error code of [SQLITE_ABORT]. Writes to the BLOB that occurred | 5039 ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred |
4664 ** before the [BLOB handle] expired are not rolled back by the | 5040 ** before the [BLOB handle] expired are not rolled back by the |
4665 ** expiration of the handle, though of course those changes might | 5041 ** expiration of the handle, though of course those changes might |
4666 ** have been overwritten by the statement that expired the BLOB handle | 5042 ** have been overwritten by the statement that expired the BLOB handle |
4667 ** or by other independent statements. | 5043 ** or by other independent statements. |
4668 ** | 5044 ** |
4669 ** On success, SQLITE_OK is returned. | 5045 ** ^(On success, sqlite3_blob_write() returns SQLITE_OK. |
4670 ** Otherwise, an [error code] or an [extended error code] is returned. | 5046 ** Otherwise, an [error code] or an [extended error code] is returned.)^ |
4671 ** | 5047 ** |
4672 ** This routine only works on a [BLOB handle] which has been created | 5048 ** 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 | 5049 ** 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 | 5050 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
4675 ** to this routine results in undefined and probably undesirable behavior. | 5051 ** to this routine results in undefined and probably undesirable behavior. |
4676 ** | 5052 ** |
4677 ** See also: [sqlite3_blob_read()]. | 5053 ** See also: [sqlite3_blob_read()]. |
4678 ** | |
4679 ** Requirements: | |
4680 ** [H17873] [H17874] [H17875] [H17876] [H17877] [H17879] [H17882] [H17885] | |
4681 ** [H17888] | |
4682 */ | 5054 */ |
4683 SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOff
set); | 5055 SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOff
set); |
4684 | 5056 |
4685 /* Begin preload-cache.patch for Chromium */ | |
4686 /* | 5057 /* |
4687 ** Preload the databases into the pager cache, up to the maximum size of the | 5058 ** 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 SQLITE_API int sqlite3_preload(sqlite3 *db); | |
4698 /* End preload-cache.patch for Chromium */ | |
4699 | |
4700 /* | |
4701 ** CAPI3REF: Virtual File System Objects {H11200} <S20100> | |
4702 ** | 5059 ** |
4703 ** A virtual filesystem (VFS) is an [sqlite3_vfs] object | 5060 ** A virtual filesystem (VFS) is an [sqlite3_vfs] object |
4704 ** that SQLite uses to interact | 5061 ** that SQLite uses to interact |
4705 ** with the underlying operating system. Most SQLite builds come with a | 5062 ** with the underlying operating system. Most SQLite builds come with a |
4706 ** single default VFS that is appropriate for the host computer. | 5063 ** single default VFS that is appropriate for the host computer. |
4707 ** New VFSes can be registered and existing VFSes can be unregistered. | 5064 ** New VFSes can be registered and existing VFSes can be unregistered. |
4708 ** The following interfaces are provided. | 5065 ** The following interfaces are provided. |
4709 ** | 5066 ** |
4710 ** The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. | 5067 ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. |
4711 ** Names are case sensitive. | 5068 ** ^Names are case sensitive. |
4712 ** Names are zero-terminated UTF-8 strings. | 5069 ** ^Names are zero-terminated UTF-8 strings. |
4713 ** If there is no match, a NULL pointer is returned. | 5070 ** ^If there is no match, a NULL pointer is returned. |
4714 ** If zVfsName is NULL then the default VFS is returned. | 5071 ** ^If zVfsName is NULL then the default VFS is returned. |
4715 ** | 5072 ** |
4716 ** New VFSes are registered with sqlite3_vfs_register(). | 5073 ** ^New VFSes are registered with sqlite3_vfs_register(). |
4717 ** Each new VFS becomes the default VFS if the makeDflt flag is set. | 5074 ** ^Each new VFS becomes the default VFS if the makeDflt flag is set. |
4718 ** The same VFS can be registered multiple times without injury. | 5075 ** ^The same VFS can be registered multiple times without injury. |
4719 ** To make an existing VFS into the default VFS, register it again | 5076 ** ^To make an existing VFS into the default VFS, register it again |
4720 ** with the makeDflt flag set. If two different VFSes with the | 5077 ** with the makeDflt flag set. If two different VFSes with the |
4721 ** same name are registered, the behavior is undefined. If a | 5078 ** same name are registered, the behavior is undefined. If a |
4722 ** VFS is registered with a name that is NULL or an empty string, | 5079 ** VFS is registered with a name that is NULL or an empty string, |
4723 ** then the behavior is undefined. | 5080 ** then the behavior is undefined. |
4724 ** | 5081 ** |
4725 ** Unregister a VFS with the sqlite3_vfs_unregister() interface. | 5082 ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. |
4726 ** If the default VFS is unregistered, another VFS is chosen as | 5083 ** ^(If the default VFS is unregistered, another VFS is chosen as |
4727 ** the default. The choice for the new VFS is arbitrary. | 5084 ** the default. The choice for the new VFS is arbitrary.)^ |
4728 ** | |
4729 ** Requirements: | |
4730 ** [H11203] [H11206] [H11209] [H11212] [H11215] [H11218] | |
4731 */ | 5085 */ |
4732 SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); | 5086 SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); |
4733 SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); | 5087 SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); |
4734 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); | 5088 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); |
4735 | 5089 |
4736 /* | 5090 /* |
4737 ** CAPI3REF: Mutexes {H17000} <S20000> | 5091 ** CAPI3REF: Mutexes |
4738 ** | 5092 ** |
4739 ** The SQLite core uses these routines for thread | 5093 ** The SQLite core uses these routines for thread |
4740 ** synchronization. Though they are intended for internal | 5094 ** synchronization. Though they are intended for internal |
4741 ** use by SQLite, code that links against SQLite is | 5095 ** use by SQLite, code that links against SQLite is |
4742 ** permitted to use any of these routines. | 5096 ** permitted to use any of these routines. |
4743 ** | 5097 ** |
4744 ** The SQLite source code contains multiple implementations | 5098 ** The SQLite source code contains multiple implementations |
4745 ** of these mutex routines. An appropriate implementation | 5099 ** of these mutex routines. An appropriate implementation |
4746 ** is selected automatically at compile-time. The following | 5100 ** is selected automatically at compile-time. ^(The following |
4747 ** implementations are available in the SQLite core: | 5101 ** implementations are available in the SQLite core: |
4748 ** | 5102 ** |
4749 ** <ul> | 5103 ** <ul> |
4750 ** <li> SQLITE_MUTEX_OS2 | 5104 ** <li> SQLITE_MUTEX_OS2 |
4751 ** <li> SQLITE_MUTEX_PTHREAD | 5105 ** <li> SQLITE_MUTEX_PTHREAD |
4752 ** <li> SQLITE_MUTEX_W32 | 5106 ** <li> SQLITE_MUTEX_W32 |
4753 ** <li> SQLITE_MUTEX_NOOP | 5107 ** <li> SQLITE_MUTEX_NOOP |
4754 ** </ul> | 5108 ** </ul>)^ |
4755 ** | 5109 ** |
4756 ** The SQLITE_MUTEX_NOOP implementation is a set of routines | 5110 ** ^The SQLITE_MUTEX_NOOP implementation is a set of routines |
4757 ** that does no real locking and is appropriate for use in | 5111 ** that does no real locking and is appropriate for use in |
4758 ** a single-threaded application. The SQLITE_MUTEX_OS2, | 5112 ** a single-threaded application. ^The SQLITE_MUTEX_OS2, |
4759 ** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations | 5113 ** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations |
4760 ** are appropriate for use on OS/2, Unix, and Windows. | 5114 ** are appropriate for use on OS/2, Unix, and Windows. |
4761 ** | 5115 ** |
4762 ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor | 5116 ** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor |
4763 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex | 5117 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex |
4764 ** implementation is included with the library. In this case the | 5118 ** implementation is included with the library. In this case the |
4765 ** application must supply a custom mutex implementation using the | 5119 ** application must supply a custom mutex implementation using the |
4766 ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function | 5120 ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function |
4767 ** before calling sqlite3_initialize() or any other public sqlite3_ | 5121 ** before calling sqlite3_initialize() or any other public sqlite3_ |
4768 ** function that calls sqlite3_initialize(). | 5122 ** function that calls sqlite3_initialize().)^ |
4769 ** | 5123 ** |
4770 ** {H17011} The sqlite3_mutex_alloc() routine allocates a new | 5124 ** ^The sqlite3_mutex_alloc() routine allocates a new |
4771 ** mutex and returns a pointer to it. {H17012} If it returns NULL | 5125 ** mutex and returns a pointer to it. ^If it returns NULL |
4772 ** that means that a mutex could not be allocated. {H17013} SQLite | 5126 ** that means that a mutex could not be allocated. ^SQLite |
4773 ** will unwind its stack and return an error. {H17014} The argument | 5127 ** will unwind its stack and return an error. ^(The argument |
4774 ** to sqlite3_mutex_alloc() is one of these integer constants: | 5128 ** to sqlite3_mutex_alloc() is one of these integer constants: |
4775 ** | 5129 ** |
4776 ** <ul> | 5130 ** <ul> |
4777 ** <li> SQLITE_MUTEX_FAST | 5131 ** <li> SQLITE_MUTEX_FAST |
4778 ** <li> SQLITE_MUTEX_RECURSIVE | 5132 ** <li> SQLITE_MUTEX_RECURSIVE |
4779 ** <li> SQLITE_MUTEX_STATIC_MASTER | 5133 ** <li> SQLITE_MUTEX_STATIC_MASTER |
4780 ** <li> SQLITE_MUTEX_STATIC_MEM | 5134 ** <li> SQLITE_MUTEX_STATIC_MEM |
4781 ** <li> SQLITE_MUTEX_STATIC_MEM2 | 5135 ** <li> SQLITE_MUTEX_STATIC_MEM2 |
4782 ** <li> SQLITE_MUTEX_STATIC_PRNG | 5136 ** <li> SQLITE_MUTEX_STATIC_PRNG |
4783 ** <li> SQLITE_MUTEX_STATIC_LRU | 5137 ** <li> SQLITE_MUTEX_STATIC_LRU |
4784 ** <li> SQLITE_MUTEX_STATIC_LRU2 | 5138 ** <li> SQLITE_MUTEX_STATIC_LRU2 |
4785 ** </ul> | 5139 ** </ul>)^ |
4786 ** | 5140 ** |
4787 ** {H17015} The first two constants cause sqlite3_mutex_alloc() to create | 5141 ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) |
4788 ** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE | 5142 ** cause sqlite3_mutex_alloc() to create |
4789 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END} | 5143 ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE |
| 5144 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used. |
4790 ** The mutex implementation does not need to make a distinction | 5145 ** The mutex implementation does not need to make a distinction |
4791 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does | 5146 ** 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 | 5147 ** 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 | 5148 ** cases where it really needs one. ^If a faster non-recursive mutex |
4794 ** implementation is available on the host platform, the mutex subsystem | 5149 ** implementation is available on the host platform, the mutex subsystem |
4795 ** might return such a mutex in response to SQLITE_MUTEX_FAST. | 5150 ** might return such a mutex in response to SQLITE_MUTEX_FAST. |
4796 ** | 5151 ** |
4797 ** {H17017} The other allowed parameters to sqlite3_mutex_alloc() each return | 5152 ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other |
4798 ** a pointer to a static preexisting mutex. {END} Six static mutexes are | 5153 ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return |
| 5154 ** a pointer to a static preexisting mutex. ^Six static mutexes are |
4799 ** used by the current version of SQLite. Future versions of SQLite | 5155 ** used by the current version of SQLite. Future versions of SQLite |
4800 ** may add additional static mutexes. Static mutexes are for internal | 5156 ** may add additional static mutexes. Static mutexes are for internal |
4801 ** use by SQLite only. Applications that use SQLite mutexes should | 5157 ** use by SQLite only. Applications that use SQLite mutexes should |
4802 ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or | 5158 ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or |
4803 ** SQLITE_MUTEX_RECURSIVE. | 5159 ** SQLITE_MUTEX_RECURSIVE. |
4804 ** | 5160 ** |
4805 ** {H17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST | 5161 ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST |
4806 ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() | 5162 ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() |
4807 ** returns a different mutex on every call. {H17034} But for the static | 5163 ** returns a different mutex on every call. ^But for the static |
4808 ** mutex types, the same mutex is returned on every call that has | 5164 ** mutex types, the same mutex is returned on every call that has |
4809 ** the same type number. | 5165 ** the same type number. |
4810 ** | 5166 ** |
4811 ** {H17019} The sqlite3_mutex_free() routine deallocates a previously | 5167 ** ^The sqlite3_mutex_free() routine deallocates a previously |
4812 ** allocated dynamic mutex. {H17020} SQLite is careful to deallocate every | 5168 ** allocated dynamic mutex. ^SQLite is careful to deallocate every |
4813 ** dynamic mutex that it allocates. {A17021} The dynamic mutexes must not be in | 5169 ** dynamic mutex that it allocates. The dynamic mutexes must not be in |
4814 ** use when they are deallocated. {A17022} Attempting to deallocate a static | 5170 ** use when they are deallocated. Attempting to deallocate a static |
4815 ** mutex results in undefined behavior. {H17023} SQLite never deallocates | 5171 ** mutex results in undefined behavior. ^SQLite never deallocates |
4816 ** a static mutex. {END} | 5172 ** a static mutex. |
4817 ** | 5173 ** |
4818 ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt | 5174 ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt |
4819 ** to enter a mutex. {H17024} If another thread is already within the mutex, | 5175 ** to enter a mutex. ^If another thread is already within the mutex, |
4820 ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return | 5176 ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return |
4821 ** SQLITE_BUSY. {H17025} The sqlite3_mutex_try() interface returns [SQLITE_OK] | 5177 ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] |
4822 ** upon successful entry. {H17026} Mutexes created using | 5178 ** upon successful entry. ^(Mutexes created using |
4823 ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. | 5179 ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. |
4824 ** {H17027} In such cases the, | 5180 ** In such cases the, |
4825 ** mutex must be exited an equal number of times before another thread | 5181 ** 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 | 5182 ** can enter.)^ ^(If the same thread tries to enter any other |
4827 ** kind of mutex more than once, the behavior is undefined. | 5183 ** kind of mutex more than once, the behavior is undefined. |
4828 ** {H17029} SQLite will never exhibit | 5184 ** SQLite will never exhibit |
4829 ** such behavior in its own use of mutexes. | 5185 ** such behavior in its own use of mutexes.)^ |
4830 ** | 5186 ** |
4831 ** Some systems (for example, Windows 95) do not support the operation | 5187 ** ^(Some systems (for example, Windows 95) do not support the operation |
4832 ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() | 5188 ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() |
4833 ** will always return SQLITE_BUSY. {H17030} The SQLite core only ever uses | 5189 ** will always return SQLITE_BUSY. The SQLite core only ever uses |
4834 ** sqlite3_mutex_try() as an optimization so this is acceptable behavior. | 5190 ** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^ |
4835 ** | 5191 ** |
4836 ** {H17031} The sqlite3_mutex_leave() routine exits a mutex that was | 5192 ** ^The sqlite3_mutex_leave() routine exits a mutex that was |
4837 ** previously entered by the same thread. {A17032} The behavior | 5193 ** previously entered by the same thread. ^(The behavior |
4838 ** is undefined if the mutex is not currently entered by the | 5194 ** is undefined if the mutex is not currently entered by the |
4839 ** calling thread or is not currently allocated. {H17033} SQLite will | 5195 ** calling thread or is not currently allocated. SQLite will |
4840 ** never do either. {END} | 5196 ** never do either.)^ |
4841 ** | 5197 ** |
4842 ** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or | 5198 ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or |
4843 ** sqlite3_mutex_leave() is a NULL pointer, then all three routines | 5199 ** sqlite3_mutex_leave() is a NULL pointer, then all three routines |
4844 ** behave as no-ops. | 5200 ** behave as no-ops. |
4845 ** | 5201 ** |
4846 ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. | 5202 ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. |
4847 */ | 5203 */ |
4848 SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int); | 5204 SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int); |
4849 SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*); | 5205 SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*); |
4850 SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*); | 5206 SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*); |
4851 SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*); | 5207 SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*); |
4852 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*); | 5208 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*); |
4853 | 5209 |
4854 /* | 5210 /* |
4855 ** CAPI3REF: Mutex Methods Object {H17120} <S20130> | 5211 ** CAPI3REF: Mutex Methods Object |
4856 ** EXPERIMENTAL | |
4857 ** | 5212 ** |
4858 ** An instance of this structure defines the low-level routines | 5213 ** An instance of this structure defines the low-level routines |
4859 ** used to allocate and use mutexes. | 5214 ** used to allocate and use mutexes. |
4860 ** | 5215 ** |
4861 ** Usually, the default mutex implementations provided by SQLite are | 5216 ** Usually, the default mutex implementations provided by SQLite are |
4862 ** sufficient, however the user has the option of substituting a custom | 5217 ** sufficient, however the user has the option of substituting a custom |
4863 ** implementation for specialized deployments or systems for which SQLite | 5218 ** implementation for specialized deployments or systems for which SQLite |
4864 ** does not provide a suitable implementation. In this case, the user | 5219 ** does not provide a suitable implementation. In this case, the user |
4865 ** creates and populates an instance of this structure to pass | 5220 ** creates and populates an instance of this structure to pass |
4866 ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. | 5221 ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. |
4867 ** Additionally, an instance of this structure can be used as an | 5222 ** Additionally, an instance of this structure can be used as an |
4868 ** output variable when querying the system for the current mutex | 5223 ** output variable when querying the system for the current mutex |
4869 ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. | 5224 ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. |
4870 ** | 5225 ** |
4871 ** The xMutexInit method defined by this structure is invoked as | 5226 ** ^The xMutexInit method defined by this structure is invoked as |
4872 ** part of system initialization by the sqlite3_initialize() function. | 5227 ** part of system initialization by the sqlite3_initialize() function. |
4873 ** {H17001} The xMutexInit routine shall be called by SQLite once for each | 5228 ** ^The xMutexInit routine is called by SQLite exactly once for each |
4874 ** effective call to [sqlite3_initialize()]. | 5229 ** effective call to [sqlite3_initialize()]. |
4875 ** | 5230 ** |
4876 ** The xMutexEnd method defined by this structure is invoked as | 5231 ** ^The xMutexEnd method defined by this structure is invoked as |
4877 ** part of system shutdown by the sqlite3_shutdown() function. The | 5232 ** part of system shutdown by the sqlite3_shutdown() function. The |
4878 ** implementation of this method is expected to release all outstanding | 5233 ** implementation of this method is expected to release all outstanding |
4879 ** resources obtained by the mutex methods implementation, especially | 5234 ** resources obtained by the mutex methods implementation, especially |
4880 ** those obtained by the xMutexInit method. {H17003} The xMutexEnd() | 5235 ** those obtained by the xMutexInit method. ^The xMutexEnd() |
4881 ** interface shall be invoked once for each call to [sqlite3_shutdown()]. | 5236 ** interface is invoked exactly once for each call to [sqlite3_shutdown()]. |
4882 ** | 5237 ** |
4883 ** The remaining seven methods defined by this structure (xMutexAlloc, | 5238 ** ^(The remaining seven methods defined by this structure (xMutexAlloc, |
4884 ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and | 5239 ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and |
4885 ** xMutexNotheld) implement the following interfaces (respectively): | 5240 ** xMutexNotheld) implement the following interfaces (respectively): |
4886 ** | 5241 ** |
4887 ** <ul> | 5242 ** <ul> |
4888 ** <li> [sqlite3_mutex_alloc()] </li> | 5243 ** <li> [sqlite3_mutex_alloc()] </li> |
4889 ** <li> [sqlite3_mutex_free()] </li> | 5244 ** <li> [sqlite3_mutex_free()] </li> |
4890 ** <li> [sqlite3_mutex_enter()] </li> | 5245 ** <li> [sqlite3_mutex_enter()] </li> |
4891 ** <li> [sqlite3_mutex_try()] </li> | 5246 ** <li> [sqlite3_mutex_try()] </li> |
4892 ** <li> [sqlite3_mutex_leave()] </li> | 5247 ** <li> [sqlite3_mutex_leave()] </li> |
4893 ** <li> [sqlite3_mutex_held()] </li> | 5248 ** <li> [sqlite3_mutex_held()] </li> |
4894 ** <li> [sqlite3_mutex_notheld()] </li> | 5249 ** <li> [sqlite3_mutex_notheld()] </li> |
4895 ** </ul> | 5250 ** </ul>)^ |
4896 ** | 5251 ** |
4897 ** The only difference is that the public sqlite3_XXX functions enumerated | 5252 ** The only difference is that the public sqlite3_XXX functions enumerated |
4898 ** above silently ignore any invocations that pass a NULL pointer instead | 5253 ** above silently ignore any invocations that pass a NULL pointer instead |
4899 ** of a valid mutex handle. The implementations of the methods defined | 5254 ** of a valid mutex handle. The implementations of the methods defined |
4900 ** by this structure are not required to handle this case, the results | 5255 ** 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 | 5256 ** 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 | 5257 ** (i.e. it is acceptable to provide an implementation that segfaults if |
4903 ** it is passed a NULL pointer). | 5258 ** it is passed a NULL pointer). |
4904 ** | 5259 ** |
4905 ** The xMutexInit() method must be threadsafe. It must be harmless to | 5260 ** The xMutexInit() method must be threadsafe. ^It must be harmless to |
4906 ** invoke xMutexInit() mutiple times within the same process and without | 5261 ** invoke xMutexInit() multiple times within the same process and without |
4907 ** intervening calls to xMutexEnd(). Second and subsequent calls to | 5262 ** intervening calls to xMutexEnd(). Second and subsequent calls to |
4908 ** xMutexInit() must be no-ops. | 5263 ** xMutexInit() must be no-ops. |
4909 ** | 5264 ** |
4910 ** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] | 5265 ** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] |
4911 ** and its associates). Similarly, xMutexAlloc() must not use SQLite memory | 5266 ** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory |
4912 ** allocation for a static mutex. However xMutexAlloc() may use SQLite | 5267 ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite |
4913 ** memory allocation for a fast or recursive mutex. | 5268 ** memory allocation for a fast or recursive mutex. |
4914 ** | 5269 ** |
4915 ** SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is | 5270 ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is |
4916 ** called, but only if the prior call to xMutexInit returned SQLITE_OK. | 5271 ** 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 | 5272 ** If xMutexInit fails in any way, it is expected to clean up after itself |
4918 ** prior to returning. | 5273 ** prior to returning. |
4919 */ | 5274 */ |
4920 typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; | 5275 typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; |
4921 struct sqlite3_mutex_methods { | 5276 struct sqlite3_mutex_methods { |
4922 int (*xMutexInit)(void); | 5277 int (*xMutexInit)(void); |
4923 int (*xMutexEnd)(void); | 5278 int (*xMutexEnd)(void); |
4924 sqlite3_mutex *(*xMutexAlloc)(int); | 5279 sqlite3_mutex *(*xMutexAlloc)(int); |
4925 void (*xMutexFree)(sqlite3_mutex *); | 5280 void (*xMutexFree)(sqlite3_mutex *); |
4926 void (*xMutexEnter)(sqlite3_mutex *); | 5281 void (*xMutexEnter)(sqlite3_mutex *); |
4927 int (*xMutexTry)(sqlite3_mutex *); | 5282 int (*xMutexTry)(sqlite3_mutex *); |
4928 void (*xMutexLeave)(sqlite3_mutex *); | 5283 void (*xMutexLeave)(sqlite3_mutex *); |
4929 int (*xMutexHeld)(sqlite3_mutex *); | 5284 int (*xMutexHeld)(sqlite3_mutex *); |
4930 int (*xMutexNotheld)(sqlite3_mutex *); | 5285 int (*xMutexNotheld)(sqlite3_mutex *); |
4931 }; | 5286 }; |
4932 | 5287 |
4933 /* | 5288 /* |
4934 ** CAPI3REF: Mutex Verification Routines {H17080} <S20130> <S30800> | 5289 ** CAPI3REF: Mutex Verification Routines |
4935 ** | 5290 ** |
4936 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines | 5291 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines |
4937 ** are intended for use inside assert() statements. {H17081} The SQLite core | 5292 ** are intended for use inside assert() statements. ^The SQLite core |
4938 ** never uses these routines except inside an assert() and applications | 5293 ** never uses these routines except inside an assert() and applications |
4939 ** are advised to follow the lead of the core. {H17082} The core only | 5294 ** are advised to follow the lead of the core. ^The SQLite core only |
4940 ** provides implementations for these routines when it is compiled | 5295 ** provides implementations for these routines when it is compiled |
4941 ** with the SQLITE_DEBUG flag. {A17087} External mutex implementations | 5296 ** with the SQLITE_DEBUG flag. ^External mutex implementations |
4942 ** are only required to provide these routines if SQLITE_DEBUG is | 5297 ** are only required to provide these routines if SQLITE_DEBUG is |
4943 ** defined and if NDEBUG is not defined. | 5298 ** defined and if NDEBUG is not defined. |
4944 ** | 5299 ** |
4945 ** {H17083} These routines should return true if the mutex in their argument | 5300 ** ^These routines should return true if the mutex in their argument |
4946 ** is held or not held, respectively, by the calling thread. | 5301 ** is held or not held, respectively, by the calling thread. |
4947 ** | 5302 ** |
4948 ** {X17084} The implementation is not required to provided versions of these | 5303 ** ^The implementation is not required to provided versions of these |
4949 ** routines that actually work. If the implementation does not provide working | 5304 ** routines that actually work. If the implementation does not provide working |
4950 ** versions of these routines, it should at least provide stubs that always | 5305 ** versions of these routines, it should at least provide stubs that always |
4951 ** return true so that one does not get spurious assertion failures. | 5306 ** return true so that one does not get spurious assertion failures. |
4952 ** | 5307 ** |
4953 ** {H17085} If the argument to sqlite3_mutex_held() is a NULL pointer then | 5308 ** ^If the argument to sqlite3_mutex_held() is a NULL pointer then |
4954 ** the routine should return 1. {END} This seems counter-intuitive since | 5309 ** the routine should return 1. This seems counter-intuitive since |
4955 ** clearly the mutex cannot be held if it does not exist. But the | 5310 ** 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 | 5311 ** 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 | 5312 ** 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 | 5313 ** call to sqlite3_mutex_held() to fail, so a non-zero return is |
4959 ** the appropriate thing to do. {H17086} The sqlite3_mutex_notheld() | 5314 ** the appropriate thing to do. ^The sqlite3_mutex_notheld() |
4960 ** interface should also return 1 when given a NULL pointer. | 5315 ** interface should also return 1 when given a NULL pointer. |
4961 */ | 5316 */ |
| 5317 #ifndef NDEBUG |
4962 SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*); | 5318 SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*); |
4963 SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*); | 5319 SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*); |
| 5320 #endif |
4964 | 5321 |
4965 /* | 5322 /* |
4966 ** CAPI3REF: Mutex Types {H17001} <H17000> | 5323 ** CAPI3REF: Mutex Types |
4967 ** | 5324 ** |
4968 ** The [sqlite3_mutex_alloc()] interface takes a single argument | 5325 ** The [sqlite3_mutex_alloc()] interface takes a single argument |
4969 ** which is one of these integer constants. | 5326 ** which is one of these integer constants. |
4970 ** | 5327 ** |
4971 ** The set of static mutexes may change from one SQLite release to the | 5328 ** 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 | 5329 ** next. Applications that override the built-in mutex logic must be |
4973 ** prepared to accommodate additional static mutexes. | 5330 ** prepared to accommodate additional static mutexes. |
4974 */ | 5331 */ |
4975 #define SQLITE_MUTEX_FAST 0 | 5332 #define SQLITE_MUTEX_FAST 0 |
4976 #define SQLITE_MUTEX_RECURSIVE 1 | 5333 #define SQLITE_MUTEX_RECURSIVE 1 |
4977 #define SQLITE_MUTEX_STATIC_MASTER 2 | 5334 #define SQLITE_MUTEX_STATIC_MASTER 2 |
4978 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ | 5335 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ |
4979 #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ | 5336 #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ |
4980 #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ | 5337 #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ |
4981 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ | 5338 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ |
4982 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ | 5339 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ |
4983 #define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */ | 5340 #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ |
| 5341 #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ |
4984 | 5342 |
4985 /* | 5343 /* |
4986 ** CAPI3REF: Retrieve the mutex for a database connection {H17002} <H17000> | 5344 ** CAPI3REF: Retrieve the mutex for a database connection |
4987 ** | 5345 ** |
4988 ** This interface returns a pointer the [sqlite3_mutex] object that | 5346 ** ^This interface returns a pointer the [sqlite3_mutex] object that |
4989 ** serializes access to the [database connection] given in the argument | 5347 ** serializes access to the [database connection] given in the argument |
4990 ** when the [threading mode] is Serialized. | 5348 ** when the [threading mode] is Serialized. |
4991 ** If the [threading mode] is Single-thread or Multi-thread then this | 5349 ** ^If the [threading mode] is Single-thread or Multi-thread then this |
4992 ** routine returns a NULL pointer. | 5350 ** routine returns a NULL pointer. |
4993 */ | 5351 */ |
4994 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*); | 5352 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*); |
4995 | 5353 |
4996 /* | 5354 /* |
4997 ** CAPI3REF: Low-Level Control Of Database Files {H11300} <S30800> | 5355 ** CAPI3REF: Low-Level Control Of Database Files |
4998 ** | 5356 ** |
4999 ** {H11301} The [sqlite3_file_control()] interface makes a direct call to the | 5357 ** ^The [sqlite3_file_control()] interface makes a direct call to the |
5000 ** xFileControl method for the [sqlite3_io_methods] object associated | 5358 ** xFileControl method for the [sqlite3_io_methods] object associated |
5001 ** with a particular database identified by the second argument. {H11302} The | 5359 ** with a particular database identified by the second argument. ^The |
5002 ** name of the database is the name assigned to the database by the | 5360 ** name of the database is "main" for the main database or "temp" for the |
5003 ** <a href="lang_attach.html">ATTACH</a> SQL command that opened the | 5361 ** 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" | 5362 ** databases that are added using the [ATTACH] SQL command. |
5005 ** or a NULL pointer. {H11304} The third and fourth parameters to this routine | 5363 ** ^A NULL pointer can be used in place of "main" to refer to the |
| 5364 ** main database file. |
| 5365 ** ^The third and fourth parameters to this routine |
5006 ** are passed directly through to the second and third parameters of | 5366 ** are passed directly through to the second and third parameters of |
5007 ** the xFileControl method. {H11305} The return value of the xFileControl | 5367 ** the xFileControl method. ^The return value of the xFileControl |
5008 ** method becomes the return value of this routine. | 5368 ** method becomes the return value of this routine. |
5009 ** | 5369 ** |
5010 ** {H11306} If the second parameter (zDbName) does not match the name of any | 5370 ** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes |
5011 ** open database file, then SQLITE_ERROR is returned. {H11307} This error | 5371 ** a pointer to the underlying [sqlite3_file] object to be written into |
| 5372 ** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER |
| 5373 ** case is a short-circuit path which does not actually invoke the |
| 5374 ** underlying sqlite3_io_methods.xFileControl method. |
| 5375 ** |
| 5376 ** ^If the second parameter (zDbName) does not match the name of any |
| 5377 ** open database file, then SQLITE_ERROR is returned. ^This error |
5012 ** code is not remembered and will not be recalled by [sqlite3_errcode()] | 5378 ** code is not remembered and will not be recalled by [sqlite3_errcode()] |
5013 ** or [sqlite3_errmsg()]. {A11308} The underlying xFileControl method might | 5379 ** or [sqlite3_errmsg()]. The underlying xFileControl method might |
5014 ** also return SQLITE_ERROR. {A11309} There is no way to distinguish between | 5380 ** also return SQLITE_ERROR. There is no way to distinguish between |
5015 ** an incorrect zDbName and an SQLITE_ERROR return from the underlying | 5381 ** an incorrect zDbName and an SQLITE_ERROR return from the underlying |
5016 ** xFileControl method. {END} | 5382 ** xFileControl method. |
5017 ** | 5383 ** |
5018 ** See also: [SQLITE_FCNTL_LOCKSTATE] | 5384 ** See also: [SQLITE_FCNTL_LOCKSTATE] |
5019 */ | 5385 */ |
5020 SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*
); | 5386 SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*
); |
5021 | 5387 |
5022 /* | 5388 /* |
5023 ** CAPI3REF: Testing Interface {H11400} <S30800> | 5389 ** CAPI3REF: Testing Interface |
5024 ** | 5390 ** |
5025 ** The sqlite3_test_control() interface is used to read out internal | 5391 ** ^The sqlite3_test_control() interface is used to read out internal |
5026 ** state of SQLite and to inject faults into SQLite for testing | 5392 ** state of SQLite and to inject faults into SQLite for testing |
5027 ** purposes. The first parameter is an operation code that determines | 5393 ** purposes. ^The first parameter is an operation code that determines |
5028 ** the number, meaning, and operation of all subsequent parameters. | 5394 ** the number, meaning, and operation of all subsequent parameters. |
5029 ** | 5395 ** |
5030 ** This interface is not for use by applications. It exists solely | 5396 ** This interface is not for use by applications. It exists solely |
5031 ** for verifying the correct operation of the SQLite library. Depending | 5397 ** for verifying the correct operation of the SQLite library. Depending |
5032 ** on how the SQLite library is compiled, this interface might not exist. | 5398 ** on how the SQLite library is compiled, this interface might not exist. |
5033 ** | 5399 ** |
5034 ** The details of the operation codes, their meanings, the parameters | 5400 ** The details of the operation codes, their meanings, the parameters |
5035 ** they take, and what they do are all subject to change without notice. | 5401 ** 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 | 5402 ** Unlike most of the SQLite API, this function is not guaranteed to |
5037 ** operate consistently from one release to the next. | 5403 ** operate consistently from one release to the next. |
5038 */ | 5404 */ |
5039 SQLITE_API int sqlite3_test_control(int op, ...); | 5405 SQLITE_API int sqlite3_test_control(int op, ...); |
5040 | 5406 |
5041 /* | 5407 /* |
5042 ** CAPI3REF: Testing Interface Operation Codes {H11410} <H11400> | 5408 ** CAPI3REF: Testing Interface Operation Codes |
5043 ** | 5409 ** |
5044 ** These constants are the valid operation code parameters used | 5410 ** These constants are the valid operation code parameters used |
5045 ** as the first argument to [sqlite3_test_control()]. | 5411 ** as the first argument to [sqlite3_test_control()]. |
5046 ** | 5412 ** |
5047 ** These parameters and their meanings are subject to change | 5413 ** These parameters and their meanings are subject to change |
5048 ** without notice. These values are for testing purposes only. | 5414 ** without notice. These values are for testing purposes only. |
5049 ** Applications should not use any of these parameters or the | 5415 ** Applications should not use any of these parameters or the |
5050 ** [sqlite3_test_control()] interface. | 5416 ** [sqlite3_test_control()] interface. |
5051 */ | 5417 */ |
| 5418 #define SQLITE_TESTCTRL_FIRST 5 |
5052 #define SQLITE_TESTCTRL_PRNG_SAVE 5 | 5419 #define SQLITE_TESTCTRL_PRNG_SAVE 5 |
5053 #define SQLITE_TESTCTRL_PRNG_RESTORE 6 | 5420 #define SQLITE_TESTCTRL_PRNG_RESTORE 6 |
5054 #define SQLITE_TESTCTRL_PRNG_RESET 7 | 5421 #define SQLITE_TESTCTRL_PRNG_RESET 7 |
5055 #define SQLITE_TESTCTRL_BITVEC_TEST 8 | 5422 #define SQLITE_TESTCTRL_BITVEC_TEST 8 |
5056 #define SQLITE_TESTCTRL_FAULT_INSTALL 9 | 5423 #define SQLITE_TESTCTRL_FAULT_INSTALL 9 |
5057 #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 | 5424 #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 |
5058 #define SQLITE_TESTCTRL_PENDING_BYTE 11 | 5425 #define SQLITE_TESTCTRL_PENDING_BYTE 11 |
5059 #define SQLITE_TESTCTRL_ASSERT 12 | 5426 #define SQLITE_TESTCTRL_ASSERT 12 |
5060 #define SQLITE_TESTCTRL_ALWAYS 13 | 5427 #define SQLITE_TESTCTRL_ALWAYS 13 |
5061 #define SQLITE_TESTCTRL_RESERVE 14 | 5428 #define SQLITE_TESTCTRL_RESERVE 14 |
| 5429 #define SQLITE_TESTCTRL_OPTIMIZATIONS 15 |
| 5430 #define SQLITE_TESTCTRL_ISKEYWORD 16 |
| 5431 #define SQLITE_TESTCTRL_PGHDRSZ 17 |
| 5432 #define SQLITE_TESTCTRL_SCRATCHMALLOC 18 |
| 5433 #define SQLITE_TESTCTRL_LAST 18 |
5062 | 5434 |
5063 /* | 5435 /* |
5064 ** CAPI3REF: SQLite Runtime Status {H17200} <S60200> | 5436 ** CAPI3REF: SQLite Runtime Status |
5065 ** EXPERIMENTAL | |
5066 ** | 5437 ** |
5067 ** This interface is used to retrieve runtime status information | 5438 ** ^This interface is used to retrieve runtime status information |
5068 ** about the preformance of SQLite, and optionally to reset various | 5439 ** about the performance of SQLite, and optionally to reset various |
5069 ** highwater marks. The first argument is an integer code for | 5440 ** highwater marks. ^The first argument is an integer code for |
5070 ** the specific parameter to measure. Recognized integer codes | 5441 ** the specific parameter to measure. ^(Recognized integer codes |
5071 ** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...]. | 5442 ** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...].)^ |
5072 ** The current value of the parameter is returned into *pCurrent. | 5443 ** ^The current value of the parameter is returned into *pCurrent. |
5073 ** The highest recorded value is returned in *pHighwater. If the | 5444 ** ^The highest recorded value is returned in *pHighwater. ^If the |
5074 ** resetFlag is true, then the highest record value is reset after | 5445 ** resetFlag is true, then the highest record value is reset after |
5075 ** *pHighwater is written. Some parameters do not record the highest | 5446 ** *pHighwater is written. ^(Some parameters do not record the highest |
5076 ** value. For those parameters | 5447 ** value. For those parameters |
5077 ** nothing is written into *pHighwater and the resetFlag is ignored. | 5448 ** nothing is written into *pHighwater and the resetFlag is ignored.)^ |
5078 ** Other parameters record only the highwater mark and not the current | 5449 ** ^(Other parameters record only the highwater mark and not the current |
5079 ** value. For these latter parameters nothing is written into *pCurrent. | 5450 ** value. For these latter parameters nothing is written into *pCurrent.)^ |
5080 ** | 5451 ** |
5081 ** This routine returns SQLITE_OK on success and a non-zero | 5452 ** ^The sqlite3_status() routine returns SQLITE_OK on success and a |
5082 ** [error code] on failure. | 5453 ** non-zero [error code] on failure. |
5083 ** | 5454 ** |
5084 ** This routine is threadsafe but is not atomic. This routine can be | 5455 ** This routine is threadsafe but is not atomic. This routine can be |
5085 ** called while other threads are running the same or different SQLite | 5456 ** called while other threads are running the same or different SQLite |
5086 ** interfaces. However the values returned in *pCurrent and | 5457 ** interfaces. However the values returned in *pCurrent and |
5087 ** *pHighwater reflect the status of SQLite at different points in time | 5458 ** *pHighwater reflect the status of SQLite at different points in time |
5088 ** and it is possible that another thread might change the parameter | 5459 ** and it is possible that another thread might change the parameter |
5089 ** in between the times when *pCurrent and *pHighwater are written. | 5460 ** in between the times when *pCurrent and *pHighwater are written. |
5090 ** | 5461 ** |
5091 ** See also: [sqlite3_db_status()] | 5462 ** See also: [sqlite3_db_status()] |
5092 */ | 5463 */ |
5093 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_status(int op, int *pCurrent, int *pH
ighwater, int resetFlag); | 5464 SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetF
lag); |
5094 | 5465 |
5095 | 5466 |
5096 /* | 5467 /* |
5097 ** CAPI3REF: Status Parameters {H17250} <H17200> | 5468 ** CAPI3REF: Status Parameters |
5098 ** EXPERIMENTAL | |
5099 ** | 5469 ** |
5100 ** These integer constants designate various run-time status parameters | 5470 ** These integer constants designate various run-time status parameters |
5101 ** that can be returned by [sqlite3_status()]. | 5471 ** that can be returned by [sqlite3_status()]. |
5102 ** | 5472 ** |
5103 ** <dl> | 5473 ** <dl> |
5104 ** <dt>SQLITE_STATUS_MEMORY_USED</dt> | 5474 ** ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> |
5105 ** <dd>This parameter is the current amount of memory checked out | 5475 ** <dd>This parameter is the current amount of memory checked out |
5106 ** using [sqlite3_malloc()], either directly or indirectly. The | 5476 ** using [sqlite3_malloc()], either directly or indirectly. The |
5107 ** figure includes calls made to [sqlite3_malloc()] by the application | 5477 ** figure includes calls made to [sqlite3_malloc()] by the application |
5108 ** and internal memory usage by the SQLite library. Scratch memory | 5478 ** and internal memory usage by the SQLite library. Scratch memory |
5109 ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache | 5479 ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache |
5110 ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in | 5480 ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in |
5111 ** this parameter. The amount returned is the sum of the allocation | 5481 ** this parameter. The amount returned is the sum of the allocation |
5112 ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd> | 5482 ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ |
5113 ** | 5483 ** |
5114 ** <dt>SQLITE_STATUS_MALLOC_SIZE</dt> | 5484 ** ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> |
5115 ** <dd>This parameter records the largest memory allocation request | 5485 ** <dd>This parameter records the largest memory allocation request |
5116 ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their | 5486 ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their |
5117 ** internal equivalents). Only the value returned in the | 5487 ** internal equivalents). Only the value returned in the |
5118 ** *pHighwater parameter to [sqlite3_status()] is of interest. | 5488 ** *pHighwater parameter to [sqlite3_status()] is of interest. |
5119 ** The value written into the *pCurrent parameter is undefined.</dd> | 5489 ** The value written into the *pCurrent parameter is undefined.</dd>)^ |
5120 ** | 5490 ** |
5121 ** <dt>SQLITE_STATUS_PAGECACHE_USED</dt> | 5491 ** ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> |
| 5492 ** <dd>This parameter records the number of separate memory allocations |
| 5493 ** currently checked out.</dd>)^ |
| 5494 ** |
| 5495 ** ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> |
5122 ** <dd>This parameter returns the number of pages used out of the | 5496 ** <dd>This parameter returns the number of pages used out of the |
5123 ** [pagecache memory allocator] that was configured using | 5497 ** [pagecache memory allocator] that was configured using |
5124 ** [SQLITE_CONFIG_PAGECACHE]. The | 5498 ** [SQLITE_CONFIG_PAGECACHE]. The |
5125 ** value returned is in pages, not in bytes.</dd> | 5499 ** value returned is in pages, not in bytes.</dd>)^ |
5126 ** | 5500 ** |
5127 ** <dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> | 5501 ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> |
5128 ** <dd>This parameter returns the number of bytes of page cache | 5502 ** <dd>This parameter returns the number of bytes of page cache |
5129 ** allocation which could not be statisfied by the [SQLITE_CONFIG_PAGECACHE] | 5503 ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] |
5130 ** buffer and where forced to overflow to [sqlite3_malloc()]. The | 5504 ** buffer and where forced to overflow to [sqlite3_malloc()]. The |
5131 ** returned value includes allocations that overflowed because they | 5505 ** returned value includes allocations that overflowed because they |
5132 ** where too large (they were larger than the "sz" parameter to | 5506 ** where too large (they were larger than the "sz" parameter to |
5133 ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because | 5507 ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because |
5134 ** no space was left in the page cache.</dd> | 5508 ** no space was left in the page cache.</dd>)^ |
5135 ** | 5509 ** |
5136 ** <dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> | 5510 ** ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> |
5137 ** <dd>This parameter records the largest memory allocation request | 5511 ** <dd>This parameter records the largest memory allocation request |
5138 ** handed to [pagecache memory allocator]. Only the value returned in the | 5512 ** handed to [pagecache memory allocator]. Only the value returned in the |
5139 ** *pHighwater parameter to [sqlite3_status()] is of interest. | 5513 ** *pHighwater parameter to [sqlite3_status()] is of interest. |
5140 ** The value written into the *pCurrent parameter is undefined.</dd> | 5514 ** The value written into the *pCurrent parameter is undefined.</dd>)^ |
5141 ** | 5515 ** |
5142 ** <dt>SQLITE_STATUS_SCRATCH_USED</dt> | 5516 ** ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt> |
5143 ** <dd>This parameter returns the number of allocations used out of the | 5517 ** <dd>This parameter returns the number of allocations used out of the |
5144 ** [scratch memory allocator] configured using | 5518 ** [scratch memory allocator] configured using |
5145 ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not | 5519 ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not |
5146 ** in bytes. Since a single thread may only have one scratch allocation | 5520 ** in bytes. Since a single thread may only have one scratch allocation |
5147 ** outstanding at time, this parameter also reports the number of threads | 5521 ** outstanding at time, this parameter also reports the number of threads |
5148 ** using scratch memory at the same time.</dd> | 5522 ** using scratch memory at the same time.</dd>)^ |
5149 ** | 5523 ** |
5150 ** <dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> | 5524 ** ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> |
5151 ** <dd>This parameter returns the number of bytes of scratch memory | 5525 ** <dd>This parameter returns the number of bytes of scratch memory |
5152 ** allocation which could not be statisfied by the [SQLITE_CONFIG_SCRATCH] | 5526 ** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH] |
5153 ** buffer and where forced to overflow to [sqlite3_malloc()]. The values | 5527 ** buffer and where forced to overflow to [sqlite3_malloc()]. The values |
5154 ** returned include overflows because the requested allocation was too | 5528 ** returned include overflows because the requested allocation was too |
5155 ** larger (that is, because the requested allocation was larger than the | 5529 ** larger (that is, because the requested allocation was larger than the |
5156 ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer | 5530 ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer |
5157 ** slots were available. | 5531 ** slots were available. |
5158 ** </dd> | 5532 ** </dd>)^ |
5159 ** | 5533 ** |
5160 ** <dt>SQLITE_STATUS_SCRATCH_SIZE</dt> | 5534 ** ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt> |
5161 ** <dd>This parameter records the largest memory allocation request | 5535 ** <dd>This parameter records the largest memory allocation request |
5162 ** handed to [scratch memory allocator]. Only the value returned in the | 5536 ** handed to [scratch memory allocator]. Only the value returned in the |
5163 ** *pHighwater parameter to [sqlite3_status()] is of interest. | 5537 ** *pHighwater parameter to [sqlite3_status()] is of interest. |
5164 ** The value written into the *pCurrent parameter is undefined.</dd> | 5538 ** The value written into the *pCurrent parameter is undefined.</dd>)^ |
5165 ** | 5539 ** |
5166 ** <dt>SQLITE_STATUS_PARSER_STACK</dt> | 5540 ** ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> |
5167 ** <dd>This parameter records the deepest parser stack. It is only | 5541 ** <dd>This parameter records the deepest parser stack. It is only |
5168 ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd> | 5542 ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ |
5169 ** </dl> | 5543 ** </dl> |
5170 ** | 5544 ** |
5171 ** New status parameters may be added from time to time. | 5545 ** New status parameters may be added from time to time. |
5172 */ | 5546 */ |
5173 #define SQLITE_STATUS_MEMORY_USED 0 | 5547 #define SQLITE_STATUS_MEMORY_USED 0 |
5174 #define SQLITE_STATUS_PAGECACHE_USED 1 | 5548 #define SQLITE_STATUS_PAGECACHE_USED 1 |
5175 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 | 5549 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 |
5176 #define SQLITE_STATUS_SCRATCH_USED 3 | 5550 #define SQLITE_STATUS_SCRATCH_USED 3 |
5177 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 | 5551 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 |
5178 #define SQLITE_STATUS_MALLOC_SIZE 5 | 5552 #define SQLITE_STATUS_MALLOC_SIZE 5 |
5179 #define SQLITE_STATUS_PARSER_STACK 6 | 5553 #define SQLITE_STATUS_PARSER_STACK 6 |
5180 #define SQLITE_STATUS_PAGECACHE_SIZE 7 | 5554 #define SQLITE_STATUS_PAGECACHE_SIZE 7 |
5181 #define SQLITE_STATUS_SCRATCH_SIZE 8 | 5555 #define SQLITE_STATUS_SCRATCH_SIZE 8 |
| 5556 #define SQLITE_STATUS_MALLOC_COUNT 9 |
5182 | 5557 |
5183 /* | 5558 /* |
5184 ** CAPI3REF: Database Connection Status {H17500} <S60200> | 5559 ** CAPI3REF: Database Connection Status |
5185 ** EXPERIMENTAL | |
5186 ** | 5560 ** |
5187 ** This interface is used to retrieve runtime status information | 5561 ** ^This interface is used to retrieve runtime status information |
5188 ** about a single [database connection]. The first argument is the | 5562 ** about a single [database connection]. ^The first argument is the |
5189 ** database connection object to be interrogated. The second argument | 5563 ** database connection object to be interrogated. ^The second argument |
5190 ** is the parameter to interrogate. Currently, the only allowed value | 5564 ** is an integer constant, taken from the set of |
5191 ** for the second parameter is [SQLITE_DBSTATUS_LOOKASIDE_USED]. | 5565 ** [SQLITE_DBSTATUS_LOOKASIDE_USED | SQLITE_DBSTATUS_*] macros, that |
5192 ** Additional options will likely appear in future releases of SQLite. | 5566 ** determines the parameter to interrogate. The set of |
| 5567 ** [SQLITE_DBSTATUS_LOOKASIDE_USED | SQLITE_DBSTATUS_*] macros is likely |
| 5568 ** to grow in future releases of SQLite. |
5193 ** | 5569 ** |
5194 ** The current value of the requested parameter is written into *pCur | 5570 ** ^The current value of the requested parameter is written into *pCur |
5195 ** and the highest instantaneous value is written into *pHiwtr. If | 5571 ** and the highest instantaneous value is written into *pHiwtr. ^If |
5196 ** the resetFlg is true, then the highest instantaneous value is | 5572 ** the resetFlg is true, then the highest instantaneous value is |
5197 ** reset back down to the current value. | 5573 ** reset back down to the current value. |
5198 ** | 5574 ** |
| 5575 ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a |
| 5576 ** non-zero [error code] on failure. |
| 5577 ** |
5199 ** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. | 5578 ** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. |
5200 */ | 5579 */ |
5201 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_db_status(sqlite3*, int op, int *pCur
, int *pHiwtr, int resetFlg); | 5580 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int r
esetFlg); |
5202 | 5581 |
5203 /* | 5582 /* |
5204 ** CAPI3REF: Status Parameters for database connections {H17520} <H17500> | 5583 ** CAPI3REF: Status Parameters for database connections |
5205 ** EXPERIMENTAL | |
5206 ** | 5584 ** |
5207 ** These constants are the available integer "verbs" that can be passed as | 5585 ** These constants are the available integer "verbs" that can be passed as |
5208 ** the second argument to the [sqlite3_db_status()] interface. | 5586 ** the second argument to the [sqlite3_db_status()] interface. |
5209 ** | 5587 ** |
5210 ** New verbs may be added in future releases of SQLite. Existing verbs | 5588 ** New verbs may be added in future releases of SQLite. Existing verbs |
5211 ** might be discontinued. Applications should check the return code from | 5589 ** might be discontinued. Applications should check the return code from |
5212 ** [sqlite3_db_status()] to make sure that the call worked. | 5590 ** [sqlite3_db_status()] to make sure that the call worked. |
5213 ** The [sqlite3_db_status()] interface will return a non-zero error code | 5591 ** The [sqlite3_db_status()] interface will return a non-zero error code |
5214 ** if a discontinued or unsupported verb is invoked. | 5592 ** if a discontinued or unsupported verb is invoked. |
5215 ** | 5593 ** |
5216 ** <dl> | 5594 ** <dl> |
5217 ** <dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> | 5595 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> |
5218 ** <dd>This parameter returns the number of lookaside memory slots currently | 5596 ** <dd>This parameter returns the number of lookaside memory slots currently |
5219 ** checked out.</dd> | 5597 ** checked out.</dd>)^ |
| 5598 ** |
| 5599 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> |
| 5600 ** <dd>This parameter returns the number malloc attempts that were |
| 5601 ** satisfied using lookaside memory. Only the high-water value is meaningful; |
| 5602 ** the current value is always zero.)^ |
| 5603 ** |
| 5604 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt> |
| 5605 ** <dd>This parameter returns the number malloc attempts that might have |
| 5606 ** been satisfied using lookaside memory but failed due to the amount of |
| 5607 ** memory requested being larger than the lookaside slot size. |
| 5608 ** Only the high-water value is meaningful; |
| 5609 ** the current value is always zero.)^ |
| 5610 ** |
| 5611 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt> |
| 5612 ** <dd>This parameter returns the number malloc attempts that might have |
| 5613 ** been satisfied using lookaside memory but failed due to all lookaside |
| 5614 ** memory already being in use. |
| 5615 ** Only the high-water value is meaningful; |
| 5616 ** the current value is always zero.)^ |
| 5617 ** |
| 5618 ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> |
| 5619 ** <dd>This parameter returns the approximate number of of bytes of heap |
| 5620 ** memory used by all pager caches associated with the database connection.)^ |
| 5621 ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. |
| 5622 ** |
| 5623 ** ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> |
| 5624 ** <dd>This parameter returns the approximate number of of bytes of heap |
| 5625 ** memory used to store the schema for all databases associated |
| 5626 ** with the connection - main, temp, and any [ATTACH]-ed databases.)^ |
| 5627 ** ^The full amount of memory used by the schemas is reported, even if the |
| 5628 ** schema memory is shared with other database connections due to |
| 5629 ** [shared cache mode] being enabled. |
| 5630 ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. |
| 5631 ** |
| 5632 ** ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> |
| 5633 ** <dd>This parameter returns the approximate number of of bytes of heap |
| 5634 ** and lookaside memory used by all prepared statements associated with |
| 5635 ** the database connection.)^ |
| 5636 ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. |
| 5637 ** </dd> |
5220 ** </dl> | 5638 ** </dl> |
5221 */ | 5639 */ |
5222 #define SQLITE_DBSTATUS_LOOKASIDE_USED 0 | 5640 #define SQLITE_DBSTATUS_LOOKASIDE_USED 0 |
| 5641 #define SQLITE_DBSTATUS_CACHE_USED 1 |
| 5642 #define SQLITE_DBSTATUS_SCHEMA_USED 2 |
| 5643 #define SQLITE_DBSTATUS_STMT_USED 3 |
| 5644 #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 |
| 5645 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 |
| 5646 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 |
| 5647 #define SQLITE_DBSTATUS_MAX 6 /* Largest defined DBSTATUS */ |
5223 | 5648 |
5224 | 5649 |
5225 /* | 5650 /* |
5226 ** CAPI3REF: Prepared Statement Status {H17550} <S60200> | 5651 ** CAPI3REF: Prepared Statement Status |
5227 ** EXPERIMENTAL | |
5228 ** | 5652 ** |
5229 ** Each prepared statement maintains various | 5653 ** ^(Each prepared statement maintains various |
5230 ** [SQLITE_STMTSTATUS_SORT | counters] that measure the number | 5654 ** [SQLITE_STMTSTATUS_SORT | counters] that measure the number |
5231 ** of times it has performed specific operations. These counters can | 5655 ** of times it has performed specific operations.)^ These counters can |
5232 ** be used to monitor the performance characteristics of the prepared | 5656 ** be used to monitor the performance characteristics of the prepared |
5233 ** statements. For example, if the number of table steps greatly exceeds | 5657 ** 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 | 5658 ** 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 | 5659 ** that the prepared statement is using a full table scan rather than |
5236 ** an index. | 5660 ** an index. |
5237 ** | 5661 ** |
5238 ** This interface is used to retrieve and reset counter values from | 5662 ** ^(This interface is used to retrieve and reset counter values from |
5239 ** a [prepared statement]. The first argument is the prepared statement | 5663 ** a [prepared statement]. The first argument is the prepared statement |
5240 ** object to be interrogated. The second argument | 5664 ** object to be interrogated. The second argument |
5241 ** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter] | 5665 ** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter] |
5242 ** to be interrogated. | 5666 ** to be interrogated.)^ |
5243 ** The current value of the requested counter is returned. | 5667 ** ^The current value of the requested counter is returned. |
5244 ** If the resetFlg is true, then the counter is reset to zero after this | 5668 ** ^If the resetFlg is true, then the counter is reset to zero after this |
5245 ** interface call returns. | 5669 ** interface call returns. |
5246 ** | 5670 ** |
5247 ** See also: [sqlite3_status()] and [sqlite3_db_status()]. | 5671 ** See also: [sqlite3_status()] and [sqlite3_db_status()]. |
5248 */ | 5672 */ |
5249 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_stmt_status(sqlite3_stmt*, int op,int
resetFlg); | 5673 SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); |
5250 | 5674 |
5251 /* | 5675 /* |
5252 ** CAPI3REF: Status Parameters for prepared statements {H17570} <H17550> | 5676 ** CAPI3REF: Status Parameters for prepared statements |
5253 ** EXPERIMENTAL | |
5254 ** | 5677 ** |
5255 ** These preprocessor macros define integer codes that name counter | 5678 ** These preprocessor macros define integer codes that name counter |
5256 ** values associated with the [sqlite3_stmt_status()] interface. | 5679 ** values associated with the [sqlite3_stmt_status()] interface. |
5257 ** The meanings of the various counters are as follows: | 5680 ** The meanings of the various counters are as follows: |
5258 ** | 5681 ** |
5259 ** <dl> | 5682 ** <dl> |
5260 ** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> | 5683 ** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> |
5261 ** <dd>This is the number of times that SQLite has stepped forward in | 5684 ** <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 | 5685 ** a table as part of a full table scan. Large numbers for this counter |
5263 ** may indicate opportunities for performance improvement through | 5686 ** may indicate opportunities for performance improvement through |
5264 ** careful use of indices.</dd> | 5687 ** careful use of indices.</dd> |
5265 ** | 5688 ** |
5266 ** <dt>SQLITE_STMTSTATUS_SORT</dt> | 5689 ** <dt>SQLITE_STMTSTATUS_SORT</dt> |
5267 ** <dd>This is the number of sort operations that have occurred. | 5690 ** <dd>^This is the number of sort operations that have occurred. |
5268 ** A non-zero value in this counter may indicate an opportunity to | 5691 ** A non-zero value in this counter may indicate an opportunity to |
5269 ** improvement performance through careful use of indices.</dd> | 5692 ** improvement performance through careful use of indices.</dd> |
5270 ** | 5693 ** |
| 5694 ** <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> |
| 5695 ** <dd>^This is the number of rows inserted into transient indices that |
| 5696 ** were created automatically in order to help joins run faster. |
| 5697 ** A non-zero value in this counter may indicate an opportunity to |
| 5698 ** improvement performance by adding permanent indices that do not |
| 5699 ** need to be reinitialized each time the statement is run.</dd> |
| 5700 ** |
5271 ** </dl> | 5701 ** </dl> |
5272 */ | 5702 */ |
5273 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 | 5703 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 |
5274 #define SQLITE_STMTSTATUS_SORT 2 | 5704 #define SQLITE_STMTSTATUS_SORT 2 |
| 5705 #define SQLITE_STMTSTATUS_AUTOINDEX 3 |
5275 | 5706 |
5276 /* | 5707 /* |
5277 ** CAPI3REF: Custom Page Cache Object | 5708 ** CAPI3REF: Custom Page Cache Object |
5278 ** EXPERIMENTAL | |
5279 ** | 5709 ** |
5280 ** The sqlite3_pcache type is opaque. It is implemented by | 5710 ** The sqlite3_pcache type is opaque. It is implemented by |
5281 ** the pluggable module. The SQLite core has no knowledge of | 5711 ** the pluggable module. The SQLite core has no knowledge of |
5282 ** its size or internal structure and never deals with the | 5712 ** its size or internal structure and never deals with the |
5283 ** sqlite3_pcache object except by holding and passing pointers | 5713 ** sqlite3_pcache object except by holding and passing pointers |
5284 ** to the object. | 5714 ** to the object. |
5285 ** | 5715 ** |
5286 ** See [sqlite3_pcache_methods] for additional information. | 5716 ** See [sqlite3_pcache_methods] for additional information. |
5287 */ | 5717 */ |
5288 typedef struct sqlite3_pcache sqlite3_pcache; | 5718 typedef struct sqlite3_pcache sqlite3_pcache; |
5289 | 5719 |
5290 /* | 5720 /* |
5291 ** CAPI3REF: Application Defined Page Cache. | 5721 ** CAPI3REF: Application Defined Page Cache. |
5292 ** KEYWORDS: {page cache} | 5722 ** KEYWORDS: {page cache} |
5293 ** EXPERIMENTAL | |
5294 ** | 5723 ** |
5295 ** The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can | 5724 ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can |
5296 ** register an alternative page cache implementation by passing in an | 5725 ** register an alternative page cache implementation by passing in an |
5297 ** instance of the sqlite3_pcache_methods structure. The majority of the | 5726 ** instance of the sqlite3_pcache_methods structure.)^ |
5298 ** heap memory used by SQLite is used by the page cache to cache data read | 5727 ** In many applications, most of the heap memory allocated by |
5299 ** from, or ready to be written to, the database file. By implementing a | 5728 ** SQLite is used for the page cache. |
5300 ** custom page cache using this API, an application can control more | 5729 ** By implementing a |
5301 ** precisely the amount of memory consumed by SQLite, the way in which | 5730 ** custom page cache using this API, an application can better control |
| 5731 ** the amount of memory consumed by SQLite, the way in which |
5302 ** that memory is allocated and released, and the policies used to | 5732 ** that memory is allocated and released, and the policies used to |
5303 ** determine exactly which parts of a database file are cached and for | 5733 ** determine exactly which parts of a database file are cached and for |
5304 ** how long. | 5734 ** how long. |
5305 ** | 5735 ** |
5306 ** The contents of the sqlite3_pcache_methods structure are copied to an | 5736 ** The alternative page cache mechanism is an |
| 5737 ** extreme measure that is only needed by the most demanding applications. |
| 5738 ** The built-in page cache is recommended for most uses. |
| 5739 ** |
| 5740 ** ^(The contents of the sqlite3_pcache_methods structure are copied to an |
5307 ** internal buffer by SQLite within the call to [sqlite3_config]. Hence | 5741 ** internal buffer by SQLite within the call to [sqlite3_config]. Hence |
5308 ** the application may discard the parameter after the call to | 5742 ** the application may discard the parameter after the call to |
5309 ** [sqlite3_config()] returns. | 5743 ** [sqlite3_config()] returns.)^ |
5310 ** | 5744 ** |
5311 ** The xInit() method is called once for each call to [sqlite3_initialize()] | 5745 ** ^(The xInit() method is called once for each effective |
5312 ** (usually only once during the lifetime of the process). It is passed | 5746 ** call to [sqlite3_initialize()])^ |
5313 ** a copy of the sqlite3_pcache_methods.pArg value. It can be used to set | 5747 ** (usually only once during the lifetime of the process). ^(The xInit() |
5314 ** up global structures and mutexes required by the custom page cache | 5748 ** method is passed a copy of the sqlite3_pcache_methods.pArg value.)^ |
5315 ** implementation. | 5749 ** The intent of the xInit() method is to set up global data structures |
| 5750 ** required by the custom page cache implementation. |
| 5751 ** ^(If the xInit() method is NULL, then the |
| 5752 ** built-in default page cache is used instead of the application defined |
| 5753 ** page cache.)^ |
5316 ** | 5754 ** |
5317 ** The xShutdown() method is called from within [sqlite3_shutdown()], | 5755 ** ^The xShutdown() method is called by [sqlite3_shutdown()]. |
5318 ** if the application invokes this API. It can be used to clean up | 5756 ** It can be used to clean up |
5319 ** any outstanding resources before process shutdown, if required. | 5757 ** any outstanding resources before process shutdown, if required. |
| 5758 ** ^The xShutdown() method may be NULL. |
5320 ** | 5759 ** |
5321 ** SQLite holds a [SQLITE_MUTEX_RECURSIVE] mutex when it invokes | 5760 ** ^SQLite automatically serializes calls to the xInit method, |
5322 ** the xInit method, so the xInit method need not be threadsafe. The | 5761 ** so the xInit method need not be threadsafe. ^The |
5323 ** xShutdown method is only called from [sqlite3_shutdown()] so it does | 5762 ** xShutdown method is only called from [sqlite3_shutdown()] so it does |
5324 ** not need to be threadsafe either. All other methods must be threadsafe | 5763 ** not need to be threadsafe either. All other methods must be threadsafe |
5325 ** in multithreaded applications. | 5764 ** in multithreaded applications. |
5326 ** | 5765 ** |
5327 ** SQLite will never invoke xInit() more than once without an intervening | 5766 ** ^SQLite will never invoke xInit() more than once without an intervening |
5328 ** call to xShutdown(). | 5767 ** call to xShutdown(). |
5329 ** | 5768 ** |
5330 ** The xCreate() method is used to construct a new cache instance. SQLite | 5769 ** ^SQLite invokes the xCreate() method to construct a new cache instance. |
5331 ** will typically create one cache instance for each open database file, | 5770 ** SQLite will typically create one cache instance for each open database file, |
5332 ** though this is not guaranteed. The | 5771 ** though this is not guaranteed. ^The |
5333 ** first parameter, szPage, is the size in bytes of the pages that must | 5772 ** 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 | 5773 ** 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 | 5774 ** 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 | 5775 ** increment (here called "R") of less than 250. SQLite will use the |
5337 ** extra R bytes on each page to store metadata about the underlying | 5776 ** extra R bytes on each page to store metadata about the underlying |
5338 ** database page on disk. The value of R depends | 5777 ** database page on disk. The value of R depends |
5339 ** on the SQLite version, the target platform, and how SQLite was compiled. | 5778 ** 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 | 5779 ** ^(R is constant for a particular build of SQLite. Except, there are two |
| 5780 ** distinct values of R when SQLite is compiled with the proprietary |
| 5781 ** ZIPVFS extension.)^ ^The second argument to |
5341 ** xCreate(), bPurgeable, is true if the cache being created will | 5782 ** xCreate(), bPurgeable, is true if the cache being created will |
5342 ** be used to cache database pages of a file stored on disk, or | 5783 ** 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 | 5784 ** 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; | 5785 ** 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 | 5786 ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will |
5346 ** never invoke xUnpin() except to deliberately delete a page. | 5787 ** never invoke xUnpin() except to deliberately delete a page. |
5347 ** In other words, a cache created with bPurgeable set to false will | 5788 ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to |
| 5789 ** false will always have the "discard" flag set to true. |
| 5790 ** ^Hence, a cache created with bPurgeable false will |
5348 ** never contain any unpinned pages. | 5791 ** never contain any unpinned pages. |
5349 ** | 5792 ** |
5350 ** The xCachesize() method may be called at any time by SQLite to set the | 5793 ** ^(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 | 5794 ** suggested maximum cache-size (number of pages stored by) the cache |
5352 ** instance passed as the first argument. This is the value configured using | 5795 ** instance passed as the first argument. This is the value configured using |
5353 ** the SQLite "[PRAGMA cache_size]" command. As with the bPurgeable parameter, | 5796 ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable |
5354 ** the implementation is not required to do anything with this | 5797 ** parameter, the implementation is not required to do anything with this |
5355 ** value; it is advisory only. | 5798 ** value; it is advisory only. |
5356 ** | 5799 ** |
5357 ** The xPagecount() method should return the number of pages currently | 5800 ** The xPagecount() method must return the number of pages currently |
5358 ** stored in the cache. | 5801 ** stored in the cache, both pinned and unpinned. |
5359 ** | 5802 ** |
5360 ** The xFetch() method is used to fetch a page and return a pointer to it. | 5803 ** 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 | 5804 ** the page, or a NULL pointer. |
5362 ** 8-byte boundary. The page to be fetched is determined by the key. The | 5805 ** 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 | 5806 ** 8-byte boundary. The page to be fetched is determined by the key. ^The |
| 5807 ** mimimum key value is 1. After it has been retrieved using xFetch, the page |
5364 ** is considered to be "pinned". | 5808 ** is considered to be "pinned". |
5365 ** | 5809 ** |
5366 ** If the requested page is already in the page cache, then the page cache | 5810 ** 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 | 5811 ** 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 | 5812 ** 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 | 5813 ** cache implementation should use the value of the createFlag |
5370 ** createFlag parameter passed to xFetch, according to the following table: | 5814 ** parameter to help it determined what action to take: |
5371 ** | 5815 ** |
5372 ** <table border=1 width=85% align=center> | 5816 ** <table border=1 width=85% align=center> |
5373 ** <tr><th> createFlag <th> Behaviour when page is not already in cache | 5817 ** <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. | 5818 ** <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. | 5819 ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. |
5376 ** Otherwise return NULL. | 5820 ** Otherwise return NULL. |
5377 ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return | 5821 ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return |
5378 ** NULL if allocating a new page is effectively impossible. | 5822 ** NULL if allocating a new page is effectively impossible. |
5379 ** </table> | 5823 ** </table> |
5380 ** | 5824 ** |
5381 ** SQLite will normally invoke xFetch() with a createFlag of 0 or 1. If | 5825 ** ^(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 | 5826 ** will only use a createFlag of 2 after a prior call with a createFlag of 1 |
| 5827 ** failed.)^ In between the to xFetch() calls, SQLite may |
5383 ** attempt to unpin one or more cache pages by spilling the content of | 5828 ** 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 | 5829 ** 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 ** | 5830 ** |
5388 ** xUnpin() is called by SQLite with a pointer to a currently pinned page | 5831 ** ^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, | 5832 ** 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 | 5833 ** then the page must be evicted from the cache. |
5391 ** assumes that the next time the page is retrieved from the cache using | 5834 ** ^If the discard parameter is |
5392 ** the xFetch() method, it will be zeroed. If the discard parameter is | 5835 ** 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 | 5836 ** page cache implementation. ^The page cache implementation |
5394 ** may choose to evict unpinned pages at any time. | 5837 ** may choose to evict unpinned pages at any time. |
5395 ** | 5838 ** |
5396 ** The cache is not required to perform any reference counting. A single | 5839 ** The cache must not perform any reference counting. A single |
5397 ** call to xUnpin() unpins the page regardless of the number of prior calls | 5840 ** call to xUnpin() unpins the page regardless of the number of prior calls |
5398 ** to xFetch(). | 5841 ** to xFetch(). |
5399 ** | 5842 ** |
5400 ** The xRekey() method is used to change the key value associated with the | 5843 ** 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 | 5844 ** page passed as the second argument. If the cache |
5402 ** previously contains an entry associated with newKey, it should be | 5845 ** previously contains an entry associated with newKey, it must be |
5403 ** discarded. Any prior cache entry associated with newKey is guaranteed not | 5846 ** discarded. ^Any prior cache entry associated with newKey is guaranteed not |
5404 ** to be pinned. | 5847 ** to be pinned. |
5405 ** | 5848 ** |
5406 ** When SQLite calls the xTruncate() method, the cache must discard all | 5849 ** When SQLite calls the xTruncate() method, the cache must discard all |
5407 ** existing cache entries with page numbers (keys) greater than or equal | 5850 ** existing cache entries with page numbers (keys) greater than or equal |
5408 ** to the value of the iLimit parameter passed to xTruncate(). If any | 5851 ** to the value of the iLimit parameter passed to xTruncate(). If any |
5409 ** of these pages are pinned, they are implicitly unpinned, meaning that | 5852 ** of these pages are pinned, they are implicitly unpinned, meaning that |
5410 ** they can be safely discarded. | 5853 ** they can be safely discarded. |
5411 ** | 5854 ** |
5412 ** The xDestroy() method is used to delete a cache allocated by xCreate(). | 5855 ** ^The xDestroy() method is used to delete a cache allocated by xCreate(). |
5413 ** All resources associated with the specified cache should be freed. After | 5856 ** All resources associated with the specified cache should be freed. ^After |
5414 ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] | 5857 ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] |
5415 ** handle invalid, and will not use it with any other sqlite3_pcache_methods | 5858 ** handle invalid, and will not use it with any other sqlite3_pcache_methods |
5416 ** functions. | 5859 ** functions. |
5417 */ | 5860 */ |
5418 typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; | 5861 typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; |
5419 struct sqlite3_pcache_methods { | 5862 struct sqlite3_pcache_methods { |
5420 void *pArg; | 5863 void *pArg; |
5421 int (*xInit)(void*); | 5864 int (*xInit)(void*); |
5422 void (*xShutdown)(void*); | 5865 void (*xShutdown)(void*); |
5423 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); | 5866 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); |
5424 void (*xCachesize)(sqlite3_pcache*, int nCachesize); | 5867 void (*xCachesize)(sqlite3_pcache*, int nCachesize); |
5425 int (*xPagecount)(sqlite3_pcache*); | 5868 int (*xPagecount)(sqlite3_pcache*); |
5426 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); | 5869 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); |
5427 void (*xUnpin)(sqlite3_pcache*, void*, int discard); | 5870 void (*xUnpin)(sqlite3_pcache*, void*, int discard); |
5428 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); | 5871 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); |
5429 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); | 5872 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); |
5430 void (*xDestroy)(sqlite3_pcache*); | 5873 void (*xDestroy)(sqlite3_pcache*); |
5431 }; | 5874 }; |
5432 | 5875 |
5433 /* | 5876 /* |
5434 ** CAPI3REF: Online Backup Object | 5877 ** CAPI3REF: Online Backup Object |
5435 ** EXPERIMENTAL | |
5436 ** | 5878 ** |
5437 ** The sqlite3_backup object records state information about an ongoing | 5879 ** The sqlite3_backup object records state information about an ongoing |
5438 ** online backup operation. The sqlite3_backup object is created by | 5880 ** online backup operation. ^The sqlite3_backup object is created by |
5439 ** a call to [sqlite3_backup_init()] and is destroyed by a call to | 5881 ** a call to [sqlite3_backup_init()] and is destroyed by a call to |
5440 ** [sqlite3_backup_finish()]. | 5882 ** [sqlite3_backup_finish()]. |
5441 ** | 5883 ** |
5442 ** See Also: [Using the SQLite Online Backup API] | 5884 ** See Also: [Using the SQLite Online Backup API] |
5443 */ | 5885 */ |
5444 typedef struct sqlite3_backup sqlite3_backup; | 5886 typedef struct sqlite3_backup sqlite3_backup; |
5445 | 5887 |
5446 /* | 5888 /* |
5447 ** CAPI3REF: Online Backup API. | 5889 ** CAPI3REF: Online Backup API. |
5448 ** EXPERIMENTAL | |
5449 ** | 5890 ** |
5450 ** This API is used to overwrite the contents of one database with that | 5891 ** The backup API copies the content of one database into another. |
5451 ** of another. It is useful either for creating backups of databases or | 5892 ** It is useful either for creating backups of databases or |
5452 ** for copying in-memory databases to or from persistent files. | 5893 ** for copying in-memory databases to or from persistent files. |
5453 ** | 5894 ** |
5454 ** See Also: [Using the SQLite Online Backup API] | 5895 ** See Also: [Using the SQLite Online Backup API] |
5455 ** | 5896 ** |
5456 ** Exclusive access is required to the destination database for the | 5897 ** ^SQLite holds a write transaction open on the destination database file |
5457 ** duration of the operation. However the source database is only | 5898 ** for the duration of the backup operation. |
5458 ** read-locked while it is actually being read, it is not locked | 5899 ** ^The source database is read-locked only while it is being read; |
5459 ** continuously for the entire operation. Thus, the backup may be | 5900 ** it is not locked continuously for the entire backup operation. |
5460 ** performed on a live database without preventing other users from | 5901 ** ^Thus, the backup may be performed on a live source database without |
5461 ** writing to the database for an extended period of time. | 5902 ** preventing other database connections from |
| 5903 ** reading or writing to the source database while the backup is underway. |
5462 ** | 5904 ** |
5463 ** To perform a backup operation: | 5905 ** ^(To perform a backup operation: |
5464 ** <ol> | 5906 ** <ol> |
5465 ** <li><b>sqlite3_backup_init()</b> is called once to initialize the | 5907 ** <li><b>sqlite3_backup_init()</b> is called once to initialize the |
5466 ** backup, | 5908 ** backup, |
5467 ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer | 5909 ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer |
5468 ** the data between the two databases, and finally | 5910 ** the data between the two databases, and finally |
5469 ** <li><b>sqlite3_backup_finish()</b> is called to release all resources | 5911 ** <li><b>sqlite3_backup_finish()</b> is called to release all resources |
5470 ** associated with the backup operation. | 5912 ** associated with the backup operation. |
5471 ** </ol> | 5913 ** </ol>)^ |
5472 ** There should be exactly one call to sqlite3_backup_finish() for each | 5914 ** There should be exactly one call to sqlite3_backup_finish() for each |
5473 ** successful call to sqlite3_backup_init(). | 5915 ** successful call to sqlite3_backup_init(). |
5474 ** | 5916 ** |
5475 ** <b>sqlite3_backup_init()</b> | 5917 ** <b>sqlite3_backup_init()</b> |
5476 ** | 5918 ** |
5477 ** The first two arguments passed to [sqlite3_backup_init()] are the database | 5919 ** ^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 | 5920 ** [database connection] associated with the destination database |
5479 ** used to attach the destination database to the handle. The database name | 5921 ** and the database name, respectively. |
5480 ** is "main" for the main database, "temp" for the temporary database, or | 5922 ** ^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 | 5923 ** temporary database, or the name specified after the AS keyword in |
5482 ** an attached database. The third and fourth arguments passed to | 5924 ** an [ATTACH] statement for an attached database. |
5483 ** sqlite3_backup_init() identify the [database connection] | 5925 ** ^The S and M arguments passed to |
5484 ** and database name used | 5926 ** sqlite3_backup_init(D,N,S,M) identify the [database connection] |
5485 ** to access the source database. The values passed for the source and | 5927 ** and database name of the source database, respectively. |
5486 ** destination [database connection] parameters must not be the same. | 5928 ** ^The source and destination [database connections] (parameters S and D) |
| 5929 ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with |
| 5930 ** an error. |
5487 ** | 5931 ** |
5488 ** If an error occurs within sqlite3_backup_init(), then NULL is returned | 5932 ** ^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] | 5933 ** returned and an error code and error message are stored in the |
5490 ** passed as the first argument. They may be retrieved using the | 5934 ** destination [database connection] D. |
5491 ** [sqlite3_errcode()], [sqlite3_errmsg()], and [sqlite3_errmsg16()] functions. | 5935 ** ^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 | 5936 ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or |
5493 ** returned. This pointer may be used with the sqlite3_backup_step() and | 5937 ** [sqlite3_errmsg16()] functions. |
| 5938 ** ^A successful call to sqlite3_backup_init() returns a pointer to an |
| 5939 ** [sqlite3_backup] object. |
| 5940 ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and |
5494 ** sqlite3_backup_finish() functions to perform the specified backup | 5941 ** sqlite3_backup_finish() functions to perform the specified backup |
5495 ** operation. | 5942 ** operation. |
5496 ** | 5943 ** |
5497 ** <b>sqlite3_backup_step()</b> | 5944 ** <b>sqlite3_backup_step()</b> |
5498 ** | 5945 ** |
5499 ** Function [sqlite3_backup_step()] is used to copy up to nPage pages between | 5946 ** ^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 | 5947 ** the source and destination databases specified by [sqlite3_backup] object B. |
5501 ** second parameter passed to sqlite3_backup_step(). If nPage is a negative | 5948 ** ^If N is negative, all remaining source pages are copied. |
5502 ** value, all remaining source pages are copied. If the required pages are | 5949 ** ^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 | 5950 ** are still more pages to be copied, then the function returns [SQLITE_OK]. |
5504 ** backup is complete, it returns [SQLITE_OK]. If no error occured and there | 5951 ** ^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 | 5952 ** from source to destination, then it returns [SQLITE_DONE]. |
5506 ** occurs, then an SQLite error code is returned. As well as [SQLITE_OK] and | 5953 ** ^If an error occurs while running sqlite3_backup_step(B,N), |
| 5954 ** 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], | 5955 ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], |
5508 ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an | 5956 ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an |
5509 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. | 5957 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. |
5510 ** | 5958 ** |
5511 ** As well as the case where the destination database file was opened for | 5959 ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if |
5512 ** read-only access, sqlite3_backup_step() may return [SQLITE_READONLY] if | 5960 ** <ol> |
5513 ** the destination is an in-memory database with a different page size | 5961 ** <li> the destination database was opened read-only, or |
5514 ** from the source database. | 5962 ** <li> the destination database is using write-ahead-log journaling |
| 5963 ** and the destination and source page sizes differ, or |
| 5964 ** <li> the destination database is an in-memory database and the |
| 5965 ** destination and source page sizes differ. |
| 5966 ** </ol>)^ |
5515 ** | 5967 ** |
5516 ** If sqlite3_backup_step() cannot obtain a required file-system lock, then | 5968 ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then |
5517 ** the [sqlite3_busy_handler | busy-handler function] | 5969 ** the [sqlite3_busy_handler | busy-handler function] |
5518 ** is invoked (if one is specified). If the | 5970 ** is invoked (if one is specified). ^If the |
5519 ** busy-handler returns non-zero before the lock is available, then | 5971 ** 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 | 5972 ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to |
5521 ** sqlite3_backup_step() can be retried later. If the source | 5973 ** sqlite3_backup_step() can be retried later. ^If the source |
5522 ** [database connection] | 5974 ** [database connection] |
5523 ** is being used to write to the source database when sqlite3_backup_step() | 5975 ** 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 | 5976 ** 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 | 5977 ** case the call to sqlite3_backup_step() can be retried later on. ^(If |
5526 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or | 5978 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or |
5527 ** [SQLITE_READONLY] is returned, then | 5979 ** [SQLITE_READONLY] is returned, then |
5528 ** there is no point in retrying the call to sqlite3_backup_step(). These | 5980 ** 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 | 5981 ** errors are considered fatal.)^ The application must accept |
5530 ** that the backup operation has failed and pass the backup operation handle | 5982 ** that the backup operation has failed and pass the backup operation handle |
5531 ** to the sqlite3_backup_finish() to release associated resources. | 5983 ** to the sqlite3_backup_finish() to release associated resources. |
5532 ** | 5984 ** |
5533 ** Following the first call to sqlite3_backup_step(), an exclusive lock is | 5985 ** ^The first call to sqlite3_backup_step() obtains an exclusive lock |
5534 ** obtained on the destination file. It is not released until either | 5986 ** on the destination file. ^The exclusive lock is not released until either |
5535 ** sqlite3_backup_finish() is called or the backup operation is complete | 5987 ** sqlite3_backup_finish() is called or the backup operation is complete |
5536 ** and sqlite3_backup_step() returns [SQLITE_DONE]. Additionally, each time | 5988 ** 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 | 5989 ** sqlite3_backup_step() obtains a [shared lock] on the source database that |
5538 ** the source database file. This lock is released before the | 5990 ** lasts for the duration of the sqlite3_backup_step() call. |
5539 ** sqlite3_backup_step() call returns. Because the source database is not | 5991 ** ^Because the source database is not locked between calls to |
5540 ** locked between calls to sqlite3_backup_step(), it may be modified mid-way | 5992 ** sqlite3_backup_step(), the source database may be modified mid-way |
5541 ** through the backup procedure. If the source database is modified by an | 5993 ** 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 | 5994 ** external process or via a database connection other than the one being |
5543 ** used by the backup operation, then the backup will be transparently | 5995 ** used by the backup operation, then the backup will be automatically |
5544 ** restarted by the next call to sqlite3_backup_step(). If the source | 5996 ** 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 | 5997 ** database is modified by the using the same database connection as is used |
5546 ** by the backup operation, then the backup database is transparently | 5998 ** by the backup operation, then the backup database is automatically |
5547 ** updated at the same time. | 5999 ** updated at the same time. |
5548 ** | 6000 ** |
5549 ** <b>sqlite3_backup_finish()</b> | 6001 ** <b>sqlite3_backup_finish()</b> |
5550 ** | 6002 ** |
5551 ** Once sqlite3_backup_step() has returned [SQLITE_DONE], or when the | 6003 ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the |
5552 ** application wishes to abandon the backup operation, the [sqlite3_backup] | 6004 ** application wishes to abandon the backup operation, the application |
5553 ** object should be passed to sqlite3_backup_finish(). This releases all | 6005 ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). |
5554 ** resources associated with the backup operation. If sqlite3_backup_step() | 6006 ** ^The sqlite3_backup_finish() interfaces releases all |
5555 ** has not yet returned [SQLITE_DONE], then any active write-transaction on the | 6007 ** resources associated with the [sqlite3_backup] object. |
5556 ** destination database is rolled back. The [sqlite3_backup] object is invalid | 6008 ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any |
| 6009 ** active write-transaction on the destination database is rolled back. |
| 6010 ** The [sqlite3_backup] object is invalid |
5557 ** and may not be used following a call to sqlite3_backup_finish(). | 6011 ** and may not be used following a call to sqlite3_backup_finish(). |
5558 ** | 6012 ** |
5559 ** The value returned by sqlite3_backup_finish is [SQLITE_OK] if no error | 6013 ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no |
5560 ** occurred, regardless or whether or not sqlite3_backup_step() was called | 6014 ** sqlite3_backup_step() errors occurred, regardless or whether or not |
5561 ** a sufficient number of times to complete the backup operation. Or, if | 6015 ** sqlite3_backup_step() completed. |
5562 ** an out-of-memory condition or IO error occured during a call to | 6016 ** ^If an out-of-memory condition or IO error occurred during any prior |
5563 ** sqlite3_backup_step() then [SQLITE_NOMEM] or an | 6017 ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then |
5564 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] error code | 6018 ** 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 ** | 6019 ** |
5568 ** A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() is | 6020 ** ^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 | 6021 ** is not a permanent error and does not affect the return value of |
5570 ** sqlite3_backup_finish(). | 6022 ** sqlite3_backup_finish(). |
5571 ** | 6023 ** |
5572 ** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b> | 6024 ** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b> |
5573 ** | 6025 ** |
5574 ** Each call to sqlite3_backup_step() sets two values stored internally | 6026 ** ^Each call to sqlite3_backup_step() sets two values inside |
5575 ** by an [sqlite3_backup] object. The number of pages still to be backed | 6027 ** 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 | 6028 ** 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 | 6029 ** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces |
5578 ** sqlite3_backup_pagecount(). | 6030 ** retrieve these two values, respectively. |
5579 ** | 6031 ** |
5580 ** The values returned by these functions are only updated by | 6032 ** ^The values returned by these functions are only updated by |
5581 ** sqlite3_backup_step(). If the source database is modified during a backup | 6033 ** 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 | 6034 ** 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 | 6035 ** pages that need to be updated or the size of the source database file |
5584 ** changing. | 6036 ** changing. |
5585 ** | 6037 ** |
5586 ** <b>Concurrent Usage of Database Handles</b> | 6038 ** <b>Concurrent Usage of Database Handles</b> |
5587 ** | 6039 ** |
5588 ** The source [database connection] may be used by the application for other | 6040 ** ^The source [database connection] may be used by the application for other |
5589 ** purposes while a backup operation is underway or being initialized. | 6041 ** purposes while a backup operation is underway or being initialized. |
5590 ** If SQLite is compiled and configured to support threadsafe database | 6042 ** ^If SQLite is compiled and configured to support threadsafe database |
5591 ** connections, then the source database connection may be used concurrently | 6043 ** connections, then the source database connection may be used concurrently |
5592 ** from within other threads. | 6044 ** from within other threads. |
5593 ** | 6045 ** |
5594 ** However, the application must guarantee that the destination database | 6046 ** However, the application must guarantee that the destination |
5595 ** connection handle is not passed to any other API (by any thread) after | 6047 ** [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 | 6048 ** sqlite3_backup_init() is called and before the corresponding call to |
5597 ** sqlite3_backup_finish(). Unfortunately SQLite does not currently check | 6049 ** sqlite3_backup_finish(). SQLite does not currently check to see |
5598 ** for this, if the application does use the destination [database connection] | 6050 ** if the application incorrectly accesses the destination [database connection] |
5599 ** for some other purpose during a backup operation, things may appear to | 6051 ** and so no error code is reported, but the operations may malfunction |
5600 ** work correctly but in fact be subtly malfunctioning. Use of the | 6052 ** nevertheless. Use of the destination database connection while a |
5601 ** destination database connection while a backup is in progress might | 6053 ** backup is in progress might also also cause a mutex deadlock. |
5602 ** also cause a mutex deadlock. | |
5603 ** | 6054 ** |
5604 ** Furthermore, if running in [shared cache mode], the application must | 6055 ** If running in [shared cache mode], the application must |
5605 ** guarantee that the shared cache used by the destination database | 6056 ** guarantee that the shared cache used by the destination database |
5606 ** is not accessed while the backup is running. In practice this means | 6057 ** is not accessed while the backup is running. In practice this means |
5607 ** that the application must guarantee that the file-system file being | 6058 ** that the application must guarantee that the disk file being |
5608 ** backed up to is not accessed by any connection within the process, | 6059 ** 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(). | 6060 ** not just the specific connection that was passed to sqlite3_backup_init(). |
5610 ** | 6061 ** |
5611 ** The [sqlite3_backup] object itself is partially threadsafe. Multiple | 6062 ** The [sqlite3_backup] object itself is partially threadsafe. Multiple |
5612 ** threads may safely make multiple concurrent calls to sqlite3_backup_step(). | 6063 ** threads may safely make multiple concurrent calls to sqlite3_backup_step(). |
5613 ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() | 6064 ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() |
5614 ** APIs are not strictly speaking threadsafe. If they are invoked at the | 6065 ** 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 | 6066 ** same time as another thread is invoking sqlite3_backup_step() it is |
5616 ** possible that they return invalid values. | 6067 ** possible that they return invalid values. |
5617 */ | 6068 */ |
5618 SQLITE_API sqlite3_backup *sqlite3_backup_init( | 6069 SQLITE_API sqlite3_backup *sqlite3_backup_init( |
5619 sqlite3 *pDest, /* Destination database handle */ | 6070 sqlite3 *pDest, /* Destination database handle */ |
5620 const char *zDestName, /* Destination database name */ | 6071 const char *zDestName, /* Destination database name */ |
5621 sqlite3 *pSource, /* Source database handle */ | 6072 sqlite3 *pSource, /* Source database handle */ |
5622 const char *zSourceName /* Source database name */ | 6073 const char *zSourceName /* Source database name */ |
5623 ); | 6074 ); |
5624 SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage); | 6075 SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage); |
5625 SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p); | 6076 SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p); |
5626 SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p); | 6077 SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p); |
5627 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p); | 6078 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p); |
5628 | 6079 |
5629 /* | 6080 /* |
5630 ** CAPI3REF: Unlock Notification | 6081 ** CAPI3REF: Unlock Notification |
5631 ** EXPERIMENTAL | |
5632 ** | 6082 ** |
5633 ** When running in shared-cache mode, a database operation may fail with | 6083 ** ^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 | 6084 ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or |
5635 ** individual tables within the shared-cache cannot be obtained. See | 6085 ** individual tables within the shared-cache cannot be obtained. See |
5636 ** [SQLite Shared-Cache Mode] for a description of shared-cache locking. | 6086 ** [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 | 6087 ** ^This API may be used to register a callback that SQLite will invoke |
5638 ** when the connection currently holding the required lock relinquishes it. | 6088 ** when the connection currently holding the required lock relinquishes it. |
5639 ** This API is only available if the library was compiled with the | 6089 ** ^This API is only available if the library was compiled with the |
5640 ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. | 6090 ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. |
5641 ** | 6091 ** |
5642 ** See Also: [Using the SQLite Unlock Notification Feature]. | 6092 ** See Also: [Using the SQLite Unlock Notification Feature]. |
5643 ** | 6093 ** |
5644 ** Shared-cache locks are released when a database connection concludes | 6094 ** ^Shared-cache locks are released when a database connection concludes |
5645 ** its current transaction, either by committing it or rolling it back. | 6095 ** its current transaction, either by committing it or rolling it back. |
5646 ** | 6096 ** |
5647 ** When a connection (known as the blocked connection) fails to obtain a | 6097 ** ^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 | 6098 ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the |
5649 ** identity of the database connection (the blocking connection) that | 6099 ** identity of the database connection (the blocking connection) that |
5650 ** has locked the required resource is stored internally. After an | 6100 ** has locked the required resource is stored internally. ^After an |
5651 ** application receives an SQLITE_LOCKED error, it may call the | 6101 ** application receives an SQLITE_LOCKED error, it may call the |
5652 ** sqlite3_unlock_notify() method with the blocked connection handle as | 6102 ** sqlite3_unlock_notify() method with the blocked connection handle as |
5653 ** the first argument to register for a callback that will be invoked | 6103 ** the first argument to register for a callback that will be invoked |
5654 ** when the blocking connections current transaction is concluded. The | 6104 ** when the blocking connections current transaction is concluded. ^The |
5655 ** callback is invoked from within the [sqlite3_step] or [sqlite3_close] | 6105 ** callback is invoked from within the [sqlite3_step] or [sqlite3_close] |
5656 ** call that concludes the blocking connections transaction. | 6106 ** call that concludes the blocking connections transaction. |
5657 ** | 6107 ** |
5658 ** If sqlite3_unlock_notify() is called in a multi-threaded application, | 6108 ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, |
5659 ** there is a chance that the blocking connection will have already | 6109 ** there is a chance that the blocking connection will have already |
5660 ** concluded its transaction by the time sqlite3_unlock_notify() is invoked. | 6110 ** concluded its transaction by the time sqlite3_unlock_notify() is invoked. |
5661 ** If this happens, then the specified callback is invoked immediately, | 6111 ** If this happens, then the specified callback is invoked immediately, |
5662 ** from within the call to sqlite3_unlock_notify(). | 6112 ** from within the call to sqlite3_unlock_notify().)^ |
5663 ** | 6113 ** |
5664 ** If the blocked connection is attempting to obtain a write-lock on a | 6114 ** ^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 | 6115 ** 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 | 6116 ** a read-lock on the same table, then SQLite arbitrarily selects one of |
5667 ** the other connections to use as the blocking connection. | 6117 ** the other connections to use as the blocking connection. |
5668 ** | 6118 ** |
5669 ** There may be at most one unlock-notify callback registered by a | 6119 ** ^(There may be at most one unlock-notify callback registered by a |
5670 ** blocked connection. If sqlite3_unlock_notify() is called when the | 6120 ** blocked connection. If sqlite3_unlock_notify() is called when the |
5671 ** blocked connection already has a registered unlock-notify callback, | 6121 ** blocked connection already has a registered unlock-notify callback, |
5672 ** then the new callback replaces the old. If sqlite3_unlock_notify() is | 6122 ** 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 | 6123 ** called with a NULL pointer as its second argument, then any existing |
5674 ** unlock-notify callback is cancelled. The blocked connections | 6124 ** unlock-notify callback is canceled. ^The blocked connections |
5675 ** unlock-notify callback may also be canceled by closing the blocked | 6125 ** unlock-notify callback may also be canceled by closing the blocked |
5676 ** connection using [sqlite3_close()]. | 6126 ** connection using [sqlite3_close()]. |
5677 ** | 6127 ** |
5678 ** The unlock-notify callback is not reentrant. If an application invokes | 6128 ** The unlock-notify callback is not reentrant. If an application invokes |
5679 ** any sqlite3_xxx API functions from within an unlock-notify callback, a | 6129 ** any sqlite3_xxx API functions from within an unlock-notify callback, a |
5680 ** crash or deadlock may be the result. | 6130 ** crash or deadlock may be the result. |
5681 ** | 6131 ** |
5682 ** Unless deadlock is detected (see below), sqlite3_unlock_notify() always | 6132 ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always |
5683 ** returns SQLITE_OK. | 6133 ** returns SQLITE_OK. |
5684 ** | 6134 ** |
5685 ** <b>Callback Invocation Details</b> | 6135 ** <b>Callback Invocation Details</b> |
5686 ** | 6136 ** |
5687 ** When an unlock-notify callback is registered, the application provides a | 6137 ** 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. | 6138 ** 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 | 6139 ** However, the signature of the callback function allows SQLite to pass |
5690 ** it an array of void* context pointers. The first argument passed to | 6140 ** 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, | 6141 ** 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. | 6142 ** and the second is the number of entries in the array. |
5693 ** | 6143 ** |
5694 ** When a blocking connections transaction is concluded, there may be | 6144 ** When a blocking connections transaction is concluded, there may be |
5695 ** more than one blocked connection that has registered for an unlock-notify | 6145 ** more than one blocked connection that has registered for an unlock-notify |
5696 ** callback. If two or more such blocked connections have specified the | 6146 ** callback. ^If two or more such blocked connections have specified the |
5697 ** same callback function, then instead of invoking the callback function | 6147 ** same callback function, then instead of invoking the callback function |
5698 ** multiple times, it is invoked once with the set of void* context pointers | 6148 ** multiple times, it is invoked once with the set of void* context pointers |
5699 ** specified by the blocked connections bundled together into an array. | 6149 ** specified by the blocked connections bundled together into an array. |
5700 ** This gives the application an opportunity to prioritize any actions | 6150 ** This gives the application an opportunity to prioritize any actions |
5701 ** related to the set of unblocked database connections. | 6151 ** related to the set of unblocked database connections. |
5702 ** | 6152 ** |
5703 ** <b>Deadlock Detection</b> | 6153 ** <b>Deadlock Detection</b> |
5704 ** | 6154 ** |
5705 ** Assuming that after registering for an unlock-notify callback a | 6155 ** Assuming that after registering for an unlock-notify callback a |
5706 ** database waits for the callback to be issued before taking any further | 6156 ** database waits for the callback to be issued before taking any further |
5707 ** action (a reasonable assumption), then using this API may cause the | 6157 ** action (a reasonable assumption), then using this API may cause the |
5708 ** application to deadlock. For example, if connection X is waiting for | 6158 ** application to deadlock. For example, if connection X is waiting for |
5709 ** connection Y's transaction to be concluded, and similarly connection | 6159 ** connection Y's transaction to be concluded, and similarly connection |
5710 ** Y is waiting on connection X's transaction, then neither connection | 6160 ** Y is waiting on connection X's transaction, then neither connection |
5711 ** will proceed and the system may remain deadlocked indefinitely. | 6161 ** will proceed and the system may remain deadlocked indefinitely. |
5712 ** | 6162 ** |
5713 ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock | 6163 ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock |
5714 ** detection. If a given call to sqlite3_unlock_notify() would put the | 6164 ** 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 | 6165 ** 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 | 6166 ** 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 | 6167 ** a deadlocked state if connection A has registered for an unlock-notify |
5718 ** callback on the conclusion of connection B's transaction, and connection | 6168 ** callback on the conclusion of connection B's transaction, and connection |
5719 ** B has itself registered for an unlock-notify callback when connection | 6169 ** B has itself registered for an unlock-notify callback when connection |
5720 ** A's transaction is concluded. Indirect deadlock is also detected, so | 6170 ** A's transaction is concluded. ^Indirect deadlock is also detected, so |
5721 ** the system is also considered to be deadlocked if connection B has | 6171 ** the system is also considered to be deadlocked if connection B has |
5722 ** registered for an unlock-notify callback on the conclusion of connection | 6172 ** registered for an unlock-notify callback on the conclusion of connection |
5723 ** C's transaction, where connection C is waiting on connection A. Any | 6173 ** C's transaction, where connection C is waiting on connection A. ^Any |
5724 ** number of levels of indirection are allowed. | 6174 ** number of levels of indirection are allowed. |
5725 ** | 6175 ** |
5726 ** <b>The "DROP TABLE" Exception</b> | 6176 ** <b>The "DROP TABLE" Exception</b> |
5727 ** | 6177 ** |
5728 ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost | 6178 ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost |
5729 ** always appropriate to call sqlite3_unlock_notify(). There is however, | 6179 ** always appropriate to call sqlite3_unlock_notify(). There is however, |
5730 ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, | 6180 ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, |
5731 ** SQLite checks if there are any currently executing SELECT statements | 6181 ** SQLite checks if there are any currently executing SELECT statements |
5732 ** that belong to the same connection. If there are, SQLITE_LOCKED is | 6182 ** that belong to the same connection. If there are, SQLITE_LOCKED is |
5733 ** returned. In this case there is no "blocking connection", so invoking | 6183 ** returned. In this case there is no "blocking connection", so invoking |
5734 ** sqlite3_unlock_notify() results in the unlock-notify callback being | 6184 ** sqlite3_unlock_notify() results in the unlock-notify callback being |
5735 ** invoked immediately. If the application then re-attempts the "DROP TABLE" | 6185 ** invoked immediately. If the application then re-attempts the "DROP TABLE" |
5736 ** or "DROP INDEX" query, an infinite loop might be the result. | 6186 ** or "DROP INDEX" query, an infinite loop might be the result. |
5737 ** | 6187 ** |
5738 ** One way around this problem is to check the extended error code returned | 6188 ** 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 | 6189 ** 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 | 6190 ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in |
5741 ** the special "DROP TABLE/INDEX" case, the extended error code is just | 6191 ** the special "DROP TABLE/INDEX" case, the extended error code is just |
5742 ** SQLITE_LOCKED. | 6192 ** SQLITE_LOCKED.)^ |
5743 */ | 6193 */ |
5744 SQLITE_API int sqlite3_unlock_notify( | 6194 SQLITE_API int sqlite3_unlock_notify( |
5745 sqlite3 *pBlocked, /* Waiting connection */ | 6195 sqlite3 *pBlocked, /* Waiting connection */ |
5746 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ | 6196 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ |
5747 void *pNotifyArg /* Argument to pass to xNotify */ | 6197 void *pNotifyArg /* Argument to pass to xNotify */ |
5748 ); | 6198 ); |
5749 | 6199 |
5750 | 6200 |
5751 /* | 6201 /* |
5752 ** CAPI3REF: String Comparison | 6202 ** CAPI3REF: String Comparison |
5753 ** EXPERIMENTAL | 6203 ** |
5754 ** | 6204 ** ^The [sqlite3_strnicmp()] API allows applications and extensions to |
5755 ** The [sqlite3_strnicmp()] API allows applications and extensions to | |
5756 ** compare the contents of two buffers containing UTF-8 strings in a | 6205 ** compare the contents of two buffers containing UTF-8 strings in a |
5757 ** case-indendent fashion, using the same definition of case independence | 6206 ** case-independent fashion, using the same definition of case independence |
5758 ** that SQLite uses internally when comparing identifiers. | 6207 ** that SQLite uses internally when comparing identifiers. |
5759 */ | 6208 */ |
5760 SQLITE_API int sqlite3_strnicmp(const char *, const char *, int); | 6209 SQLITE_API int sqlite3_strnicmp(const char *, const char *, int); |
5761 | 6210 |
5762 /* | 6211 /* |
| 6212 ** CAPI3REF: Error Logging Interface |
| 6213 ** |
| 6214 ** ^The [sqlite3_log()] interface writes a message into the error log |
| 6215 ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. |
| 6216 ** ^If logging is enabled, the zFormat string and subsequent arguments are |
| 6217 ** used with [sqlite3_snprintf()] to generate the final output string. |
| 6218 ** |
| 6219 ** The sqlite3_log() interface is intended for use by extensions such as |
| 6220 ** virtual tables, collating functions, and SQL functions. While there is |
| 6221 ** nothing to prevent an application from calling sqlite3_log(), doing so |
| 6222 ** is considered bad form. |
| 6223 ** |
| 6224 ** The zFormat string must not be NULL. |
| 6225 ** |
| 6226 ** To avoid deadlocks and other threading problems, the sqlite3_log() routine |
| 6227 ** will not use dynamically allocated memory. The log message is stored in |
| 6228 ** a fixed-length buffer on the stack. If the log message is longer than |
| 6229 ** a few hundred characters, it will be truncated to the length of the |
| 6230 ** buffer. |
| 6231 */ |
| 6232 SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...); |
| 6233 |
| 6234 /* |
| 6235 ** CAPI3REF: Write-Ahead Log Commit Hook |
| 6236 ** |
| 6237 ** ^The [sqlite3_wal_hook()] function is used to register a callback that |
| 6238 ** will be invoked each time a database connection commits data to a |
| 6239 ** [write-ahead log] (i.e. whenever a transaction is committed in |
| 6240 ** [journal_mode | journal_mode=WAL mode]). |
| 6241 ** |
| 6242 ** ^The callback is invoked by SQLite after the commit has taken place and |
| 6243 ** the associated write-lock on the database released, so the implementation |
| 6244 ** may read, write or [checkpoint] the database as required. |
| 6245 ** |
| 6246 ** ^The first parameter passed to the callback function when it is invoked |
| 6247 ** is a copy of the third parameter passed to sqlite3_wal_hook() when |
| 6248 ** registering the callback. ^The second is a copy of the database handle. |
| 6249 ** ^The third parameter is the name of the database that was written to - |
| 6250 ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter |
| 6251 ** is the number of pages currently in the write-ahead log file, |
| 6252 ** including those that were just committed. |
| 6253 ** |
| 6254 ** The callback function should normally return [SQLITE_OK]. ^If an error |
| 6255 ** code is returned, that error will propagate back up through the |
| 6256 ** SQLite code base to cause the statement that provoked the callback |
| 6257 ** to report an error, though the commit will have still occurred. If the |
| 6258 ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value |
| 6259 ** that does not correspond to any valid SQLite error code, the results |
| 6260 ** are undefined. |
| 6261 ** |
| 6262 ** A single database handle may have at most a single write-ahead log callback |
| 6263 ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any |
| 6264 ** previously registered write-ahead log callback. ^Note that the |
| 6265 ** [sqlite3_wal_autocheckpoint()] interface and the |
| 6266 ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will |
| 6267 ** those overwrite any prior [sqlite3_wal_hook()] settings. |
| 6268 */ |
| 6269 SQLITE_API void *sqlite3_wal_hook( |
| 6270 sqlite3*, |
| 6271 int(*)(void *,sqlite3*,const char*,int), |
| 6272 void* |
| 6273 ); |
| 6274 |
| 6275 /* |
| 6276 ** CAPI3REF: Configure an auto-checkpoint |
| 6277 ** |
| 6278 ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around |
| 6279 ** [sqlite3_wal_hook()] that causes any database on [database connection] D |
| 6280 ** to automatically [checkpoint] |
| 6281 ** after committing a transaction if there are N or |
| 6282 ** more frames in the [write-ahead log] file. ^Passing zero or |
| 6283 ** a negative value as the nFrame parameter disables automatic |
| 6284 ** checkpoints entirely. |
| 6285 ** |
| 6286 ** ^The callback registered by this function replaces any existing callback |
| 6287 ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback |
| 6288 ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism |
| 6289 ** configured by this function. |
| 6290 ** |
| 6291 ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface |
| 6292 ** from SQL. |
| 6293 ** |
| 6294 ** ^Every new [database connection] defaults to having the auto-checkpoint |
| 6295 ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] |
| 6296 ** pages. The use of this interface |
| 6297 ** is only necessary if the default setting is found to be suboptimal |
| 6298 ** for a particular application. |
| 6299 */ |
| 6300 SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N); |
| 6301 |
| 6302 /* |
| 6303 ** CAPI3REF: Checkpoint a database |
| 6304 ** |
| 6305 ** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X |
| 6306 ** on [database connection] D to be [checkpointed]. ^If X is NULL or an |
| 6307 ** empty string, then a checkpoint is run on all databases of |
| 6308 ** connection D. ^If the database connection D is not in |
| 6309 ** [WAL | write-ahead log mode] then this interface is a harmless no-op. |
| 6310 ** |
| 6311 ** ^The [wal_checkpoint pragma] can be used to invoke this interface |
| 6312 ** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the |
| 6313 ** [wal_autocheckpoint pragma] can be used to cause this interface to be |
| 6314 ** run whenever the WAL reaches a certain size threshold. |
| 6315 ** |
| 6316 ** See also: [sqlite3_wal_checkpoint_v2()] |
| 6317 */ |
| 6318 SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); |
| 6319 |
| 6320 /* |
| 6321 ** CAPI3REF: Checkpoint a database |
| 6322 ** |
| 6323 ** Run a checkpoint operation on WAL database zDb attached to database |
| 6324 ** handle db. The specific operation is determined by the value of the |
| 6325 ** eMode parameter: |
| 6326 ** |
| 6327 ** <dl> |
| 6328 ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> |
| 6329 ** Checkpoint as many frames as possible without waiting for any database |
| 6330 ** readers or writers to finish. Sync the db file if all frames in the log |
| 6331 ** are checkpointed. This mode is the same as calling |
| 6332 ** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked. |
| 6333 ** |
| 6334 ** <dt>SQLITE_CHECKPOINT_FULL<dd> |
| 6335 ** This mode blocks (calls the busy-handler callback) until there is no |
| 6336 ** database writer and all readers are reading from the most recent database |
| 6337 ** snapshot. It then checkpoints all frames in the log file and syncs the |
| 6338 ** database file. This call blocks database writers while it is running, |
| 6339 ** but not database readers. |
| 6340 ** |
| 6341 ** <dt>SQLITE_CHECKPOINT_RESTART<dd> |
| 6342 ** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after |
| 6343 ** checkpointing the log file it blocks (calls the busy-handler callback) |
| 6344 ** until all readers are reading from the database file only. This ensures |
| 6345 ** that the next client to write to the database file restarts the log file |
| 6346 ** from the beginning. This call blocks database writers while it is running, |
| 6347 ** but not database readers. |
| 6348 ** </dl> |
| 6349 ** |
| 6350 ** If pnLog is not NULL, then *pnLog is set to the total number of frames in |
| 6351 ** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to |
| 6352 ** the total number of checkpointed frames (including any that were already |
| 6353 ** checkpointed when this function is called). *pnLog and *pnCkpt may be |
| 6354 ** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK. |
| 6355 ** If no values are available because of an error, they are both set to -1 |
| 6356 ** before returning to communicate this to the caller. |
| 6357 ** |
| 6358 ** All calls obtain an exclusive "checkpoint" lock on the database file. If |
| 6359 ** any other process is running a checkpoint operation at the same time, the |
| 6360 ** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a |
| 6361 ** busy-handler configured, it will not be invoked in this case. |
| 6362 ** |
| 6363 ** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive |
| 6364 ** "writer" lock on the database file. If the writer lock cannot be obtained |
| 6365 ** immediately, and a busy-handler is configured, it is invoked and the writer |
| 6366 ** lock retried until either the busy-handler returns 0 or the lock is |
| 6367 ** successfully obtained. The busy-handler is also invoked while waiting for |
| 6368 ** database readers as described above. If the busy-handler returns 0 before |
| 6369 ** the writer lock is obtained or while waiting for database readers, the |
| 6370 ** checkpoint operation proceeds from that point in the same way as |
| 6371 ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible |
| 6372 ** without blocking any further. SQLITE_BUSY is returned in this case. |
| 6373 ** |
| 6374 ** If parameter zDb is NULL or points to a zero length string, then the |
| 6375 ** specified operation is attempted on all WAL databases. In this case the |
| 6376 ** values written to output parameters *pnLog and *pnCkpt are undefined. If |
| 6377 ** an SQLITE_BUSY error is encountered when processing one or more of the |
| 6378 ** attached WAL databases, the operation is still attempted on any remaining |
| 6379 ** attached databases and SQLITE_BUSY is returned to the caller. If any other |
| 6380 ** error occurs while processing an attached database, processing is abandoned |
| 6381 ** and the error code returned to the caller immediately. If no error |
| 6382 ** (SQLITE_BUSY or otherwise) is encountered while processing the attached |
| 6383 ** databases, SQLITE_OK is returned. |
| 6384 ** |
| 6385 ** If database zDb is the name of an attached database that is not in WAL |
| 6386 ** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. If |
| 6387 ** zDb is not NULL (or a zero length string) and is not the name of any |
| 6388 ** attached database, SQLITE_ERROR is returned to the caller. |
| 6389 */ |
| 6390 SQLITE_API int sqlite3_wal_checkpoint_v2( |
| 6391 sqlite3 *db, /* Database handle */ |
| 6392 const char *zDb, /* Name of attached database (or NULL) */ |
| 6393 int eMode, /* SQLITE_CHECKPOINT_* value */ |
| 6394 int *pnLog, /* OUT: Size of WAL log in frames */ |
| 6395 int *pnCkpt /* OUT: Total number of frames checkpointed */ |
| 6396 ); |
| 6397 |
| 6398 /* |
| 6399 ** CAPI3REF: Checkpoint operation parameters |
| 6400 ** |
| 6401 ** These constants can be used as the 3rd parameter to |
| 6402 ** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()] |
| 6403 ** documentation for additional information about the meaning and use of |
| 6404 ** each of these values. |
| 6405 */ |
| 6406 #define SQLITE_CHECKPOINT_PASSIVE 0 |
| 6407 #define SQLITE_CHECKPOINT_FULL 1 |
| 6408 #define SQLITE_CHECKPOINT_RESTART 2 |
| 6409 |
| 6410 |
| 6411 /* |
5763 ** Undo the hack that converts floating point types to integer for | 6412 ** Undo the hack that converts floating point types to integer for |
5764 ** builds on processors without floating point support. | 6413 ** builds on processors without floating point support. |
5765 */ | 6414 */ |
5766 #ifdef SQLITE_OMIT_FLOATING_POINT | 6415 #ifdef SQLITE_OMIT_FLOATING_POINT |
5767 # undef double | 6416 # undef double |
5768 #endif | 6417 #endif |
5769 | 6418 |
5770 #ifdef __cplusplus | 6419 #ifdef __cplusplus |
5771 } /* End of the 'extern "C"' block */ | 6420 } /* End of the 'extern "C"' block */ |
5772 #endif | 6421 #endif |
5773 #endif | 6422 #endif |
5774 | 6423 |
| 6424 /* |
| 6425 ** 2010 August 30 |
| 6426 ** |
| 6427 ** The author disclaims copyright to this source code. In place of |
| 6428 ** a legal notice, here is a blessing: |
| 6429 ** |
| 6430 ** May you do good and not evil. |
| 6431 ** May you find forgiveness for yourself and forgive others. |
| 6432 ** May you share freely, never taking more than you give. |
| 6433 ** |
| 6434 ************************************************************************* |
| 6435 */ |
| 6436 |
| 6437 #ifndef _SQLITE3RTREE_H_ |
| 6438 #define _SQLITE3RTREE_H_ |
| 6439 |
| 6440 |
| 6441 #ifdef __cplusplus |
| 6442 extern "C" { |
| 6443 #endif |
| 6444 |
| 6445 typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry; |
| 6446 |
| 6447 /* |
| 6448 ** Register a geometry callback named zGeom that can be used as part of an |
| 6449 ** R-Tree geometry query as follows: |
| 6450 ** |
| 6451 ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...) |
| 6452 */ |
| 6453 SQLITE_API int sqlite3_rtree_geometry_callback( |
| 6454 sqlite3 *db, |
| 6455 const char *zGeom, |
| 6456 int (*xGeom)(sqlite3_rtree_geometry *, int nCoord, double *aCoord, int *pRes), |
| 6457 void *pContext |
| 6458 ); |
| 6459 |
| 6460 |
| 6461 /* |
| 6462 ** A pointer to a structure of the following type is passed as the first |
| 6463 ** argument to callbacks registered using rtree_geometry_callback(). |
| 6464 */ |
| 6465 struct sqlite3_rtree_geometry { |
| 6466 void *pContext; /* Copy of pContext passed to s_r_g_c() */ |
| 6467 int nParam; /* Size of array aParam[] */ |
| 6468 double *aParam; /* Parameters passed to SQL geom function */ |
| 6469 void *pUser; /* Callback implementation user data */ |
| 6470 void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */ |
| 6471 }; |
| 6472 |
| 6473 |
| 6474 #ifdef __cplusplus |
| 6475 } /* end of the 'extern "C"' block */ |
| 6476 #endif |
| 6477 |
| 6478 #endif /* ifndef _SQLITE3RTREE_H_ */ |
| 6479 |
OLD | NEW |