Révision | 548cc2cec760edb19d8fe81edab263e5d51dbb26 (tree) |
---|---|
l'heure | 2012-11-19 00:04:48 |
Auteur | shom5xg <shom@.(no...> |
Commiter | shom5xg |
Add the libraries for SQLite
@@ -0,0 +1,2 @@ | ||
1 | +"C:\Program Files\Microsoft Visual Studio 10.0\VC\bin\lib.exe" /def:sqlite3.def /machine:x86 | |
2 | +pause | |
\ No newline at end of file |
@@ -0,0 +1,207 @@ | ||
1 | +EXPORTS | |
2 | +sqlite3_aggregate_context | |
3 | +sqlite3_aggregate_count | |
4 | +sqlite3_auto_extension | |
5 | +sqlite3_backup_finish | |
6 | +sqlite3_backup_init | |
7 | +sqlite3_backup_pagecount | |
8 | +sqlite3_backup_remaining | |
9 | +sqlite3_backup_step | |
10 | +sqlite3_bind_blob | |
11 | +sqlite3_bind_double | |
12 | +sqlite3_bind_int | |
13 | +sqlite3_bind_int64 | |
14 | +sqlite3_bind_null | |
15 | +sqlite3_bind_parameter_count | |
16 | +sqlite3_bind_parameter_index | |
17 | +sqlite3_bind_parameter_name | |
18 | +sqlite3_bind_text | |
19 | +sqlite3_bind_text16 | |
20 | +sqlite3_bind_value | |
21 | +sqlite3_bind_zeroblob | |
22 | +sqlite3_blob_bytes | |
23 | +sqlite3_blob_close | |
24 | +sqlite3_blob_open | |
25 | +sqlite3_blob_read | |
26 | +sqlite3_blob_reopen | |
27 | +sqlite3_blob_write | |
28 | +sqlite3_busy_handler | |
29 | +sqlite3_busy_timeout | |
30 | +sqlite3_changes | |
31 | +sqlite3_clear_bindings | |
32 | +sqlite3_close | |
33 | +sqlite3_close_v2 | |
34 | +sqlite3_collation_needed | |
35 | +sqlite3_collation_needed16 | |
36 | +sqlite3_column_blob | |
37 | +sqlite3_column_bytes | |
38 | +sqlite3_column_bytes16 | |
39 | +sqlite3_column_count | |
40 | +sqlite3_column_database_name | |
41 | +sqlite3_column_database_name16 | |
42 | +sqlite3_column_decltype | |
43 | +sqlite3_column_decltype16 | |
44 | +sqlite3_column_double | |
45 | +sqlite3_column_int | |
46 | +sqlite3_column_int64 | |
47 | +sqlite3_column_name | |
48 | +sqlite3_column_name16 | |
49 | +sqlite3_column_origin_name | |
50 | +sqlite3_column_origin_name16 | |
51 | +sqlite3_column_table_name | |
52 | +sqlite3_column_table_name16 | |
53 | +sqlite3_column_text | |
54 | +sqlite3_column_text16 | |
55 | +sqlite3_column_type | |
56 | +sqlite3_column_value | |
57 | +sqlite3_commit_hook | |
58 | +sqlite3_compileoption_get | |
59 | +sqlite3_compileoption_used | |
60 | +sqlite3_complete | |
61 | +sqlite3_complete16 | |
62 | +sqlite3_config | |
63 | +sqlite3_context_db_handle | |
64 | +sqlite3_create_collation | |
65 | +sqlite3_create_collation16 | |
66 | +sqlite3_create_collation_v2 | |
67 | +sqlite3_create_function | |
68 | +sqlite3_create_function16 | |
69 | +sqlite3_create_function_v2 | |
70 | +sqlite3_create_module | |
71 | +sqlite3_create_module_v2 | |
72 | +sqlite3_data_count | |
73 | +sqlite3_db_config | |
74 | +sqlite3_db_filename | |
75 | +sqlite3_db_handle | |
76 | +sqlite3_db_mutex | |
77 | +sqlite3_db_readonly | |
78 | +sqlite3_db_release_memory | |
79 | +sqlite3_db_status | |
80 | +sqlite3_declare_vtab | |
81 | +sqlite3_enable_load_extension | |
82 | +sqlite3_enable_shared_cache | |
83 | +sqlite3_errcode | |
84 | +sqlite3_errmsg | |
85 | +sqlite3_errmsg16 | |
86 | +sqlite3_exec | |
87 | +sqlite3_expired | |
88 | +sqlite3_extended_errcode | |
89 | +sqlite3_extended_result_codes | |
90 | +sqlite3_file_control | |
91 | +sqlite3_finalize | |
92 | +sqlite3_free | |
93 | +sqlite3_free_table | |
94 | +sqlite3_get_autocommit | |
95 | +sqlite3_get_auxdata | |
96 | +sqlite3_get_table | |
97 | +sqlite3_global_recover | |
98 | +sqlite3_initialize | |
99 | +sqlite3_interrupt | |
100 | +sqlite3_last_insert_rowid | |
101 | +sqlite3_libversion | |
102 | +sqlite3_libversion_number | |
103 | +sqlite3_limit | |
104 | +sqlite3_load_extension | |
105 | +sqlite3_log | |
106 | +sqlite3_malloc | |
107 | +sqlite3_memory_alarm | |
108 | +sqlite3_memory_highwater | |
109 | +sqlite3_memory_used | |
110 | +sqlite3_mprintf | |
111 | +sqlite3_mutex_alloc | |
112 | +sqlite3_mutex_enter | |
113 | +sqlite3_mutex_free | |
114 | +sqlite3_mutex_leave | |
115 | +sqlite3_mutex_try | |
116 | +sqlite3_next_stmt | |
117 | +sqlite3_open | |
118 | +sqlite3_open16 | |
119 | +sqlite3_open_v2 | |
120 | +sqlite3_os_end | |
121 | +sqlite3_os_init | |
122 | +sqlite3_overload_function | |
123 | +sqlite3_prepare | |
124 | +sqlite3_prepare16 | |
125 | +sqlite3_prepare16_v2 | |
126 | +sqlite3_prepare_v2 | |
127 | +sqlite3_profile | |
128 | +sqlite3_progress_handler | |
129 | +sqlite3_randomness | |
130 | +sqlite3_realloc | |
131 | +sqlite3_release_memory | |
132 | +sqlite3_reset | |
133 | +sqlite3_reset_auto_extension | |
134 | +sqlite3_result_blob | |
135 | +sqlite3_result_double | |
136 | +sqlite3_result_error | |
137 | +sqlite3_result_error16 | |
138 | +sqlite3_result_error_code | |
139 | +sqlite3_result_error_nomem | |
140 | +sqlite3_result_error_toobig | |
141 | +sqlite3_result_int | |
142 | +sqlite3_result_int64 | |
143 | +sqlite3_result_null | |
144 | +sqlite3_result_text | |
145 | +sqlite3_result_text16 | |
146 | +sqlite3_result_text16be | |
147 | +sqlite3_result_text16le | |
148 | +sqlite3_result_value | |
149 | +sqlite3_result_zeroblob | |
150 | +sqlite3_rollback_hook | |
151 | +sqlite3_rtree_geometry_callback | |
152 | +sqlite3_set_authorizer | |
153 | +sqlite3_set_auxdata | |
154 | +sqlite3_shutdown | |
155 | +sqlite3_sleep | |
156 | +sqlite3_snprintf | |
157 | +sqlite3_soft_heap_limit | |
158 | +sqlite3_soft_heap_limit64 | |
159 | +sqlite3_sourceid | |
160 | +sqlite3_sql | |
161 | +sqlite3_status | |
162 | +sqlite3_step | |
163 | +sqlite3_stmt_busy | |
164 | +sqlite3_stmt_readonly | |
165 | +sqlite3_stmt_status | |
166 | +sqlite3_stricmp | |
167 | +sqlite3_strnicmp | |
168 | +sqlite3_table_column_metadata | |
169 | +sqlite3_test_control | |
170 | +sqlite3_thread_cleanup | |
171 | +sqlite3_threadsafe | |
172 | +sqlite3_total_changes | |
173 | +sqlite3_trace | |
174 | +sqlite3_transfer_bindings | |
175 | +sqlite3_update_hook | |
176 | +sqlite3_uri_boolean | |
177 | +sqlite3_uri_int64 | |
178 | +sqlite3_uri_parameter | |
179 | +sqlite3_user_data | |
180 | +sqlite3_value_blob | |
181 | +sqlite3_value_bytes | |
182 | +sqlite3_value_bytes16 | |
183 | +sqlite3_value_double | |
184 | +sqlite3_value_int | |
185 | +sqlite3_value_int64 | |
186 | +sqlite3_value_numeric_type | |
187 | +sqlite3_value_text | |
188 | +sqlite3_value_text16 | |
189 | +sqlite3_value_text16be | |
190 | +sqlite3_value_text16le | |
191 | +sqlite3_value_type | |
192 | +sqlite3_vfs_find | |
193 | +sqlite3_vfs_register | |
194 | +sqlite3_vfs_unregister | |
195 | +sqlite3_vmprintf | |
196 | +sqlite3_vsnprintf | |
197 | +sqlite3_vtab_config | |
198 | +sqlite3_vtab_on_conflict | |
199 | +sqlite3_wal_autocheckpoint | |
200 | +sqlite3_wal_checkpoint | |
201 | +sqlite3_wal_checkpoint_v2 | |
202 | +sqlite3_wal_hook | |
203 | +sqlite3_win32_mbcs_to_utf8 | |
204 | +sqlite3_win32_set_directory | |
205 | +sqlite3_win32_sleep | |
206 | +sqlite3_win32_utf8_to_mbcs | |
207 | +sqlite3_win32_write_debug |
@@ -0,0 +1,7097 @@ | ||
1 | +/* | |
2 | +** 2001 September 15 | |
3 | +** | |
4 | +** The author disclaims copyright to this source code. In place of | |
5 | +** a legal notice, here is a blessing: | |
6 | +** | |
7 | +** May you do good and not evil. | |
8 | +** May you find forgiveness for yourself and forgive others. | |
9 | +** May you share freely, never taking more than you give. | |
10 | +** | |
11 | +************************************************************************* | |
12 | +** This header file defines the interface that the SQLite library | |
13 | +** presents to client programs. If a C-function, structure, datatype, | |
14 | +** or constant definition does not appear in this file, then it is | |
15 | +** not a published API of SQLite, is subject to change without | |
16 | +** notice, and should not be referenced by programs that use SQLite. | |
17 | +** | |
18 | +** Some of the definitions that are in this file are marked as | |
19 | +** "experimental". Experimental interfaces are normally new | |
20 | +** features recently added to SQLite. We do not anticipate changes | |
21 | +** to experimental interfaces but reserve the right to make minor changes | |
22 | +** if experience from use "in the wild" suggest such changes are prudent. | |
23 | +** | |
24 | +** The official C-language API documentation for SQLite is derived | |
25 | +** from comments in this file. This file is the authoritative source | |
26 | +** on how SQLite interfaces are suppose to operate. | |
27 | +** | |
28 | +** The name of this file under configuration management is "sqlite.h.in". | |
29 | +** The makefile makes some minor changes to this file (such as inserting | |
30 | +** the version number) and changes its name to "sqlite3.h" as | |
31 | +** part of the build process. | |
32 | +*/ | |
33 | +#ifndef _SQLITE3_H_ | |
34 | +#define _SQLITE3_H_ | |
35 | +#include <stdarg.h> /* Needed for the definition of va_list */ | |
36 | + | |
37 | +/* | |
38 | +** Make sure we can call this stuff from C++. | |
39 | +*/ | |
40 | +#ifdef __cplusplus | |
41 | +extern "C" { | |
42 | +#endif | |
43 | + | |
44 | + | |
45 | +/* | |
46 | +** Add the ability to override 'extern' | |
47 | +*/ | |
48 | +#ifndef SQLITE_EXTERN | |
49 | +# define SQLITE_EXTERN extern | |
50 | +#endif | |
51 | + | |
52 | +#ifndef SQLITE_API | |
53 | +# define SQLITE_API | |
54 | +#endif | |
55 | + | |
56 | + | |
57 | +/* | |
58 | +** These no-op macros are used in front of interfaces to mark those | |
59 | +** interfaces as either deprecated or experimental. New applications | |
60 | +** should not use deprecated interfaces - they are support for backwards | |
61 | +** compatibility only. Application writers should be aware that | |
62 | +** experimental interfaces are subject to change in point releases. | |
63 | +** | |
64 | +** These macros used to resolve to various kinds of compiler magic that | |
65 | +** would generate warning messages when they were used. But that | |
66 | +** compiler magic ended up generating such a flurry of bug reports | |
67 | +** that we have taken it all out and gone back to using simple | |
68 | +** noop macros. | |
69 | +*/ | |
70 | +#define SQLITE_DEPRECATED | |
71 | +#define SQLITE_EXPERIMENTAL | |
72 | + | |
73 | +/* | |
74 | +** Ensure these symbols were not defined by some previous header file. | |
75 | +*/ | |
76 | +#ifdef SQLITE_VERSION | |
77 | +# undef SQLITE_VERSION | |
78 | +#endif | |
79 | +#ifdef SQLITE_VERSION_NUMBER | |
80 | +# undef SQLITE_VERSION_NUMBER | |
81 | +#endif | |
82 | + | |
83 | +/* | |
84 | +** CAPI3REF: Compile-Time Library Version Numbers | |
85 | +** | |
86 | +** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header | |
87 | +** evaluates to a string literal that is the SQLite version in the | |
88 | +** format "X.Y.Z" where X is the major version number (always 3 for | |
89 | +** SQLite3) and Y is the minor version number and Z is the release number.)^ | |
90 | +** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer | |
91 | +** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same | |
92 | +** numbers used in [SQLITE_VERSION].)^ | |
93 | +** The SQLITE_VERSION_NUMBER for any given release of SQLite will also | |
94 | +** be larger than the release from which it is derived. Either Y will | |
95 | +** be held constant and Z will be incremented or else Y will be incremented | |
96 | +** and Z will be reset to zero. | |
97 | +** | |
98 | +** Since version 3.6.18, SQLite source code has been stored in the | |
99 | +** <a href="http://www.fossil-scm.org/">Fossil configuration management | |
100 | +** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to | |
101 | +** a string which identifies a particular check-in of SQLite | |
102 | +** within its configuration management system. ^The SQLITE_SOURCE_ID | |
103 | +** string contains the date and time of the check-in (UTC) and an SHA1 | |
104 | +** hash of the entire source tree. | |
105 | +** | |
106 | +** See also: [sqlite3_libversion()], | |
107 | +** [sqlite3_libversion_number()], [sqlite3_sourceid()], | |
108 | +** [sqlite_version()] and [sqlite_source_id()]. | |
109 | +*/ | |
110 | +#define SQLITE_VERSION "3.7.14.1" | |
111 | +#define SQLITE_VERSION_NUMBER 3007014 | |
112 | +#define SQLITE_SOURCE_ID "2012-10-04 19:37:12 091570e46d04e84b67228e0bdbcd6e1fb60c6bdb" | |
113 | + | |
114 | +/* | |
115 | +** CAPI3REF: Run-Time Library Version Numbers | |
116 | +** KEYWORDS: sqlite3_version, sqlite3_sourceid | |
117 | +** | |
118 | +** These interfaces provide the same information as the [SQLITE_VERSION], | |
119 | +** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros | |
120 | +** but are associated with the library instead of the header file. ^(Cautious | |
121 | +** programmers might include assert() statements in their application to | |
122 | +** verify that values returned by these interfaces match the macros in | |
123 | +** the header, and thus insure that the application is | |
124 | +** compiled with matching library and header files. | |
125 | +** | |
126 | +** <blockquote><pre> | |
127 | +** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); | |
128 | +** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 ); | |
129 | +** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 ); | |
130 | +** </pre></blockquote>)^ | |
131 | +** | |
132 | +** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION] | |
133 | +** macro. ^The sqlite3_libversion() function returns a pointer to the | |
134 | +** to the sqlite3_version[] string constant. The sqlite3_libversion() | |
135 | +** function is provided for use in DLLs since DLL users usually do not have | |
136 | +** direct access to string constants within the DLL. ^The | |
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. | |
141 | +** | |
142 | +** See also: [sqlite_version()] and [sqlite_source_id()]. | |
143 | +*/ | |
144 | +SQLITE_API SQLITE_EXTERN const char sqlite3_version[]; | |
145 | +SQLITE_API const char *sqlite3_libversion(void); | |
146 | +SQLITE_API const char *sqlite3_sourceid(void); | |
147 | +SQLITE_API int sqlite3_libversion_number(void); | |
148 | + | |
149 | +/* | |
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 with mutexing code omitted due to the | |
181 | +** [SQLITE_THREADSAFE] compile-time option being set to 0. | |
182 | +** | |
183 | +** SQLite can be compiled with or without mutexes. When | |
184 | +** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes | |
185 | +** are enabled and SQLite is threadsafe. When the | |
186 | +** [SQLITE_THREADSAFE] macro is 0, | |
187 | +** the mutexes are omitted. Without the mutexes, it is not safe | |
188 | +** to use SQLite concurrently from more than one thread. | |
189 | +** | |
190 | +** Enabling mutexes incurs a measurable performance penalty. | |
191 | +** So if speed is of utmost importance, it makes sense to disable | |
192 | +** the mutexes. But for maximum safety, mutexes should be enabled. | |
193 | +** ^The default behavior is for mutexes to be enabled. | |
194 | +** | |
195 | +** This interface can be used by an application to make sure that the | |
196 | +** version of SQLite that it is linking against was compiled with | |
197 | +** the desired setting of the [SQLITE_THREADSAFE] macro. | |
198 | +** | |
199 | +** This interface only reports on the compile-time mutex setting | |
200 | +** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with | |
201 | +** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but | |
202 | +** can be fully or partially disabled using a call to [sqlite3_config()] | |
203 | +** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], | |
204 | +** or [SQLITE_CONFIG_MUTEX]. ^(The return value of the | |
205 | +** sqlite3_threadsafe() function shows only the compile-time setting of | |
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().)^ | |
209 | +** | |
210 | +** See the [threading mode] documentation for additional information. | |
211 | +*/ | |
212 | +SQLITE_API int sqlite3_threadsafe(void); | |
213 | + | |
214 | +/* | |
215 | +** CAPI3REF: Database Connection Handle | |
216 | +** KEYWORDS: {database connection} {database connections} | |
217 | +** | |
218 | +** Each open SQLite database is represented by a pointer to an instance of | |
219 | +** the opaque structure named "sqlite3". It is useful to think of an sqlite3 | |
220 | +** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and | |
221 | +** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] | |
222 | +** and [sqlite3_close_v2()] are its destructors. There are many other | |
223 | +** interfaces (such as | |
224 | +** [sqlite3_prepare_v2()], [sqlite3_create_function()], and | |
225 | +** [sqlite3_busy_timeout()] to name but three) that are methods on an | |
226 | +** sqlite3 object. | |
227 | +*/ | |
228 | +typedef struct sqlite3 sqlite3; | |
229 | + | |
230 | +/* | |
231 | +** CAPI3REF: 64-Bit Integer Types | |
232 | +** KEYWORDS: sqlite_int64 sqlite_uint64 | |
233 | +** | |
234 | +** Because there is no cross-platform way to specify 64-bit integer types | |
235 | +** SQLite includes typedefs for 64-bit signed and unsigned integers. | |
236 | +** | |
237 | +** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. | |
238 | +** The sqlite_int64 and sqlite_uint64 types are supported for backwards | |
239 | +** compatibility only. | |
240 | +** | |
241 | +** ^The sqlite3_int64 and sqlite_int64 types can store integer values | |
242 | +** between -9223372036854775808 and +9223372036854775807 inclusive. ^The | |
243 | +** sqlite3_uint64 and sqlite_uint64 types can store integer values | |
244 | +** between 0 and +18446744073709551615 inclusive. | |
245 | +*/ | |
246 | +#ifdef SQLITE_INT64_TYPE | |
247 | + typedef SQLITE_INT64_TYPE sqlite_int64; | |
248 | + typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; | |
249 | +#elif defined(_MSC_VER) || defined(__BORLANDC__) | |
250 | + typedef __int64 sqlite_int64; | |
251 | + typedef unsigned __int64 sqlite_uint64; | |
252 | +#else | |
253 | + typedef long long int sqlite_int64; | |
254 | + typedef unsigned long long int sqlite_uint64; | |
255 | +#endif | |
256 | +typedef sqlite_int64 sqlite3_int64; | |
257 | +typedef sqlite_uint64 sqlite3_uint64; | |
258 | + | |
259 | +/* | |
260 | +** If compiling for a processor that lacks floating point support, | |
261 | +** substitute integer for floating-point. | |
262 | +*/ | |
263 | +#ifdef SQLITE_OMIT_FLOATING_POINT | |
264 | +# define double sqlite3_int64 | |
265 | +#endif | |
266 | + | |
267 | +/* | |
268 | +** CAPI3REF: Closing A Database Connection | |
269 | +** | |
270 | +** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors | |
271 | +** for the [sqlite3] object. | |
272 | +** ^Calls to sqlite3_close() and sqlite3_close_v2() return SQLITE_OK if | |
273 | +** the [sqlite3] object is successfully destroyed and all associated | |
274 | +** resources are deallocated. | |
275 | +** | |
276 | +** ^If the database connection is associated with unfinalized prepared | |
277 | +** statements or unfinished sqlite3_backup objects then sqlite3_close() | |
278 | +** will leave the database connection open and return [SQLITE_BUSY]. | |
279 | +** ^If sqlite3_close_v2() is called with unfinalized prepared statements | |
280 | +** and unfinished sqlite3_backups, then the database connection becomes | |
281 | +** an unusable "zombie" which will automatically be deallocated when the | |
282 | +** last prepared statement is finalized or the last sqlite3_backup is | |
283 | +** finished. The sqlite3_close_v2() interface is intended for use with | |
284 | +** host languages that are garbage collected, and where the order in which | |
285 | +** destructors are called is arbitrary. | |
286 | +** | |
287 | +** Applications should [sqlite3_finalize | finalize] all [prepared statements], | |
288 | +** [sqlite3_blob_close | close] all [BLOB handles], and | |
289 | +** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated | |
290 | +** with the [sqlite3] object prior to attempting to close the object. ^If | |
291 | +** sqlite3_close() is called on a [database connection] that still has | |
292 | +** outstanding [prepared statements], [BLOB handles], and/or | |
293 | +** [sqlite3_backup] objects then it returns SQLITE_OK but the deallocation | |
294 | +** of resources is deferred until all [prepared statements], [BLOB handles], | |
295 | +** and [sqlite3_backup] objects are also destroyed. | |
296 | +** | |
297 | +** ^If an [sqlite3] object is destroyed while a transaction is open, | |
298 | +** the transaction is automatically rolled back. | |
299 | +** | |
300 | +** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)] | |
301 | +** must be either a NULL | |
302 | +** pointer or an [sqlite3] object pointer obtained | |
303 | +** from [sqlite3_open()], [sqlite3_open16()], or | |
304 | +** [sqlite3_open_v2()], and not previously closed. | |
305 | +** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer | |
306 | +** argument is a harmless no-op. | |
307 | +*/ | |
308 | +SQLITE_API int sqlite3_close(sqlite3*); | |
309 | +SQLITE_API int sqlite3_close_v2(sqlite3*); | |
310 | + | |
311 | +/* | |
312 | +** The type for a callback function. | |
313 | +** This is legacy and deprecated. It is included for historical | |
314 | +** compatibility and is not documented. | |
315 | +*/ | |
316 | +typedef int (*sqlite3_callback)(void*,int,char**, char**); | |
317 | + | |
318 | +/* | |
319 | +** CAPI3REF: One-Step Query Execution Interface | |
320 | +** | |
321 | +** The sqlite3_exec() interface is a convenience wrapper around | |
322 | +** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], | |
323 | +** that allows an application to run multiple statements of SQL | |
324 | +** without having to use a lot of C code. | |
325 | +** | |
326 | +** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, | |
327 | +** semicolon-separate SQL statements passed into its 2nd argument, | |
328 | +** in the context of the [database connection] passed in as its 1st | |
329 | +** argument. ^If the callback function of the 3rd argument to | |
330 | +** sqlite3_exec() is not NULL, then it is invoked for each result row | |
331 | +** coming out of the evaluated SQL statements. ^The 4th argument to | |
332 | +** sqlite3_exec() is relayed through to the 1st argument of each | |
333 | +** callback invocation. ^If the callback pointer to sqlite3_exec() | |
334 | +** is NULL, then no callback is ever invoked and result rows are | |
335 | +** ignored. | |
336 | +** | |
337 | +** ^If an error occurs while evaluating the SQL statements passed into | |
338 | +** sqlite3_exec(), then execution of the current statement stops and | |
339 | +** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec() | |
340 | +** is not NULL then any error message is written into memory obtained | |
341 | +** from [sqlite3_malloc()] and passed back through the 5th parameter. | |
342 | +** To avoid memory leaks, the application should invoke [sqlite3_free()] | |
343 | +** on error message strings returned through the 5th parameter of | |
344 | +** of sqlite3_exec() after the error message string is no longer needed. | |
345 | +** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors | |
346 | +** occur, then sqlite3_exec() sets the pointer in its 5th parameter to | |
347 | +** NULL before returning. | |
348 | +** | |
349 | +** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec() | |
350 | +** routine returns SQLITE_ABORT without invoking the callback again and | |
351 | +** without running any subsequent SQL statements. | |
352 | +** | |
353 | +** ^The 2nd argument to the sqlite3_exec() callback function is the | |
354 | +** number of columns in the result. ^The 3rd argument to the sqlite3_exec() | |
355 | +** callback is an array of pointers to strings obtained as if from | |
356 | +** [sqlite3_column_text()], one for each column. ^If an element of a | |
357 | +** result row is NULL then the corresponding string pointer for the | |
358 | +** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the | |
359 | +** sqlite3_exec() callback is an array of pointers to strings where each | |
360 | +** entry represents the name of corresponding result column as obtained | |
361 | +** from [sqlite3_column_name()]. | |
362 | +** | |
363 | +** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer | |
364 | +** to an empty string, or a pointer that contains only whitespace and/or | |
365 | +** SQL comments, then no SQL statements are evaluated and the database | |
366 | +** is not changed. | |
367 | +** | |
368 | +** Restrictions: | |
369 | +** | |
370 | +** <ul> | |
371 | +** <li> The application must insure that the 1st parameter to sqlite3_exec() | |
372 | +** is a valid and open [database connection]. | |
373 | +** <li> The application must not close [database connection] specified by | |
374 | +** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. | |
375 | +** <li> The application must not modify the SQL statement text passed into | |
376 | +** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. | |
377 | +** </ul> | |
378 | +*/ | |
379 | +SQLITE_API int sqlite3_exec( | |
380 | + sqlite3*, /* An open database */ | |
381 | + const char *sql, /* SQL to be evaluated */ | |
382 | + int (*callback)(void*,int,char**,char**), /* Callback function */ | |
383 | + void *, /* 1st argument to callback */ | |
384 | + char **errmsg /* Error msg written here */ | |
385 | +); | |
386 | + | |
387 | +/* | |
388 | +** CAPI3REF: Result Codes | |
389 | +** KEYWORDS: SQLITE_OK {error code} {error codes} | |
390 | +** KEYWORDS: {result code} {result codes} | |
391 | +** | |
392 | +** Many SQLite functions return an integer result code from the set shown | |
393 | +** here in order to indicate success or failure. | |
394 | +** | |
395 | +** New error codes may be added in future versions of SQLite. | |
396 | +** | |
397 | +** See also: [SQLITE_IOERR_READ | extended result codes], | |
398 | +** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes]. | |
399 | +*/ | |
400 | +#define SQLITE_OK 0 /* Successful result */ | |
401 | +/* beginning-of-error-codes */ | |
402 | +#define SQLITE_ERROR 1 /* SQL error or missing database */ | |
403 | +#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ | |
404 | +#define SQLITE_PERM 3 /* Access permission denied */ | |
405 | +#define SQLITE_ABORT 4 /* Callback routine requested an abort */ | |
406 | +#define SQLITE_BUSY 5 /* The database file is locked */ | |
407 | +#define SQLITE_LOCKED 6 /* A table in the database is locked */ | |
408 | +#define SQLITE_NOMEM 7 /* A malloc() failed */ | |
409 | +#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ | |
410 | +#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ | |
411 | +#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ | |
412 | +#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ | |
413 | +#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */ | |
414 | +#define SQLITE_FULL 13 /* Insertion failed because database is full */ | |
415 | +#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ | |
416 | +#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ | |
417 | +#define SQLITE_EMPTY 16 /* Database is empty */ | |
418 | +#define SQLITE_SCHEMA 17 /* The database schema changed */ | |
419 | +#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ | |
420 | +#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ | |
421 | +#define SQLITE_MISMATCH 20 /* Data type mismatch */ | |
422 | +#define SQLITE_MISUSE 21 /* Library used incorrectly */ | |
423 | +#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ | |
424 | +#define SQLITE_AUTH 23 /* Authorization denied */ | |
425 | +#define SQLITE_FORMAT 24 /* Auxiliary database format error */ | |
426 | +#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ | |
427 | +#define SQLITE_NOTADB 26 /* File opened that is not a database file */ | |
428 | +#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ | |
429 | +#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ | |
430 | +/* end-of-error-codes */ | |
431 | + | |
432 | +/* | |
433 | +** CAPI3REF: Extended Result Codes | |
434 | +** KEYWORDS: {extended error code} {extended error codes} | |
435 | +** KEYWORDS: {extended result code} {extended result codes} | |
436 | +** | |
437 | +** In its default configuration, SQLite API routines return one of 26 integer | |
438 | +** [SQLITE_OK | result codes]. However, experience has shown that many of | |
439 | +** these result codes are too coarse-grained. They do not provide as | |
440 | +** much information about problems as programmers might like. In an effort to | |
441 | +** address this, newer versions of SQLite (version 3.3.8 and later) include | |
442 | +** support for additional result codes that provide more detailed information | |
443 | +** about errors. The extended result codes are enabled or disabled | |
444 | +** on a per database connection basis using the | |
445 | +** [sqlite3_extended_result_codes()] API. | |
446 | +** | |
447 | +** Some of the available extended result codes are listed here. | |
448 | +** One may expect the number of extended result codes will be expand | |
449 | +** over time. Software that uses extended result codes should expect | |
450 | +** to see new result codes in future releases of SQLite. | |
451 | +** | |
452 | +** The SQLITE_OK result code will never be extended. It will always | |
453 | +** be exactly zero. | |
454 | +*/ | |
455 | +#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) | |
456 | +#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) | |
457 | +#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) | |
458 | +#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) | |
459 | +#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) | |
460 | +#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) | |
461 | +#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) | |
462 | +#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) | |
463 | +#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) | |
464 | +#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) | |
465 | +#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) | |
466 | +#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) | |
467 | +#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) | |
468 | +#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) | |
469 | +#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) | |
470 | +#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) | |
471 | +#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) | |
472 | +#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) | |
473 | +#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) | |
474 | +#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) | |
475 | +#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) | |
476 | +#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) | |
477 | +#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) | |
478 | +#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) | |
479 | +#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) | |
480 | +#define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8)) | |
481 | +#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) | |
482 | +#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) | |
483 | +#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) | |
484 | +#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8)) | |
485 | + | |
486 | +/* | |
487 | +** CAPI3REF: Flags For File Open Operations | |
488 | +** | |
489 | +** These bit values are intended for use in the | |
490 | +** 3rd parameter to the [sqlite3_open_v2()] interface and | |
491 | +** in the 4th parameter to the [sqlite3_vfs.xOpen] method. | |
492 | +*/ | |
493 | +#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ | |
494 | +#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ | |
495 | +#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ | |
496 | +#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ | |
497 | +#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ | |
498 | +#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ | |
499 | +#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ | |
500 | +#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */ | |
501 | +#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ | |
502 | +#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ | |
503 | +#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ | |
504 | +#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ | |
505 | +#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ | |
506 | +#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ | |
507 | +#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ | |
508 | +#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ | |
509 | +#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ | |
510 | +#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ | |
511 | +#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ | |
512 | +#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ | |
513 | + | |
514 | +/* Reserved: 0x00F00000 */ | |
515 | + | |
516 | +/* | |
517 | +** CAPI3REF: Device Characteristics | |
518 | +** | |
519 | +** The xDeviceCharacteristics method of the [sqlite3_io_methods] | |
520 | +** object returns an integer which is a vector of these | |
521 | +** bit values expressing I/O characteristics of the mass storage | |
522 | +** device that holds the file that the [sqlite3_io_methods] | |
523 | +** refers to. | |
524 | +** | |
525 | +** The SQLITE_IOCAP_ATOMIC property means that all writes of | |
526 | +** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values | |
527 | +** mean that writes of blocks that are nnn bytes in size and | |
528 | +** are aligned to an address which is an integer multiple of | |
529 | +** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means | |
530 | +** that when data is appended to a file, the data is appended | |
531 | +** first then the size of the file is extended, never the other | |
532 | +** way around. The SQLITE_IOCAP_SEQUENTIAL property means that | |
533 | +** information is written to disk in the same order as calls | |
534 | +** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that | |
535 | +** after reboot following a crash or power loss, the only bytes in a | |
536 | +** file that were written at the application level might have changed | |
537 | +** and that adjacent bytes, even bytes within the same sector are | |
538 | +** guaranteed to be unchanged. | |
539 | +*/ | |
540 | +#define SQLITE_IOCAP_ATOMIC 0x00000001 | |
541 | +#define SQLITE_IOCAP_ATOMIC512 0x00000002 | |
542 | +#define SQLITE_IOCAP_ATOMIC1K 0x00000004 | |
543 | +#define SQLITE_IOCAP_ATOMIC2K 0x00000008 | |
544 | +#define SQLITE_IOCAP_ATOMIC4K 0x00000010 | |
545 | +#define SQLITE_IOCAP_ATOMIC8K 0x00000020 | |
546 | +#define SQLITE_IOCAP_ATOMIC16K 0x00000040 | |
547 | +#define SQLITE_IOCAP_ATOMIC32K 0x00000080 | |
548 | +#define SQLITE_IOCAP_ATOMIC64K 0x00000100 | |
549 | +#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 | |
550 | +#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 | |
551 | +#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 | |
552 | +#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 | |
553 | + | |
554 | +/* | |
555 | +** CAPI3REF: File Locking Levels | |
556 | +** | |
557 | +** SQLite uses one of these integer values as the second | |
558 | +** argument to calls it makes to the xLock() and xUnlock() methods | |
559 | +** of an [sqlite3_io_methods] object. | |
560 | +*/ | |
561 | +#define SQLITE_LOCK_NONE 0 | |
562 | +#define SQLITE_LOCK_SHARED 1 | |
563 | +#define SQLITE_LOCK_RESERVED 2 | |
564 | +#define SQLITE_LOCK_PENDING 3 | |
565 | +#define SQLITE_LOCK_EXCLUSIVE 4 | |
566 | + | |
567 | +/* | |
568 | +** CAPI3REF: Synchronization Type Flags | |
569 | +** | |
570 | +** When SQLite invokes the xSync() method of an | |
571 | +** [sqlite3_io_methods] object it uses a combination of | |
572 | +** these integer values as the second argument. | |
573 | +** | |
574 | +** When the SQLITE_SYNC_DATAONLY flag is used, it means that the | |
575 | +** sync operation only needs to flush data to mass storage. Inode | |
576 | +** information need not be flushed. If the lower four bits of the flag | |
577 | +** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. | |
578 | +** If the lower four bits equal SQLITE_SYNC_FULL, that means | |
579 | +** to use Mac OS X style fullsync instead of fsync(). | |
580 | +** | |
581 | +** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags | |
582 | +** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL | |
583 | +** settings. The [synchronous pragma] determines when calls to the | |
584 | +** xSync VFS method occur and applies uniformly across all platforms. | |
585 | +** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how | |
586 | +** energetic or rigorous or forceful the sync operations are and | |
587 | +** only make a difference on Mac OSX for the default SQLite code. | |
588 | +** (Third-party VFS implementations might also make the distinction | |
589 | +** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the | |
590 | +** operating systems natively supported by SQLite, only Mac OSX | |
591 | +** cares about the difference.) | |
592 | +*/ | |
593 | +#define SQLITE_SYNC_NORMAL 0x00002 | |
594 | +#define SQLITE_SYNC_FULL 0x00003 | |
595 | +#define SQLITE_SYNC_DATAONLY 0x00010 | |
596 | + | |
597 | +/* | |
598 | +** CAPI3REF: OS Interface Open File Handle | |
599 | +** | |
600 | +** An [sqlite3_file] object represents an open file in the | |
601 | +** [sqlite3_vfs | OS interface layer]. Individual OS interface | |
602 | +** implementations will | |
603 | +** want to subclass this object by appending additional fields | |
604 | +** for their own use. The pMethods entry is a pointer to an | |
605 | +** [sqlite3_io_methods] object that defines methods for performing | |
606 | +** I/O operations on the open file. | |
607 | +*/ | |
608 | +typedef struct sqlite3_file sqlite3_file; | |
609 | +struct sqlite3_file { | |
610 | + const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ | |
611 | +}; | |
612 | + | |
613 | +/* | |
614 | +** CAPI3REF: OS Interface File Virtual Methods Object | |
615 | +** | |
616 | +** Every file opened by the [sqlite3_vfs.xOpen] method populates an | |
617 | +** [sqlite3_file] object (or, more commonly, a subclass of the | |
618 | +** [sqlite3_file] object) with a pointer to an instance of this object. | |
619 | +** This object defines the methods used to perform various operations | |
620 | +** against the open file represented by the [sqlite3_file] object. | |
621 | +** | |
622 | +** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element | |
623 | +** to a non-NULL pointer, then the sqlite3_io_methods.xClose method | |
624 | +** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The | |
625 | +** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] | |
626 | +** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element | |
627 | +** to NULL. | |
628 | +** | |
629 | +** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or | |
630 | +** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). | |
631 | +** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] | |
632 | +** flag may be ORed in to indicate that only the data of the file | |
633 | +** and not its inode needs to be synced. | |
634 | +** | |
635 | +** The integer values to xLock() and xUnlock() are one of | |
636 | +** <ul> | |
637 | +** <li> [SQLITE_LOCK_NONE], | |
638 | +** <li> [SQLITE_LOCK_SHARED], | |
639 | +** <li> [SQLITE_LOCK_RESERVED], | |
640 | +** <li> [SQLITE_LOCK_PENDING], or | |
641 | +** <li> [SQLITE_LOCK_EXCLUSIVE]. | |
642 | +** </ul> | |
643 | +** xLock() increases the lock. xUnlock() decreases the lock. | |
644 | +** The xCheckReservedLock() method checks whether any database connection, | |
645 | +** either in this process or in some other process, is holding a RESERVED, | |
646 | +** PENDING, or EXCLUSIVE lock on the file. It returns true | |
647 | +** if such a lock exists and false otherwise. | |
648 | +** | |
649 | +** The xFileControl() method is a generic interface that allows custom | |
650 | +** VFS implementations to directly control an open file using the | |
651 | +** [sqlite3_file_control()] interface. The second "op" argument is an | |
652 | +** integer opcode. The third argument is a generic pointer intended to | |
653 | +** point to a structure that may contain arguments or space in which to | |
654 | +** write return values. Potential uses for xFileControl() might be | |
655 | +** functions to enable blocking locks with timeouts, to change the | |
656 | +** locking strategy (for example to use dot-file locks), to inquire | |
657 | +** about the status of a lock, or to break stale locks. The SQLite | |
658 | +** core reserves all opcodes less than 100 for its own use. | |
659 | +** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. | |
660 | +** Applications that define a custom xFileControl method should use opcodes | |
661 | +** greater than 100 to avoid conflicts. VFS implementations should | |
662 | +** return [SQLITE_NOTFOUND] for file control opcodes that they do not | |
663 | +** recognize. | |
664 | +** | |
665 | +** The xSectorSize() method returns the sector size of the | |
666 | +** device that underlies the file. The sector size is the | |
667 | +** minimum write that can be performed without disturbing | |
668 | +** other bytes in the file. The xDeviceCharacteristics() | |
669 | +** method returns a bit vector describing behaviors of the | |
670 | +** underlying device: | |
671 | +** | |
672 | +** <ul> | |
673 | +** <li> [SQLITE_IOCAP_ATOMIC] | |
674 | +** <li> [SQLITE_IOCAP_ATOMIC512] | |
675 | +** <li> [SQLITE_IOCAP_ATOMIC1K] | |
676 | +** <li> [SQLITE_IOCAP_ATOMIC2K] | |
677 | +** <li> [SQLITE_IOCAP_ATOMIC4K] | |
678 | +** <li> [SQLITE_IOCAP_ATOMIC8K] | |
679 | +** <li> [SQLITE_IOCAP_ATOMIC16K] | |
680 | +** <li> [SQLITE_IOCAP_ATOMIC32K] | |
681 | +** <li> [SQLITE_IOCAP_ATOMIC64K] | |
682 | +** <li> [SQLITE_IOCAP_SAFE_APPEND] | |
683 | +** <li> [SQLITE_IOCAP_SEQUENTIAL] | |
684 | +** </ul> | |
685 | +** | |
686 | +** The SQLITE_IOCAP_ATOMIC property means that all writes of | |
687 | +** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values | |
688 | +** mean that writes of blocks that are nnn bytes in size and | |
689 | +** are aligned to an address which is an integer multiple of | |
690 | +** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means | |
691 | +** that when data is appended to a file, the data is appended | |
692 | +** first then the size of the file is extended, never the other | |
693 | +** way around. The SQLITE_IOCAP_SEQUENTIAL property means that | |
694 | +** information is written to disk in the same order as calls | |
695 | +** to xWrite(). | |
696 | +** | |
697 | +** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill | |
698 | +** in the unread portions of the buffer with zeros. A VFS that | |
699 | +** fails to zero-fill short reads might seem to work. However, | |
700 | +** failure to zero-fill short reads will eventually lead to | |
701 | +** database corruption. | |
702 | +*/ | |
703 | +typedef struct sqlite3_io_methods sqlite3_io_methods; | |
704 | +struct sqlite3_io_methods { | |
705 | + int iVersion; | |
706 | + int (*xClose)(sqlite3_file*); | |
707 | + int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); | |
708 | + int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); | |
709 | + int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); | |
710 | + int (*xSync)(sqlite3_file*, int flags); | |
711 | + int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); | |
712 | + int (*xLock)(sqlite3_file*, int); | |
713 | + int (*xUnlock)(sqlite3_file*, int); | |
714 | + int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); | |
715 | + int (*xFileControl)(sqlite3_file*, int op, void *pArg); | |
716 | + int (*xSectorSize)(sqlite3_file*); | |
717 | + int (*xDeviceCharacteristics)(sqlite3_file*); | |
718 | + /* Methods above are valid for version 1 */ | |
719 | + int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**); | |
720 | + int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); | |
721 | + void (*xShmBarrier)(sqlite3_file*); | |
722 | + int (*xShmUnmap)(sqlite3_file*, int deleteFlag); | |
723 | + /* Methods above are valid for version 2 */ | |
724 | + /* Additional methods may be added in future releases */ | |
725 | +}; | |
726 | + | |
727 | +/* | |
728 | +** CAPI3REF: Standard File Control Opcodes | |
729 | +** | |
730 | +** These integer constants are opcodes for the xFileControl method | |
731 | +** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] | |
732 | +** interface. | |
733 | +** | |
734 | +** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This | |
735 | +** opcode causes the xFileControl method to write the current state of | |
736 | +** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], | |
737 | +** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) | |
738 | +** into an integer that the pArg argument points to. This capability | |
739 | +** is used during testing and only needs to be supported when SQLITE_TEST | |
740 | +** is defined. | |
741 | +** <ul> | |
742 | +** <li>[[SQLITE_FCNTL_SIZE_HINT]] | |
743 | +** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS | |
744 | +** layer a hint of how large the database file will grow to be during the | |
745 | +** current transaction. This hint is not guaranteed to be accurate but it | |
746 | +** is often close. The underlying VFS might choose to preallocate database | |
747 | +** file space based on this hint in order to help writes to the database | |
748 | +** file run faster. | |
749 | +** | |
750 | +** <li>[[SQLITE_FCNTL_CHUNK_SIZE]] | |
751 | +** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS | |
752 | +** extends and truncates the database file in chunks of a size specified | |
753 | +** by the user. The fourth argument to [sqlite3_file_control()] should | |
754 | +** point to an integer (type int) containing the new chunk-size to use | |
755 | +** for the nominated database. Allocating database file space in large | |
756 | +** chunks (say 1MB at a time), may reduce file-system fragmentation and | |
757 | +** improve performance on some systems. | |
758 | +** | |
759 | +** <li>[[SQLITE_FCNTL_FILE_POINTER]] | |
760 | +** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer | |
761 | +** to the [sqlite3_file] object associated with a particular database | |
762 | +** connection. See the [sqlite3_file_control()] documentation for | |
763 | +** additional information. | |
764 | +** | |
765 | +** <li>[[SQLITE_FCNTL_SYNC_OMITTED]] | |
766 | +** ^(The [SQLITE_FCNTL_SYNC_OMITTED] opcode is generated internally by | |
767 | +** SQLite and sent to all VFSes in place of a call to the xSync method | |
768 | +** when the database connection has [PRAGMA synchronous] set to OFF.)^ | |
769 | +** Some specialized VFSes need this signal in order to operate correctly | |
770 | +** when [PRAGMA synchronous | PRAGMA synchronous=OFF] is set, but most | |
771 | +** VFSes do not need this signal and should silently ignore this opcode. | |
772 | +** Applications should not call [sqlite3_file_control()] with this | |
773 | +** opcode as doing so may disrupt the operation of the specialized VFSes | |
774 | +** that do require it. | |
775 | +** | |
776 | +** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]] | |
777 | +** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic | |
778 | +** retry counts and intervals for certain disk I/O operations for the | |
779 | +** windows [VFS] in order to provide robustness in the presence of | |
780 | +** anti-virus programs. By default, the windows VFS will retry file read, | |
781 | +** file write, and file delete operations up to 10 times, with a delay | |
782 | +** of 25 milliseconds before the first retry and with the delay increasing | |
783 | +** by an additional 25 milliseconds with each subsequent retry. This | |
784 | +** opcode allows these two values (10 retries and 25 milliseconds of delay) | |
785 | +** to be adjusted. The values are changed for all database connections | |
786 | +** within the same process. The argument is a pointer to an array of two | |
787 | +** integers where the first integer i the new retry count and the second | |
788 | +** integer is the delay. If either integer is negative, then the setting | |
789 | +** is not changed but instead the prior value of that setting is written | |
790 | +** into the array entry, allowing the current retry settings to be | |
791 | +** interrogated. The zDbName parameter is ignored. | |
792 | +** | |
793 | +** <li>[[SQLITE_FCNTL_PERSIST_WAL]] | |
794 | +** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the | |
795 | +** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary | |
796 | +** write ahead log and shared memory files used for transaction control | |
797 | +** are automatically deleted when the latest connection to the database | |
798 | +** closes. Setting persistent WAL mode causes those files to persist after | |
799 | +** close. Persisting the files is useful when other processes that do not | |
800 | +** have write permission on the directory containing the database file want | |
801 | +** to read the database file, as the WAL and shared memory files must exist | |
802 | +** in order for the database to be readable. The fourth parameter to | |
803 | +** [sqlite3_file_control()] for this opcode should be a pointer to an integer. | |
804 | +** That integer is 0 to disable persistent WAL mode or 1 to enable persistent | |
805 | +** WAL mode. If the integer is -1, then it is overwritten with the current | |
806 | +** WAL persistence setting. | |
807 | +** | |
808 | +** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]] | |
809 | +** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the | |
810 | +** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting | |
811 | +** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the | |
812 | +** xDeviceCharacteristics methods. The fourth parameter to | |
813 | +** [sqlite3_file_control()] for this opcode should be a pointer to an integer. | |
814 | +** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage | |
815 | +** mode. If the integer is -1, then it is overwritten with the current | |
816 | +** zero-damage mode setting. | |
817 | +** | |
818 | +** <li>[[SQLITE_FCNTL_OVERWRITE]] | |
819 | +** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening | |
820 | +** a write transaction to indicate that, unless it is rolled back for some | |
821 | +** reason, the entire database file will be overwritten by the current | |
822 | +** transaction. This is used by VACUUM operations. | |
823 | +** | |
824 | +** <li>[[SQLITE_FCNTL_VFSNAME]] | |
825 | +** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of | |
826 | +** all [VFSes] in the VFS stack. The names are of all VFS shims and the | |
827 | +** final bottom-level VFS are written into memory obtained from | |
828 | +** [sqlite3_malloc()] and the result is stored in the char* variable | |
829 | +** that the fourth parameter of [sqlite3_file_control()] points to. | |
830 | +** The caller is responsible for freeing the memory when done. As with | |
831 | +** all file-control actions, there is no guarantee that this will actually | |
832 | +** do anything. Callers should initialize the char* variable to a NULL | |
833 | +** pointer in case this file-control is not implemented. This file-control | |
834 | +** is intended for diagnostic use only. | |
835 | +** | |
836 | +** <li>[[SQLITE_FCNTL_PRAGMA]] | |
837 | +** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] | |
838 | +** file control is sent to the open [sqlite3_file] object corresponding | |
839 | +** to the database file to which the pragma statement refers. ^The argument | |
840 | +** to the [SQLITE_FCNTL_PRAGMA] file control is an array of | |
841 | +** pointers to strings (char**) in which the second element of the array | |
842 | +** is the name of the pragma and the third element is the argument to the | |
843 | +** pragma or NULL if the pragma has no argument. ^The handler for an | |
844 | +** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element | |
845 | +** of the char** argument point to a string obtained from [sqlite3_mprintf()] | |
846 | +** or the equivalent and that string will become the result of the pragma or | |
847 | +** the error message if the pragma fails. ^If the | |
848 | +** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal | |
849 | +** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA] | |
850 | +** file control returns [SQLITE_OK], then the parser assumes that the | |
851 | +** VFS has handled the PRAGMA itself and the parser generates a no-op | |
852 | +** prepared statement. ^If the [SQLITE_FCNTL_PRAGMA] file control returns | |
853 | +** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means | |
854 | +** that the VFS encountered an error while handling the [PRAGMA] and the | |
855 | +** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA] | |
856 | +** file control occurs at the beginning of pragma statement analysis and so | |
857 | +** it is able to override built-in [PRAGMA] statements. | |
858 | +** </ul> | |
859 | +*/ | |
860 | +#define SQLITE_FCNTL_LOCKSTATE 1 | |
861 | +#define SQLITE_GET_LOCKPROXYFILE 2 | |
862 | +#define SQLITE_SET_LOCKPROXYFILE 3 | |
863 | +#define SQLITE_LAST_ERRNO 4 | |
864 | +#define SQLITE_FCNTL_SIZE_HINT 5 | |
865 | +#define SQLITE_FCNTL_CHUNK_SIZE 6 | |
866 | +#define SQLITE_FCNTL_FILE_POINTER 7 | |
867 | +#define SQLITE_FCNTL_SYNC_OMITTED 8 | |
868 | +#define SQLITE_FCNTL_WIN32_AV_RETRY 9 | |
869 | +#define SQLITE_FCNTL_PERSIST_WAL 10 | |
870 | +#define SQLITE_FCNTL_OVERWRITE 11 | |
871 | +#define SQLITE_FCNTL_VFSNAME 12 | |
872 | +#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 | |
873 | +#define SQLITE_FCNTL_PRAGMA 14 | |
874 | + | |
875 | +/* | |
876 | +** CAPI3REF: Mutex Handle | |
877 | +** | |
878 | +** The mutex module within SQLite defines [sqlite3_mutex] to be an | |
879 | +** abstract type for a mutex object. The SQLite core never looks | |
880 | +** at the internal representation of an [sqlite3_mutex]. It only | |
881 | +** deals with pointers to the [sqlite3_mutex] object. | |
882 | +** | |
883 | +** Mutexes are created using [sqlite3_mutex_alloc()]. | |
884 | +*/ | |
885 | +typedef struct sqlite3_mutex sqlite3_mutex; | |
886 | + | |
887 | +/* | |
888 | +** CAPI3REF: OS Interface Object | |
889 | +** | |
890 | +** An instance of the sqlite3_vfs object defines the interface between | |
891 | +** the SQLite core and the underlying operating system. The "vfs" | |
892 | +** in the name of the object stands for "virtual file system". See | |
893 | +** the [VFS | VFS documentation] for further information. | |
894 | +** | |
895 | +** The value of the iVersion field is initially 1 but may be larger in | |
896 | +** future versions of SQLite. Additional fields may be appended to this | |
897 | +** object when the iVersion value is increased. Note that the structure | |
898 | +** of the sqlite3_vfs object changes in the transaction between | |
899 | +** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not | |
900 | +** modified. | |
901 | +** | |
902 | +** The szOsFile field is the size of the subclassed [sqlite3_file] | |
903 | +** structure used by this VFS. mxPathname is the maximum length of | |
904 | +** a pathname in this VFS. | |
905 | +** | |
906 | +** Registered sqlite3_vfs objects are kept on a linked list formed by | |
907 | +** the pNext pointer. The [sqlite3_vfs_register()] | |
908 | +** and [sqlite3_vfs_unregister()] interfaces manage this list | |
909 | +** in a thread-safe way. The [sqlite3_vfs_find()] interface | |
910 | +** searches the list. Neither the application code nor the VFS | |
911 | +** implementation should use the pNext pointer. | |
912 | +** | |
913 | +** The pNext field is the only field in the sqlite3_vfs | |
914 | +** structure that SQLite will ever modify. SQLite will only access | |
915 | +** or modify this field while holding a particular static mutex. | |
916 | +** The application should never modify anything within the sqlite3_vfs | |
917 | +** object once the object has been registered. | |
918 | +** | |
919 | +** The zName field holds the name of the VFS module. The name must | |
920 | +** be unique across all VFS modules. | |
921 | +** | |
922 | +** [[sqlite3_vfs.xOpen]] | |
923 | +** ^SQLite guarantees that the zFilename parameter to xOpen | |
924 | +** is either a NULL pointer or string obtained | |
925 | +** from xFullPathname() with an optional suffix added. | |
926 | +** ^If a suffix is added to the zFilename parameter, it will | |
927 | +** consist of a single "-" character followed by no more than | |
928 | +** 11 alphanumeric and/or "-" characters. | |
929 | +** ^SQLite further guarantees that | |
930 | +** the string will be valid and unchanged until xClose() is | |
931 | +** called. Because of the previous sentence, | |
932 | +** the [sqlite3_file] can safely store a pointer to the | |
933 | +** filename if it needs to remember the filename for some reason. | |
934 | +** If the zFilename parameter to xOpen is a NULL pointer then xOpen | |
935 | +** must invent its own temporary name for the file. ^Whenever the | |
936 | +** xFilename parameter is NULL it will also be the case that the | |
937 | +** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. | |
938 | +** | |
939 | +** The flags argument to xOpen() includes all bits set in | |
940 | +** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] | |
941 | +** or [sqlite3_open16()] is used, then flags includes at least | |
942 | +** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. | |
943 | +** If xOpen() opens a file read-only then it sets *pOutFlags to | |
944 | +** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. | |
945 | +** | |
946 | +** ^(SQLite will also add one of the following flags to the xOpen() | |
947 | +** call, depending on the object being opened: | |
948 | +** | |
949 | +** <ul> | |
950 | +** <li> [SQLITE_OPEN_MAIN_DB] | |
951 | +** <li> [SQLITE_OPEN_MAIN_JOURNAL] | |
952 | +** <li> [SQLITE_OPEN_TEMP_DB] | |
953 | +** <li> [SQLITE_OPEN_TEMP_JOURNAL] | |
954 | +** <li> [SQLITE_OPEN_TRANSIENT_DB] | |
955 | +** <li> [SQLITE_OPEN_SUBJOURNAL] | |
956 | +** <li> [SQLITE_OPEN_MASTER_JOURNAL] | |
957 | +** <li> [SQLITE_OPEN_WAL] | |
958 | +** </ul>)^ | |
959 | +** | |
960 | +** The file I/O implementation can use the object type flags to | |
961 | +** change the way it deals with files. For example, an application | |
962 | +** that does not care about crash recovery or rollback might make | |
963 | +** the open of a journal file a no-op. Writes to this journal would | |
964 | +** also be no-ops, and any attempt to read the journal would return | |
965 | +** SQLITE_IOERR. Or the implementation might recognize that a database | |
966 | +** file will be doing page-aligned sector reads and writes in a random | |
967 | +** order and set up its I/O subsystem accordingly. | |
968 | +** | |
969 | +** SQLite might also add one of the following flags to the xOpen method: | |
970 | +** | |
971 | +** <ul> | |
972 | +** <li> [SQLITE_OPEN_DELETEONCLOSE] | |
973 | +** <li> [SQLITE_OPEN_EXCLUSIVE] | |
974 | +** </ul> | |
975 | +** | |
976 | +** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be | |
977 | +** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] | |
978 | +** will be set for TEMP databases and their journals, transient | |
979 | +** databases, and subjournals. | |
980 | +** | |
981 | +** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction | |
982 | +** with the [SQLITE_OPEN_CREATE] flag, which are both directly | |
983 | +** analogous to the O_EXCL and O_CREAT flags of the POSIX open() | |
984 | +** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the | |
985 | +** SQLITE_OPEN_CREATE, is used to indicate that file should always | |
986 | +** be created, and that it is an error if it already exists. | |
987 | +** It is <i>not</i> used to indicate the file should be opened | |
988 | +** for exclusive access. | |
989 | +** | |
990 | +** ^At least szOsFile bytes of memory are allocated by SQLite | |
991 | +** to hold the [sqlite3_file] structure passed as the third | |
992 | +** argument to xOpen. The xOpen method does not have to | |
993 | +** allocate the structure; it should just fill it in. Note that | |
994 | +** the xOpen method must set the sqlite3_file.pMethods to either | |
995 | +** a valid [sqlite3_io_methods] object or to NULL. xOpen must do | |
996 | +** this even if the open fails. SQLite expects that the sqlite3_file.pMethods | |
997 | +** element will be valid after xOpen returns regardless of the success | |
998 | +** or failure of the xOpen call. | |
999 | +** | |
1000 | +** [[sqlite3_vfs.xAccess]] | |
1001 | +** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] | |
1002 | +** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to | |
1003 | +** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] | |
1004 | +** to test whether a file is at least readable. The file can be a | |
1005 | +** directory. | |
1006 | +** | |
1007 | +** ^SQLite will always allocate at least mxPathname+1 bytes for the | |
1008 | +** output buffer xFullPathname. The exact size of the output buffer | |
1009 | +** is also passed as a parameter to both methods. If the output buffer | |
1010 | +** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is | |
1011 | +** handled as a fatal error by SQLite, vfs implementations should endeavor | |
1012 | +** to prevent this by setting mxPathname to a sufficiently large value. | |
1013 | +** | |
1014 | +** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() | |
1015 | +** interfaces are not strictly a part of the filesystem, but they are | |
1016 | +** included in the VFS structure for completeness. | |
1017 | +** The xRandomness() function attempts to return nBytes bytes | |
1018 | +** of good-quality randomness into zOut. The return value is | |
1019 | +** the actual number of bytes of randomness obtained. | |
1020 | +** The xSleep() method causes the calling thread to sleep for at | |
1021 | +** least the number of microseconds given. ^The xCurrentTime() | |
1022 | +** method returns a Julian Day Number for the current date and time as | |
1023 | +** a floating point value. | |
1024 | +** ^The xCurrentTimeInt64() method returns, as an integer, the Julian | |
1025 | +** Day Number multiplied by 86400000 (the number of milliseconds in | |
1026 | +** a 24-hour day). | |
1027 | +** ^SQLite will use the xCurrentTimeInt64() method to get the current | |
1028 | +** date and time if that method is available (if iVersion is 2 or | |
1029 | +** greater and the function pointer is not NULL) and will fall back | |
1030 | +** to xCurrentTime() if xCurrentTimeInt64() is unavailable. | |
1031 | +** | |
1032 | +** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces | |
1033 | +** are not used by the SQLite core. These optional interfaces are provided | |
1034 | +** by some VFSes to facilitate testing of the VFS code. By overriding | |
1035 | +** system calls with functions under its control, a test program can | |
1036 | +** simulate faults and error conditions that would otherwise be difficult | |
1037 | +** or impossible to induce. The set of system calls that can be overridden | |
1038 | +** varies from one VFS to another, and from one version of the same VFS to the | |
1039 | +** next. Applications that use these interfaces must be prepared for any | |
1040 | +** or all of these interfaces to be NULL or for their behavior to change | |
1041 | +** from one release to the next. Applications must not attempt to access | |
1042 | +** any of these methods if the iVersion of the VFS is less than 3. | |
1043 | +*/ | |
1044 | +typedef struct sqlite3_vfs sqlite3_vfs; | |
1045 | +typedef void (*sqlite3_syscall_ptr)(void); | |
1046 | +struct sqlite3_vfs { | |
1047 | + int iVersion; /* Structure version number (currently 3) */ | |
1048 | + int szOsFile; /* Size of subclassed sqlite3_file */ | |
1049 | + int mxPathname; /* Maximum file pathname length */ | |
1050 | + sqlite3_vfs *pNext; /* Next registered VFS */ | |
1051 | + const char *zName; /* Name of this virtual file system */ | |
1052 | + void *pAppData; /* Pointer to application-specific data */ | |
1053 | + int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, | |
1054 | + int flags, int *pOutFlags); | |
1055 | + int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); | |
1056 | + int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); | |
1057 | + int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); | |
1058 | + void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); | |
1059 | + void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); | |
1060 | + void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); | |
1061 | + void (*xDlClose)(sqlite3_vfs*, void*); | |
1062 | + int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); | |
1063 | + int (*xSleep)(sqlite3_vfs*, int microseconds); | |
1064 | + int (*xCurrentTime)(sqlite3_vfs*, double*); | |
1065 | + int (*xGetLastError)(sqlite3_vfs*, int, char *); | |
1066 | + /* | |
1067 | + ** The methods above are in version 1 of the sqlite_vfs object | |
1068 | + ** definition. Those that follow are added in version 2 or later | |
1069 | + */ | |
1070 | + int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*); | |
1071 | + /* | |
1072 | + ** The methods above are in versions 1 and 2 of the sqlite_vfs object. | |
1073 | + ** Those below are for version 3 and greater. | |
1074 | + */ | |
1075 | + int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr); | |
1076 | + sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName); | |
1077 | + const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); | |
1078 | + /* | |
1079 | + ** The methods above are in versions 1 through 3 of the sqlite_vfs object. | |
1080 | + ** New fields may be appended in figure versions. The iVersion | |
1081 | + ** value will increment whenever this happens. | |
1082 | + */ | |
1083 | +}; | |
1084 | + | |
1085 | +/* | |
1086 | +** CAPI3REF: Flags for the xAccess VFS method | |
1087 | +** | |
1088 | +** These integer constants can be used as the third parameter to | |
1089 | +** the xAccess method of an [sqlite3_vfs] object. They determine | |
1090 | +** what kind of permissions the xAccess method is looking for. | |
1091 | +** With SQLITE_ACCESS_EXISTS, the xAccess method | |
1092 | +** simply checks whether the file exists. | |
1093 | +** With SQLITE_ACCESS_READWRITE, the xAccess method | |
1094 | +** checks whether the named directory is both readable and writable | |
1095 | +** (in other words, if files can be added, removed, and renamed within | |
1096 | +** the directory). | |
1097 | +** The SQLITE_ACCESS_READWRITE constant is currently used only by the | |
1098 | +** [temp_store_directory pragma], though this could change in a future | |
1099 | +** release of SQLite. | |
1100 | +** With SQLITE_ACCESS_READ, the xAccess method | |
1101 | +** checks whether the file is readable. The SQLITE_ACCESS_READ constant is | |
1102 | +** currently unused, though it might be used in a future release of | |
1103 | +** SQLite. | |
1104 | +*/ | |
1105 | +#define SQLITE_ACCESS_EXISTS 0 | |
1106 | +#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ | |
1107 | +#define SQLITE_ACCESS_READ 2 /* Unused */ | |
1108 | + | |
1109 | +/* | |
1110 | +** CAPI3REF: Flags for the xShmLock VFS method | |
1111 | +** | |
1112 | +** These integer constants define the various locking operations | |
1113 | +** allowed by the xShmLock method of [sqlite3_io_methods]. The | |
1114 | +** following are the only legal combinations of flags to the | |
1115 | +** xShmLock method: | |
1116 | +** | |
1117 | +** <ul> | |
1118 | +** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED | |
1119 | +** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE | |
1120 | +** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED | |
1121 | +** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE | |
1122 | +** </ul> | |
1123 | +** | |
1124 | +** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as | |
1125 | +** was given no the corresponding lock. | |
1126 | +** | |
1127 | +** The xShmLock method can transition between unlocked and SHARED or | |
1128 | +** between unlocked and EXCLUSIVE. It cannot transition between SHARED | |
1129 | +** and EXCLUSIVE. | |
1130 | +*/ | |
1131 | +#define SQLITE_SHM_UNLOCK 1 | |
1132 | +#define SQLITE_SHM_LOCK 2 | |
1133 | +#define SQLITE_SHM_SHARED 4 | |
1134 | +#define SQLITE_SHM_EXCLUSIVE 8 | |
1135 | + | |
1136 | +/* | |
1137 | +** CAPI3REF: Maximum xShmLock index | |
1138 | +** | |
1139 | +** The xShmLock method on [sqlite3_io_methods] may use values | |
1140 | +** between 0 and this upper bound as its "offset" argument. | |
1141 | +** The SQLite core will never attempt to acquire or release a | |
1142 | +** lock outside of this range | |
1143 | +*/ | |
1144 | +#define SQLITE_SHM_NLOCK 8 | |
1145 | + | |
1146 | + | |
1147 | +/* | |
1148 | +** CAPI3REF: Initialize The SQLite Library | |
1149 | +** | |
1150 | +** ^The sqlite3_initialize() routine initializes the | |
1151 | +** SQLite library. ^The sqlite3_shutdown() routine | |
1152 | +** deallocates any resources that were allocated by sqlite3_initialize(). | |
1153 | +** These routines are designed to aid in process initialization and | |
1154 | +** shutdown on embedded systems. Workstation applications using | |
1155 | +** SQLite normally do not need to invoke either of these routines. | |
1156 | +** | |
1157 | +** A call to sqlite3_initialize() is an "effective" call if it is | |
1158 | +** the first time sqlite3_initialize() is invoked during the lifetime of | |
1159 | +** the process, or if it is the first time sqlite3_initialize() is invoked | |
1160 | +** following a call to sqlite3_shutdown(). ^(Only an effective call | |
1161 | +** of sqlite3_initialize() does any initialization. All other calls | |
1162 | +** are harmless no-ops.)^ | |
1163 | +** | |
1164 | +** A call to sqlite3_shutdown() is an "effective" call if it is the first | |
1165 | +** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only | |
1166 | +** an effective call to sqlite3_shutdown() does any deinitialization. | |
1167 | +** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ | |
1168 | +** | |
1169 | +** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() | |
1170 | +** is not. The sqlite3_shutdown() interface must only be called from a | |
1171 | +** single thread. All open [database connections] must be closed and all | |
1172 | +** other SQLite resources must be deallocated prior to invoking | |
1173 | +** sqlite3_shutdown(). | |
1174 | +** | |
1175 | +** Among other things, ^sqlite3_initialize() will invoke | |
1176 | +** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() | |
1177 | +** will invoke sqlite3_os_end(). | |
1178 | +** | |
1179 | +** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. | |
1180 | +** ^If for some reason, sqlite3_initialize() is unable to initialize | |
1181 | +** the library (perhaps it is unable to allocate a needed resource such | |
1182 | +** as a mutex) it returns an [error code] other than [SQLITE_OK]. | |
1183 | +** | |
1184 | +** ^The sqlite3_initialize() routine is called internally by many other | |
1185 | +** SQLite interfaces so that an application usually does not need to | |
1186 | +** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] | |
1187 | +** calls sqlite3_initialize() so the SQLite library will be automatically | |
1188 | +** initialized when [sqlite3_open()] is called if it has not be initialized | |
1189 | +** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] | |
1190 | +** compile-time option, then the automatic calls to sqlite3_initialize() | |
1191 | +** are omitted and the application must call sqlite3_initialize() directly | |
1192 | +** prior to using any other SQLite interface. For maximum portability, | |
1193 | +** it is recommended that applications always invoke sqlite3_initialize() | |
1194 | +** directly prior to using any other SQLite interface. Future releases | |
1195 | +** of SQLite may require this. In other words, the behavior exhibited | |
1196 | +** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the | |
1197 | +** default behavior in some future release of SQLite. | |
1198 | +** | |
1199 | +** The sqlite3_os_init() routine does operating-system specific | |
1200 | +** initialization of the SQLite library. The sqlite3_os_end() | |
1201 | +** routine undoes the effect of sqlite3_os_init(). Typical tasks | |
1202 | +** performed by these routines include allocation or deallocation | |
1203 | +** of static resources, initialization of global variables, | |
1204 | +** setting up a default [sqlite3_vfs] module, or setting up | |
1205 | +** a default configuration using [sqlite3_config()]. | |
1206 | +** | |
1207 | +** The application should never invoke either sqlite3_os_init() | |
1208 | +** or sqlite3_os_end() directly. The application should only invoke | |
1209 | +** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() | |
1210 | +** interface is called automatically by sqlite3_initialize() and | |
1211 | +** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate | |
1212 | +** implementations for sqlite3_os_init() and sqlite3_os_end() | |
1213 | +** are built into SQLite when it is compiled for Unix, Windows, or OS/2. | |
1214 | +** When [custom builds | built for other platforms] | |
1215 | +** (using the [SQLITE_OS_OTHER=1] compile-time | |
1216 | +** option) the application must supply a suitable implementation for | |
1217 | +** sqlite3_os_init() and sqlite3_os_end(). An application-supplied | |
1218 | +** implementation of sqlite3_os_init() or sqlite3_os_end() | |
1219 | +** must return [SQLITE_OK] on success and some other [error code] upon | |
1220 | +** failure. | |
1221 | +*/ | |
1222 | +SQLITE_API int sqlite3_initialize(void); | |
1223 | +SQLITE_API int sqlite3_shutdown(void); | |
1224 | +SQLITE_API int sqlite3_os_init(void); | |
1225 | +SQLITE_API int sqlite3_os_end(void); | |
1226 | + | |
1227 | +/* | |
1228 | +** CAPI3REF: Configuring The SQLite Library | |
1229 | +** | |
1230 | +** The sqlite3_config() interface is used to make global configuration | |
1231 | +** changes to SQLite in order to tune SQLite to the specific needs of | |
1232 | +** the application. The default configuration is recommended for most | |
1233 | +** applications and so this routine is usually not necessary. It is | |
1234 | +** provided to support rare applications with unusual needs. | |
1235 | +** | |
1236 | +** The sqlite3_config() interface is not threadsafe. The application | |
1237 | +** must insure that no other SQLite interfaces are invoked by other | |
1238 | +** threads while sqlite3_config() is running. Furthermore, sqlite3_config() | |
1239 | +** may only be invoked prior to library initialization using | |
1240 | +** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. | |
1241 | +** ^If sqlite3_config() is called after [sqlite3_initialize()] and before | |
1242 | +** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. | |
1243 | +** Note, however, that ^sqlite3_config() can be called as part of the | |
1244 | +** implementation of an application-defined [sqlite3_os_init()]. | |
1245 | +** | |
1246 | +** The first argument to sqlite3_config() is an integer | |
1247 | +** [configuration option] that determines | |
1248 | +** what property of SQLite is to be configured. Subsequent arguments | |
1249 | +** vary depending on the [configuration option] | |
1250 | +** in the first argument. | |
1251 | +** | |
1252 | +** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. | |
1253 | +** ^If the option is unknown or SQLite is unable to set the option | |
1254 | +** then this routine returns a non-zero [error code]. | |
1255 | +*/ | |
1256 | +SQLITE_API int sqlite3_config(int, ...); | |
1257 | + | |
1258 | +/* | |
1259 | +** CAPI3REF: Configure database connections | |
1260 | +** | |
1261 | +** The sqlite3_db_config() interface is used to make configuration | |
1262 | +** changes to a [database connection]. The interface is similar to | |
1263 | +** [sqlite3_config()] except that the changes apply to a single | |
1264 | +** [database connection] (specified in the first argument). | |
1265 | +** | |
1266 | +** The second argument to sqlite3_db_config(D,V,...) is the | |
1267 | +** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code | |
1268 | +** that indicates what aspect of the [database connection] is being configured. | |
1269 | +** Subsequent arguments vary depending on the configuration verb. | |
1270 | +** | |
1271 | +** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if | |
1272 | +** the call is considered successful. | |
1273 | +*/ | |
1274 | +SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...); | |
1275 | + | |
1276 | +/* | |
1277 | +** CAPI3REF: Memory Allocation Routines | |
1278 | +** | |
1279 | +** An instance of this object defines the interface between SQLite | |
1280 | +** and low-level memory allocation routines. | |
1281 | +** | |
1282 | +** This object is used in only one place in the SQLite interface. | |
1283 | +** A pointer to an instance of this object is the argument to | |
1284 | +** [sqlite3_config()] when the configuration option is | |
1285 | +** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. | |
1286 | +** By creating an instance of this object | |
1287 | +** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) | |
1288 | +** during configuration, an application can specify an alternative | |
1289 | +** memory allocation subsystem for SQLite to use for all of its | |
1290 | +** dynamic memory needs. | |
1291 | +** | |
1292 | +** Note that SQLite comes with several [built-in memory allocators] | |
1293 | +** that are perfectly adequate for the overwhelming majority of applications | |
1294 | +** and that this object is only useful to a tiny minority of applications | |
1295 | +** with specialized memory allocation requirements. This object is | |
1296 | +** also used during testing of SQLite in order to specify an alternative | |
1297 | +** memory allocator that simulates memory out-of-memory conditions in | |
1298 | +** order to verify that SQLite recovers gracefully from such | |
1299 | +** conditions. | |
1300 | +** | |
1301 | +** The xMalloc, xRealloc, and xFree methods must work like the | |
1302 | +** malloc(), realloc() and free() functions from the standard C library. | |
1303 | +** ^SQLite guarantees that the second argument to | |
1304 | +** xRealloc is always a value returned by a prior call to xRoundup. | |
1305 | +** | |
1306 | +** xSize should return the allocated size of a memory allocation | |
1307 | +** previously obtained from xMalloc or xRealloc. The allocated size | |
1308 | +** is always at least as big as the requested size but may be larger. | |
1309 | +** | |
1310 | +** The xRoundup method returns what would be the allocated size of | |
1311 | +** a memory allocation given a particular requested size. Most memory | |
1312 | +** allocators round up memory allocations at least to the next multiple | |
1313 | +** of 8. Some allocators round up to a larger multiple or to a power of 2. | |
1314 | +** Every memory allocation request coming in through [sqlite3_malloc()] | |
1315 | +** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, | |
1316 | +** that causes the corresponding memory allocation to fail. | |
1317 | +** | |
1318 | +** The xInit method initializes the memory allocator. (For example, | |
1319 | +** it might allocate any require mutexes or initialize internal data | |
1320 | +** structures. The xShutdown method is invoked (indirectly) by | |
1321 | +** [sqlite3_shutdown()] and should deallocate any resources acquired | |
1322 | +** by xInit. The pAppData pointer is used as the only parameter to | |
1323 | +** xInit and xShutdown. | |
1324 | +** | |
1325 | +** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes | |
1326 | +** the xInit method, so the xInit method need not be threadsafe. The | |
1327 | +** xShutdown method is only called from [sqlite3_shutdown()] so it does | |
1328 | +** not need to be threadsafe either. For all other methods, SQLite | |
1329 | +** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the | |
1330 | +** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which | |
1331 | +** it is by default) and so the methods are automatically serialized. | |
1332 | +** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other | |
1333 | +** methods must be threadsafe or else make their own arrangements for | |
1334 | +** serialization. | |
1335 | +** | |
1336 | +** SQLite will never invoke xInit() more than once without an intervening | |
1337 | +** call to xShutdown(). | |
1338 | +*/ | |
1339 | +typedef struct sqlite3_mem_methods sqlite3_mem_methods; | |
1340 | +struct sqlite3_mem_methods { | |
1341 | + void *(*xMalloc)(int); /* Memory allocation function */ | |
1342 | + void (*xFree)(void*); /* Free a prior allocation */ | |
1343 | + void *(*xRealloc)(void*,int); /* Resize an allocation */ | |
1344 | + int (*xSize)(void*); /* Return the size of an allocation */ | |
1345 | + int (*xRoundup)(int); /* Round up request size to allocation size */ | |
1346 | + int (*xInit)(void*); /* Initialize the memory allocator */ | |
1347 | + void (*xShutdown)(void*); /* Deinitialize the memory allocator */ | |
1348 | + void *pAppData; /* Argument to xInit() and xShutdown() */ | |
1349 | +}; | |
1350 | + | |
1351 | +/* | |
1352 | +** CAPI3REF: Configuration Options | |
1353 | +** KEYWORDS: {configuration option} | |
1354 | +** | |
1355 | +** These constants are the available integer configuration options that | |
1356 | +** can be passed as the first argument to the [sqlite3_config()] interface. | |
1357 | +** | |
1358 | +** New configuration options may be added in future releases of SQLite. | |
1359 | +** Existing configuration options might be discontinued. Applications | |
1360 | +** should check the return code from [sqlite3_config()] to make sure that | |
1361 | +** the call worked. The [sqlite3_config()] interface will return a | |
1362 | +** non-zero [error code] if a discontinued or unsupported configuration option | |
1363 | +** is invoked. | |
1364 | +** | |
1365 | +** <dl> | |
1366 | +** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt> | |
1367 | +** <dd>There are no arguments to this option. ^This option sets the | |
1368 | +** [threading mode] to Single-thread. In other words, it disables | |
1369 | +** all mutexing and puts SQLite into a mode where it can only be used | |
1370 | +** by a single thread. ^If SQLite is compiled with | |
1371 | +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then | |
1372 | +** it is not possible to change the [threading mode] from its default | |
1373 | +** value of Single-thread and so [sqlite3_config()] will return | |
1374 | +** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD | |
1375 | +** configuration option.</dd> | |
1376 | +** | |
1377 | +** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt> | |
1378 | +** <dd>There are no arguments to this option. ^This option sets the | |
1379 | +** [threading mode] to Multi-thread. In other words, it disables | |
1380 | +** mutexing on [database connection] and [prepared statement] objects. | |
1381 | +** The application is responsible for serializing access to | |
1382 | +** [database connections] and [prepared statements]. But other mutexes | |
1383 | +** are enabled so that SQLite will be safe to use in a multi-threaded | |
1384 | +** environment as long as no two threads attempt to use the same | |
1385 | +** [database connection] at the same time. ^If SQLite is compiled with | |
1386 | +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then | |
1387 | +** it is not possible to set the Multi-thread [threading mode] and | |
1388 | +** [sqlite3_config()] will return [SQLITE_ERROR] if called with the | |
1389 | +** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> | |
1390 | +** | |
1391 | +** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt> | |
1392 | +** <dd>There are no arguments to this option. ^This option sets the | |
1393 | +** [threading mode] to Serialized. In other words, this option enables | |
1394 | +** all mutexes including the recursive | |
1395 | +** mutexes on [database connection] and [prepared statement] objects. | |
1396 | +** In this mode (which is the default when SQLite is compiled with | |
1397 | +** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access | |
1398 | +** to [database connections] and [prepared statements] so that the | |
1399 | +** application is free to use the same [database connection] or the | |
1400 | +** same [prepared statement] in different threads at the same time. | |
1401 | +** ^If SQLite is compiled with | |
1402 | +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then | |
1403 | +** it is not possible to set the Serialized [threading mode] and | |
1404 | +** [sqlite3_config()] will return [SQLITE_ERROR] if called with the | |
1405 | +** SQLITE_CONFIG_SERIALIZED configuration option.</dd> | |
1406 | +** | |
1407 | +** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt> | |
1408 | +** <dd> ^(This option takes a single argument which is a pointer to an | |
1409 | +** instance of the [sqlite3_mem_methods] structure. The argument specifies | |
1410 | +** alternative low-level memory allocation routines to be used in place of | |
1411 | +** the memory allocation routines built into SQLite.)^ ^SQLite makes | |
1412 | +** its own private copy of the content of the [sqlite3_mem_methods] structure | |
1413 | +** before the [sqlite3_config()] call returns.</dd> | |
1414 | +** | |
1415 | +** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt> | |
1416 | +** <dd> ^(This option takes a single argument which is a pointer to an | |
1417 | +** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] | |
1418 | +** structure is filled with the currently defined memory allocation routines.)^ | |
1419 | +** This option can be used to overload the default memory allocation | |
1420 | +** routines with a wrapper that simulations memory allocation failure or | |
1421 | +** tracks memory usage, for example. </dd> | |
1422 | +** | |
1423 | +** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt> | |
1424 | +** <dd> ^This option takes single argument of type int, interpreted as a | |
1425 | +** boolean, which enables or disables the collection of memory allocation | |
1426 | +** statistics. ^(When memory allocation statistics are disabled, the | |
1427 | +** following SQLite interfaces become non-operational: | |
1428 | +** <ul> | |
1429 | +** <li> [sqlite3_memory_used()] | |
1430 | +** <li> [sqlite3_memory_highwater()] | |
1431 | +** <li> [sqlite3_soft_heap_limit64()] | |
1432 | +** <li> [sqlite3_status()] | |
1433 | +** </ul>)^ | |
1434 | +** ^Memory allocation statistics are enabled by default unless SQLite is | |
1435 | +** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory | |
1436 | +** allocation statistics are disabled by default. | |
1437 | +** </dd> | |
1438 | +** | |
1439 | +** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt> | |
1440 | +** <dd> ^This option specifies a static memory buffer that SQLite can use for | |
1441 | +** scratch memory. There are three arguments: A pointer an 8-byte | |
1442 | +** aligned memory buffer from which the scratch allocations will be | |
1443 | +** drawn, the size of each scratch allocation (sz), | |
1444 | +** and the maximum number of scratch allocations (N). The sz | |
1445 | +** argument must be a multiple of 16. | |
1446 | +** The first argument must be a pointer to an 8-byte aligned buffer | |
1447 | +** of at least sz*N bytes of memory. | |
1448 | +** ^SQLite will use no more than two scratch buffers per thread. So | |
1449 | +** N should be set to twice the expected maximum number of threads. | |
1450 | +** ^SQLite will never require a scratch buffer that is more than 6 | |
1451 | +** times the database page size. ^If SQLite needs needs additional | |
1452 | +** scratch memory beyond what is provided by this configuration option, then | |
1453 | +** [sqlite3_malloc()] will be used to obtain the memory needed.</dd> | |
1454 | +** | |
1455 | +** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt> | |
1456 | +** <dd> ^This option specifies a static memory buffer that SQLite can use for | |
1457 | +** the database page cache with the default page cache implementation. | |
1458 | +** This configuration should not be used if an application-define page | |
1459 | +** cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option. | |
1460 | +** There are three arguments to this option: A pointer to 8-byte aligned | |
1461 | +** memory, the size of each page buffer (sz), and the number of pages (N). | |
1462 | +** The sz argument should be the size of the largest database page | |
1463 | +** (a power of two between 512 and 32768) plus a little extra for each | |
1464 | +** page header. ^The page header size is 20 to 40 bytes depending on | |
1465 | +** the host architecture. ^It is harmless, apart from the wasted memory, | |
1466 | +** to make sz a little too large. The first | |
1467 | +** argument should point to an allocation of at least sz*N bytes of memory. | |
1468 | +** ^SQLite will use the memory provided by the first argument to satisfy its | |
1469 | +** memory needs for the first N pages that it adds to cache. ^If additional | |
1470 | +** page cache memory is needed beyond what is provided by this option, then | |
1471 | +** SQLite goes to [sqlite3_malloc()] for the additional storage space. | |
1472 | +** The pointer in the first argument must | |
1473 | +** be aligned to an 8-byte boundary or subsequent behavior of SQLite | |
1474 | +** will be undefined.</dd> | |
1475 | +** | |
1476 | +** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt> | |
1477 | +** <dd> ^This option specifies a static memory buffer that SQLite will use | |
1478 | +** for all of its dynamic memory allocation needs beyond those provided | |
1479 | +** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. | |
1480 | +** There are three arguments: An 8-byte aligned pointer to the memory, | |
1481 | +** the number of bytes in the memory buffer, and the minimum allocation size. | |
1482 | +** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts | |
1483 | +** to using its default memory allocator (the system malloc() implementation), | |
1484 | +** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the | |
1485 | +** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or | |
1486 | +** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory | |
1487 | +** allocator is engaged to handle all of SQLites memory allocation needs. | |
1488 | +** The first pointer (the memory pointer) must be aligned to an 8-byte | |
1489 | +** boundary or subsequent behavior of SQLite will be undefined. | |
1490 | +** The minimum allocation size is capped at 2**12. Reasonable values | |
1491 | +** for the minimum allocation size are 2**5 through 2**8.</dd> | |
1492 | +** | |
1493 | +** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt> | |
1494 | +** <dd> ^(This option takes a single argument which is a pointer to an | |
1495 | +** instance of the [sqlite3_mutex_methods] structure. The argument specifies | |
1496 | +** alternative low-level mutex routines to be used in place | |
1497 | +** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the | |
1498 | +** content of the [sqlite3_mutex_methods] structure before the call to | |
1499 | +** [sqlite3_config()] returns. ^If SQLite is compiled with | |
1500 | +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then | |
1501 | +** the entire mutexing subsystem is omitted from the build and hence calls to | |
1502 | +** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will | |
1503 | +** return [SQLITE_ERROR].</dd> | |
1504 | +** | |
1505 | +** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt> | |
1506 | +** <dd> ^(This option takes a single argument which is a pointer to an | |
1507 | +** instance of the [sqlite3_mutex_methods] structure. The | |
1508 | +** [sqlite3_mutex_methods] | |
1509 | +** structure is filled with the currently defined mutex routines.)^ | |
1510 | +** This option can be used to overload the default mutex allocation | |
1511 | +** routines with a wrapper used to track mutex usage for performance | |
1512 | +** profiling or testing, for example. ^If SQLite is compiled with | |
1513 | +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then | |
1514 | +** the entire mutexing subsystem is omitted from the build and hence calls to | |
1515 | +** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will | |
1516 | +** return [SQLITE_ERROR].</dd> | |
1517 | +** | |
1518 | +** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt> | |
1519 | +** <dd> ^(This option takes two arguments that determine the default | |
1520 | +** memory allocation for the lookaside memory allocator on each | |
1521 | +** [database connection]. The first argument is the | |
1522 | +** size of each lookaside buffer slot and the second is the number of | |
1523 | +** slots allocated to each database connection.)^ ^(This option sets the | |
1524 | +** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] | |
1525 | +** verb to [sqlite3_db_config()] can be used to change the lookaside | |
1526 | +** configuration on individual connections.)^ </dd> | |
1527 | +** | |
1528 | +** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt> | |
1529 | +** <dd> ^(This option takes a single argument which is a pointer to | |
1530 | +** an [sqlite3_pcache_methods2] object. This object specifies the interface | |
1531 | +** to a custom page cache implementation.)^ ^SQLite makes a copy of the | |
1532 | +** object and uses it for page cache memory allocations.</dd> | |
1533 | +** | |
1534 | +** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt> | |
1535 | +** <dd> ^(This option takes a single argument which is a pointer to an | |
1536 | +** [sqlite3_pcache_methods2] object. SQLite copies of the current | |
1537 | +** page cache implementation into that object.)^ </dd> | |
1538 | +** | |
1539 | +** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt> | |
1540 | +** <dd> ^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a | |
1541 | +** function with a call signature of void(*)(void*,int,const char*), | |
1542 | +** and a pointer to void. ^If the function pointer is not NULL, it is | |
1543 | +** invoked by [sqlite3_log()] to process each logging event. ^If the | |
1544 | +** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. | |
1545 | +** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is | |
1546 | +** passed through as the first parameter to the application-defined logger | |
1547 | +** function whenever that function is invoked. ^The second parameter to | |
1548 | +** the logger function is a copy of the first parameter to the corresponding | |
1549 | +** [sqlite3_log()] call and is intended to be a [result code] or an | |
1550 | +** [extended result code]. ^The third parameter passed to the logger is | |
1551 | +** log message after formatting via [sqlite3_snprintf()]. | |
1552 | +** The SQLite logging interface is not reentrant; the logger function | |
1553 | +** supplied by the application must not invoke any SQLite interface. | |
1554 | +** In a multi-threaded application, the application-defined logger | |
1555 | +** function must be threadsafe. </dd> | |
1556 | +** | |
1557 | +** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI | |
1558 | +** <dd> This option takes a single argument of type int. If non-zero, then | |
1559 | +** URI handling is globally enabled. If the parameter is zero, then URI handling | |
1560 | +** is globally disabled. If URI handling is globally enabled, all filenames | |
1561 | +** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or | |
1562 | +** specified as part of [ATTACH] commands are interpreted as URIs, regardless | |
1563 | +** of whether or not the [SQLITE_OPEN_URI] flag is set when the database | |
1564 | +** connection is opened. If it is globally disabled, filenames are | |
1565 | +** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the | |
1566 | +** database connection is opened. By default, URI handling is globally | |
1567 | +** disabled. The default value may be changed by compiling with the | |
1568 | +** [SQLITE_USE_URI] symbol defined. | |
1569 | +** | |
1570 | +** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] | |
1571 | +** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE | |
1572 | +** <dd> These options are obsolete and should not be used by new code. | |
1573 | +** They are retained for backwards compatibility but are now no-ops. | |
1574 | +** </dl> | |
1575 | +*/ | |
1576 | +#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ | |
1577 | +#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ | |
1578 | +#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ | |
1579 | +#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ | |
1580 | +#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ | |
1581 | +#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ | |
1582 | +#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ | |
1583 | +#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ | |
1584 | +#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ | |
1585 | +#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ | |
1586 | +#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ | |
1587 | +/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ | |
1588 | +#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ | |
1589 | +#define SQLITE_CONFIG_PCACHE 14 /* no-op */ | |
1590 | +#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ | |
1591 | +#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ | |
1592 | +#define SQLITE_CONFIG_URI 17 /* int */ | |
1593 | +#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */ | |
1594 | +#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */ | |
1595 | + | |
1596 | +/* | |
1597 | +** CAPI3REF: Database Connection Configuration Options | |
1598 | +** | |
1599 | +** These constants are the available integer configuration options that | |
1600 | +** can be passed as the second argument to the [sqlite3_db_config()] interface. | |
1601 | +** | |
1602 | +** New configuration options may be added in future releases of SQLite. | |
1603 | +** Existing configuration options might be discontinued. Applications | |
1604 | +** should check the return code from [sqlite3_db_config()] to make sure that | |
1605 | +** the call worked. ^The [sqlite3_db_config()] interface will return a | |
1606 | +** non-zero [error code] if a discontinued or unsupported configuration option | |
1607 | +** is invoked. | |
1608 | +** | |
1609 | +** <dl> | |
1610 | +** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> | |
1611 | +** <dd> ^This option takes three additional arguments that determine the | |
1612 | +** [lookaside memory allocator] configuration for the [database connection]. | |
1613 | +** ^The first argument (the third parameter to [sqlite3_db_config()] is a | |
1614 | +** pointer to a memory buffer to use for lookaside memory. | |
1615 | +** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb | |
1616 | +** may be NULL in which case SQLite will allocate the | |
1617 | +** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the | |
1618 | +** size of each lookaside buffer slot. ^The third argument is the number of | |
1619 | +** slots. The size of the buffer in the first argument must be greater than | |
1620 | +** or equal to the product of the second and third arguments. The buffer | |
1621 | +** must be aligned to an 8-byte boundary. ^If the second argument to | |
1622 | +** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally | |
1623 | +** rounded down to the next smaller multiple of 8. ^(The lookaside memory | |
1624 | +** configuration for a database connection can only be changed when that | |
1625 | +** connection is not currently using lookaside memory, or in other words | |
1626 | +** when the "current value" returned by | |
1627 | +** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. | |
1628 | +** Any attempt to change the lookaside memory configuration when lookaside | |
1629 | +** memory is in use leaves the configuration unchanged and returns | |
1630 | +** [SQLITE_BUSY].)^</dd> | |
1631 | +** | |
1632 | +** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> | |
1633 | +** <dd> ^This option is used to enable or disable the enforcement of | |
1634 | +** [foreign key constraints]. There should be two additional arguments. | |
1635 | +** The first argument is an integer which is 0 to disable FK enforcement, | |
1636 | +** positive to enable FK enforcement or negative to leave FK enforcement | |
1637 | +** unchanged. The second parameter is a pointer to an integer into which | |
1638 | +** is written 0 or 1 to indicate whether FK enforcement is off or on | |
1639 | +** following this call. The second parameter may be a NULL pointer, in | |
1640 | +** which case the FK enforcement setting is not reported back. </dd> | |
1641 | +** | |
1642 | +** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> | |
1643 | +** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. | |
1644 | +** There should be two additional arguments. | |
1645 | +** The first argument is an integer which is 0 to disable triggers, | |
1646 | +** positive to enable triggers or negative to leave the setting unchanged. | |
1647 | +** The second parameter is a pointer to an integer into which | |
1648 | +** is written 0 or 1 to indicate whether triggers are disabled or enabled | |
1649 | +** following this call. The second parameter may be a NULL pointer, in | |
1650 | +** which case the trigger setting is not reported back. </dd> | |
1651 | +** | |
1652 | +** </dl> | |
1653 | +*/ | |
1654 | +#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ | |
1655 | +#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ | |
1656 | +#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ | |
1657 | + | |
1658 | + | |
1659 | +/* | |
1660 | +** CAPI3REF: Enable Or Disable Extended Result Codes | |
1661 | +** | |
1662 | +** ^The sqlite3_extended_result_codes() routine enables or disables the | |
1663 | +** [extended result codes] feature of SQLite. ^The extended result | |
1664 | +** codes are disabled by default for historical compatibility. | |
1665 | +*/ | |
1666 | +SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff); | |
1667 | + | |
1668 | +/* | |
1669 | +** CAPI3REF: Last Insert Rowid | |
1670 | +** | |
1671 | +** ^Each entry in an SQLite table has a unique 64-bit signed | |
1672 | +** integer key called the [ROWID | "rowid"]. ^The rowid is always available | |
1673 | +** as an undeclared column named ROWID, OID, or _ROWID_ as long as those | |
1674 | +** names are not also used by explicitly declared columns. ^If | |
1675 | +** the table has a column of type [INTEGER PRIMARY KEY] then that column | |
1676 | +** is another alias for the rowid. | |
1677 | +** | |
1678 | +** ^This routine returns the [rowid] of the most recent | |
1679 | +** successful [INSERT] into the database from the [database connection] | |
1680 | +** in the first argument. ^As of SQLite version 3.7.7, this routines | |
1681 | +** records the last insert rowid of both ordinary tables and [virtual tables]. | |
1682 | +** ^If no successful [INSERT]s | |
1683 | +** have ever occurred on that database connection, zero is returned. | |
1684 | +** | |
1685 | +** ^(If an [INSERT] occurs within a trigger or within a [virtual table] | |
1686 | +** method, then this routine will return the [rowid] of the inserted | |
1687 | +** row as long as the trigger or virtual table method is running. | |
1688 | +** But once the trigger or virtual table method ends, the value returned | |
1689 | +** by this routine reverts to what it was before the trigger or virtual | |
1690 | +** table method began.)^ | |
1691 | +** | |
1692 | +** ^An [INSERT] that fails due to a constraint violation is not a | |
1693 | +** successful [INSERT] and does not change the value returned by this | |
1694 | +** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, | |
1695 | +** and INSERT OR ABORT make no changes to the return value of this | |
1696 | +** routine when their insertion fails. ^(When INSERT OR REPLACE | |
1697 | +** encounters a constraint violation, it does not fail. The | |
1698 | +** INSERT continues to completion after deleting rows that caused | |
1699 | +** the constraint problem so INSERT OR REPLACE will always change | |
1700 | +** the return value of this interface.)^ | |
1701 | +** | |
1702 | +** ^For the purposes of this routine, an [INSERT] is considered to | |
1703 | +** be successful even if it is subsequently rolled back. | |
1704 | +** | |
1705 | +** This function is accessible to SQL statements via the | |
1706 | +** [last_insert_rowid() SQL function]. | |
1707 | +** | |
1708 | +** If a separate thread performs a new [INSERT] on the same | |
1709 | +** database connection while the [sqlite3_last_insert_rowid()] | |
1710 | +** function is running and thus changes the last insert [rowid], | |
1711 | +** then the value returned by [sqlite3_last_insert_rowid()] is | |
1712 | +** unpredictable and might not equal either the old or the new | |
1713 | +** last insert [rowid]. | |
1714 | +*/ | |
1715 | +SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); | |
1716 | + | |
1717 | +/* | |
1718 | +** CAPI3REF: Count The Number Of Rows Modified | |
1719 | +** | |
1720 | +** ^This function returns the number of database rows that were changed | |
1721 | +** or inserted or deleted by the most recently completed SQL statement | |
1722 | +** on the [database connection] specified by the first parameter. | |
1723 | +** ^(Only changes that are directly specified by the [INSERT], [UPDATE], | |
1724 | +** or [DELETE] statement are counted. Auxiliary changes caused by | |
1725 | +** triggers or [foreign key actions] are not counted.)^ Use the | |
1726 | +** [sqlite3_total_changes()] function to find the total number of changes | |
1727 | +** including changes caused by triggers and foreign key actions. | |
1728 | +** | |
1729 | +** ^Changes to a view that are simulated by an [INSTEAD OF trigger] | |
1730 | +** are not counted. Only real table changes are counted. | |
1731 | +** | |
1732 | +** ^(A "row change" is a change to a single row of a single table | |
1733 | +** caused by an INSERT, DELETE, or UPDATE statement. Rows that | |
1734 | +** are changed as side effects of [REPLACE] constraint resolution, | |
1735 | +** rollback, ABORT processing, [DROP TABLE], or by any other | |
1736 | +** mechanisms do not count as direct row changes.)^ | |
1737 | +** | |
1738 | +** A "trigger context" is a scope of execution that begins and | |
1739 | +** ends with the script of a [CREATE TRIGGER | trigger]. | |
1740 | +** Most SQL statements are | |
1741 | +** evaluated outside of any trigger. This is the "top level" | |
1742 | +** trigger context. If a trigger fires from the top level, a | |
1743 | +** new trigger context is entered for the duration of that one | |
1744 | +** trigger. Subtriggers create subcontexts for their duration. | |
1745 | +** | |
1746 | +** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does | |
1747 | +** not create a new trigger context. | |
1748 | +** | |
1749 | +** ^This function returns the number of direct row changes in the | |
1750 | +** most recent INSERT, UPDATE, or DELETE statement within the same | |
1751 | +** trigger context. | |
1752 | +** | |
1753 | +** ^Thus, when called from the top level, this function returns the | |
1754 | +** number of changes in the most recent INSERT, UPDATE, or DELETE | |
1755 | +** that also occurred at the top level. ^(Within the body of a trigger, | |
1756 | +** the sqlite3_changes() interface can be called to find the number of | |
1757 | +** changes in the most recently completed INSERT, UPDATE, or DELETE | |
1758 | +** statement within the body of the same trigger. | |
1759 | +** However, the number returned does not include changes | |
1760 | +** caused by subtriggers since those have their own context.)^ | |
1761 | +** | |
1762 | +** See also the [sqlite3_total_changes()] interface, the | |
1763 | +** [count_changes pragma], and the [changes() SQL function]. | |
1764 | +** | |
1765 | +** If a separate thread makes changes on the same database connection | |
1766 | +** while [sqlite3_changes()] is running then the value returned | |
1767 | +** is unpredictable and not meaningful. | |
1768 | +*/ | |
1769 | +SQLITE_API int sqlite3_changes(sqlite3*); | |
1770 | + | |
1771 | +/* | |
1772 | +** CAPI3REF: Total Number Of Rows Modified | |
1773 | +** | |
1774 | +** ^This function returns the number of row changes caused by [INSERT], | |
1775 | +** [UPDATE] or [DELETE] statements since the [database connection] was opened. | |
1776 | +** ^(The count returned by sqlite3_total_changes() includes all changes | |
1777 | +** from all [CREATE TRIGGER | trigger] contexts and changes made by | |
1778 | +** [foreign key actions]. However, | |
1779 | +** the count does not include changes used to implement [REPLACE] constraints, | |
1780 | +** do rollbacks or ABORT processing, or [DROP TABLE] processing. The | |
1781 | +** count does not include rows of views that fire an [INSTEAD OF trigger], | |
1782 | +** though if the INSTEAD OF trigger makes changes of its own, those changes | |
1783 | +** are counted.)^ | |
1784 | +** ^The sqlite3_total_changes() function counts the changes as soon as | |
1785 | +** the statement that makes them is completed (when the statement handle | |
1786 | +** is passed to [sqlite3_reset()] or [sqlite3_finalize()]). | |
1787 | +** | |
1788 | +** See also the [sqlite3_changes()] interface, the | |
1789 | +** [count_changes pragma], and the [total_changes() SQL function]. | |
1790 | +** | |
1791 | +** If a separate thread makes changes on the same database connection | |
1792 | +** while [sqlite3_total_changes()] is running then the value | |
1793 | +** returned is unpredictable and not meaningful. | |
1794 | +*/ | |
1795 | +SQLITE_API int sqlite3_total_changes(sqlite3*); | |
1796 | + | |
1797 | +/* | |
1798 | +** CAPI3REF: Interrupt A Long-Running Query | |
1799 | +** | |
1800 | +** ^This function causes any pending database operation to abort and | |
1801 | +** return at its earliest opportunity. This routine is typically | |
1802 | +** called in response to a user action such as pressing "Cancel" | |
1803 | +** or Ctrl-C where the user wants a long query operation to halt | |
1804 | +** immediately. | |
1805 | +** | |
1806 | +** ^It is safe to call this routine from a thread different from the | |
1807 | +** thread that is currently running the database operation. But it | |
1808 | +** is not safe to call this routine with a [database connection] that | |
1809 | +** is closed or might close before sqlite3_interrupt() returns. | |
1810 | +** | |
1811 | +** ^If an SQL operation is very nearly finished at the time when | |
1812 | +** sqlite3_interrupt() is called, then it might not have an opportunity | |
1813 | +** to be interrupted and might continue to completion. | |
1814 | +** | |
1815 | +** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. | |
1816 | +** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE | |
1817 | +** that is inside an explicit transaction, then the entire transaction | |
1818 | +** will be rolled back automatically. | |
1819 | +** | |
1820 | +** ^The sqlite3_interrupt(D) call is in effect until all currently running | |
1821 | +** SQL statements on [database connection] D complete. ^Any new SQL statements | |
1822 | +** that are started after the sqlite3_interrupt() call and before the | |
1823 | +** running statements reaches zero are interrupted as if they had been | |
1824 | +** running prior to the sqlite3_interrupt() call. ^New SQL statements | |
1825 | +** that are started after the running statement count reaches zero are | |
1826 | +** not effected by the sqlite3_interrupt(). | |
1827 | +** ^A call to sqlite3_interrupt(D) that occurs when there are no running | |
1828 | +** SQL statements is a no-op and has no effect on SQL statements | |
1829 | +** that are started after the sqlite3_interrupt() call returns. | |
1830 | +** | |
1831 | +** If the database connection closes while [sqlite3_interrupt()] | |
1832 | +** is running then bad things will likely happen. | |
1833 | +*/ | |
1834 | +SQLITE_API void sqlite3_interrupt(sqlite3*); | |
1835 | + | |
1836 | +/* | |
1837 | +** CAPI3REF: Determine If An SQL Statement Is Complete | |
1838 | +** | |
1839 | +** These routines are useful during command-line input to determine if the | |
1840 | +** currently entered text seems to form a complete SQL statement or | |
1841 | +** if additional input is needed before sending the text into | |
1842 | +** SQLite for parsing. ^These routines return 1 if the input string | |
1843 | +** appears to be a complete SQL statement. ^A statement is judged to be | |
1844 | +** complete if it ends with a semicolon token and is not a prefix of a | |
1845 | +** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within | |
1846 | +** string literals or quoted identifier names or comments are not | |
1847 | +** independent tokens (they are part of the token in which they are | |
1848 | +** embedded) and thus do not count as a statement terminator. ^Whitespace | |
1849 | +** and comments that follow the final semicolon are ignored. | |
1850 | +** | |
1851 | +** ^These routines return 0 if the statement is incomplete. ^If a | |
1852 | +** memory allocation fails, then SQLITE_NOMEM is returned. | |
1853 | +** | |
1854 | +** ^These routines do not parse the SQL statements thus | |
1855 | +** will not detect syntactically incorrect SQL. | |
1856 | +** | |
1857 | +** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior | |
1858 | +** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked | |
1859 | +** automatically by sqlite3_complete16(). If that initialization fails, | |
1860 | +** then the return value from sqlite3_complete16() will be non-zero | |
1861 | +** regardless of whether or not the input SQL is complete.)^ | |
1862 | +** | |
1863 | +** The input to [sqlite3_complete()] must be a zero-terminated | |
1864 | +** UTF-8 string. | |
1865 | +** | |
1866 | +** The input to [sqlite3_complete16()] must be a zero-terminated | |
1867 | +** UTF-16 string in native byte order. | |
1868 | +*/ | |
1869 | +SQLITE_API int sqlite3_complete(const char *sql); | |
1870 | +SQLITE_API int sqlite3_complete16(const void *sql); | |
1871 | + | |
1872 | +/* | |
1873 | +** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors | |
1874 | +** | |
1875 | +** ^This routine sets a callback function that might be invoked whenever | |
1876 | +** an attempt is made to open a database table that another thread | |
1877 | +** or process has locked. | |
1878 | +** | |
1879 | +** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] | |
1880 | +** is returned immediately upon encountering the lock. ^If the busy callback | |
1881 | +** is not NULL, then the callback might be invoked with two arguments. | |
1882 | +** | |
1883 | +** ^The first argument to the busy handler is a copy of the void* pointer which | |
1884 | +** is the third argument to sqlite3_busy_handler(). ^The second argument to | |
1885 | +** the busy handler callback is the number of times that the busy handler has | |
1886 | +** been invoked for this locking event. ^If the | |
1887 | +** busy callback returns 0, then no additional attempts are made to | |
1888 | +** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. | |
1889 | +** ^If the callback returns non-zero, then another attempt | |
1890 | +** is made to open the database for reading and the cycle repeats. | |
1891 | +** | |
1892 | +** The presence of a busy handler does not guarantee that it will be invoked | |
1893 | +** when there is lock contention. ^If SQLite determines that invoking the busy | |
1894 | +** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] | |
1895 | +** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. | |
1896 | +** Consider a scenario where one process is holding a read lock that | |
1897 | +** it is trying to promote to a reserved lock and | |
1898 | +** a second process is holding a reserved lock that it is trying | |
1899 | +** to promote to an exclusive lock. The first process cannot proceed | |
1900 | +** because it is blocked by the second and the second process cannot | |
1901 | +** proceed because it is blocked by the first. If both processes | |
1902 | +** invoke the busy handlers, neither will make any progress. Therefore, | |
1903 | +** SQLite returns [SQLITE_BUSY] for the first process, hoping that this | |
1904 | +** will induce the first process to release its read lock and allow | |
1905 | +** the second process to proceed. | |
1906 | +** | |
1907 | +** ^The default busy callback is NULL. | |
1908 | +** | |
1909 | +** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] | |
1910 | +** when SQLite is in the middle of a large transaction where all the | |
1911 | +** changes will not fit into the in-memory cache. SQLite will | |
1912 | +** already hold a RESERVED lock on the database file, but it needs | |
1913 | +** to promote this lock to EXCLUSIVE so that it can spill cache | |
1914 | +** pages into the database file without harm to concurrent | |
1915 | +** readers. ^If it is unable to promote the lock, then the in-memory | |
1916 | +** cache will be left in an inconsistent state and so the error | |
1917 | +** code is promoted from the relatively benign [SQLITE_BUSY] to | |
1918 | +** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion | |
1919 | +** forces an automatic rollback of the changes. See the | |
1920 | +** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> | |
1921 | +** CorruptionFollowingBusyError</a> wiki page for a discussion of why | |
1922 | +** this is important. | |
1923 | +** | |
1924 | +** ^(There can only be a single busy handler defined for each | |
1925 | +** [database connection]. Setting a new busy handler clears any | |
1926 | +** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] | |
1927 | +** will also set or clear the busy handler. | |
1928 | +** | |
1929 | +** The busy callback should not take any actions which modify the | |
1930 | +** database connection that invoked the busy handler. Any such actions | |
1931 | +** result in undefined behavior. | |
1932 | +** | |
1933 | +** A busy handler must not close the database connection | |
1934 | +** or [prepared statement] that invoked the busy handler. | |
1935 | +*/ | |
1936 | +SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); | |
1937 | + | |
1938 | +/* | |
1939 | +** CAPI3REF: Set A Busy Timeout | |
1940 | +** | |
1941 | +** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps | |
1942 | +** for a specified amount of time when a table is locked. ^The handler | |
1943 | +** will sleep multiple times until at least "ms" milliseconds of sleeping | |
1944 | +** have accumulated. ^After at least "ms" milliseconds of sleeping, | |
1945 | +** the handler returns 0 which causes [sqlite3_step()] to return | |
1946 | +** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. | |
1947 | +** | |
1948 | +** ^Calling this routine with an argument less than or equal to zero | |
1949 | +** turns off all busy handlers. | |
1950 | +** | |
1951 | +** ^(There can only be a single busy handler for a particular | |
1952 | +** [database connection] any any given moment. If another busy handler | |
1953 | +** was defined (using [sqlite3_busy_handler()]) prior to calling | |
1954 | +** this routine, that other busy handler is cleared.)^ | |
1955 | +*/ | |
1956 | +SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); | |
1957 | + | |
1958 | +/* | |
1959 | +** CAPI3REF: Convenience Routines For Running Queries | |
1960 | +** | |
1961 | +** This is a legacy interface that is preserved for backwards compatibility. | |
1962 | +** Use of this interface is not recommended. | |
1963 | +** | |
1964 | +** Definition: A <b>result table</b> is memory data structure created by the | |
1965 | +** [sqlite3_get_table()] interface. A result table records the | |
1966 | +** complete query results from one or more queries. | |
1967 | +** | |
1968 | +** The table conceptually has a number of rows and columns. But | |
1969 | +** these numbers are not part of the result table itself. These | |
1970 | +** numbers are obtained separately. Let N be the number of rows | |
1971 | +** and M be the number of columns. | |
1972 | +** | |
1973 | +** A result table is an array of pointers to zero-terminated UTF-8 strings. | |
1974 | +** There are (N+1)*M elements in the array. The first M pointers point | |
1975 | +** to zero-terminated strings that contain the names of the columns. | |
1976 | +** The remaining entries all point to query results. NULL values result | |
1977 | +** in NULL pointers. All other values are in their UTF-8 zero-terminated | |
1978 | +** string representation as returned by [sqlite3_column_text()]. | |
1979 | +** | |
1980 | +** A result table might consist of one or more memory allocations. | |
1981 | +** It is not safe to pass a result table directly to [sqlite3_free()]. | |
1982 | +** A result table should be deallocated using [sqlite3_free_table()]. | |
1983 | +** | |
1984 | +** ^(As an example of the result table format, suppose a query result | |
1985 | +** is as follows: | |
1986 | +** | |
1987 | +** <blockquote><pre> | |
1988 | +** Name | Age | |
1989 | +** ----------------------- | |
1990 | +** Alice | 43 | |
1991 | +** Bob | 28 | |
1992 | +** Cindy | 21 | |
1993 | +** </pre></blockquote> | |
1994 | +** | |
1995 | +** There are two column (M==2) and three rows (N==3). Thus the | |
1996 | +** result table has 8 entries. Suppose the result table is stored | |
1997 | +** in an array names azResult. Then azResult holds this content: | |
1998 | +** | |
1999 | +** <blockquote><pre> | |
2000 | +** azResult[0] = "Name"; | |
2001 | +** azResult[1] = "Age"; | |
2002 | +** azResult[2] = "Alice"; | |
2003 | +** azResult[3] = "43"; | |
2004 | +** azResult[4] = "Bob"; | |
2005 | +** azResult[5] = "28"; | |
2006 | +** azResult[6] = "Cindy"; | |
2007 | +** azResult[7] = "21"; | |
2008 | +** </pre></blockquote>)^ | |
2009 | +** | |
2010 | +** ^The sqlite3_get_table() function evaluates one or more | |
2011 | +** semicolon-separated SQL statements in the zero-terminated UTF-8 | |
2012 | +** string of its 2nd parameter and returns a result table to the | |
2013 | +** pointer given in its 3rd parameter. | |
2014 | +** | |
2015 | +** After the application has finished with the result from sqlite3_get_table(), | |
2016 | +** it must pass the result table pointer to sqlite3_free_table() in order to | |
2017 | +** release the memory that was malloced. Because of the way the | |
2018 | +** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling | |
2019 | +** function must not try to call [sqlite3_free()] directly. Only | |
2020 | +** [sqlite3_free_table()] is able to release the memory properly and safely. | |
2021 | +** | |
2022 | +** The sqlite3_get_table() interface is implemented as a wrapper around | |
2023 | +** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access | |
2024 | +** to any internal data structures of SQLite. It uses only the public | |
2025 | +** interface defined here. As a consequence, errors that occur in the | |
2026 | +** wrapper layer outside of the internal [sqlite3_exec()] call are not | |
2027 | +** reflected in subsequent calls to [sqlite3_errcode()] or | |
2028 | +** [sqlite3_errmsg()]. | |
2029 | +*/ | |
2030 | +SQLITE_API int sqlite3_get_table( | |
2031 | + sqlite3 *db, /* An open database */ | |
2032 | + const char *zSql, /* SQL to be evaluated */ | |
2033 | + char ***pazResult, /* Results of the query */ | |
2034 | + int *pnRow, /* Number of result rows written here */ | |
2035 | + int *pnColumn, /* Number of result columns written here */ | |
2036 | + char **pzErrmsg /* Error msg written here */ | |
2037 | +); | |
2038 | +SQLITE_API void sqlite3_free_table(char **result); | |
2039 | + | |
2040 | +/* | |
2041 | +** CAPI3REF: Formatted String Printing Functions | |
2042 | +** | |
2043 | +** These routines are work-alikes of the "printf()" family of functions | |
2044 | +** from the standard C library. | |
2045 | +** | |
2046 | +** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their | |
2047 | +** results into memory obtained from [sqlite3_malloc()]. | |
2048 | +** The strings returned by these two routines should be | |
2049 | +** released by [sqlite3_free()]. ^Both routines return a | |
2050 | +** NULL pointer if [sqlite3_malloc()] is unable to allocate enough | |
2051 | +** memory to hold the resulting string. | |
2052 | +** | |
2053 | +** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from | |
2054 | +** the standard C library. The result is written into the | |
2055 | +** buffer supplied as the second parameter whose size is given by | |
2056 | +** the first parameter. Note that the order of the | |
2057 | +** first two parameters is reversed from snprintf().)^ This is an | |
2058 | +** historical accident that cannot be fixed without breaking | |
2059 | +** backwards compatibility. ^(Note also that sqlite3_snprintf() | |
2060 | +** returns a pointer to its buffer instead of the number of | |
2061 | +** characters actually written into the buffer.)^ We admit that | |
2062 | +** the number of characters written would be a more useful return | |
2063 | +** value but we cannot change the implementation of sqlite3_snprintf() | |
2064 | +** now without breaking compatibility. | |
2065 | +** | |
2066 | +** ^As long as the buffer size is greater than zero, sqlite3_snprintf() | |
2067 | +** guarantees that the buffer is always zero-terminated. ^The first | |
2068 | +** parameter "n" is the total size of the buffer, including space for | |
2069 | +** the zero terminator. So the longest string that can be completely | |
2070 | +** written will be n-1 characters. | |
2071 | +** | |
2072 | +** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). | |
2073 | +** | |
2074 | +** These routines all implement some additional formatting | |
2075 | +** options that are useful for constructing SQL statements. | |
2076 | +** All of the usual printf() formatting options apply. In addition, there | |
2077 | +** is are "%q", "%Q", and "%z" options. | |
2078 | +** | |
2079 | +** ^(The %q option works like %s in that it substitutes a nul-terminated | |
2080 | +** string from the argument list. But %q also doubles every '\'' character. | |
2081 | +** %q is designed for use inside a string literal.)^ By doubling each '\'' | |
2082 | +** character it escapes that character and allows it to be inserted into | |
2083 | +** the string. | |
2084 | +** | |
2085 | +** For example, assume the string variable zText contains text as follows: | |
2086 | +** | |
2087 | +** <blockquote><pre> | |
2088 | +** char *zText = "It's a happy day!"; | |
2089 | +** </pre></blockquote> | |
2090 | +** | |
2091 | +** One can use this text in an SQL statement as follows: | |
2092 | +** | |
2093 | +** <blockquote><pre> | |
2094 | +** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); | |
2095 | +** sqlite3_exec(db, zSQL, 0, 0, 0); | |
2096 | +** sqlite3_free(zSQL); | |
2097 | +** </pre></blockquote> | |
2098 | +** | |
2099 | +** Because the %q format string is used, the '\'' character in zText | |
2100 | +** is escaped and the SQL generated is as follows: | |
2101 | +** | |
2102 | +** <blockquote><pre> | |
2103 | +** INSERT INTO table1 VALUES('It''s a happy day!') | |
2104 | +** </pre></blockquote> | |
2105 | +** | |
2106 | +** This is correct. Had we used %s instead of %q, the generated SQL | |
2107 | +** would have looked like this: | |
2108 | +** | |
2109 | +** <blockquote><pre> | |
2110 | +** INSERT INTO table1 VALUES('It's a happy day!'); | |
2111 | +** </pre></blockquote> | |
2112 | +** | |
2113 | +** This second example is an SQL syntax error. As a general rule you should | |
2114 | +** always use %q instead of %s when inserting text into a string literal. | |
2115 | +** | |
2116 | +** ^(The %Q option works like %q except it also adds single quotes around | |
2117 | +** the outside of the total string. Additionally, if the parameter in the | |
2118 | +** argument list is a NULL pointer, %Q substitutes the text "NULL" (without | |
2119 | +** single quotes).)^ So, for example, one could say: | |
2120 | +** | |
2121 | +** <blockquote><pre> | |
2122 | +** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); | |
2123 | +** sqlite3_exec(db, zSQL, 0, 0, 0); | |
2124 | +** sqlite3_free(zSQL); | |
2125 | +** </pre></blockquote> | |
2126 | +** | |
2127 | +** The code above will render a correct SQL statement in the zSQL | |
2128 | +** variable even if the zText variable is a NULL pointer. | |
2129 | +** | |
2130 | +** ^(The "%z" formatting option works like "%s" but with the | |
2131 | +** addition that after the string has been read and copied into | |
2132 | +** the result, [sqlite3_free()] is called on the input string.)^ | |
2133 | +*/ | |
2134 | +SQLITE_API char *sqlite3_mprintf(const char*,...); | |
2135 | +SQLITE_API char *sqlite3_vmprintf(const char*, va_list); | |
2136 | +SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...); | |
2137 | +SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list); | |
2138 | + | |
2139 | +/* | |
2140 | +** CAPI3REF: Memory Allocation Subsystem | |
2141 | +** | |
2142 | +** The SQLite core uses these three routines for all of its own | |
2143 | +** internal memory allocation needs. "Core" in the previous sentence | |
2144 | +** does not include operating-system specific VFS implementation. The | |
2145 | +** Windows VFS uses native malloc() and free() for some operations. | |
2146 | +** | |
2147 | +** ^The sqlite3_malloc() routine returns a pointer to a block | |
2148 | +** of memory at least N bytes in length, where N is the parameter. | |
2149 | +** ^If sqlite3_malloc() is unable to obtain sufficient free | |
2150 | +** memory, it returns a NULL pointer. ^If the parameter N to | |
2151 | +** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns | |
2152 | +** a NULL pointer. | |
2153 | +** | |
2154 | +** ^Calling sqlite3_free() with a pointer previously returned | |
2155 | +** by sqlite3_malloc() or sqlite3_realloc() releases that memory so | |
2156 | +** that it might be reused. ^The sqlite3_free() routine is | |
2157 | +** a no-op if is called with a NULL pointer. Passing a NULL pointer | |
2158 | +** to sqlite3_free() is harmless. After being freed, memory | |
2159 | +** should neither be read nor written. Even reading previously freed | |
2160 | +** memory might result in a segmentation fault or other severe error. | |
2161 | +** Memory corruption, a segmentation fault, or other severe error | |
2162 | +** might result if sqlite3_free() is called with a non-NULL pointer that | |
2163 | +** was not obtained from sqlite3_malloc() or sqlite3_realloc(). | |
2164 | +** | |
2165 | +** ^(The sqlite3_realloc() interface attempts to resize a | |
2166 | +** prior memory allocation to be at least N bytes, where N is the | |
2167 | +** second parameter. The memory allocation to be resized is the first | |
2168 | +** parameter.)^ ^ If the first parameter to sqlite3_realloc() | |
2169 | +** is a NULL pointer then its behavior is identical to calling | |
2170 | +** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). | |
2171 | +** ^If the second parameter to sqlite3_realloc() is zero or | |
2172 | +** negative then the behavior is exactly the same as calling | |
2173 | +** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). | |
2174 | +** ^sqlite3_realloc() returns a pointer to a memory allocation | |
2175 | +** of at least N bytes in size or NULL if sufficient memory is unavailable. | |
2176 | +** ^If M is the size of the prior allocation, then min(N,M) bytes | |
2177 | +** of the prior allocation are copied into the beginning of buffer returned | |
2178 | +** by sqlite3_realloc() and the prior allocation is freed. | |
2179 | +** ^If sqlite3_realloc() returns NULL, then the prior allocation | |
2180 | +** is not freed. | |
2181 | +** | |
2182 | +** ^The memory returned by sqlite3_malloc() and sqlite3_realloc() | |
2183 | +** is always aligned to at least an 8 byte boundary, or to a | |
2184 | +** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time | |
2185 | +** option is used. | |
2186 | +** | |
2187 | +** In SQLite version 3.5.0 and 3.5.1, it was possible to define | |
2188 | +** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in | |
2189 | +** implementation of these routines to be omitted. That capability | |
2190 | +** is no longer provided. Only built-in memory allocators can be used. | |
2191 | +** | |
2192 | +** Prior to SQLite version 3.7.10, the Windows OS interface layer called | |
2193 | +** the system malloc() and free() directly when converting | |
2194 | +** filenames between the UTF-8 encoding used by SQLite | |
2195 | +** and whatever filename encoding is used by the particular Windows | |
2196 | +** installation. Memory allocation errors were detected, but | |
2197 | +** they were reported back as [SQLITE_CANTOPEN] or | |
2198 | +** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. | |
2199 | +** | |
2200 | +** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] | |
2201 | +** must be either NULL or else pointers obtained from a prior | |
2202 | +** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have | |
2203 | +** not yet been released. | |
2204 | +** | |
2205 | +** The application must not read or write any part of | |
2206 | +** a block of memory after it has been released using | |
2207 | +** [sqlite3_free()] or [sqlite3_realloc()]. | |
2208 | +*/ | |
2209 | +SQLITE_API void *sqlite3_malloc(int); | |
2210 | +SQLITE_API void *sqlite3_realloc(void*, int); | |
2211 | +SQLITE_API void sqlite3_free(void*); | |
2212 | + | |
2213 | +/* | |
2214 | +** CAPI3REF: Memory Allocator Statistics | |
2215 | +** | |
2216 | +** SQLite provides these two interfaces for reporting on the status | |
2217 | +** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] | |
2218 | +** routines, which form the built-in memory allocation subsystem. | |
2219 | +** | |
2220 | +** ^The [sqlite3_memory_used()] routine returns the number of bytes | |
2221 | +** of memory currently outstanding (malloced but not freed). | |
2222 | +** ^The [sqlite3_memory_highwater()] routine returns the maximum | |
2223 | +** value of [sqlite3_memory_used()] since the high-water mark | |
2224 | +** was last reset. ^The values returned by [sqlite3_memory_used()] and | |
2225 | +** [sqlite3_memory_highwater()] include any overhead | |
2226 | +** added by SQLite in its implementation of [sqlite3_malloc()], | |
2227 | +** but not overhead added by the any underlying system library | |
2228 | +** routines that [sqlite3_malloc()] may call. | |
2229 | +** | |
2230 | +** ^The memory high-water mark is reset to the current value of | |
2231 | +** [sqlite3_memory_used()] if and only if the parameter to | |
2232 | +** [sqlite3_memory_highwater()] is true. ^The value returned | |
2233 | +** by [sqlite3_memory_highwater(1)] is the high-water mark | |
2234 | +** prior to the reset. | |
2235 | +*/ | |
2236 | +SQLITE_API sqlite3_int64 sqlite3_memory_used(void); | |
2237 | +SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag); | |
2238 | + | |
2239 | +/* | |
2240 | +** CAPI3REF: Pseudo-Random Number Generator | |
2241 | +** | |
2242 | +** SQLite contains a high-quality pseudo-random number generator (PRNG) used to | |
2243 | +** select random [ROWID | ROWIDs] when inserting new records into a table that | |
2244 | +** already uses the largest possible [ROWID]. The PRNG is also used for | |
2245 | +** the build-in random() and randomblob() SQL functions. This interface allows | |
2246 | +** applications to access the same PRNG for other purposes. | |
2247 | +** | |
2248 | +** ^A call to this routine stores N bytes of randomness into buffer P. | |
2249 | +** | |
2250 | +** ^The first time this routine is invoked (either internally or by | |
2251 | +** the application) the PRNG is seeded using randomness obtained | |
2252 | +** from the xRandomness method of the default [sqlite3_vfs] object. | |
2253 | +** ^On all subsequent invocations, the pseudo-randomness is generated | |
2254 | +** internally and without recourse to the [sqlite3_vfs] xRandomness | |
2255 | +** method. | |
2256 | +*/ | |
2257 | +SQLITE_API void sqlite3_randomness(int N, void *P); | |
2258 | + | |
2259 | +/* | |
2260 | +** CAPI3REF: Compile-Time Authorization Callbacks | |
2261 | +** | |
2262 | +** ^This routine registers an authorizer callback with a particular | |
2263 | +** [database connection], supplied in the first argument. | |
2264 | +** ^The authorizer callback is invoked as SQL statements are being compiled | |
2265 | +** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], | |
2266 | +** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various | |
2267 | +** points during the compilation process, as logic is being created | |
2268 | +** to perform various actions, the authorizer callback is invoked to | |
2269 | +** see if those actions are allowed. ^The authorizer callback should | |
2270 | +** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the | |
2271 | +** specific action but allow the SQL statement to continue to be | |
2272 | +** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be | |
2273 | +** rejected with an error. ^If the authorizer callback returns | |
2274 | +** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] | |
2275 | +** then the [sqlite3_prepare_v2()] or equivalent call that triggered | |
2276 | +** the authorizer will fail with an error message. | |
2277 | +** | |
2278 | +** When the callback returns [SQLITE_OK], that means the operation | |
2279 | +** requested is ok. ^When the callback returns [SQLITE_DENY], the | |
2280 | +** [sqlite3_prepare_v2()] or equivalent call that triggered the | |
2281 | +** authorizer will fail with an error message explaining that | |
2282 | +** access is denied. | |
2283 | +** | |
2284 | +** ^The first parameter to the authorizer callback is a copy of the third | |
2285 | +** parameter to the sqlite3_set_authorizer() interface. ^The second parameter | |
2286 | +** to the callback is an integer [SQLITE_COPY | action code] that specifies | |
2287 | +** the particular action to be authorized. ^The third through sixth parameters | |
2288 | +** to the callback are zero-terminated strings that contain additional | |
2289 | +** details about the action to be authorized. | |
2290 | +** | |
2291 | +** ^If the action code is [SQLITE_READ] | |
2292 | +** and the callback returns [SQLITE_IGNORE] then the | |
2293 | +** [prepared statement] statement is constructed to substitute | |
2294 | +** a NULL value in place of the table column that would have | |
2295 | +** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] | |
2296 | +** return can be used to deny an untrusted user access to individual | |
2297 | +** columns of a table. | |
2298 | +** ^If the action code is [SQLITE_DELETE] and the callback returns | |
2299 | +** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the | |
2300 | +** [truncate optimization] is disabled and all rows are deleted individually. | |
2301 | +** | |
2302 | +** An authorizer is used when [sqlite3_prepare | preparing] | |
2303 | +** SQL statements from an untrusted source, to ensure that the SQL statements | |
2304 | +** do not try to access data they are not allowed to see, or that they do not | |
2305 | +** try to execute malicious statements that damage the database. For | |
2306 | +** example, an application may allow a user to enter arbitrary | |
2307 | +** SQL queries for evaluation by a database. But the application does | |
2308 | +** not want the user to be able to make arbitrary changes to the | |
2309 | +** database. An authorizer could then be put in place while the | |
2310 | +** user-entered SQL is being [sqlite3_prepare | prepared] that | |
2311 | +** disallows everything except [SELECT] statements. | |
2312 | +** | |
2313 | +** Applications that need to process SQL from untrusted sources | |
2314 | +** might also consider lowering resource limits using [sqlite3_limit()] | |
2315 | +** and limiting database size using the [max_page_count] [PRAGMA] | |
2316 | +** in addition to using an authorizer. | |
2317 | +** | |
2318 | +** ^(Only a single authorizer can be in place on a database connection | |
2319 | +** at a time. Each call to sqlite3_set_authorizer overrides the | |
2320 | +** previous call.)^ ^Disable the authorizer by installing a NULL callback. | |
2321 | +** The authorizer is disabled by default. | |
2322 | +** | |
2323 | +** The authorizer callback must not do anything that will modify | |
2324 | +** the database connection that invoked the authorizer callback. | |
2325 | +** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their | |
2326 | +** database connections for the meaning of "modify" in this paragraph. | |
2327 | +** | |
2328 | +** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the | |
2329 | +** statement might be re-prepared during [sqlite3_step()] due to a | |
2330 | +** schema change. Hence, the application should ensure that the | |
2331 | +** correct authorizer callback remains in place during the [sqlite3_step()]. | |
2332 | +** | |
2333 | +** ^Note that the authorizer callback is invoked only during | |
2334 | +** [sqlite3_prepare()] or its variants. Authorization is not | |
2335 | +** performed during statement evaluation in [sqlite3_step()], unless | |
2336 | +** as stated in the previous paragraph, sqlite3_step() invokes | |
2337 | +** sqlite3_prepare_v2() to reprepare a statement after a schema change. | |
2338 | +*/ | |
2339 | +SQLITE_API int sqlite3_set_authorizer( | |
2340 | + sqlite3*, | |
2341 | + int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), | |
2342 | + void *pUserData | |
2343 | +); | |
2344 | + | |
2345 | +/* | |
2346 | +** CAPI3REF: Authorizer Return Codes | |
2347 | +** | |
2348 | +** The [sqlite3_set_authorizer | authorizer callback function] must | |
2349 | +** return either [SQLITE_OK] or one of these two constants in order | |
2350 | +** to signal SQLite whether or not the action is permitted. See the | |
2351 | +** [sqlite3_set_authorizer | authorizer documentation] for additional | |
2352 | +** information. | |
2353 | +** | |
2354 | +** Note that SQLITE_IGNORE is also used as a [SQLITE_ROLLBACK | return code] | |
2355 | +** from the [sqlite3_vtab_on_conflict()] interface. | |
2356 | +*/ | |
2357 | +#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ | |
2358 | +#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ | |
2359 | + | |
2360 | +/* | |
2361 | +** CAPI3REF: Authorizer Action Codes | |
2362 | +** | |
2363 | +** The [sqlite3_set_authorizer()] interface registers a callback function | |
2364 | +** that is invoked to authorize certain SQL statement actions. The | |
2365 | +** second parameter to the callback is an integer code that specifies | |
2366 | +** what action is being authorized. These are the integer action codes that | |
2367 | +** the authorizer callback may be passed. | |
2368 | +** | |
2369 | +** These action code values signify what kind of operation is to be | |
2370 | +** authorized. The 3rd and 4th parameters to the authorization | |
2371 | +** callback function will be parameters or NULL depending on which of these | |
2372 | +** codes is used as the second parameter. ^(The 5th parameter to the | |
2373 | +** authorizer callback is the name of the database ("main", "temp", | |
2374 | +** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback | |
2375 | +** is the name of the inner-most trigger or view that is responsible for | |
2376 | +** the access attempt or NULL if this access attempt is directly from | |
2377 | +** top-level SQL code. | |
2378 | +*/ | |
2379 | +/******************************************* 3rd ************ 4th ***********/ | |
2380 | +#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ | |
2381 | +#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ | |
2382 | +#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ | |
2383 | +#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ | |
2384 | +#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ | |
2385 | +#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ | |
2386 | +#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ | |
2387 | +#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ | |
2388 | +#define SQLITE_DELETE 9 /* Table Name NULL */ | |
2389 | +#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ | |
2390 | +#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ | |
2391 | +#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ | |
2392 | +#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ | |
2393 | +#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ | |
2394 | +#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ | |
2395 | +#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ | |
2396 | +#define SQLITE_DROP_VIEW 17 /* View Name NULL */ | |
2397 | +#define SQLITE_INSERT 18 /* Table Name NULL */ | |
2398 | +#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ | |
2399 | +#define SQLITE_READ 20 /* Table Name Column Name */ | |
2400 | +#define SQLITE_SELECT 21 /* NULL NULL */ | |
2401 | +#define SQLITE_TRANSACTION 22 /* Operation NULL */ | |
2402 | +#define SQLITE_UPDATE 23 /* Table Name Column Name */ | |
2403 | +#define SQLITE_ATTACH 24 /* Filename NULL */ | |
2404 | +#define SQLITE_DETACH 25 /* Database Name NULL */ | |
2405 | +#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ | |
2406 | +#define SQLITE_REINDEX 27 /* Index Name NULL */ | |
2407 | +#define SQLITE_ANALYZE 28 /* Table Name NULL */ | |
2408 | +#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ | |
2409 | +#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ | |
2410 | +#define SQLITE_FUNCTION 31 /* NULL Function Name */ | |
2411 | +#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ | |
2412 | +#define SQLITE_COPY 0 /* No longer used */ | |
2413 | + | |
2414 | +/* | |
2415 | +** CAPI3REF: Tracing And Profiling Functions | |
2416 | +** | |
2417 | +** These routines register callback functions that can be used for | |
2418 | +** tracing and profiling the execution of SQL statements. | |
2419 | +** | |
2420 | +** ^The callback function registered by sqlite3_trace() is invoked at | |
2421 | +** various times when an SQL statement is being run by [sqlite3_step()]. | |
2422 | +** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the | |
2423 | +** SQL statement text as the statement first begins executing. | |
2424 | +** ^(Additional sqlite3_trace() callbacks might occur | |
2425 | +** as each triggered subprogram is entered. The callbacks for triggers | |
2426 | +** contain a UTF-8 SQL comment that identifies the trigger.)^ | |
2427 | +** | |
2428 | +** ^The callback function registered by sqlite3_profile() is invoked | |
2429 | +** as each SQL statement finishes. ^The profile callback contains | |
2430 | +** the original statement text and an estimate of wall-clock time | |
2431 | +** of how long that statement took to run. ^The profile callback | |
2432 | +** time is in units of nanoseconds, however the current implementation | |
2433 | +** is only capable of millisecond resolution so the six least significant | |
2434 | +** digits in the time are meaningless. Future versions of SQLite | |
2435 | +** might provide greater resolution on the profiler callback. The | |
2436 | +** sqlite3_profile() function is considered experimental and is | |
2437 | +** subject to change in future versions of SQLite. | |
2438 | +*/ | |
2439 | +SQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); | |
2440 | +SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, | |
2441 | + void(*xProfile)(void*,const char*,sqlite3_uint64), void*); | |
2442 | + | |
2443 | +/* | |
2444 | +** CAPI3REF: Query Progress Callbacks | |
2445 | +** | |
2446 | +** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback | |
2447 | +** function X to be invoked periodically during long running calls to | |
2448 | +** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for | |
2449 | +** database connection D. An example use for this | |
2450 | +** interface is to keep a GUI updated during a large query. | |
2451 | +** | |
2452 | +** ^The parameter P is passed through as the only parameter to the | |
2453 | +** callback function X. ^The parameter N is the number of | |
2454 | +** [virtual machine instructions] that are evaluated between successive | |
2455 | +** invocations of the callback X. | |
2456 | +** | |
2457 | +** ^Only a single progress handler may be defined at one time per | |
2458 | +** [database connection]; setting a new progress handler cancels the | |
2459 | +** old one. ^Setting parameter X to NULL disables the progress handler. | |
2460 | +** ^The progress handler is also disabled by setting N to a value less | |
2461 | +** than 1. | |
2462 | +** | |
2463 | +** ^If the progress callback returns non-zero, the operation is | |
2464 | +** interrupted. This feature can be used to implement a | |
2465 | +** "Cancel" button on a GUI progress dialog box. | |
2466 | +** | |
2467 | +** The progress handler callback must not do anything that will modify | |
2468 | +** the database connection that invoked the progress handler. | |
2469 | +** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their | |
2470 | +** database connections for the meaning of "modify" in this paragraph. | |
2471 | +** | |
2472 | +*/ | |
2473 | +SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); | |
2474 | + | |
2475 | +/* | |
2476 | +** CAPI3REF: Opening A New Database Connection | |
2477 | +** | |
2478 | +** ^These routines open an SQLite database file as specified by the | |
2479 | +** filename argument. ^The filename argument is interpreted as UTF-8 for | |
2480 | +** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte | |
2481 | +** order for sqlite3_open16(). ^(A [database connection] handle is usually | |
2482 | +** returned in *ppDb, even if an error occurs. The only exception is that | |
2483 | +** if SQLite is unable to allocate memory to hold the [sqlite3] object, | |
2484 | +** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] | |
2485 | +** object.)^ ^(If the database is opened (and/or created) successfully, then | |
2486 | +** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The | |
2487 | +** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain | |
2488 | +** an English language description of the error following a failure of any | |
2489 | +** of the sqlite3_open() routines. | |
2490 | +** | |
2491 | +** ^The default encoding for the database will be UTF-8 if | |
2492 | +** sqlite3_open() or sqlite3_open_v2() is called and | |
2493 | +** UTF-16 in the native byte order if sqlite3_open16() is used. | |
2494 | +** | |
2495 | +** Whether or not an error occurs when it is opened, resources | |
2496 | +** associated with the [database connection] handle should be released by | |
2497 | +** passing it to [sqlite3_close()] when it is no longer required. | |
2498 | +** | |
2499 | +** The sqlite3_open_v2() interface works like sqlite3_open() | |
2500 | +** except that it accepts two additional parameters for additional control | |
2501 | +** over the new database connection. ^(The flags parameter to | |
2502 | +** sqlite3_open_v2() can take one of | |
2503 | +** the following three values, optionally combined with the | |
2504 | +** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], | |
2505 | +** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^ | |
2506 | +** | |
2507 | +** <dl> | |
2508 | +** ^(<dt>[SQLITE_OPEN_READONLY]</dt> | |
2509 | +** <dd>The database is opened in read-only mode. If the database does not | |
2510 | +** already exist, an error is returned.</dd>)^ | |
2511 | +** | |
2512 | +** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> | |
2513 | +** <dd>The database is opened for reading and writing if possible, or reading | |
2514 | +** only if the file is write protected by the operating system. In either | |
2515 | +** case the database must already exist, otherwise an error is returned.</dd>)^ | |
2516 | +** | |
2517 | +** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> | |
2518 | +** <dd>The database is opened for reading and writing, and is created if | |
2519 | +** it does not already exist. This is the behavior that is always used for | |
2520 | +** sqlite3_open() and sqlite3_open16().</dd>)^ | |
2521 | +** </dl> | |
2522 | +** | |
2523 | +** If the 3rd parameter to sqlite3_open_v2() is not one of the | |
2524 | +** combinations shown above optionally combined with other | |
2525 | +** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] | |
2526 | +** then the behavior is undefined. | |
2527 | +** | |
2528 | +** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection | |
2529 | +** opens in the multi-thread [threading mode] as long as the single-thread | |
2530 | +** mode has not been set at compile-time or start-time. ^If the | |
2531 | +** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens | |
2532 | +** in the serialized [threading mode] unless single-thread was | |
2533 | +** previously selected at compile-time or start-time. | |
2534 | +** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be | |
2535 | +** eligible to use [shared cache mode], regardless of whether or not shared | |
2536 | +** cache is enabled using [sqlite3_enable_shared_cache()]. ^The | |
2537 | +** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not | |
2538 | +** participate in [shared cache mode] even if it is enabled. | |
2539 | +** | |
2540 | +** ^The fourth parameter to sqlite3_open_v2() is the name of the | |
2541 | +** [sqlite3_vfs] object that defines the operating system interface that | |
2542 | +** the new database connection should use. ^If the fourth parameter is | |
2543 | +** a NULL pointer then the default [sqlite3_vfs] object is used. | |
2544 | +** | |
2545 | +** ^If the filename is ":memory:", then a private, temporary in-memory database | |
2546 | +** is created for the connection. ^This in-memory database will vanish when | |
2547 | +** the database connection is closed. Future versions of SQLite might | |
2548 | +** make use of additional special filenames that begin with the ":" character. | |
2549 | +** It is recommended that when a database filename actually does begin with | |
2550 | +** a ":" character you should prefix the filename with a pathname such as | |
2551 | +** "./" to avoid ambiguity. | |
2552 | +** | |
2553 | +** ^If the filename is an empty string, then a private, temporary | |
2554 | +** on-disk database will be created. ^This private database will be | |
2555 | +** automatically deleted as soon as the database connection is closed. | |
2556 | +** | |
2557 | +** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3> | |
2558 | +** | |
2559 | +** ^If [URI filename] interpretation is enabled, and the filename argument | |
2560 | +** begins with "file:", then the filename is interpreted as a URI. ^URI | |
2561 | +** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is | |
2562 | +** set in the fourth argument to sqlite3_open_v2(), or if it has | |
2563 | +** been enabled globally using the [SQLITE_CONFIG_URI] option with the | |
2564 | +** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. | |
2565 | +** As of SQLite version 3.7.7, URI filename interpretation is turned off | |
2566 | +** by default, but future releases of SQLite might enable URI filename | |
2567 | +** interpretation by default. See "[URI filenames]" for additional | |
2568 | +** information. | |
2569 | +** | |
2570 | +** URI filenames are parsed according to RFC 3986. ^If the URI contains an | |
2571 | +** authority, then it must be either an empty string or the string | |
2572 | +** "localhost". ^If the authority is not an empty string or "localhost", an | |
2573 | +** error is returned to the caller. ^The fragment component of a URI, if | |
2574 | +** present, is ignored. | |
2575 | +** | |
2576 | +** ^SQLite uses the path component of the URI as the name of the disk file | |
2577 | +** which contains the database. ^If the path begins with a '/' character, | |
2578 | +** then it is interpreted as an absolute path. ^If the path does not begin | |
2579 | +** with a '/' (meaning that the authority section is omitted from the URI) | |
2580 | +** then the path is interpreted as a relative path. | |
2581 | +** ^On windows, the first component of an absolute path | |
2582 | +** is a drive specification (e.g. "C:"). | |
2583 | +** | |
2584 | +** [[core URI query parameters]] | |
2585 | +** The query component of a URI may contain parameters that are interpreted | |
2586 | +** either by SQLite itself, or by a [VFS | custom VFS implementation]. | |
2587 | +** SQLite interprets the following three query parameters: | |
2588 | +** | |
2589 | +** <ul> | |
2590 | +** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of | |
2591 | +** a VFS object that provides the operating system interface that should | |
2592 | +** be used to access the database file on disk. ^If this option is set to | |
2593 | +** an empty string the default VFS object is used. ^Specifying an unknown | |
2594 | +** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is | |
2595 | +** present, then the VFS specified by the option takes precedence over | |
2596 | +** the value passed as the fourth parameter to sqlite3_open_v2(). | |
2597 | +** | |
2598 | +** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw", | |
2599 | +** "rwc", or "memory". Attempting to set it to any other value is | |
2600 | +** an error)^. | |
2601 | +** ^If "ro" is specified, then the database is opened for read-only | |
2602 | +** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the | |
2603 | +** third argument to sqlite3_prepare_v2(). ^If the mode option is set to | |
2604 | +** "rw", then the database is opened for read-write (but not create) | |
2605 | +** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had | |
2606 | +** been set. ^Value "rwc" is equivalent to setting both | |
2607 | +** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is | |
2608 | +** set to "memory" then a pure [in-memory database] that never reads | |
2609 | +** or writes from disk is used. ^It is an error to specify a value for | |
2610 | +** the mode parameter that is less restrictive than that specified by | |
2611 | +** the flags passed in the third parameter to sqlite3_open_v2(). | |
2612 | +** | |
2613 | +** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or | |
2614 | +** "private". ^Setting it to "shared" is equivalent to setting the | |
2615 | +** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to | |
2616 | +** sqlite3_open_v2(). ^Setting the cache parameter to "private" is | |
2617 | +** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. | |
2618 | +** ^If sqlite3_open_v2() is used and the "cache" parameter is present in | |
2619 | +** a URI filename, its value overrides any behaviour requested by setting | |
2620 | +** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. | |
2621 | +** </ul> | |
2622 | +** | |
2623 | +** ^Specifying an unknown parameter in the query component of a URI is not an | |
2624 | +** error. Future versions of SQLite might understand additional query | |
2625 | +** parameters. See "[query parameters with special meaning to SQLite]" for | |
2626 | +** additional information. | |
2627 | +** | |
2628 | +** [[URI filename examples]] <h3>URI filename examples</h3> | |
2629 | +** | |
2630 | +** <table border="1" align=center cellpadding=5> | |
2631 | +** <tr><th> URI filenames <th> Results | |
2632 | +** <tr><td> file:data.db <td> | |
2633 | +** Open the file "data.db" in the current directory. | |
2634 | +** <tr><td> file:/home/fred/data.db<br> | |
2635 | +** file:///home/fred/data.db <br> | |
2636 | +** file://localhost/home/fred/data.db <br> <td> | |
2637 | +** Open the database file "/home/fred/data.db". | |
2638 | +** <tr><td> file://darkstar/home/fred/data.db <td> | |
2639 | +** An error. "darkstar" is not a recognized authority. | |
2640 | +** <tr><td style="white-space:nowrap"> | |
2641 | +** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db | |
2642 | +** <td> Windows only: Open the file "data.db" on fred's desktop on drive | |
2643 | +** C:. Note that the %20 escaping in this example is not strictly | |
2644 | +** necessary - space characters can be used literally | |
2645 | +** in URI filenames. | |
2646 | +** <tr><td> file:data.db?mode=ro&cache=private <td> | |
2647 | +** Open file "data.db" in the current directory for read-only access. | |
2648 | +** Regardless of whether or not shared-cache mode is enabled by | |
2649 | +** default, use a private cache. | |
2650 | +** <tr><td> file:/home/fred/data.db?vfs=unix-nolock <td> | |
2651 | +** Open file "/home/fred/data.db". Use the special VFS "unix-nolock". | |
2652 | +** <tr><td> file:data.db?mode=readonly <td> | |
2653 | +** An error. "readonly" is not a valid option for the "mode" parameter. | |
2654 | +** </table> | |
2655 | +** | |
2656 | +** ^URI hexadecimal escape sequences (%HH) are supported within the path and | |
2657 | +** query components of a URI. A hexadecimal escape sequence consists of a | |
2658 | +** percent sign - "%" - followed by exactly two hexadecimal digits | |
2659 | +** specifying an octet value. ^Before the path or query components of a | |
2660 | +** URI filename are interpreted, they are encoded using UTF-8 and all | |
2661 | +** hexadecimal escape sequences replaced by a single byte containing the | |
2662 | +** corresponding octet. If this process generates an invalid UTF-8 encoding, | |
2663 | +** the results are undefined. | |
2664 | +** | |
2665 | +** <b>Note to Windows users:</b> The encoding used for the filename argument | |
2666 | +** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever | |
2667 | +** codepage is currently defined. Filenames containing international | |
2668 | +** characters must be converted to UTF-8 prior to passing them into | |
2669 | +** sqlite3_open() or sqlite3_open_v2(). | |
2670 | +** | |
2671 | +** <b>Note to Windows Runtime users:</b> The temporary directory must be set | |
2672 | +** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various | |
2673 | +** features that require the use of temporary files may fail. | |
2674 | +** | |
2675 | +** See also: [sqlite3_temp_directory] | |
2676 | +*/ | |
2677 | +SQLITE_API int sqlite3_open( | |
2678 | + const char *filename, /* Database filename (UTF-8) */ | |
2679 | + sqlite3 **ppDb /* OUT: SQLite db handle */ | |
2680 | +); | |
2681 | +SQLITE_API int sqlite3_open16( | |
2682 | + const void *filename, /* Database filename (UTF-16) */ | |
2683 | + sqlite3 **ppDb /* OUT: SQLite db handle */ | |
2684 | +); | |
2685 | +SQLITE_API int sqlite3_open_v2( | |
2686 | + const char *filename, /* Database filename (UTF-8) */ | |
2687 | + sqlite3 **ppDb, /* OUT: SQLite db handle */ | |
2688 | + int flags, /* Flags */ | |
2689 | + const char *zVfs /* Name of VFS module to use */ | |
2690 | +); | |
2691 | + | |
2692 | +/* | |
2693 | +** CAPI3REF: Obtain Values For URI Parameters | |
2694 | +** | |
2695 | +** These are utility routines, useful to VFS implementations, that check | |
2696 | +** to see if a database file was a URI that contained a specific query | |
2697 | +** parameter, and if so obtains the value of that query parameter. | |
2698 | +** | |
2699 | +** If F is the database filename pointer passed into the xOpen() method of | |
2700 | +** a VFS implementation when the flags parameter to xOpen() has one or | |
2701 | +** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and | |
2702 | +** P is the name of the query parameter, then | |
2703 | +** sqlite3_uri_parameter(F,P) returns the value of the P | |
2704 | +** parameter if it exists or a NULL pointer if P does not appear as a | |
2705 | +** query parameter on F. If P is a query parameter of F | |
2706 | +** has no explicit value, then sqlite3_uri_parameter(F,P) returns | |
2707 | +** a pointer to an empty string. | |
2708 | +** | |
2709 | +** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean | |
2710 | +** parameter and returns true (1) or false (0) according to the value | |
2711 | +** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the | |
2712 | +** value of query parameter P is one of "yes", "true", or "on" in any | |
2713 | +** case or if the value begins with a non-zero number. The | |
2714 | +** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of | |
2715 | +** query parameter P is one of "no", "false", or "off" in any case or | |
2716 | +** if the value begins with a numeric zero. If P is not a query | |
2717 | +** parameter on F or if the value of P is does not match any of the | |
2718 | +** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0). | |
2719 | +** | |
2720 | +** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a | |
2721 | +** 64-bit signed integer and returns that integer, or D if P does not | |
2722 | +** exist. If the value of P is something other than an integer, then | |
2723 | +** zero is returned. | |
2724 | +** | |
2725 | +** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and | |
2726 | +** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and | |
2727 | +** is not a database file pathname pointer that SQLite passed into the xOpen | |
2728 | +** VFS method, then the behavior of this routine is undefined and probably | |
2729 | +** undesirable. | |
2730 | +*/ | |
2731 | +SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam); | |
2732 | +SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); | |
2733 | +SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64); | |
2734 | + | |
2735 | + | |
2736 | +/* | |
2737 | +** CAPI3REF: Error Codes And Messages | |
2738 | +** | |
2739 | +** ^The sqlite3_errcode() interface returns the numeric [result code] or | |
2740 | +** [extended result code] for the most recent failed sqlite3_* API call | |
2741 | +** associated with a [database connection]. If a prior API call failed | |
2742 | +** but the most recent API call succeeded, the return value from | |
2743 | +** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode() | |
2744 | +** interface is the same except that it always returns the | |
2745 | +** [extended result code] even when extended result codes are | |
2746 | +** disabled. | |
2747 | +** | |
2748 | +** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language | |
2749 | +** text that describes the error, as either UTF-8 or UTF-16 respectively. | |
2750 | +** ^(Memory to hold the error message string is managed internally. | |
2751 | +** The application does not need to worry about freeing the result. | |
2752 | +** However, the error string might be overwritten or deallocated by | |
2753 | +** subsequent calls to other SQLite interface functions.)^ | |
2754 | +** | |
2755 | +** When the serialized [threading mode] is in use, it might be the | |
2756 | +** case that a second error occurs on a separate thread in between | |
2757 | +** the time of the first error and the call to these interfaces. | |
2758 | +** When that happens, the second error will be reported since these | |
2759 | +** interfaces always report the most recent result. To avoid | |
2760 | +** this, each thread can obtain exclusive use of the [database connection] D | |
2761 | +** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning | |
2762 | +** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after | |
2763 | +** all calls to the interfaces listed here are completed. | |
2764 | +** | |
2765 | +** If an interface fails with SQLITE_MISUSE, that means the interface | |
2766 | +** was invoked incorrectly by the application. In that case, the | |
2767 | +** error code and message may or may not be set. | |
2768 | +*/ | |
2769 | +SQLITE_API int sqlite3_errcode(sqlite3 *db); | |
2770 | +SQLITE_API int sqlite3_extended_errcode(sqlite3 *db); | |
2771 | +SQLITE_API const char *sqlite3_errmsg(sqlite3*); | |
2772 | +SQLITE_API const void *sqlite3_errmsg16(sqlite3*); | |
2773 | + | |
2774 | +/* | |
2775 | +** CAPI3REF: SQL Statement Object | |
2776 | +** KEYWORDS: {prepared statement} {prepared statements} | |
2777 | +** | |
2778 | +** An instance of this object represents a single SQL statement. | |
2779 | +** This object is variously known as a "prepared statement" or a | |
2780 | +** "compiled SQL statement" or simply as a "statement". | |
2781 | +** | |
2782 | +** The life of a statement object goes something like this: | |
2783 | +** | |
2784 | +** <ol> | |
2785 | +** <li> Create the object using [sqlite3_prepare_v2()] or a related | |
2786 | +** function. | |
2787 | +** <li> Bind values to [host parameters] using the sqlite3_bind_*() | |
2788 | +** interfaces. | |
2789 | +** <li> Run the SQL by calling [sqlite3_step()] one or more times. | |
2790 | +** <li> Reset the statement using [sqlite3_reset()] then go back | |
2791 | +** to step 2. Do this zero or more times. | |
2792 | +** <li> Destroy the object using [sqlite3_finalize()]. | |
2793 | +** </ol> | |
2794 | +** | |
2795 | +** Refer to documentation on individual methods above for additional | |
2796 | +** information. | |
2797 | +*/ | |
2798 | +typedef struct sqlite3_stmt sqlite3_stmt; | |
2799 | + | |
2800 | +/* | |
2801 | +** CAPI3REF: Run-time Limits | |
2802 | +** | |
2803 | +** ^(This interface allows the size of various constructs to be limited | |
2804 | +** on a connection by connection basis. The first parameter is the | |
2805 | +** [database connection] whose limit is to be set or queried. The | |
2806 | +** second parameter is one of the [limit categories] that define a | |
2807 | +** class of constructs to be size limited. The third parameter is the | |
2808 | +** new limit for that construct.)^ | |
2809 | +** | |
2810 | +** ^If the new limit is a negative number, the limit is unchanged. | |
2811 | +** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a | |
2812 | +** [limits | hard upper bound] | |
2813 | +** set at compile-time by a C preprocessor macro called | |
2814 | +** [limits | SQLITE_MAX_<i>NAME</i>]. | |
2815 | +** (The "_LIMIT_" in the name is changed to "_MAX_".))^ | |
2816 | +** ^Attempts to increase a limit above its hard upper bound are | |
2817 | +** silently truncated to the hard upper bound. | |
2818 | +** | |
2819 | +** ^Regardless of whether or not the limit was changed, the | |
2820 | +** [sqlite3_limit()] interface returns the prior value of the limit. | |
2821 | +** ^Hence, to find the current value of a limit without changing it, | |
2822 | +** simply invoke this interface with the third parameter set to -1. | |
2823 | +** | |
2824 | +** Run-time limits are intended for use in applications that manage | |
2825 | +** both their own internal database and also databases that are controlled | |
2826 | +** by untrusted external sources. An example application might be a | |
2827 | +** web browser that has its own databases for storing history and | |
2828 | +** separate databases controlled by JavaScript applications downloaded | |
2829 | +** off the Internet. The internal databases can be given the | |
2830 | +** large, default limits. Databases managed by external sources can | |
2831 | +** be given much smaller limits designed to prevent a denial of service | |
2832 | +** attack. Developers might also want to use the [sqlite3_set_authorizer()] | |
2833 | +** interface to further control untrusted SQL. The size of the database | |
2834 | +** created by an untrusted script can be contained using the | |
2835 | +** [max_page_count] [PRAGMA]. | |
2836 | +** | |
2837 | +** New run-time limit categories may be added in future releases. | |
2838 | +*/ | |
2839 | +SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal); | |
2840 | + | |
2841 | +/* | |
2842 | +** CAPI3REF: Run-Time Limit Categories | |
2843 | +** KEYWORDS: {limit category} {*limit categories} | |
2844 | +** | |
2845 | +** These constants define various performance limits | |
2846 | +** that can be lowered at run-time using [sqlite3_limit()]. | |
2847 | +** The synopsis of the meanings of the various limits is shown below. | |
2848 | +** Additional information is available at [limits | Limits in SQLite]. | |
2849 | +** | |
2850 | +** <dl> | |
2851 | +** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt> | |
2852 | +** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^ | |
2853 | +** | |
2854 | +** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> | |
2855 | +** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ | |
2856 | +** | |
2857 | +** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt> | |
2858 | +** <dd>The maximum number of columns in a table definition or in the | |
2859 | +** result set of a [SELECT] or the maximum number of columns in an index | |
2860 | +** or in an ORDER BY or GROUP BY clause.</dd>)^ | |
2861 | +** | |
2862 | +** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> | |
2863 | +** <dd>The maximum depth of the parse tree on any expression.</dd>)^ | |
2864 | +** | |
2865 | +** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> | |
2866 | +** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ | |
2867 | +** | |
2868 | +** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> | |
2869 | +** <dd>The maximum number of instructions in a virtual machine program | |
2870 | +** used to implement an SQL statement. This limit is not currently | |
2871 | +** enforced, though that might be added in some future release of | |
2872 | +** SQLite.</dd>)^ | |
2873 | +** | |
2874 | +** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> | |
2875 | +** <dd>The maximum number of arguments on a function.</dd>)^ | |
2876 | +** | |
2877 | +** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt> | |
2878 | +** <dd>The maximum number of [ATTACH | attached databases].)^</dd> | |
2879 | +** | |
2880 | +** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]] | |
2881 | +** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> | |
2882 | +** <dd>The maximum length of the pattern argument to the [LIKE] or | |
2883 | +** [GLOB] operators.</dd>)^ | |
2884 | +** | |
2885 | +** [[SQLITE_LIMIT_VARIABLE_NUMBER]] | |
2886 | +** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> | |
2887 | +** <dd>The maximum index number of any [parameter] in an SQL statement.)^ | |
2888 | +** | |
2889 | +** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> | |
2890 | +** <dd>The maximum depth of recursion for triggers.</dd>)^ | |
2891 | +** </dl> | |
2892 | +*/ | |
2893 | +#define SQLITE_LIMIT_LENGTH 0 | |
2894 | +#define SQLITE_LIMIT_SQL_LENGTH 1 | |
2895 | +#define SQLITE_LIMIT_COLUMN 2 | |
2896 | +#define SQLITE_LIMIT_EXPR_DEPTH 3 | |
2897 | +#define SQLITE_LIMIT_COMPOUND_SELECT 4 | |
2898 | +#define SQLITE_LIMIT_VDBE_OP 5 | |
2899 | +#define SQLITE_LIMIT_FUNCTION_ARG 6 | |
2900 | +#define SQLITE_LIMIT_ATTACHED 7 | |
2901 | +#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 | |
2902 | +#define SQLITE_LIMIT_VARIABLE_NUMBER 9 | |
2903 | +#define SQLITE_LIMIT_TRIGGER_DEPTH 10 | |
2904 | + | |
2905 | +/* | |
2906 | +** CAPI3REF: Compiling An SQL Statement | |
2907 | +** KEYWORDS: {SQL statement compiler} | |
2908 | +** | |
2909 | +** To execute an SQL query, it must first be compiled into a byte-code | |
2910 | +** program using one of these routines. | |
2911 | +** | |
2912 | +** The first argument, "db", is a [database connection] obtained from a | |
2913 | +** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or | |
2914 | +** [sqlite3_open16()]. The database connection must not have been closed. | |
2915 | +** | |
2916 | +** The second argument, "zSql", is the statement to be compiled, encoded | |
2917 | +** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() | |
2918 | +** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() | |
2919 | +** use UTF-16. | |
2920 | +** | |
2921 | +** ^If the nByte argument is less than zero, then zSql is read up to the | |
2922 | +** first zero terminator. ^If nByte is non-negative, then it is the maximum | |
2923 | +** number of bytes read from zSql. ^When nByte is non-negative, the | |
2924 | +** zSql string ends at either the first '\000' or '\u0000' character or | |
2925 | +** the nByte-th byte, whichever comes first. If the caller knows | |
2926 | +** that the supplied string is nul-terminated, then there is a small | |
2927 | +** performance advantage to be gained by passing an nByte parameter that | |
2928 | +** is equal to the number of bytes in the input string <i>including</i> | |
2929 | +** the nul-terminator bytes as this saves SQLite from having to | |
2930 | +** make a copy of the input string. | |
2931 | +** | |
2932 | +** ^If pzTail is not NULL then *pzTail is made to point to the first byte | |
2933 | +** past the end of the first SQL statement in zSql. These routines only | |
2934 | +** compile the first statement in zSql, so *pzTail is left pointing to | |
2935 | +** what remains uncompiled. | |
2936 | +** | |
2937 | +** ^*ppStmt is left pointing to a compiled [prepared statement] that can be | |
2938 | +** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set | |
2939 | +** to NULL. ^If the input text contains no SQL (if the input is an empty | |
2940 | +** string or a comment) then *ppStmt is set to NULL. | |
2941 | +** The calling procedure is responsible for deleting the compiled | |
2942 | +** SQL statement using [sqlite3_finalize()] after it has finished with it. | |
2943 | +** ppStmt may not be NULL. | |
2944 | +** | |
2945 | +** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; | |
2946 | +** otherwise an [error code] is returned. | |
2947 | +** | |
2948 | +** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are | |
2949 | +** recommended for all new programs. The two older interfaces are retained | |
2950 | +** for backwards compatibility, but their use is discouraged. | |
2951 | +** ^In the "v2" interfaces, the prepared statement | |
2952 | +** that is returned (the [sqlite3_stmt] object) contains a copy of the | |
2953 | +** original SQL text. This causes the [sqlite3_step()] interface to | |
2954 | +** behave differently in three ways: | |
2955 | +** | |
2956 | +** <ol> | |
2957 | +** <li> | |
2958 | +** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it | |
2959 | +** always used to do, [sqlite3_step()] will automatically recompile the SQL | |
2960 | +** statement and try to run it again. | |
2961 | +** </li> | |
2962 | +** | |
2963 | +** <li> | |
2964 | +** ^When an error occurs, [sqlite3_step()] will return one of the detailed | |
2965 | +** [error codes] or [extended error codes]. ^The legacy behavior was that | |
2966 | +** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code | |
2967 | +** and the application would have to make a second call to [sqlite3_reset()] | |
2968 | +** in order to find the underlying cause of the problem. With the "v2" prepare | |
2969 | +** interfaces, the underlying reason for the error is returned immediately. | |
2970 | +** </li> | |
2971 | +** | |
2972 | +** <li> | |
2973 | +** ^If the specific value bound to [parameter | host parameter] in the | |
2974 | +** WHERE clause might influence the choice of query plan for a statement, | |
2975 | +** then the statement will be automatically recompiled, as if there had been | |
2976 | +** a schema change, on the first [sqlite3_step()] call following any change | |
2977 | +** to the [sqlite3_bind_text | bindings] of that [parameter]. | |
2978 | +** ^The specific value of WHERE-clause [parameter] might influence the | |
2979 | +** choice of query plan if the parameter is the left-hand side of a [LIKE] | |
2980 | +** or [GLOB] operator or if the parameter is compared to an indexed column | |
2981 | +** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled. | |
2982 | +** the | |
2983 | +** </li> | |
2984 | +** </ol> | |
2985 | +*/ | |
2986 | +SQLITE_API int sqlite3_prepare( | |
2987 | + sqlite3 *db, /* Database handle */ | |
2988 | + const char *zSql, /* SQL statement, UTF-8 encoded */ | |
2989 | + int nByte, /* Maximum length of zSql in bytes. */ | |
2990 | + sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | |
2991 | + const char **pzTail /* OUT: Pointer to unused portion of zSql */ | |
2992 | +); | |
2993 | +SQLITE_API int sqlite3_prepare_v2( | |
2994 | + sqlite3 *db, /* Database handle */ | |
2995 | + const char *zSql, /* SQL statement, UTF-8 encoded */ | |
2996 | + int nByte, /* Maximum length of zSql in bytes. */ | |
2997 | + sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | |
2998 | + const char **pzTail /* OUT: Pointer to unused portion of zSql */ | |
2999 | +); | |
3000 | +SQLITE_API int sqlite3_prepare16( | |
3001 | + sqlite3 *db, /* Database handle */ | |
3002 | + const void *zSql, /* SQL statement, UTF-16 encoded */ | |
3003 | + int nByte, /* Maximum length of zSql in bytes. */ | |
3004 | + sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | |
3005 | + const void **pzTail /* OUT: Pointer to unused portion of zSql */ | |
3006 | +); | |
3007 | +SQLITE_API int sqlite3_prepare16_v2( | |
3008 | + sqlite3 *db, /* Database handle */ | |
3009 | + const void *zSql, /* SQL statement, UTF-16 encoded */ | |
3010 | + int nByte, /* Maximum length of zSql in bytes. */ | |
3011 | + sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | |
3012 | + const void **pzTail /* OUT: Pointer to unused portion of zSql */ | |
3013 | +); | |
3014 | + | |
3015 | +/* | |
3016 | +** CAPI3REF: Retrieving Statement SQL | |
3017 | +** | |
3018 | +** ^This interface can be used to retrieve a saved copy of the original | |
3019 | +** SQL text used to create a [prepared statement] if that statement was | |
3020 | +** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. | |
3021 | +*/ | |
3022 | +SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); | |
3023 | + | |
3024 | +/* | |
3025 | +** CAPI3REF: Determine If An SQL Statement Writes The Database | |
3026 | +** | |
3027 | +** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if | |
3028 | +** and only if the [prepared statement] X makes no direct changes to | |
3029 | +** the content of the database file. | |
3030 | +** | |
3031 | +** Note that [application-defined SQL functions] or | |
3032 | +** [virtual tables] might change the database indirectly as a side effect. | |
3033 | +** ^(For example, if an application defines a function "eval()" that | |
3034 | +** calls [sqlite3_exec()], then the following SQL statement would | |
3035 | +** change the database file through side-effects: | |
3036 | +** | |
3037 | +** <blockquote><pre> | |
3038 | +** SELECT eval('DELETE FROM t1') FROM t2; | |
3039 | +** </pre></blockquote> | |
3040 | +** | |
3041 | +** But because the [SELECT] statement does not change the database file | |
3042 | +** directly, sqlite3_stmt_readonly() would still return true.)^ | |
3043 | +** | |
3044 | +** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], | |
3045 | +** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, | |
3046 | +** since the statements themselves do not actually modify the database but | |
3047 | +** rather they control the timing of when other statements modify the | |
3048 | +** database. ^The [ATTACH] and [DETACH] statements also cause | |
3049 | +** sqlite3_stmt_readonly() to return true since, while those statements | |
3050 | +** change the configuration of a database connection, they do not make | |
3051 | +** changes to the content of the database files on disk. | |
3052 | +*/ | |
3053 | +SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); | |
3054 | + | |
3055 | +/* | |
3056 | +** CAPI3REF: Determine If A Prepared Statement Has Been Reset | |
3057 | +** | |
3058 | +** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the | |
3059 | +** [prepared statement] S has been stepped at least once using | |
3060 | +** [sqlite3_step(S)] but has not run to completion and/or has not | |
3061 | +** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S) | |
3062 | +** interface returns false if S is a NULL pointer. If S is not a | |
3063 | +** NULL pointer and is not a pointer to a valid [prepared statement] | |
3064 | +** object, then the behavior is undefined and probably undesirable. | |
3065 | +** | |
3066 | +** This interface can be used in combination [sqlite3_next_stmt()] | |
3067 | +** to locate all prepared statements associated with a database | |
3068 | +** connection that are in need of being reset. This can be used, | |
3069 | +** for example, in diagnostic routines to search for prepared | |
3070 | +** statements that are holding a transaction open. | |
3071 | +*/ | |
3072 | +SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*); | |
3073 | + | |
3074 | +/* | |
3075 | +** CAPI3REF: Dynamically Typed Value Object | |
3076 | +** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} | |
3077 | +** | |
3078 | +** SQLite uses the sqlite3_value object to represent all values | |
3079 | +** that can be stored in a database table. SQLite uses dynamic typing | |
3080 | +** for the values it stores. ^Values stored in sqlite3_value objects | |
3081 | +** can be integers, floating point values, strings, BLOBs, or NULL. | |
3082 | +** | |
3083 | +** An sqlite3_value object may be either "protected" or "unprotected". | |
3084 | +** Some interfaces require a protected sqlite3_value. Other interfaces | |
3085 | +** will accept either a protected or an unprotected sqlite3_value. | |
3086 | +** Every interface that accepts sqlite3_value arguments specifies | |
3087 | +** whether or not it requires a protected sqlite3_value. | |
3088 | +** | |
3089 | +** The terms "protected" and "unprotected" refer to whether or not | |
3090 | +** a mutex is held. An internal mutex is held for a protected | |
3091 | +** sqlite3_value object but no mutex is held for an unprotected | |
3092 | +** sqlite3_value object. If SQLite is compiled to be single-threaded | |
3093 | +** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) | |
3094 | +** or if SQLite is run in one of reduced mutex modes | |
3095 | +** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] | |
3096 | +** then there is no distinction between protected and unprotected | |
3097 | +** sqlite3_value objects and they can be used interchangeably. However, | |
3098 | +** for maximum code portability it is recommended that applications | |
3099 | +** still make the distinction between protected and unprotected | |
3100 | +** sqlite3_value objects even when not strictly required. | |
3101 | +** | |
3102 | +** ^The sqlite3_value objects that are passed as parameters into the | |
3103 | +** implementation of [application-defined SQL functions] are protected. | |
3104 | +** ^The sqlite3_value object returned by | |
3105 | +** [sqlite3_column_value()] is unprotected. | |
3106 | +** Unprotected sqlite3_value objects may only be used with | |
3107 | +** [sqlite3_result_value()] and [sqlite3_bind_value()]. | |
3108 | +** The [sqlite3_value_blob | sqlite3_value_type()] family of | |
3109 | +** interfaces require protected sqlite3_value objects. | |
3110 | +*/ | |
3111 | +typedef struct Mem sqlite3_value; | |
3112 | + | |
3113 | +/* | |
3114 | +** CAPI3REF: SQL Function Context Object | |
3115 | +** | |
3116 | +** The context in which an SQL function executes is stored in an | |
3117 | +** sqlite3_context object. ^A pointer to an sqlite3_context object | |
3118 | +** is always first parameter to [application-defined SQL functions]. | |
3119 | +** The application-defined SQL function implementation will pass this | |
3120 | +** pointer through into calls to [sqlite3_result_int | sqlite3_result()], | |
3121 | +** [sqlite3_aggregate_context()], [sqlite3_user_data()], | |
3122 | +** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], | |
3123 | +** and/or [sqlite3_set_auxdata()]. | |
3124 | +*/ | |
3125 | +typedef struct sqlite3_context sqlite3_context; | |
3126 | + | |
3127 | +/* | |
3128 | +** CAPI3REF: Binding Values To Prepared Statements | |
3129 | +** KEYWORDS: {host parameter} {host parameters} {host parameter name} | |
3130 | +** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} | |
3131 | +** | |
3132 | +** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, | |
3133 | +** literals may be replaced by a [parameter] that matches one of following | |
3134 | +** templates: | |
3135 | +** | |
3136 | +** <ul> | |
3137 | +** <li> ? | |
3138 | +** <li> ?NNN | |
3139 | +** <li> :VVV | |
3140 | +** <li> @VVV | |
3141 | +** <li> $VVV | |
3142 | +** </ul> | |
3143 | +** | |
3144 | +** In the templates above, NNN represents an integer literal, | |
3145 | +** and VVV represents an alphanumeric identifier.)^ ^The values of these | |
3146 | +** parameters (also called "host parameter names" or "SQL parameters") | |
3147 | +** can be set using the sqlite3_bind_*() routines defined here. | |
3148 | +** | |
3149 | +** ^The first argument to the sqlite3_bind_*() routines is always | |
3150 | +** a pointer to the [sqlite3_stmt] object returned from | |
3151 | +** [sqlite3_prepare_v2()] or its variants. | |
3152 | +** | |
3153 | +** ^The second argument is the index of the SQL parameter to be set. | |
3154 | +** ^The leftmost SQL parameter has an index of 1. ^When the same named | |
3155 | +** SQL parameter is used more than once, second and subsequent | |
3156 | +** occurrences have the same index as the first occurrence. | |
3157 | +** ^The index for named parameters can be looked up using the | |
3158 | +** [sqlite3_bind_parameter_index()] API if desired. ^The index | |
3159 | +** for "?NNN" parameters is the value of NNN. | |
3160 | +** ^The NNN value must be between 1 and the [sqlite3_limit()] | |
3161 | +** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). | |
3162 | +** | |
3163 | +** ^The third argument is the value to bind to the parameter. | |
3164 | +** | |
3165 | +** ^(In those routines that have a fourth argument, its value is the | |
3166 | +** number of bytes in the parameter. To be clear: the value is the | |
3167 | +** number of <u>bytes</u> in the value, not the number of characters.)^ | |
3168 | +** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16() | |
3169 | +** is negative, then the length of the string is | |
3170 | +** the number of bytes up to the first zero terminator. | |
3171 | +** If the fourth parameter to sqlite3_bind_blob() is negative, then | |
3172 | +** the behavior is undefined. | |
3173 | +** If a non-negative fourth parameter is provided to sqlite3_bind_text() | |
3174 | +** or sqlite3_bind_text16() then that parameter must be the byte offset | |
3175 | +** where the NUL terminator would occur assuming the string were NUL | |
3176 | +** terminated. If any NUL characters occur at byte offsets less than | |
3177 | +** the value of the fourth parameter then the resulting string value will | |
3178 | +** contain embedded NULs. The result of expressions involving strings | |
3179 | +** with embedded NULs is undefined. | |
3180 | +** | |
3181 | +** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and | |
3182 | +** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or | |
3183 | +** string after SQLite has finished with it. ^The destructor is called | |
3184 | +** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(), | |
3185 | +** sqlite3_bind_text(), or sqlite3_bind_text16() fails. | |
3186 | +** ^If the fifth argument is | |
3187 | +** the special value [SQLITE_STATIC], then SQLite assumes that the | |
3188 | +** information is in static, unmanaged space and does not need to be freed. | |
3189 | +** ^If the fifth argument has the value [SQLITE_TRANSIENT], then | |
3190 | +** SQLite makes its own private copy of the data immediately, before | |
3191 | +** the sqlite3_bind_*() routine returns. | |
3192 | +** | |
3193 | +** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that | |
3194 | +** is filled with zeroes. ^A zeroblob uses a fixed amount of memory | |
3195 | +** (just an integer to hold its size) while it is being processed. | |
3196 | +** Zeroblobs are intended to serve as placeholders for BLOBs whose | |
3197 | +** content is later written using | |
3198 | +** [sqlite3_blob_open | incremental BLOB I/O] routines. | |
3199 | +** ^A negative value for the zeroblob results in a zero-length BLOB. | |
3200 | +** | |
3201 | +** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer | |
3202 | +** for the [prepared statement] or with a prepared statement for which | |
3203 | +** [sqlite3_step()] has been called more recently than [sqlite3_reset()], | |
3204 | +** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() | |
3205 | +** routine is passed a [prepared statement] that has been finalized, the | |
3206 | +** result is undefined and probably harmful. | |
3207 | +** | |
3208 | +** ^Bindings are not cleared by the [sqlite3_reset()] routine. | |
3209 | +** ^Unbound parameters are interpreted as NULL. | |
3210 | +** | |
3211 | +** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an | |
3212 | +** [error code] if anything goes wrong. | |
3213 | +** ^[SQLITE_RANGE] is returned if the parameter | |
3214 | +** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. | |
3215 | +** | |
3216 | +** See also: [sqlite3_bind_parameter_count()], | |
3217 | +** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. | |
3218 | +*/ | |
3219 | +SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); | |
3220 | +SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); | |
3221 | +SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); | |
3222 | +SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); | |
3223 | +SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); | |
3224 | +SQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); | |
3225 | +SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); | |
3226 | +SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); | |
3227 | +SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); | |
3228 | + | |
3229 | +/* | |
3230 | +** CAPI3REF: Number Of SQL Parameters | |
3231 | +** | |
3232 | +** ^This routine can be used to find the number of [SQL parameters] | |
3233 | +** in a [prepared statement]. SQL parameters are tokens of the | |
3234 | +** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as | |
3235 | +** placeholders for values that are [sqlite3_bind_blob | bound] | |
3236 | +** to the parameters at a later time. | |
3237 | +** | |
3238 | +** ^(This routine actually returns the index of the largest (rightmost) | |
3239 | +** parameter. For all forms except ?NNN, this will correspond to the | |
3240 | +** number of unique parameters. If parameters of the ?NNN form are used, | |
3241 | +** there may be gaps in the list.)^ | |
3242 | +** | |
3243 | +** See also: [sqlite3_bind_blob|sqlite3_bind()], | |
3244 | +** [sqlite3_bind_parameter_name()], and | |
3245 | +** [sqlite3_bind_parameter_index()]. | |
3246 | +*/ | |
3247 | +SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*); | |
3248 | + | |
3249 | +/* | |
3250 | +** CAPI3REF: Name Of A Host Parameter | |
3251 | +** | |
3252 | +** ^The sqlite3_bind_parameter_name(P,N) interface returns | |
3253 | +** the name of the N-th [SQL parameter] in the [prepared statement] P. | |
3254 | +** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" | |
3255 | +** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" | |
3256 | +** respectively. | |
3257 | +** In other words, the initial ":" or "$" or "@" or "?" | |
3258 | +** is included as part of the name.)^ | |
3259 | +** ^Parameters of the form "?" without a following integer have no name | |
3260 | +** and are referred to as "nameless" or "anonymous parameters". | |
3261 | +** | |
3262 | +** ^The first host parameter has an index of 1, not 0. | |
3263 | +** | |
3264 | +** ^If the value N is out of range or if the N-th parameter is | |
3265 | +** nameless, then NULL is returned. ^The returned string is | |
3266 | +** always in UTF-8 encoding even if the named parameter was | |
3267 | +** originally specified as UTF-16 in [sqlite3_prepare16()] or | |
3268 | +** [sqlite3_prepare16_v2()]. | |
3269 | +** | |
3270 | +** See also: [sqlite3_bind_blob|sqlite3_bind()], | |
3271 | +** [sqlite3_bind_parameter_count()], and | |
3272 | +** [sqlite3_bind_parameter_index()]. | |
3273 | +*/ | |
3274 | +SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); | |
3275 | + | |
3276 | +/* | |
3277 | +** CAPI3REF: Index Of A Parameter With A Given Name | |
3278 | +** | |
3279 | +** ^Return the index of an SQL parameter given its name. ^The | |
3280 | +** index value returned is suitable for use as the second | |
3281 | +** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero | |
3282 | +** is returned if no matching parameter is found. ^The parameter | |
3283 | +** name must be given in UTF-8 even if the original statement | |
3284 | +** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. | |
3285 | +** | |
3286 | +** See also: [sqlite3_bind_blob|sqlite3_bind()], | |
3287 | +** [sqlite3_bind_parameter_count()], and | |
3288 | +** [sqlite3_bind_parameter_index()]. | |
3289 | +*/ | |
3290 | +SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); | |
3291 | + | |
3292 | +/* | |
3293 | +** CAPI3REF: Reset All Bindings On A Prepared Statement | |
3294 | +** | |
3295 | +** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset | |
3296 | +** the [sqlite3_bind_blob | bindings] on a [prepared statement]. | |
3297 | +** ^Use this routine to reset all host parameters to NULL. | |
3298 | +*/ | |
3299 | +SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*); | |
3300 | + | |
3301 | +/* | |
3302 | +** CAPI3REF: Number Of Columns In A Result Set | |
3303 | +** | |
3304 | +** ^Return the number of columns in the result set returned by the | |
3305 | +** [prepared statement]. ^This routine returns 0 if pStmt is an SQL | |
3306 | +** statement that does not return data (for example an [UPDATE]). | |
3307 | +** | |
3308 | +** See also: [sqlite3_data_count()] | |
3309 | +*/ | |
3310 | +SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt); | |
3311 | + | |
3312 | +/* | |
3313 | +** CAPI3REF: Column Names In A Result Set | |
3314 | +** | |
3315 | +** ^These routines return the name assigned to a particular column | |
3316 | +** in the result set of a [SELECT] statement. ^The sqlite3_column_name() | |
3317 | +** interface returns a pointer to a zero-terminated UTF-8 string | |
3318 | +** and sqlite3_column_name16() returns a pointer to a zero-terminated | |
3319 | +** UTF-16 string. ^The first parameter is the [prepared statement] | |
3320 | +** that implements the [SELECT] statement. ^The second parameter is the | |
3321 | +** column number. ^The leftmost column is number 0. | |
3322 | +** | |
3323 | +** ^The returned string pointer is valid until either the [prepared statement] | |
3324 | +** is destroyed by [sqlite3_finalize()] or until the statement is automatically | |
3325 | +** reprepared by the first call to [sqlite3_step()] for a particular run | |
3326 | +** or until the next call to | |
3327 | +** sqlite3_column_name() or sqlite3_column_name16() on the same column. | |
3328 | +** | |
3329 | +** ^If sqlite3_malloc() fails during the processing of either routine | |
3330 | +** (for example during a conversion from UTF-8 to UTF-16) then a | |
3331 | +** NULL pointer is returned. | |
3332 | +** | |
3333 | +** ^The name of a result column is the value of the "AS" clause for | |
3334 | +** that column, if there is an AS clause. If there is no AS clause | |
3335 | +** then the name of the column is unspecified and may change from | |
3336 | +** one release of SQLite to the next. | |
3337 | +*/ | |
3338 | +SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N); | |
3339 | +SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N); | |
3340 | + | |
3341 | +/* | |
3342 | +** CAPI3REF: Source Of Data In A Query Result | |
3343 | +** | |
3344 | +** ^These routines provide a means to determine the database, table, and | |
3345 | +** table column that is the origin of a particular result column in | |
3346 | +** [SELECT] statement. | |
3347 | +** ^The name of the database or table or column can be returned as | |
3348 | +** either a UTF-8 or UTF-16 string. ^The _database_ routines return | |
3349 | +** the database name, the _table_ routines return the table name, and | |
3350 | +** the origin_ routines return the column name. | |
3351 | +** ^The returned string is valid until the [prepared statement] is destroyed | |
3352 | +** using [sqlite3_finalize()] or until the statement is automatically | |
3353 | +** reprepared by the first call to [sqlite3_step()] for a particular run | |
3354 | +** or until the same information is requested | |
3355 | +** again in a different encoding. | |
3356 | +** | |
3357 | +** ^The names returned are the original un-aliased names of the | |
3358 | +** database, table, and column. | |
3359 | +** | |
3360 | +** ^The first argument to these interfaces is a [prepared statement]. | |
3361 | +** ^These functions return information about the Nth result column returned by | |
3362 | +** the statement, where N is the second function argument. | |
3363 | +** ^The left-most column is column 0 for these routines. | |
3364 | +** | |
3365 | +** ^If the Nth column returned by the statement is an expression or | |
3366 | +** subquery and is not a column value, then all of these functions return | |
3367 | +** NULL. ^These routine might also return NULL if a memory allocation error | |
3368 | +** occurs. ^Otherwise, they return the name of the attached database, table, | |
3369 | +** or column that query result column was extracted from. | |
3370 | +** | |
3371 | +** ^As with all other SQLite APIs, those whose names end with "16" return | |
3372 | +** UTF-16 encoded strings and the other functions return UTF-8. | |
3373 | +** | |
3374 | +** ^These APIs are only available if the library was compiled with the | |
3375 | +** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. | |
3376 | +** | |
3377 | +** If two or more threads call one or more of these routines against the same | |
3378 | +** prepared statement and column at the same time then the results are | |
3379 | +** undefined. | |
3380 | +** | |
3381 | +** If two or more threads call one or more | |
3382 | +** [sqlite3_column_database_name | column metadata interfaces] | |
3383 | +** for the same [prepared statement] and result column | |
3384 | +** at the same time then the results are undefined. | |
3385 | +*/ | |
3386 | +SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int); | |
3387 | +SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int); | |
3388 | +SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int); | |
3389 | +SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int); | |
3390 | +SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int); | |
3391 | +SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); | |
3392 | + | |
3393 | +/* | |
3394 | +** CAPI3REF: Declared Datatype Of A Query Result | |
3395 | +** | |
3396 | +** ^(The first parameter is a [prepared statement]. | |
3397 | +** If this statement is a [SELECT] statement and the Nth column of the | |
3398 | +** returned result set of that [SELECT] is a table column (not an | |
3399 | +** expression or subquery) then the declared type of the table | |
3400 | +** column is returned.)^ ^If the Nth column of the result set is an | |
3401 | +** expression or subquery, then a NULL pointer is returned. | |
3402 | +** ^The returned string is always UTF-8 encoded. | |
3403 | +** | |
3404 | +** ^(For example, given the database schema: | |
3405 | +** | |
3406 | +** CREATE TABLE t1(c1 VARIANT); | |
3407 | +** | |
3408 | +** and the following statement to be compiled: | |
3409 | +** | |
3410 | +** SELECT c1 + 1, c1 FROM t1; | |
3411 | +** | |
3412 | +** this routine would return the string "VARIANT" for the second result | |
3413 | +** column (i==1), and a NULL pointer for the first result column (i==0).)^ | |
3414 | +** | |
3415 | +** ^SQLite uses dynamic run-time typing. ^So just because a column | |
3416 | +** is declared to contain a particular type does not mean that the | |
3417 | +** data stored in that column is of the declared type. SQLite is | |
3418 | +** strongly typed, but the typing is dynamic not static. ^Type | |
3419 | +** is associated with individual values, not with the containers | |
3420 | +** used to hold those values. | |
3421 | +*/ | |
3422 | +SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int); | |
3423 | +SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int); | |
3424 | + | |
3425 | +/* | |
3426 | +** CAPI3REF: Evaluate An SQL Statement | |
3427 | +** | |
3428 | +** After a [prepared statement] has been prepared using either | |
3429 | +** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy | |
3430 | +** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function | |
3431 | +** must be called one or more times to evaluate the statement. | |
3432 | +** | |
3433 | +** The details of the behavior of the sqlite3_step() interface depend | |
3434 | +** on whether the statement was prepared using the newer "v2" interface | |
3435 | +** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy | |
3436 | +** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the | |
3437 | +** new "v2" interface is recommended for new applications but the legacy | |
3438 | +** interface will continue to be supported. | |
3439 | +** | |
3440 | +** ^In the legacy interface, the return value will be either [SQLITE_BUSY], | |
3441 | +** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. | |
3442 | +** ^With the "v2" interface, any of the other [result codes] or | |
3443 | +** [extended result codes] might be returned as well. | |
3444 | +** | |
3445 | +** ^[SQLITE_BUSY] means that the database engine was unable to acquire the | |
3446 | +** database locks it needs to do its job. ^If the statement is a [COMMIT] | |
3447 | +** or occurs outside of an explicit transaction, then you can retry the | |
3448 | +** statement. If the statement is not a [COMMIT] and occurs within an | |
3449 | +** explicit transaction then you should rollback the transaction before | |
3450 | +** continuing. | |
3451 | +** | |
3452 | +** ^[SQLITE_DONE] means that the statement has finished executing | |
3453 | +** successfully. sqlite3_step() should not be called again on this virtual | |
3454 | +** machine without first calling [sqlite3_reset()] to reset the virtual | |
3455 | +** machine back to its initial state. | |
3456 | +** | |
3457 | +** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] | |
3458 | +** is returned each time a new row of data is ready for processing by the | |
3459 | +** caller. The values may be accessed using the [column access functions]. | |
3460 | +** sqlite3_step() is called again to retrieve the next row of data. | |
3461 | +** | |
3462 | +** ^[SQLITE_ERROR] means that a run-time error (such as a constraint | |
3463 | +** violation) has occurred. sqlite3_step() should not be called again on | |
3464 | +** the VM. More information may be found by calling [sqlite3_errmsg()]. | |
3465 | +** ^With the legacy interface, a more specific error code (for example, | |
3466 | +** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) | |
3467 | +** can be obtained by calling [sqlite3_reset()] on the | |
3468 | +** [prepared statement]. ^In the "v2" interface, | |
3469 | +** the more specific error code is returned directly by sqlite3_step(). | |
3470 | +** | |
3471 | +** [SQLITE_MISUSE] means that the this routine was called inappropriately. | |
3472 | +** Perhaps it was called on a [prepared statement] that has | |
3473 | +** already been [sqlite3_finalize | finalized] or on one that had | |
3474 | +** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could | |
3475 | +** be the case that the same database connection is being used by two or | |
3476 | +** more threads at the same moment in time. | |
3477 | +** | |
3478 | +** For all versions of SQLite up to and including 3.6.23.1, a call to | |
3479 | +** [sqlite3_reset()] was required after sqlite3_step() returned anything | |
3480 | +** other than [SQLITE_ROW] before any subsequent invocation of | |
3481 | +** sqlite3_step(). Failure to reset the prepared statement using | |
3482 | +** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from | |
3483 | +** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began | |
3484 | +** calling [sqlite3_reset()] automatically in this circumstance rather | |
3485 | +** than returning [SQLITE_MISUSE]. This is not considered a compatibility | |
3486 | +** break because any application that ever receives an SQLITE_MISUSE error | |
3487 | +** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option | |
3488 | +** can be used to restore the legacy behavior. | |
3489 | +** | |
3490 | +** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() | |
3491 | +** API always returns a generic error code, [SQLITE_ERROR], following any | |
3492 | +** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call | |
3493 | +** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the | |
3494 | +** specific [error codes] that better describes the error. | |
3495 | +** We admit that this is a goofy design. The problem has been fixed | |
3496 | +** with the "v2" interface. If you prepare all of your SQL statements | |
3497 | +** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead | |
3498 | +** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, | |
3499 | +** then the more specific [error codes] are returned directly | |
3500 | +** by sqlite3_step(). The use of the "v2" interface is recommended. | |
3501 | +*/ | |
3502 | +SQLITE_API int sqlite3_step(sqlite3_stmt*); | |
3503 | + | |
3504 | +/* | |
3505 | +** CAPI3REF: Number of columns in a result set | |
3506 | +** | |
3507 | +** ^The sqlite3_data_count(P) interface returns the number of columns in the | |
3508 | +** current row of the result set of [prepared statement] P. | |
3509 | +** ^If prepared statement P does not have results ready to return | |
3510 | +** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of | |
3511 | +** interfaces) then sqlite3_data_count(P) returns 0. | |
3512 | +** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. | |
3513 | +** ^The sqlite3_data_count(P) routine returns 0 if the previous call to | |
3514 | +** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P) | |
3515 | +** will return non-zero if previous call to [sqlite3_step](P) returned | |
3516 | +** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum] | |
3517 | +** where it always returns zero since each step of that multi-step | |
3518 | +** pragma returns 0 columns of data. | |
3519 | +** | |
3520 | +** See also: [sqlite3_column_count()] | |
3521 | +*/ | |
3522 | +SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt); | |
3523 | + | |
3524 | +/* | |
3525 | +** CAPI3REF: Fundamental Datatypes | |
3526 | +** KEYWORDS: SQLITE_TEXT | |
3527 | +** | |
3528 | +** ^(Every value in SQLite has one of five fundamental datatypes: | |
3529 | +** | |
3530 | +** <ul> | |
3531 | +** <li> 64-bit signed integer | |
3532 | +** <li> 64-bit IEEE floating point number | |
3533 | +** <li> string | |
3534 | +** <li> BLOB | |
3535 | +** <li> NULL | |
3536 | +** </ul>)^ | |
3537 | +** | |
3538 | +** These constants are codes for each of those types. | |
3539 | +** | |
3540 | +** Note that the SQLITE_TEXT constant was also used in SQLite version 2 | |
3541 | +** for a completely different meaning. Software that links against both | |
3542 | +** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not | |
3543 | +** SQLITE_TEXT. | |
3544 | +*/ | |
3545 | +#define SQLITE_INTEGER 1 | |
3546 | +#define SQLITE_FLOAT 2 | |
3547 | +#define SQLITE_BLOB 4 | |
3548 | +#define SQLITE_NULL 5 | |
3549 | +#ifdef SQLITE_TEXT | |
3550 | +# undef SQLITE_TEXT | |
3551 | +#else | |
3552 | +# define SQLITE_TEXT 3 | |
3553 | +#endif | |
3554 | +#define SQLITE3_TEXT 3 | |
3555 | + | |
3556 | +/* | |
3557 | +** CAPI3REF: Result Values From A Query | |
3558 | +** KEYWORDS: {column access functions} | |
3559 | +** | |
3560 | +** These routines form the "result set" interface. | |
3561 | +** | |
3562 | +** ^These routines return information about a single column of the current | |
3563 | +** result row of a query. ^In every case the first argument is a pointer | |
3564 | +** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] | |
3565 | +** that was returned from [sqlite3_prepare_v2()] or one of its variants) | |
3566 | +** and the second argument is the index of the column for which information | |
3567 | +** should be returned. ^The leftmost column of the result set has the index 0. | |
3568 | +** ^The number of columns in the result can be determined using | |
3569 | +** [sqlite3_column_count()]. | |
3570 | +** | |
3571 | +** If the SQL statement does not currently point to a valid row, or if the | |
3572 | +** column index is out of range, the result is undefined. | |
3573 | +** These routines may only be called when the most recent call to | |
3574 | +** [sqlite3_step()] has returned [SQLITE_ROW] and neither | |
3575 | +** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. | |
3576 | +** If any of these routines are called after [sqlite3_reset()] or | |
3577 | +** [sqlite3_finalize()] or after [sqlite3_step()] has returned | |
3578 | +** something other than [SQLITE_ROW], the results are undefined. | |
3579 | +** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] | |
3580 | +** are called from a different thread while any of these routines | |
3581 | +** are pending, then the results are undefined. | |
3582 | +** | |
3583 | +** ^The sqlite3_column_type() routine returns the | |
3584 | +** [SQLITE_INTEGER | datatype code] for the initial data type | |
3585 | +** of the result column. ^The returned value is one of [SQLITE_INTEGER], | |
3586 | +** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value | |
3587 | +** returned by sqlite3_column_type() is only meaningful if no type | |
3588 | +** conversions have occurred as described below. After a type conversion, | |
3589 | +** the value returned by sqlite3_column_type() is undefined. Future | |
3590 | +** versions of SQLite may change the behavior of sqlite3_column_type() | |
3591 | +** following a type conversion. | |
3592 | +** | |
3593 | +** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() | |
3594 | +** routine returns the number of bytes in that BLOB or string. | |
3595 | +** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts | |
3596 | +** the string to UTF-8 and then returns the number of bytes. | |
3597 | +** ^If the result is a numeric value then sqlite3_column_bytes() uses | |
3598 | +** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns | |
3599 | +** the number of bytes in that string. | |
3600 | +** ^If the result is NULL, then sqlite3_column_bytes() returns zero. | |
3601 | +** | |
3602 | +** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16() | |
3603 | +** routine returns the number of bytes in that BLOB or string. | |
3604 | +** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts | |
3605 | +** the string to UTF-16 and then returns the number of bytes. | |
3606 | +** ^If the result is a numeric value then sqlite3_column_bytes16() uses | |
3607 | +** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns | |
3608 | +** the number of bytes in that string. | |
3609 | +** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. | |
3610 | +** | |
3611 | +** ^The values returned by [sqlite3_column_bytes()] and | |
3612 | +** [sqlite3_column_bytes16()] do not include the zero terminators at the end | |
3613 | +** of the string. ^For clarity: the values returned by | |
3614 | +** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of | |
3615 | +** bytes in the string, not the number of characters. | |
3616 | +** | |
3617 | +** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), | |
3618 | +** even empty strings, are always zero-terminated. ^The return | |
3619 | +** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. | |
3620 | +** | |
3621 | +** ^The object returned by [sqlite3_column_value()] is an | |
3622 | +** [unprotected sqlite3_value] object. An unprotected sqlite3_value object | |
3623 | +** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. | |
3624 | +** If the [unprotected sqlite3_value] object returned by | |
3625 | +** [sqlite3_column_value()] is used in any other way, including calls | |
3626 | +** to routines like [sqlite3_value_int()], [sqlite3_value_text()], | |
3627 | +** or [sqlite3_value_bytes()], then the behavior is undefined. | |
3628 | +** | |
3629 | +** These routines attempt to convert the value where appropriate. ^For | |
3630 | +** example, if the internal representation is FLOAT and a text result | |
3631 | +** is requested, [sqlite3_snprintf()] is used internally to perform the | |
3632 | +** conversion automatically. ^(The following table details the conversions | |
3633 | +** that are applied: | |
3634 | +** | |
3635 | +** <blockquote> | |
3636 | +** <table border="1"> | |
3637 | +** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion | |
3638 | +** | |
3639 | +** <tr><td> NULL <td> INTEGER <td> Result is 0 | |
3640 | +** <tr><td> NULL <td> FLOAT <td> Result is 0.0 | |
3641 | +** <tr><td> NULL <td> TEXT <td> Result is NULL pointer | |
3642 | +** <tr><td> NULL <td> BLOB <td> Result is NULL pointer | |
3643 | +** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float | |
3644 | +** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer | |
3645 | +** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT | |
3646 | +** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer | |
3647 | +** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float | |
3648 | +** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT | |
3649 | +** <tr><td> TEXT <td> INTEGER <td> Use atoi() | |
3650 | +** <tr><td> TEXT <td> FLOAT <td> Use atof() | |
3651 | +** <tr><td> TEXT <td> BLOB <td> No change | |
3652 | +** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() | |
3653 | +** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() | |
3654 | +** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed | |
3655 | +** </table> | |
3656 | +** </blockquote>)^ | |
3657 | +** | |
3658 | +** The table above makes reference to standard C library functions atoi() | |
3659 | +** and atof(). SQLite does not really use these functions. It has its | |
3660 | +** own equivalent internal routines. The atoi() and atof() names are | |
3661 | +** used in the table for brevity and because they are familiar to most | |
3662 | +** C programmers. | |
3663 | +** | |
3664 | +** Note that when type conversions occur, pointers returned by prior | |
3665 | +** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or | |
3666 | +** sqlite3_column_text16() may be invalidated. | |
3667 | +** Type conversions and pointer invalidations might occur | |
3668 | +** in the following cases: | |
3669 | +** | |
3670 | +** <ul> | |
3671 | +** <li> The initial content is a BLOB and sqlite3_column_text() or | |
3672 | +** sqlite3_column_text16() is called. A zero-terminator might | |
3673 | +** need to be added to the string.</li> | |
3674 | +** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or | |
3675 | +** sqlite3_column_text16() is called. The content must be converted | |
3676 | +** to UTF-16.</li> | |
3677 | +** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or | |
3678 | +** sqlite3_column_text() is called. The content must be converted | |
3679 | +** to UTF-8.</li> | |
3680 | +** </ul> | |
3681 | +** | |
3682 | +** ^Conversions between UTF-16be and UTF-16le are always done in place and do | |
3683 | +** not invalidate a prior pointer, though of course the content of the buffer | |
3684 | +** that the prior pointer references will have been modified. Other kinds | |
3685 | +** of conversion are done in place when it is possible, but sometimes they | |
3686 | +** are not possible and in those cases prior pointers are invalidated. | |
3687 | +** | |
3688 | +** The safest and easiest to remember policy is to invoke these routines | |
3689 | +** in one of the following ways: | |
3690 | +** | |
3691 | +** <ul> | |
3692 | +** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> | |
3693 | +** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> | |
3694 | +** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> | |
3695 | +** </ul> | |
3696 | +** | |
3697 | +** In other words, you should call sqlite3_column_text(), | |
3698 | +** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result | |
3699 | +** into the desired format, then invoke sqlite3_column_bytes() or | |
3700 | +** sqlite3_column_bytes16() to find the size of the result. Do not mix calls | |
3701 | +** to sqlite3_column_text() or sqlite3_column_blob() with calls to | |
3702 | +** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() | |
3703 | +** with calls to sqlite3_column_bytes(). | |
3704 | +** | |
3705 | +** ^The pointers returned are valid until a type conversion occurs as | |
3706 | +** described above, or until [sqlite3_step()] or [sqlite3_reset()] or | |
3707 | +** [sqlite3_finalize()] is called. ^The memory space used to hold strings | |
3708 | +** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned | |
3709 | +** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into | |
3710 | +** [sqlite3_free()]. | |
3711 | +** | |
3712 | +** ^(If a memory allocation error occurs during the evaluation of any | |
3713 | +** of these routines, a default value is returned. The default value | |
3714 | +** is either the integer 0, the floating point number 0.0, or a NULL | |
3715 | +** pointer. Subsequent calls to [sqlite3_errcode()] will return | |
3716 | +** [SQLITE_NOMEM].)^ | |
3717 | +*/ | |
3718 | +SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); | |
3719 | +SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); | |
3720 | +SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); | |
3721 | +SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); | |
3722 | +SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); | |
3723 | +SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); | |
3724 | +SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); | |
3725 | +SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); | |
3726 | +SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); | |
3727 | +SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); | |
3728 | + | |
3729 | +/* | |
3730 | +** CAPI3REF: Destroy A Prepared Statement Object | |
3731 | +** | |
3732 | +** ^The sqlite3_finalize() function is called to delete a [prepared statement]. | |
3733 | +** ^If the most recent evaluation of the statement encountered no errors | |
3734 | +** or if the statement is never been evaluated, then sqlite3_finalize() returns | |
3735 | +** SQLITE_OK. ^If the most recent evaluation of statement S failed, then | |
3736 | +** sqlite3_finalize(S) returns the appropriate [error code] or | |
3737 | +** [extended error code]. | |
3738 | +** | |
3739 | +** ^The sqlite3_finalize(S) routine can be called at any point during | |
3740 | +** the life cycle of [prepared statement] S: | |
3741 | +** before statement S is ever evaluated, after | |
3742 | +** one or more calls to [sqlite3_reset()], or after any call | |
3743 | +** to [sqlite3_step()] regardless of whether or not the statement has | |
3744 | +** completed execution. | |
3745 | +** | |
3746 | +** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op. | |
3747 | +** | |
3748 | +** The application must finalize every [prepared statement] in order to avoid | |
3749 | +** resource leaks. It is a grievous error for the application to try to use | |
3750 | +** a prepared statement after it has been finalized. Any use of a prepared | |
3751 | +** statement after it has been finalized can result in undefined and | |
3752 | +** undesirable behavior such as segfaults and heap corruption. | |
3753 | +*/ | |
3754 | +SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt); | |
3755 | + | |
3756 | +/* | |
3757 | +** CAPI3REF: Reset A Prepared Statement Object | |
3758 | +** | |
3759 | +** The sqlite3_reset() function is called to reset a [prepared statement] | |
3760 | +** object back to its initial state, ready to be re-executed. | |
3761 | +** ^Any SQL statement variables that had values bound to them using | |
3762 | +** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. | |
3763 | +** Use [sqlite3_clear_bindings()] to reset the bindings. | |
3764 | +** | |
3765 | +** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S | |
3766 | +** back to the beginning of its program. | |
3767 | +** | |
3768 | +** ^If the most recent call to [sqlite3_step(S)] for the | |
3769 | +** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], | |
3770 | +** or if [sqlite3_step(S)] has never before been called on S, | |
3771 | +** then [sqlite3_reset(S)] returns [SQLITE_OK]. | |
3772 | +** | |
3773 | +** ^If the most recent call to [sqlite3_step(S)] for the | |
3774 | +** [prepared statement] S indicated an error, then | |
3775 | +** [sqlite3_reset(S)] returns an appropriate [error code]. | |
3776 | +** | |
3777 | +** ^The [sqlite3_reset(S)] interface does not change the values | |
3778 | +** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. | |
3779 | +*/ | |
3780 | +SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); | |
3781 | + | |
3782 | +/* | |
3783 | +** CAPI3REF: Create Or Redefine SQL Functions | |
3784 | +** KEYWORDS: {function creation routines} | |
3785 | +** KEYWORDS: {application-defined SQL function} | |
3786 | +** KEYWORDS: {application-defined SQL functions} | |
3787 | +** | |
3788 | +** ^These functions (collectively known as "function creation routines") | |
3789 | +** are used to add SQL functions or aggregates or to redefine the behavior | |
3790 | +** of existing SQL functions or aggregates. The only differences between | |
3791 | +** these routines are the text encoding expected for | |
3792 | +** the second parameter (the name of the function being created) | |
3793 | +** and the presence or absence of a destructor callback for | |
3794 | +** the application data pointer. | |
3795 | +** | |
3796 | +** ^The first parameter is the [database connection] to which the SQL | |
3797 | +** function is to be added. ^If an application uses more than one database | |
3798 | +** connection then application-defined SQL functions must be added | |
3799 | +** to each database connection separately. | |
3800 | +** | |
3801 | +** ^The second parameter is the name of the SQL function to be created or | |
3802 | +** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 | |
3803 | +** representation, exclusive of the zero-terminator. ^Note that the name | |
3804 | +** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. | |
3805 | +** ^Any attempt to create a function with a longer name | |
3806 | +** will result in [SQLITE_MISUSE] being returned. | |
3807 | +** | |
3808 | +** ^The third parameter (nArg) | |
3809 | +** is the number of arguments that the SQL function or | |
3810 | +** aggregate takes. ^If this parameter is -1, then the SQL function or | |
3811 | +** aggregate may take any number of arguments between 0 and the limit | |
3812 | +** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third | |
3813 | +** parameter is less than -1 or greater than 127 then the behavior is | |
3814 | +** undefined. | |
3815 | +** | |
3816 | +** ^The fourth parameter, eTextRep, specifies what | |
3817 | +** [SQLITE_UTF8 | text encoding] this SQL function prefers for | |
3818 | +** its parameters. Every SQL function implementation must be able to work | |
3819 | +** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be | |
3820 | +** more efficient with one encoding than another. ^An application may | |
3821 | +** invoke sqlite3_create_function() or sqlite3_create_function16() multiple | |
3822 | +** times with the same function but with different values of eTextRep. | |
3823 | +** ^When multiple implementations of the same function are available, SQLite | |
3824 | +** will pick the one that involves the least amount of data conversion. | |
3825 | +** If there is only a single implementation which does not care what text | |
3826 | +** encoding is used, then the fourth argument should be [SQLITE_ANY]. | |
3827 | +** | |
3828 | +** ^(The fifth parameter is an arbitrary pointer. The implementation of the | |
3829 | +** function can gain access to this pointer using [sqlite3_user_data()].)^ | |
3830 | +** | |
3831 | +** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are | |
3832 | +** pointers to C-language functions that implement the SQL function or | |
3833 | +** aggregate. ^A scalar SQL function requires an implementation of the xFunc | |
3834 | +** callback only; NULL pointers must be passed as the xStep and xFinal | |
3835 | +** parameters. ^An aggregate SQL function requires an implementation of xStep | |
3836 | +** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing | |
3837 | +** SQL function or aggregate, pass NULL pointers for all three function | |
3838 | +** callbacks. | |
3839 | +** | |
3840 | +** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL, | |
3841 | +** then it is destructor for the application data pointer. | |
3842 | +** The destructor is invoked when the function is deleted, either by being | |
3843 | +** overloaded or when the database connection closes.)^ | |
3844 | +** ^The destructor is also invoked if the call to | |
3845 | +** sqlite3_create_function_v2() fails. | |
3846 | +** ^When the destructor callback of the tenth parameter is invoked, it | |
3847 | +** is passed a single argument which is a copy of the application data | |
3848 | +** pointer which was the fifth parameter to sqlite3_create_function_v2(). | |
3849 | +** | |
3850 | +** ^It is permitted to register multiple implementations of the same | |
3851 | +** functions with the same name but with either differing numbers of | |
3852 | +** arguments or differing preferred text encodings. ^SQLite will use | |
3853 | +** the implementation that most closely matches the way in which the | |
3854 | +** SQL function is used. ^A function implementation with a non-negative | |
3855 | +** nArg parameter is a better match than a function implementation with | |
3856 | +** a negative nArg. ^A function where the preferred text encoding | |
3857 | +** matches the database encoding is a better | |
3858 | +** match than a function where the encoding is different. | |
3859 | +** ^A function where the encoding difference is between UTF16le and UTF16be | |
3860 | +** is a closer match than a function where the encoding difference is | |
3861 | +** between UTF8 and UTF16. | |
3862 | +** | |
3863 | +** ^Built-in functions may be overloaded by new application-defined functions. | |
3864 | +** | |
3865 | +** ^An application-defined function is permitted to call other | |
3866 | +** SQLite interfaces. However, such calls must not | |
3867 | +** close the database connection nor finalize or reset the prepared | |
3868 | +** statement in which the function is running. | |
3869 | +*/ | |
3870 | +SQLITE_API int sqlite3_create_function( | |
3871 | + sqlite3 *db, | |
3872 | + const char *zFunctionName, | |
3873 | + int nArg, | |
3874 | + int eTextRep, | |
3875 | + void *pApp, | |
3876 | + void (*xFunc)(sqlite3_context*,int,sqlite3_value**), | |
3877 | + void (*xStep)(sqlite3_context*,int,sqlite3_value**), | |
3878 | + void (*xFinal)(sqlite3_context*) | |
3879 | +); | |
3880 | +SQLITE_API int sqlite3_create_function16( | |
3881 | + sqlite3 *db, | |
3882 | + const void *zFunctionName, | |
3883 | + int nArg, | |
3884 | + int eTextRep, | |
3885 | + void *pApp, | |
3886 | + void (*xFunc)(sqlite3_context*,int,sqlite3_value**), | |
3887 | + void (*xStep)(sqlite3_context*,int,sqlite3_value**), | |
3888 | + void (*xFinal)(sqlite3_context*) | |
3889 | +); | |
3890 | +SQLITE_API int sqlite3_create_function_v2( | |
3891 | + sqlite3 *db, | |
3892 | + const char *zFunctionName, | |
3893 | + int nArg, | |
3894 | + int eTextRep, | |
3895 | + void *pApp, | |
3896 | + void (*xFunc)(sqlite3_context*,int,sqlite3_value**), | |
3897 | + void (*xStep)(sqlite3_context*,int,sqlite3_value**), | |
3898 | + void (*xFinal)(sqlite3_context*), | |
3899 | + void(*xDestroy)(void*) | |
3900 | +); | |
3901 | + | |
3902 | +/* | |
3903 | +** CAPI3REF: Text Encodings | |
3904 | +** | |
3905 | +** These constant define integer codes that represent the various | |
3906 | +** text encodings supported by SQLite. | |
3907 | +*/ | |
3908 | +#define SQLITE_UTF8 1 | |
3909 | +#define SQLITE_UTF16LE 2 | |
3910 | +#define SQLITE_UTF16BE 3 | |
3911 | +#define SQLITE_UTF16 4 /* Use native byte order */ | |
3912 | +#define SQLITE_ANY 5 /* sqlite3_create_function only */ | |
3913 | +#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ | |
3914 | + | |
3915 | +/* | |
3916 | +** CAPI3REF: Deprecated Functions | |
3917 | +** DEPRECATED | |
3918 | +** | |
3919 | +** These functions are [deprecated]. In order to maintain | |
3920 | +** backwards compatibility with older code, these functions continue | |
3921 | +** to be supported. However, new applications should avoid | |
3922 | +** the use of these functions. To help encourage people to avoid | |
3923 | +** using these functions, we are not going to tell you what they do. | |
3924 | +*/ | |
3925 | +#ifndef SQLITE_OMIT_DEPRECATED | |
3926 | +SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); | |
3927 | +SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); | |
3928 | +SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); | |
3929 | +SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); | |
3930 | +SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); | |
3931 | +SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64); | |
3932 | +#endif | |
3933 | + | |
3934 | +/* | |
3935 | +** CAPI3REF: Obtaining SQL Function Parameter Values | |
3936 | +** | |
3937 | +** The C-language implementation of SQL functions and aggregates uses | |
3938 | +** this set of interface routines to access the parameter values on | |
3939 | +** the function or aggregate. | |
3940 | +** | |
3941 | +** The xFunc (for scalar functions) or xStep (for aggregates) parameters | |
3942 | +** to [sqlite3_create_function()] and [sqlite3_create_function16()] | |
3943 | +** define callbacks that implement the SQL functions and aggregates. | |
3944 | +** The 3rd parameter to these callbacks is an array of pointers to | |
3945 | +** [protected sqlite3_value] objects. There is one [sqlite3_value] object for | |
3946 | +** each parameter to the SQL function. These routines are used to | |
3947 | +** extract values from the [sqlite3_value] objects. | |
3948 | +** | |
3949 | +** These routines work only with [protected sqlite3_value] objects. | |
3950 | +** Any attempt to use these routines on an [unprotected sqlite3_value] | |
3951 | +** object results in undefined behavior. | |
3952 | +** | |
3953 | +** ^These routines work just like the corresponding [column access functions] | |
3954 | +** except that these routines take a single [protected sqlite3_value] object | |
3955 | +** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. | |
3956 | +** | |
3957 | +** ^The sqlite3_value_text16() interface extracts a UTF-16 string | |
3958 | +** in the native byte-order of the host machine. ^The | |
3959 | +** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces | |
3960 | +** extract UTF-16 strings as big-endian and little-endian respectively. | |
3961 | +** | |
3962 | +** ^(The sqlite3_value_numeric_type() interface attempts to apply | |
3963 | +** numeric affinity to the value. This means that an attempt is | |
3964 | +** made to convert the value to an integer or floating point. If | |
3965 | +** such a conversion is possible without loss of information (in other | |
3966 | +** words, if the value is a string that looks like a number) | |
3967 | +** then the conversion is performed. Otherwise no conversion occurs. | |
3968 | +** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ | |
3969 | +** | |
3970 | +** Please pay particular attention to the fact that the pointer returned | |
3971 | +** from [sqlite3_value_blob()], [sqlite3_value_text()], or | |
3972 | +** [sqlite3_value_text16()] can be invalidated by a subsequent call to | |
3973 | +** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], | |
3974 | +** or [sqlite3_value_text16()]. | |
3975 | +** | |
3976 | +** These routines must be called from the same thread as | |
3977 | +** the SQL function that supplied the [sqlite3_value*] parameters. | |
3978 | +*/ | |
3979 | +SQLITE_API const void *sqlite3_value_blob(sqlite3_value*); | |
3980 | +SQLITE_API int sqlite3_value_bytes(sqlite3_value*); | |
3981 | +SQLITE_API int sqlite3_value_bytes16(sqlite3_value*); | |
3982 | +SQLITE_API double sqlite3_value_double(sqlite3_value*); | |
3983 | +SQLITE_API int sqlite3_value_int(sqlite3_value*); | |
3984 | +SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); | |
3985 | +SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); | |
3986 | +SQLITE_API const void *sqlite3_value_text16(sqlite3_value*); | |
3987 | +SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); | |
3988 | +SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); | |
3989 | +SQLITE_API int sqlite3_value_type(sqlite3_value*); | |
3990 | +SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); | |
3991 | + | |
3992 | +/* | |
3993 | +** CAPI3REF: Obtain Aggregate Function Context | |
3994 | +** | |
3995 | +** Implementations of aggregate SQL functions use this | |
3996 | +** routine to allocate memory for storing their state. | |
3997 | +** | |
3998 | +** ^The first time the sqlite3_aggregate_context(C,N) routine is called | |
3999 | +** for a particular aggregate function, SQLite | |
4000 | +** allocates N of memory, zeroes out that memory, and returns a pointer | |
4001 | +** to the new memory. ^On second and subsequent calls to | |
4002 | +** sqlite3_aggregate_context() for the same aggregate function instance, | |
4003 | +** the same buffer is returned. Sqlite3_aggregate_context() is normally | |
4004 | +** called once for each invocation of the xStep callback and then one | |
4005 | +** last time when the xFinal callback is invoked. ^(When no rows match | |
4006 | +** an aggregate query, the xStep() callback of the aggregate function | |
4007 | +** implementation is never called and xFinal() is called exactly once. | |
4008 | +** In those cases, sqlite3_aggregate_context() might be called for the | |
4009 | +** first time from within xFinal().)^ | |
4010 | +** | |
4011 | +** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is | |
4012 | +** less than or equal to zero or if a memory allocate error occurs. | |
4013 | +** | |
4014 | +** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is | |
4015 | +** determined by the N parameter on first successful call. Changing the | |
4016 | +** value of N in subsequent call to sqlite3_aggregate_context() within | |
4017 | +** the same aggregate function instance will not resize the memory | |
4018 | +** allocation.)^ | |
4019 | +** | |
4020 | +** ^SQLite automatically frees the memory allocated by | |
4021 | +** sqlite3_aggregate_context() when the aggregate query concludes. | |
4022 | +** | |
4023 | +** The first parameter must be a copy of the | |
4024 | +** [sqlite3_context | SQL function context] that is the first parameter | |
4025 | +** to the xStep or xFinal callback routine that implements the aggregate | |
4026 | +** function. | |
4027 | +** | |
4028 | +** This routine must be called from the same thread in which | |
4029 | +** the aggregate SQL function is running. | |
4030 | +*/ | |
4031 | +SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); | |
4032 | + | |
4033 | +/* | |
4034 | +** CAPI3REF: User Data For Functions | |
4035 | +** | |
4036 | +** ^The sqlite3_user_data() interface returns a copy of | |
4037 | +** the pointer that was the pUserData parameter (the 5th parameter) | |
4038 | +** of the [sqlite3_create_function()] | |
4039 | +** and [sqlite3_create_function16()] routines that originally | |
4040 | +** registered the application defined function. | |
4041 | +** | |
4042 | +** This routine must be called from the same thread in which | |
4043 | +** the application-defined function is running. | |
4044 | +*/ | |
4045 | +SQLITE_API void *sqlite3_user_data(sqlite3_context*); | |
4046 | + | |
4047 | +/* | |
4048 | +** CAPI3REF: Database Connection For Functions | |
4049 | +** | |
4050 | +** ^The sqlite3_context_db_handle() interface returns a copy of | |
4051 | +** the pointer to the [database connection] (the 1st parameter) | |
4052 | +** of the [sqlite3_create_function()] | |
4053 | +** and [sqlite3_create_function16()] routines that originally | |
4054 | +** registered the application defined function. | |
4055 | +*/ | |
4056 | +SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*); | |
4057 | + | |
4058 | +/* | |
4059 | +** CAPI3REF: Function Auxiliary Data | |
4060 | +** | |
4061 | +** The following two functions may be used by scalar SQL functions to | |
4062 | +** associate metadata with argument values. If the same value is passed to | |
4063 | +** multiple invocations of the same SQL function during query execution, under | |
4064 | +** some circumstances the associated metadata may be preserved. This may | |
4065 | +** be used, for example, to add a regular-expression matching scalar | |
4066 | +** function. The compiled version of the regular expression is stored as | |
4067 | +** metadata associated with the SQL value passed as the regular expression | |
4068 | +** pattern. The compiled regular expression can be reused on multiple | |
4069 | +** invocations of the same function so that the original pattern string | |
4070 | +** does not need to be recompiled on each invocation. | |
4071 | +** | |
4072 | +** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata | |
4073 | +** associated by the sqlite3_set_auxdata() function with the Nth argument | |
4074 | +** value to the application-defined function. ^If no metadata has been ever | |
4075 | +** been set for the Nth argument of the function, or if the corresponding | |
4076 | +** function parameter has changed since the meta-data was set, | |
4077 | +** then sqlite3_get_auxdata() returns a NULL pointer. | |
4078 | +** | |
4079 | +** ^The sqlite3_set_auxdata() interface saves the metadata | |
4080 | +** pointed to by its 3rd parameter as the metadata for the N-th | |
4081 | +** argument of the application-defined function. Subsequent | |
4082 | +** calls to sqlite3_get_auxdata() might return this data, if it has | |
4083 | +** not been destroyed. | |
4084 | +** ^If it is not NULL, SQLite will invoke the destructor | |
4085 | +** function given by the 4th parameter to sqlite3_set_auxdata() on | |
4086 | +** the metadata when the corresponding function parameter changes | |
4087 | +** or when the SQL statement completes, whichever comes first. | |
4088 | +** | |
4089 | +** SQLite is free to call the destructor and drop metadata on any | |
4090 | +** parameter of any function at any time. ^The only guarantee is that | |
4091 | +** the destructor will be called before the metadata is dropped. | |
4092 | +** | |
4093 | +** ^(In practice, metadata is preserved between function calls for | |
4094 | +** expressions that are constant at compile time. This includes literal | |
4095 | +** values and [parameters].)^ | |
4096 | +** | |
4097 | +** These routines must be called from the same thread in which | |
4098 | +** the SQL function is running. | |
4099 | +*/ | |
4100 | +SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N); | |
4101 | +SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); | |
4102 | + | |
4103 | + | |
4104 | +/* | |
4105 | +** CAPI3REF: Constants Defining Special Destructor Behavior | |
4106 | +** | |
4107 | +** These are special values for the destructor that is passed in as the | |
4108 | +** final argument to routines like [sqlite3_result_blob()]. ^If the destructor | |
4109 | +** argument is SQLITE_STATIC, it means that the content pointer is constant | |
4110 | +** and will never change. It does not need to be destroyed. ^The | |
4111 | +** SQLITE_TRANSIENT value means that the content will likely change in | |
4112 | +** the near future and that SQLite should make its own private copy of | |
4113 | +** the content before returning. | |
4114 | +** | |
4115 | +** The typedef is necessary to work around problems in certain | |
4116 | +** C++ compilers. See ticket #2191. | |
4117 | +*/ | |
4118 | +typedef void (*sqlite3_destructor_type)(void*); | |
4119 | +#define SQLITE_STATIC ((sqlite3_destructor_type)0) | |
4120 | +#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) | |
4121 | + | |
4122 | +/* | |
4123 | +** CAPI3REF: Setting The Result Of An SQL Function | |
4124 | +** | |
4125 | +** These routines are used by the xFunc or xFinal callbacks that | |
4126 | +** implement SQL functions and aggregates. See | |
4127 | +** [sqlite3_create_function()] and [sqlite3_create_function16()] | |
4128 | +** for additional information. | |
4129 | +** | |
4130 | +** These functions work very much like the [parameter binding] family of | |
4131 | +** functions used to bind values to host parameters in prepared statements. | |
4132 | +** Refer to the [SQL parameter] documentation for additional information. | |
4133 | +** | |
4134 | +** ^The sqlite3_result_blob() interface sets the result from | |
4135 | +** an application-defined function to be the BLOB whose content is pointed | |
4136 | +** to by the second parameter and which is N bytes long where N is the | |
4137 | +** third parameter. | |
4138 | +** | |
4139 | +** ^The sqlite3_result_zeroblob() interfaces set the result of | |
4140 | +** the application-defined function to be a BLOB containing all zero | |
4141 | +** bytes and N bytes in size, where N is the value of the 2nd parameter. | |
4142 | +** | |
4143 | +** ^The sqlite3_result_double() interface sets the result from | |
4144 | +** an application-defined function to be a floating point value specified | |
4145 | +** by its 2nd argument. | |
4146 | +** | |
4147 | +** ^The sqlite3_result_error() and sqlite3_result_error16() functions | |
4148 | +** cause the implemented SQL function to throw an exception. | |
4149 | +** ^SQLite uses the string pointed to by the | |
4150 | +** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() | |
4151 | +** as the text of an error message. ^SQLite interprets the error | |
4152 | +** message string from sqlite3_result_error() as UTF-8. ^SQLite | |
4153 | +** interprets the string from sqlite3_result_error16() as UTF-16 in native | |
4154 | +** byte order. ^If the third parameter to sqlite3_result_error() | |
4155 | +** or sqlite3_result_error16() is negative then SQLite takes as the error | |
4156 | +** message all text up through the first zero character. | |
4157 | +** ^If the third parameter to sqlite3_result_error() or | |
4158 | +** sqlite3_result_error16() is non-negative then SQLite takes that many | |
4159 | +** bytes (not characters) from the 2nd parameter as the error message. | |
4160 | +** ^The sqlite3_result_error() and sqlite3_result_error16() | |
4161 | +** routines make a private copy of the error message text before | |
4162 | +** they return. Hence, the calling function can deallocate or | |
4163 | +** modify the text after they return without harm. | |
4164 | +** ^The sqlite3_result_error_code() function changes the error code | |
4165 | +** returned by SQLite as a result of an error in a function. ^By default, | |
4166 | +** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() | |
4167 | +** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. | |
4168 | +** | |
4169 | +** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an | |
4170 | +** error indicating that a string or BLOB is too long to represent. | |
4171 | +** | |
4172 | +** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an | |
4173 | +** error indicating that a memory allocation failed. | |
4174 | +** | |
4175 | +** ^The sqlite3_result_int() interface sets the return value | |
4176 | +** of the application-defined function to be the 32-bit signed integer | |
4177 | +** value given in the 2nd argument. | |
4178 | +** ^The sqlite3_result_int64() interface sets the return value | |
4179 | +** of the application-defined function to be the 64-bit signed integer | |
4180 | +** value given in the 2nd argument. | |
4181 | +** | |
4182 | +** ^The sqlite3_result_null() interface sets the return value | |
4183 | +** of the application-defined function to be NULL. | |
4184 | +** | |
4185 | +** ^The sqlite3_result_text(), sqlite3_result_text16(), | |
4186 | +** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces | |
4187 | +** set the return value of the application-defined function to be | |
4188 | +** a text string which is represented as UTF-8, UTF-16 native byte order, | |
4189 | +** UTF-16 little endian, or UTF-16 big endian, respectively. | |
4190 | +** ^SQLite takes the text result from the application from | |
4191 | +** the 2nd parameter of the sqlite3_result_text* interfaces. | |
4192 | +** ^If the 3rd parameter to the sqlite3_result_text* interfaces | |
4193 | +** is negative, then SQLite takes result text from the 2nd parameter | |
4194 | +** through the first zero character. | |
4195 | +** ^If the 3rd parameter to the sqlite3_result_text* interfaces | |
4196 | +** is non-negative, then as many bytes (not characters) of the text | |
4197 | +** pointed to by the 2nd parameter are taken as the application-defined | |
4198 | +** function result. If the 3rd parameter is non-negative, then it | |
4199 | +** must be the byte offset into the string where the NUL terminator would | |
4200 | +** appear if the string where NUL terminated. If any NUL characters occur | |
4201 | +** in the string at a byte offset that is less than the value of the 3rd | |
4202 | +** parameter, then the resulting string will contain embedded NULs and the | |
4203 | +** result of expressions operating on strings with embedded NULs is undefined. | |
4204 | +** ^If the 4th parameter to the sqlite3_result_text* interfaces | |
4205 | +** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that | |
4206 | +** function as the destructor on the text or BLOB result when it has | |
4207 | +** finished using that result. | |
4208 | +** ^If the 4th parameter to the sqlite3_result_text* interfaces or to | |
4209 | +** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite | |
4210 | +** assumes that the text or BLOB result is in constant space and does not | |
4211 | +** copy the content of the parameter nor call a destructor on the content | |
4212 | +** when it has finished using that result. | |
4213 | +** ^If the 4th parameter to the sqlite3_result_text* interfaces | |
4214 | +** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT | |
4215 | +** then SQLite makes a copy of the result into space obtained from | |
4216 | +** from [sqlite3_malloc()] before it returns. | |
4217 | +** | |
4218 | +** ^The sqlite3_result_value() interface sets the result of | |
4219 | +** the application-defined function to be a copy the | |
4220 | +** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The | |
4221 | +** sqlite3_result_value() interface makes a copy of the [sqlite3_value] | |
4222 | +** so that the [sqlite3_value] specified in the parameter may change or | |
4223 | +** be deallocated after sqlite3_result_value() returns without harm. | |
4224 | +** ^A [protected sqlite3_value] object may always be used where an | |
4225 | +** [unprotected sqlite3_value] object is required, so either | |
4226 | +** kind of [sqlite3_value] object can be used with this interface. | |
4227 | +** | |
4228 | +** If these routines are called from within the different thread | |
4229 | +** than the one containing the application-defined function that received | |
4230 | +** the [sqlite3_context] pointer, the results are undefined. | |
4231 | +*/ | |
4232 | +SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); | |
4233 | +SQLITE_API void sqlite3_result_double(sqlite3_context*, double); | |
4234 | +SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); | |
4235 | +SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); | |
4236 | +SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*); | |
4237 | +SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*); | |
4238 | +SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int); | |
4239 | +SQLITE_API void sqlite3_result_int(sqlite3_context*, int); | |
4240 | +SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); | |
4241 | +SQLITE_API void sqlite3_result_null(sqlite3_context*); | |
4242 | +SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); | |
4243 | +SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); | |
4244 | +SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); | |
4245 | +SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); | |
4246 | +SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); | |
4247 | +SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); | |
4248 | + | |
4249 | +/* | |
4250 | +** CAPI3REF: Define New Collating Sequences | |
4251 | +** | |
4252 | +** ^These functions add, remove, or modify a [collation] associated | |
4253 | +** with the [database connection] specified as the first argument. | |
4254 | +** | |
4255 | +** ^The name of the collation is a UTF-8 string | |
4256 | +** for sqlite3_create_collation() and sqlite3_create_collation_v2() | |
4257 | +** and a UTF-16 string in native byte order for sqlite3_create_collation16(). | |
4258 | +** ^Collation names that compare equal according to [sqlite3_strnicmp()] are | |
4259 | +** considered to be the same name. | |
4260 | +** | |
4261 | +** ^(The third argument (eTextRep) must be one of the constants: | |
4262 | +** <ul> | |
4263 | +** <li> [SQLITE_UTF8], | |
4264 | +** <li> [SQLITE_UTF16LE], | |
4265 | +** <li> [SQLITE_UTF16BE], | |
4266 | +** <li> [SQLITE_UTF16], or | |
4267 | +** <li> [SQLITE_UTF16_ALIGNED]. | |
4268 | +** </ul>)^ | |
4269 | +** ^The eTextRep argument determines the encoding of strings passed | |
4270 | +** to the collating function callback, xCallback. | |
4271 | +** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep | |
4272 | +** force strings to be UTF16 with native byte order. | |
4273 | +** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin | |
4274 | +** on an even byte address. | |
4275 | +** | |
4276 | +** ^The fourth argument, pArg, is an application data pointer that is passed | |
4277 | +** through as the first argument to the collating function callback. | |
4278 | +** | |
4279 | +** ^The fifth argument, xCallback, is a pointer to the collating function. | |
4280 | +** ^Multiple collating functions can be registered using the same name but | |
4281 | +** with different eTextRep parameters and SQLite will use whichever | |
4282 | +** function requires the least amount of data transformation. | |
4283 | +** ^If the xCallback argument is NULL then the collating function is | |
4284 | +** deleted. ^When all collating functions having the same name are deleted, | |
4285 | +** that collation is no longer usable. | |
4286 | +** | |
4287 | +** ^The collating function callback is invoked with a copy of the pArg | |
4288 | +** application data pointer and with two strings in the encoding specified | |
4289 | +** by the eTextRep argument. The collating function must return an | |
4290 | +** integer that is negative, zero, or positive | |
4291 | +** if the first string is less than, equal to, or greater than the second, | |
4292 | +** respectively. A collating function must always return the same answer | |
4293 | +** given the same inputs. If two or more collating functions are registered | |
4294 | +** to the same collation name (using different eTextRep values) then all | |
4295 | +** must give an equivalent answer when invoked with equivalent strings. | |
4296 | +** The collating function must obey the following properties for all | |
4297 | +** strings A, B, and C: | |
4298 | +** | |
4299 | +** <ol> | |
4300 | +** <li> If A==B then B==A. | |
4301 | +** <li> If A==B and B==C then A==C. | |
4302 | +** <li> If A<B THEN B>A. | |
4303 | +** <li> If A<B and B<C then A<C. | |
4304 | +** </ol> | |
4305 | +** | |
4306 | +** If a collating function fails any of the above constraints and that | |
4307 | +** collating function is registered and used, then the behavior of SQLite | |
4308 | +** is undefined. | |
4309 | +** | |
4310 | +** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() | |
4311 | +** with the addition that the xDestroy callback is invoked on pArg when | |
4312 | +** the collating function is deleted. | |
4313 | +** ^Collating functions are deleted when they are overridden by later | |
4314 | +** calls to the collation creation functions or when the | |
4315 | +** [database connection] is closed using [sqlite3_close()]. | |
4316 | +** | |
4317 | +** ^The xDestroy callback is <u>not</u> called if the | |
4318 | +** sqlite3_create_collation_v2() function fails. Applications that invoke | |
4319 | +** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should | |
4320 | +** check the return code and dispose of the application data pointer | |
4321 | +** themselves rather than expecting SQLite to deal with it for them. | |
4322 | +** This is different from every other SQLite interface. The inconsistency | |
4323 | +** is unfortunate but cannot be changed without breaking backwards | |
4324 | +** compatibility. | |
4325 | +** | |
4326 | +** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. | |
4327 | +*/ | |
4328 | +SQLITE_API int sqlite3_create_collation( | |
4329 | + sqlite3*, | |
4330 | + const char *zName, | |
4331 | + int eTextRep, | |
4332 | + void *pArg, | |
4333 | + int(*xCompare)(void*,int,const void*,int,const void*) | |
4334 | +); | |
4335 | +SQLITE_API int sqlite3_create_collation_v2( | |
4336 | + sqlite3*, | |
4337 | + const char *zName, | |
4338 | + int eTextRep, | |
4339 | + void *pArg, | |
4340 | + int(*xCompare)(void*,int,const void*,int,const void*), | |
4341 | + void(*xDestroy)(void*) | |
4342 | +); | |
4343 | +SQLITE_API int sqlite3_create_collation16( | |
4344 | + sqlite3*, | |
4345 | + const void *zName, | |
4346 | + int eTextRep, | |
4347 | + void *pArg, | |
4348 | + int(*xCompare)(void*,int,const void*,int,const void*) | |
4349 | +); | |
4350 | + | |
4351 | +/* | |
4352 | +** CAPI3REF: Collation Needed Callbacks | |
4353 | +** | |
4354 | +** ^To avoid having to register all collation sequences before a database | |
4355 | +** can be used, a single callback function may be registered with the | |
4356 | +** [database connection] to be invoked whenever an undefined collation | |
4357 | +** sequence is required. | |
4358 | +** | |
4359 | +** ^If the function is registered using the sqlite3_collation_needed() API, | |
4360 | +** then it is passed the names of undefined collation sequences as strings | |
4361 | +** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, | |
4362 | +** the names are passed as UTF-16 in machine native byte order. | |
4363 | +** ^A call to either function replaces the existing collation-needed callback. | |
4364 | +** | |
4365 | +** ^(When the callback is invoked, the first argument passed is a copy | |
4366 | +** of the second argument to sqlite3_collation_needed() or | |
4367 | +** sqlite3_collation_needed16(). The second argument is the database | |
4368 | +** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], | |
4369 | +** or [SQLITE_UTF16LE], indicating the most desirable form of the collation | |
4370 | +** sequence function required. The fourth parameter is the name of the | |
4371 | +** required collation sequence.)^ | |
4372 | +** | |
4373 | +** The callback function should register the desired collation using | |
4374 | +** [sqlite3_create_collation()], [sqlite3_create_collation16()], or | |
4375 | +** [sqlite3_create_collation_v2()]. | |
4376 | +*/ | |
4377 | +SQLITE_API int sqlite3_collation_needed( | |
4378 | + sqlite3*, | |
4379 | + void*, | |
4380 | + void(*)(void*,sqlite3*,int eTextRep,const char*) | |
4381 | +); | |
4382 | +SQLITE_API int sqlite3_collation_needed16( | |
4383 | + sqlite3*, | |
4384 | + void*, | |
4385 | + void(*)(void*,sqlite3*,int eTextRep,const void*) | |
4386 | +); | |
4387 | + | |
4388 | +#ifdef SQLITE_HAS_CODEC | |
4389 | +/* | |
4390 | +** Specify the key for an encrypted database. This routine should be | |
4391 | +** called right after sqlite3_open(). | |
4392 | +** | |
4393 | +** The code to implement this API is not available in the public release | |
4394 | +** of SQLite. | |
4395 | +*/ | |
4396 | +SQLITE_API int sqlite3_key( | |
4397 | + sqlite3 *db, /* Database to be rekeyed */ | |
4398 | + const void *pKey, int nKey /* The key */ | |
4399 | +); | |
4400 | + | |
4401 | +/* | |
4402 | +** Change the key on an open database. If the current database is not | |
4403 | +** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the | |
4404 | +** database is decrypted. | |
4405 | +** | |
4406 | +** The code to implement this API is not available in the public release | |
4407 | +** of SQLite. | |
4408 | +*/ | |
4409 | +SQLITE_API int sqlite3_rekey( | |
4410 | + sqlite3 *db, /* Database to be rekeyed */ | |
4411 | + const void *pKey, int nKey /* The new key */ | |
4412 | +); | |
4413 | + | |
4414 | +/* | |
4415 | +** Specify the activation key for a SEE database. Unless | |
4416 | +** activated, none of the SEE routines will work. | |
4417 | +*/ | |
4418 | +SQLITE_API void sqlite3_activate_see( | |
4419 | + const char *zPassPhrase /* Activation phrase */ | |
4420 | +); | |
4421 | +#endif | |
4422 | + | |
4423 | +#ifdef SQLITE_ENABLE_CEROD | |
4424 | +/* | |
4425 | +** Specify the activation key for a CEROD database. Unless | |
4426 | +** activated, none of the CEROD routines will work. | |
4427 | +*/ | |
4428 | +SQLITE_API void sqlite3_activate_cerod( | |
4429 | + const char *zPassPhrase /* Activation phrase */ | |
4430 | +); | |
4431 | +#endif | |
4432 | + | |
4433 | +/* | |
4434 | +** CAPI3REF: Suspend Execution For A Short Time | |
4435 | +** | |
4436 | +** The sqlite3_sleep() function causes the current thread to suspend execution | |
4437 | +** for at least a number of milliseconds specified in its parameter. | |
4438 | +** | |
4439 | +** If the operating system does not support sleep requests with | |
4440 | +** millisecond time resolution, then the time will be rounded up to | |
4441 | +** the nearest second. The number of milliseconds of sleep actually | |
4442 | +** requested from the operating system is returned. | |
4443 | +** | |
4444 | +** ^SQLite implements this interface by calling the xSleep() | |
4445 | +** method of the default [sqlite3_vfs] object. If the xSleep() method | |
4446 | +** of the default VFS is not implemented correctly, or not implemented at | |
4447 | +** all, then the behavior of sqlite3_sleep() may deviate from the description | |
4448 | +** in the previous paragraphs. | |
4449 | +*/ | |
4450 | +SQLITE_API int sqlite3_sleep(int); | |
4451 | + | |
4452 | +/* | |
4453 | +** CAPI3REF: Name Of The Folder Holding Temporary Files | |
4454 | +** | |
4455 | +** ^(If this global variable is made to point to a string which is | |
4456 | +** the name of a folder (a.k.a. directory), then all temporary files | |
4457 | +** created by SQLite when using a built-in [sqlite3_vfs | VFS] | |
4458 | +** will be placed in that directory.)^ ^If this variable | |
4459 | +** is a NULL pointer, then SQLite performs a search for an appropriate | |
4460 | +** temporary file directory. | |
4461 | +** | |
4462 | +** It is not safe to read or modify this variable in more than one | |
4463 | +** thread at a time. It is not safe to read or modify this variable | |
4464 | +** if a [database connection] is being used at the same time in a separate | |
4465 | +** thread. | |
4466 | +** It is intended that this variable be set once | |
4467 | +** as part of process initialization and before any SQLite interface | |
4468 | +** routines have been called and that this variable remain unchanged | |
4469 | +** thereafter. | |
4470 | +** | |
4471 | +** ^The [temp_store_directory pragma] may modify this variable and cause | |
4472 | +** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, | |
4473 | +** the [temp_store_directory pragma] always assumes that any string | |
4474 | +** that this variable points to is held in memory obtained from | |
4475 | +** [sqlite3_malloc] and the pragma may attempt to free that memory | |
4476 | +** using [sqlite3_free]. | |
4477 | +** Hence, if this variable is modified directly, either it should be | |
4478 | +** made NULL or made to point to memory obtained from [sqlite3_malloc] | |
4479 | +** or else the use of the [temp_store_directory pragma] should be avoided. | |
4480 | +** | |
4481 | +** <b>Note to Windows Runtime users:</b> The temporary directory must be set | |
4482 | +** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various | |
4483 | +** features that require the use of temporary files may fail. Here is an | |
4484 | +** example of how to do this using C++ with the Windows Runtime: | |
4485 | +** | |
4486 | +** <blockquote><pre> | |
4487 | +** LPCWSTR zPath = Windows::Storage::ApplicationData::Current-> | |
4488 | +** TemporaryFolder->Path->Data(); | |
4489 | +** char zPathBuf[MAX_PATH + 1]; | |
4490 | +** memset(zPathBuf, 0, sizeof(zPathBuf)); | |
4491 | +** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf), | |
4492 | +** NULL, NULL); | |
4493 | +** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf); | |
4494 | +** </pre></blockquote> | |
4495 | +*/ | |
4496 | +SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; | |
4497 | + | |
4498 | +/* | |
4499 | +** CAPI3REF: Name Of The Folder Holding Database Files | |
4500 | +** | |
4501 | +** ^(If this global variable is made to point to a string which is | |
4502 | +** the name of a folder (a.k.a. directory), then all database files | |
4503 | +** specified with a relative pathname and created or accessed by | |
4504 | +** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed | |
4505 | +** to be relative to that directory.)^ ^If this variable is a NULL | |
4506 | +** pointer, then SQLite assumes that all database files specified | |
4507 | +** with a relative pathname are relative to the current directory | |
4508 | +** for the process. Only the windows VFS makes use of this global | |
4509 | +** variable; it is ignored by the unix VFS. | |
4510 | +** | |
4511 | +** Changing the value of this variable while a database connection is | |
4512 | +** open can result in a corrupt database. | |
4513 | +** | |
4514 | +** It is not safe to read or modify this variable in more than one | |
4515 | +** thread at a time. It is not safe to read or modify this variable | |
4516 | +** if a [database connection] is being used at the same time in a separate | |
4517 | +** thread. | |
4518 | +** It is intended that this variable be set once | |
4519 | +** as part of process initialization and before any SQLite interface | |
4520 | +** routines have been called and that this variable remain unchanged | |
4521 | +** thereafter. | |
4522 | +** | |
4523 | +** ^The [data_store_directory pragma] may modify this variable and cause | |
4524 | +** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, | |
4525 | +** the [data_store_directory pragma] always assumes that any string | |
4526 | +** that this variable points to is held in memory obtained from | |
4527 | +** [sqlite3_malloc] and the pragma may attempt to free that memory | |
4528 | +** using [sqlite3_free]. | |
4529 | +** Hence, if this variable is modified directly, either it should be | |
4530 | +** made NULL or made to point to memory obtained from [sqlite3_malloc] | |
4531 | +** or else the use of the [data_store_directory pragma] should be avoided. | |
4532 | +*/ | |
4533 | +SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory; | |
4534 | + | |
4535 | +/* | |
4536 | +** CAPI3REF: Test For Auto-Commit Mode | |
4537 | +** KEYWORDS: {autocommit mode} | |
4538 | +** | |
4539 | +** ^The sqlite3_get_autocommit() interface returns non-zero or | |
4540 | +** zero if the given database connection is or is not in autocommit mode, | |
4541 | +** respectively. ^Autocommit mode is on by default. | |
4542 | +** ^Autocommit mode is disabled by a [BEGIN] statement. | |
4543 | +** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. | |
4544 | +** | |
4545 | +** If certain kinds of errors occur on a statement within a multi-statement | |
4546 | +** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], | |
4547 | +** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the | |
4548 | +** transaction might be rolled back automatically. The only way to | |
4549 | +** find out whether SQLite automatically rolled back the transaction after | |
4550 | +** an error is to use this function. | |
4551 | +** | |
4552 | +** If another thread changes the autocommit status of the database | |
4553 | +** connection while this routine is running, then the return value | |
4554 | +** is undefined. | |
4555 | +*/ | |
4556 | +SQLITE_API int sqlite3_get_autocommit(sqlite3*); | |
4557 | + | |
4558 | +/* | |
4559 | +** CAPI3REF: Find The Database Handle Of A Prepared Statement | |
4560 | +** | |
4561 | +** ^The sqlite3_db_handle interface returns the [database connection] handle | |
4562 | +** to which a [prepared statement] belongs. ^The [database connection] | |
4563 | +** returned by sqlite3_db_handle is the same [database connection] | |
4564 | +** that was the first argument | |
4565 | +** to the [sqlite3_prepare_v2()] call (or its variants) that was used to | |
4566 | +** create the statement in the first place. | |
4567 | +*/ | |
4568 | +SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*); | |
4569 | + | |
4570 | +/* | |
4571 | +** CAPI3REF: Return The Filename For A Database Connection | |
4572 | +** | |
4573 | +** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename | |
4574 | +** associated with database N of connection D. ^The main database file | |
4575 | +** has the name "main". If there is no attached database N on the database | |
4576 | +** connection D, or if database N is a temporary or in-memory database, then | |
4577 | +** a NULL pointer is returned. | |
4578 | +** | |
4579 | +** ^The filename returned by this function is the output of the | |
4580 | +** xFullPathname method of the [VFS]. ^In other words, the filename | |
4581 | +** will be an absolute pathname, even if the filename used | |
4582 | +** to open the database originally was a URI or relative pathname. | |
4583 | +*/ | |
4584 | +SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName); | |
4585 | + | |
4586 | +/* | |
4587 | +** CAPI3REF: Determine if a database is read-only | |
4588 | +** | |
4589 | +** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N | |
4590 | +** of connection D is read-only, 0 if it is read/write, or -1 if N is not | |
4591 | +** the name of a database on connection D. | |
4592 | +*/ | |
4593 | +SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName); | |
4594 | + | |
4595 | +/* | |
4596 | +** CAPI3REF: Find the next prepared statement | |
4597 | +** | |
4598 | +** ^This interface returns a pointer to the next [prepared statement] after | |
4599 | +** pStmt associated with the [database connection] pDb. ^If pStmt is NULL | |
4600 | +** then this interface returns a pointer to the first prepared statement | |
4601 | +** associated with the database connection pDb. ^If no prepared statement | |
4602 | +** satisfies the conditions of this routine, it returns NULL. | |
4603 | +** | |
4604 | +** The [database connection] pointer D in a call to | |
4605 | +** [sqlite3_next_stmt(D,S)] must refer to an open database | |
4606 | +** connection and in particular must not be a NULL pointer. | |
4607 | +*/ | |
4608 | +SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); | |
4609 | + | |
4610 | +/* | |
4611 | +** CAPI3REF: Commit And Rollback Notification Callbacks | |
4612 | +** | |
4613 | +** ^The sqlite3_commit_hook() interface registers a callback | |
4614 | +** function to be invoked whenever a transaction is [COMMIT | committed]. | |
4615 | +** ^Any callback set by a previous call to sqlite3_commit_hook() | |
4616 | +** for the same database connection is overridden. | |
4617 | +** ^The sqlite3_rollback_hook() interface registers a callback | |
4618 | +** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. | |
4619 | +** ^Any callback set by a previous call to sqlite3_rollback_hook() | |
4620 | +** for the same database connection is overridden. | |
4621 | +** ^The pArg argument is passed through to the callback. | |
4622 | +** ^If the callback on a commit hook function returns non-zero, | |
4623 | +** then the commit is converted into a rollback. | |
4624 | +** | |
4625 | +** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions | |
4626 | +** return the P argument from the previous call of the same function | |
4627 | +** on the same [database connection] D, or NULL for | |
4628 | +** the first call for each function on D. | |
4629 | +** | |
4630 | +** The commit and rollback hook callbacks are not reentrant. | |
4631 | +** The callback implementation must not do anything that will modify | |
4632 | +** the database connection that invoked the callback. Any actions | |
4633 | +** to modify the database connection must be deferred until after the | |
4634 | +** completion of the [sqlite3_step()] call that triggered the commit | |
4635 | +** or rollback hook in the first place. | |
4636 | +** Note that running any other SQL statements, including SELECT statements, | |
4637 | +** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify | |
4638 | +** the database connections for the meaning of "modify" in this paragraph. | |
4639 | +** | |
4640 | +** ^Registering a NULL function disables the callback. | |
4641 | +** | |
4642 | +** ^When the commit hook callback routine returns zero, the [COMMIT] | |
4643 | +** operation is allowed to continue normally. ^If the commit hook | |
4644 | +** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. | |
4645 | +** ^The rollback hook is invoked on a rollback that results from a commit | |
4646 | +** hook returning non-zero, just as it would be with any other rollback. | |
4647 | +** | |
4648 | +** ^For the purposes of this API, a transaction is said to have been | |
4649 | +** rolled back if an explicit "ROLLBACK" statement is executed, or | |
4650 | +** an error or constraint causes an implicit rollback to occur. | |
4651 | +** ^The rollback callback is not invoked if a transaction is | |
4652 | +** automatically rolled back because the database connection is closed. | |
4653 | +** | |
4654 | +** See also the [sqlite3_update_hook()] interface. | |
4655 | +*/ | |
4656 | +SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); | |
4657 | +SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); | |
4658 | + | |
4659 | +/* | |
4660 | +** CAPI3REF: Data Change Notification Callbacks | |
4661 | +** | |
4662 | +** ^The sqlite3_update_hook() interface registers a callback function | |
4663 | +** with the [database connection] identified by the first argument | |
4664 | +** to be invoked whenever a row is updated, inserted or deleted. | |
4665 | +** ^Any callback set by a previous call to this function | |
4666 | +** for the same database connection is overridden. | |
4667 | +** | |
4668 | +** ^The second argument is a pointer to the function to invoke when a | |
4669 | +** row is updated, inserted or deleted. | |
4670 | +** ^The first argument to the callback is a copy of the third argument | |
4671 | +** to sqlite3_update_hook(). | |
4672 | +** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], | |
4673 | +** or [SQLITE_UPDATE], depending on the operation that caused the callback | |
4674 | +** to be invoked. | |
4675 | +** ^The third and fourth arguments to the callback contain pointers to the | |
4676 | +** database and table name containing the affected row. | |
4677 | +** ^The final callback parameter is the [rowid] of the row. | |
4678 | +** ^In the case of an update, this is the [rowid] after the update takes place. | |
4679 | +** | |
4680 | +** ^(The update hook is not invoked when internal system tables are | |
4681 | +** modified (i.e. sqlite_master and sqlite_sequence).)^ | |
4682 | +** | |
4683 | +** ^In the current implementation, the update hook | |
4684 | +** is not invoked when duplication rows are deleted because of an | |
4685 | +** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook | |
4686 | +** invoked when rows are deleted using the [truncate optimization]. | |
4687 | +** The exceptions defined in this paragraph might change in a future | |
4688 | +** release of SQLite. | |
4689 | +** | |
4690 | +** The update hook implementation must not do anything that will modify | |
4691 | +** the database connection that invoked the update hook. Any actions | |
4692 | +** to modify the database connection must be deferred until after the | |
4693 | +** completion of the [sqlite3_step()] call that triggered the update hook. | |
4694 | +** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their | |
4695 | +** database connections for the meaning of "modify" in this paragraph. | |
4696 | +** | |
4697 | +** ^The sqlite3_update_hook(D,C,P) function | |
4698 | +** returns the P argument from the previous call | |
4699 | +** on the same [database connection] D, or NULL for | |
4700 | +** the first call on D. | |
4701 | +** | |
4702 | +** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] | |
4703 | +** interfaces. | |
4704 | +*/ | |
4705 | +SQLITE_API void *sqlite3_update_hook( | |
4706 | + sqlite3*, | |
4707 | + void(*)(void *,int ,char const *,char const *,sqlite3_int64), | |
4708 | + void* | |
4709 | +); | |
4710 | + | |
4711 | +/* | |
4712 | +** CAPI3REF: Enable Or Disable Shared Pager Cache | |
4713 | +** | |
4714 | +** ^(This routine enables or disables the sharing of the database cache | |
4715 | +** and schema data structures between [database connection | connections] | |
4716 | +** to the same database. Sharing is enabled if the argument is true | |
4717 | +** and disabled if the argument is false.)^ | |
4718 | +** | |
4719 | +** ^Cache sharing is enabled and disabled for an entire process. | |
4720 | +** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, | |
4721 | +** sharing was enabled or disabled for each thread separately. | |
4722 | +** | |
4723 | +** ^(The cache sharing mode set by this interface effects all subsequent | |
4724 | +** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. | |
4725 | +** Existing database connections continue use the sharing mode | |
4726 | +** that was in effect at the time they were opened.)^ | |
4727 | +** | |
4728 | +** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled | |
4729 | +** successfully. An [error code] is returned otherwise.)^ | |
4730 | +** | |
4731 | +** ^Shared cache is disabled by default. But this might change in | |
4732 | +** future releases of SQLite. Applications that care about shared | |
4733 | +** cache setting should set it explicitly. | |
4734 | +** | |
4735 | +** See Also: [SQLite Shared-Cache Mode] | |
4736 | +*/ | |
4737 | +SQLITE_API int sqlite3_enable_shared_cache(int); | |
4738 | + | |
4739 | +/* | |
4740 | +** CAPI3REF: Attempt To Free Heap Memory | |
4741 | +** | |
4742 | +** ^The sqlite3_release_memory() interface attempts to free N bytes | |
4743 | +** of heap memory by deallocating non-essential memory allocations | |
4744 | +** held by the database library. Memory used to cache database | |
4745 | +** pages to improve performance is an example of non-essential memory. | |
4746 | +** ^sqlite3_release_memory() returns the number of bytes actually freed, | |
4747 | +** which might be more or less than the amount requested. | |
4748 | +** ^The sqlite3_release_memory() routine is a no-op returning zero | |
4749 | +** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. | |
4750 | +** | |
4751 | +** See also: [sqlite3_db_release_memory()] | |
4752 | +*/ | |
4753 | +SQLITE_API int sqlite3_release_memory(int); | |
4754 | + | |
4755 | +/* | |
4756 | +** CAPI3REF: Free Memory Used By A Database Connection | |
4757 | +** | |
4758 | +** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap | |
4759 | +** memory as possible from database connection D. Unlike the | |
4760 | +** [sqlite3_release_memory()] interface, this interface is effect even | |
4761 | +** when then [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is | |
4762 | +** omitted. | |
4763 | +** | |
4764 | +** See also: [sqlite3_release_memory()] | |
4765 | +*/ | |
4766 | +SQLITE_API int sqlite3_db_release_memory(sqlite3*); | |
4767 | + | |
4768 | +/* | |
4769 | +** CAPI3REF: Impose A Limit On Heap Size | |
4770 | +** | |
4771 | +** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the | |
4772 | +** soft limit on the amount of heap memory that may be allocated by SQLite. | |
4773 | +** ^SQLite strives to keep heap memory utilization below the soft heap | |
4774 | +** limit by reducing the number of pages held in the page cache | |
4775 | +** as heap memory usages approaches the limit. | |
4776 | +** ^The soft heap limit is "soft" because even though SQLite strives to stay | |
4777 | +** below the limit, it will exceed the limit rather than generate | |
4778 | +** an [SQLITE_NOMEM] error. In other words, the soft heap limit | |
4779 | +** is advisory only. | |
4780 | +** | |
4781 | +** ^The return value from sqlite3_soft_heap_limit64() is the size of | |
4782 | +** the soft heap limit prior to the call, or negative in the case of an | |
4783 | +** error. ^If the argument N is negative | |
4784 | +** then no change is made to the soft heap limit. Hence, the current | |
4785 | +** size of the soft heap limit can be determined by invoking | |
4786 | +** sqlite3_soft_heap_limit64() with a negative argument. | |
4787 | +** | |
4788 | +** ^If the argument N is zero then the soft heap limit is disabled. | |
4789 | +** | |
4790 | +** ^(The soft heap limit is not enforced in the current implementation | |
4791 | +** if one or more of following conditions are true: | |
4792 | +** | |
4793 | +** <ul> | |
4794 | +** <li> The soft heap limit is set to zero. | |
4795 | +** <li> Memory accounting is disabled using a combination of the | |
4796 | +** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and | |
4797 | +** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. | |
4798 | +** <li> An alternative page cache implementation is specified using | |
4799 | +** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...). | |
4800 | +** <li> The page cache allocates from its own memory pool supplied | |
4801 | +** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than | |
4802 | +** from the heap. | |
4803 | +** </ul>)^ | |
4804 | +** | |
4805 | +** Beginning with SQLite version 3.7.3, the soft heap limit is enforced | |
4806 | +** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT] | |
4807 | +** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT], | |
4808 | +** the soft heap limit is enforced on every memory allocation. Without | |
4809 | +** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced | |
4810 | +** when memory is allocated by the page cache. Testing suggests that because | |
4811 | +** the page cache is the predominate memory user in SQLite, most | |
4812 | +** applications will achieve adequate soft heap limit enforcement without | |
4813 | +** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT]. | |
4814 | +** | |
4815 | +** The circumstances under which SQLite will enforce the soft heap limit may | |
4816 | +** changes in future releases of SQLite. | |
4817 | +*/ | |
4818 | +SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); | |
4819 | + | |
4820 | +/* | |
4821 | +** CAPI3REF: Deprecated Soft Heap Limit Interface | |
4822 | +** DEPRECATED | |
4823 | +** | |
4824 | +** This is a deprecated version of the [sqlite3_soft_heap_limit64()] | |
4825 | +** interface. This routine is provided for historical compatibility | |
4826 | +** only. All new applications should use the | |
4827 | +** [sqlite3_soft_heap_limit64()] interface rather than this one. | |
4828 | +*/ | |
4829 | +SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N); | |
4830 | + | |
4831 | + | |
4832 | +/* | |
4833 | +** CAPI3REF: Extract Metadata About A Column Of A Table | |
4834 | +** | |
4835 | +** ^This routine returns metadata about a specific column of a specific | |
4836 | +** database table accessible using the [database connection] handle | |
4837 | +** passed as the first function argument. | |
4838 | +** | |
4839 | +** ^The column is identified by the second, third and fourth parameters to | |
4840 | +** this function. ^The second parameter is either the name of the database | |
4841 | +** (i.e. "main", "temp", or an attached database) containing the specified | |
4842 | +** table or NULL. ^If it is NULL, then all attached databases are searched | |
4843 | +** for the table using the same algorithm used by the database engine to | |
4844 | +** resolve unqualified table references. | |
4845 | +** | |
4846 | +** ^The third and fourth parameters to this function are the table and column | |
4847 | +** name of the desired column, respectively. Neither of these parameters | |
4848 | +** may be NULL. | |
4849 | +** | |
4850 | +** ^Metadata is returned by writing to the memory locations passed as the 5th | |
4851 | +** and subsequent parameters to this function. ^Any of these arguments may be | |
4852 | +** NULL, in which case the corresponding element of metadata is omitted. | |
4853 | +** | |
4854 | +** ^(<blockquote> | |
4855 | +** <table border="1"> | |
4856 | +** <tr><th> Parameter <th> Output<br>Type <th> Description | |
4857 | +** | |
4858 | +** <tr><td> 5th <td> const char* <td> Data type | |
4859 | +** <tr><td> 6th <td> const char* <td> Name of default collation sequence | |
4860 | +** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint | |
4861 | +** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY | |
4862 | +** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] | |
4863 | +** </table> | |
4864 | +** </blockquote>)^ | |
4865 | +** | |
4866 | +** ^The memory pointed to by the character pointers returned for the | |
4867 | +** declaration type and collation sequence is valid only until the next | |
4868 | +** call to any SQLite API function. | |
4869 | +** | |
4870 | +** ^If the specified table is actually a view, an [error code] is returned. | |
4871 | +** | |
4872 | +** ^If the specified column is "rowid", "oid" or "_rowid_" and an | |
4873 | +** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output | |
4874 | +** parameters are set for the explicitly declared column. ^(If there is no | |
4875 | +** explicitly declared [INTEGER PRIMARY KEY] column, then the output | |
4876 | +** parameters are set as follows: | |
4877 | +** | |
4878 | +** <pre> | |
4879 | +** data type: "INTEGER" | |
4880 | +** collation sequence: "BINARY" | |
4881 | +** not null: 0 | |
4882 | +** primary key: 1 | |
4883 | +** auto increment: 0 | |
4884 | +** </pre>)^ | |
4885 | +** | |
4886 | +** ^(This function may load one or more schemas from database files. If an | |
4887 | +** error occurs during this process, or if the requested table or column | |
4888 | +** cannot be found, an [error code] is returned and an error message left | |
4889 | +** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^ | |
4890 | +** | |
4891 | +** ^This API is only available if the library was compiled with the | |
4892 | +** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. | |
4893 | +*/ | |
4894 | +SQLITE_API int sqlite3_table_column_metadata( | |
4895 | + sqlite3 *db, /* Connection handle */ | |
4896 | + const char *zDbName, /* Database name or NULL */ | |
4897 | + const char *zTableName, /* Table name */ | |
4898 | + const char *zColumnName, /* Column name */ | |
4899 | + char const **pzDataType, /* OUTPUT: Declared data type */ | |
4900 | + char const **pzCollSeq, /* OUTPUT: Collation sequence name */ | |
4901 | + int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ | |
4902 | + int *pPrimaryKey, /* OUTPUT: True if column part of PK */ | |
4903 | + int *pAutoinc /* OUTPUT: True if column is auto-increment */ | |
4904 | +); | |
4905 | + | |
4906 | +/* | |
4907 | +** CAPI3REF: Load An Extension | |
4908 | +** | |
4909 | +** ^This interface loads an SQLite extension library from the named file. | |
4910 | +** | |
4911 | +** ^The sqlite3_load_extension() interface attempts to load an | |
4912 | +** SQLite extension library contained in the file zFile. | |
4913 | +** | |
4914 | +** ^The entry point is zProc. | |
4915 | +** ^zProc may be 0, in which case the name of the entry point | |
4916 | +** defaults to "sqlite3_extension_init". | |
4917 | +** ^The sqlite3_load_extension() interface returns | |
4918 | +** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. | |
4919 | +** ^If an error occurs and pzErrMsg is not 0, then the | |
4920 | +** [sqlite3_load_extension()] interface shall attempt to | |
4921 | +** fill *pzErrMsg with error message text stored in memory | |
4922 | +** obtained from [sqlite3_malloc()]. The calling function | |
4923 | +** should free this memory by calling [sqlite3_free()]. | |
4924 | +** | |
4925 | +** ^Extension loading must be enabled using | |
4926 | +** [sqlite3_enable_load_extension()] prior to calling this API, | |
4927 | +** otherwise an error will be returned. | |
4928 | +** | |
4929 | +** See also the [load_extension() SQL function]. | |
4930 | +*/ | |
4931 | +SQLITE_API int sqlite3_load_extension( | |
4932 | + sqlite3 *db, /* Load the extension into this database connection */ | |
4933 | + const char *zFile, /* Name of the shared library containing extension */ | |
4934 | + const char *zProc, /* Entry point. Derived from zFile if 0 */ | |
4935 | + char **pzErrMsg /* Put error message here if not 0 */ | |
4936 | +); | |
4937 | + | |
4938 | +/* | |
4939 | +** CAPI3REF: Enable Or Disable Extension Loading | |
4940 | +** | |
4941 | +** ^So as not to open security holes in older applications that are | |
4942 | +** unprepared to deal with extension loading, and as a means of disabling | |
4943 | +** extension loading while evaluating user-entered SQL, the following API | |
4944 | +** is provided to turn the [sqlite3_load_extension()] mechanism on and off. | |
4945 | +** | |
4946 | +** ^Extension loading is off by default. See ticket #1863. | |
4947 | +** ^Call the sqlite3_enable_load_extension() routine with onoff==1 | |
4948 | +** to turn extension loading on and call it with onoff==0 to turn | |
4949 | +** it back off again. | |
4950 | +*/ | |
4951 | +SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); | |
4952 | + | |
4953 | +/* | |
4954 | +** CAPI3REF: Automatically Load Statically Linked Extensions | |
4955 | +** | |
4956 | +** ^This interface causes the xEntryPoint() function to be invoked for | |
4957 | +** each new [database connection] that is created. The idea here is that | |
4958 | +** xEntryPoint() is the entry point for a statically linked SQLite extension | |
4959 | +** that is to be automatically loaded into all new database connections. | |
4960 | +** | |
4961 | +** ^(Even though the function prototype shows that xEntryPoint() takes | |
4962 | +** no arguments and returns void, SQLite invokes xEntryPoint() with three | |
4963 | +** arguments and expects and integer result as if the signature of the | |
4964 | +** entry point where as follows: | |
4965 | +** | |
4966 | +** <blockquote><pre> | |
4967 | +** int xEntryPoint( | |
4968 | +** sqlite3 *db, | |
4969 | +** const char **pzErrMsg, | |
4970 | +** const struct sqlite3_api_routines *pThunk | |
4971 | +** ); | |
4972 | +** </pre></blockquote>)^ | |
4973 | +** | |
4974 | +** If the xEntryPoint routine encounters an error, it should make *pzErrMsg | |
4975 | +** point to an appropriate error message (obtained from [sqlite3_mprintf()]) | |
4976 | +** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg | |
4977 | +** is NULL before calling the xEntryPoint(). ^SQLite will invoke | |
4978 | +** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any | |
4979 | +** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], | |
4980 | +** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. | |
4981 | +** | |
4982 | +** ^Calling sqlite3_auto_extension(X) with an entry point X that is already | |
4983 | +** on the list of automatic extensions is a harmless no-op. ^No entry point | |
4984 | +** will be called more than once for each database connection that is opened. | |
4985 | +** | |
4986 | +** See also: [sqlite3_reset_auto_extension()]. | |
4987 | +*/ | |
4988 | +SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void)); | |
4989 | + | |
4990 | +/* | |
4991 | +** CAPI3REF: Reset Automatic Extension Loading | |
4992 | +** | |
4993 | +** ^This interface disables all automatic extensions previously | |
4994 | +** registered using [sqlite3_auto_extension()]. | |
4995 | +*/ | |
4996 | +SQLITE_API void sqlite3_reset_auto_extension(void); | |
4997 | + | |
4998 | +/* | |
4999 | +** The interface to the virtual-table mechanism is currently considered | |
5000 | +** to be experimental. The interface might change in incompatible ways. | |
5001 | +** If this is a problem for you, do not use the interface at this time. | |
5002 | +** | |
5003 | +** When the virtual-table mechanism stabilizes, we will declare the | |
5004 | +** interface fixed, support it indefinitely, and remove this comment. | |
5005 | +*/ | |
5006 | + | |
5007 | +/* | |
5008 | +** Structures used by the virtual table interface | |
5009 | +*/ | |
5010 | +typedef struct sqlite3_vtab sqlite3_vtab; | |
5011 | +typedef struct sqlite3_index_info sqlite3_index_info; | |
5012 | +typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; | |
5013 | +typedef struct sqlite3_module sqlite3_module; | |
5014 | + | |
5015 | +/* | |
5016 | +** CAPI3REF: Virtual Table Object | |
5017 | +** KEYWORDS: sqlite3_module {virtual table module} | |
5018 | +** | |
5019 | +** This structure, sometimes called a "virtual table module", | |
5020 | +** defines the implementation of a [virtual tables]. | |
5021 | +** This structure consists mostly of methods for the module. | |
5022 | +** | |
5023 | +** ^A virtual table module is created by filling in a persistent | |
5024 | +** instance of this structure and passing a pointer to that instance | |
5025 | +** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. | |
5026 | +** ^The registration remains valid until it is replaced by a different | |
5027 | +** module or until the [database connection] closes. The content | |
5028 | +** of this structure must not change while it is registered with | |
5029 | +** any database connection. | |
5030 | +*/ | |
5031 | +struct sqlite3_module { | |
5032 | + int iVersion; | |
5033 | + int (*xCreate)(sqlite3*, void *pAux, | |
5034 | + int argc, const char *const*argv, | |
5035 | + sqlite3_vtab **ppVTab, char**); | |
5036 | + int (*xConnect)(sqlite3*, void *pAux, | |
5037 | + int argc, const char *const*argv, | |
5038 | + sqlite3_vtab **ppVTab, char**); | |
5039 | + int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); | |
5040 | + int (*xDisconnect)(sqlite3_vtab *pVTab); | |
5041 | + int (*xDestroy)(sqlite3_vtab *pVTab); | |
5042 | + int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); | |
5043 | + int (*xClose)(sqlite3_vtab_cursor*); | |
5044 | + int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, | |
5045 | + int argc, sqlite3_value **argv); | |
5046 | + int (*xNext)(sqlite3_vtab_cursor*); | |
5047 | + int (*xEof)(sqlite3_vtab_cursor*); | |
5048 | + int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); | |
5049 | + int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); | |
5050 | + int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); | |
5051 | + int (*xBegin)(sqlite3_vtab *pVTab); | |
5052 | + int (*xSync)(sqlite3_vtab *pVTab); | |
5053 | + int (*xCommit)(sqlite3_vtab *pVTab); | |
5054 | + int (*xRollback)(sqlite3_vtab *pVTab); | |
5055 | + int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, | |
5056 | + void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), | |
5057 | + void **ppArg); | |
5058 | + int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); | |
5059 | + /* The methods above are in version 1 of the sqlite_module object. Those | |
5060 | + ** below are for version 2 and greater. */ | |
5061 | + int (*xSavepoint)(sqlite3_vtab *pVTab, int); | |
5062 | + int (*xRelease)(sqlite3_vtab *pVTab, int); | |
5063 | + int (*xRollbackTo)(sqlite3_vtab *pVTab, int); | |
5064 | +}; | |
5065 | + | |
5066 | +/* | |
5067 | +** CAPI3REF: Virtual Table Indexing Information | |
5068 | +** KEYWORDS: sqlite3_index_info | |
5069 | +** | |
5070 | +** The sqlite3_index_info structure and its substructures is used as part | |
5071 | +** of the [virtual table] interface to | |
5072 | +** pass information into and receive the reply from the [xBestIndex] | |
5073 | +** method of a [virtual table module]. The fields under **Inputs** are the | |
5074 | +** inputs to xBestIndex and are read-only. xBestIndex inserts its | |
5075 | +** results into the **Outputs** fields. | |
5076 | +** | |
5077 | +** ^(The aConstraint[] array records WHERE clause constraints of the form: | |
5078 | +** | |
5079 | +** <blockquote>column OP expr</blockquote> | |
5080 | +** | |
5081 | +** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is | |
5082 | +** stored in aConstraint[].op using one of the | |
5083 | +** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ | |
5084 | +** ^(The index of the column is stored in | |
5085 | +** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the | |
5086 | +** expr on the right-hand side can be evaluated (and thus the constraint | |
5087 | +** is usable) and false if it cannot.)^ | |
5088 | +** | |
5089 | +** ^The optimizer automatically inverts terms of the form "expr OP column" | |
5090 | +** and makes other simplifications to the WHERE clause in an attempt to | |
5091 | +** get as many WHERE clause terms into the form shown above as possible. | |
5092 | +** ^The aConstraint[] array only reports WHERE clause terms that are | |
5093 | +** relevant to the particular virtual table being queried. | |
5094 | +** | |
5095 | +** ^Information about the ORDER BY clause is stored in aOrderBy[]. | |
5096 | +** ^Each term of aOrderBy records a column of the ORDER BY clause. | |
5097 | +** | |
5098 | +** The [xBestIndex] method must fill aConstraintUsage[] with information | |
5099 | +** about what parameters to pass to xFilter. ^If argvIndex>0 then | |
5100 | +** the right-hand side of the corresponding aConstraint[] is evaluated | |
5101 | +** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit | |
5102 | +** is true, then the constraint is assumed to be fully handled by the | |
5103 | +** virtual table and is not checked again by SQLite.)^ | |
5104 | +** | |
5105 | +** ^The idxNum and idxPtr values are recorded and passed into the | |
5106 | +** [xFilter] method. | |
5107 | +** ^[sqlite3_free()] is used to free idxPtr if and only if | |
5108 | +** needToFreeIdxPtr is true. | |
5109 | +** | |
5110 | +** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in | |
5111 | +** the correct order to satisfy the ORDER BY clause so that no separate | |
5112 | +** sorting step is required. | |
5113 | +** | |
5114 | +** ^The estimatedCost value is an estimate of the cost of doing the | |
5115 | +** particular lookup. A full scan of a table with N entries should have | |
5116 | +** a cost of N. A binary search of a table of N entries should have a | |
5117 | +** cost of approximately log(N). | |
5118 | +*/ | |
5119 | +struct sqlite3_index_info { | |
5120 | + /* Inputs */ | |
5121 | + int nConstraint; /* Number of entries in aConstraint */ | |
5122 | + struct sqlite3_index_constraint { | |
5123 | + int iColumn; /* Column on left-hand side of constraint */ | |
5124 | + unsigned char op; /* Constraint operator */ | |
5125 | + unsigned char usable; /* True if this constraint is usable */ | |
5126 | + int iTermOffset; /* Used internally - xBestIndex should ignore */ | |
5127 | + } *aConstraint; /* Table of WHERE clause constraints */ | |
5128 | + int nOrderBy; /* Number of terms in the ORDER BY clause */ | |
5129 | + struct sqlite3_index_orderby { | |
5130 | + int iColumn; /* Column number */ | |
5131 | + unsigned char desc; /* True for DESC. False for ASC. */ | |
5132 | + } *aOrderBy; /* The ORDER BY clause */ | |
5133 | + /* Outputs */ | |
5134 | + struct sqlite3_index_constraint_usage { | |
5135 | + int argvIndex; /* if >0, constraint is part of argv to xFilter */ | |
5136 | + unsigned char omit; /* Do not code a test for this constraint */ | |
5137 | + } *aConstraintUsage; | |
5138 | + int idxNum; /* Number used to identify the index */ | |
5139 | + char *idxStr; /* String, possibly obtained from sqlite3_malloc */ | |
5140 | + int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ | |
5141 | + int orderByConsumed; /* True if output is already ordered */ | |
5142 | + double estimatedCost; /* Estimated cost of using this index */ | |
5143 | +}; | |
5144 | + | |
5145 | +/* | |
5146 | +** CAPI3REF: Virtual Table Constraint Operator Codes | |
5147 | +** | |
5148 | +** These macros defined the allowed values for the | |
5149 | +** [sqlite3_index_info].aConstraint[].op field. Each value represents | |
5150 | +** an operator that is part of a constraint term in the wHERE clause of | |
5151 | +** a query that uses a [virtual table]. | |
5152 | +*/ | |
5153 | +#define SQLITE_INDEX_CONSTRAINT_EQ 2 | |
5154 | +#define SQLITE_INDEX_CONSTRAINT_GT 4 | |
5155 | +#define SQLITE_INDEX_CONSTRAINT_LE 8 | |
5156 | +#define SQLITE_INDEX_CONSTRAINT_LT 16 | |
5157 | +#define SQLITE_INDEX_CONSTRAINT_GE 32 | |
5158 | +#define SQLITE_INDEX_CONSTRAINT_MATCH 64 | |
5159 | + | |
5160 | +/* | |
5161 | +** CAPI3REF: Register A Virtual Table Implementation | |
5162 | +** | |
5163 | +** ^These routines are used to register a new [virtual table module] name. | |
5164 | +** ^Module names must be registered before | |
5165 | +** creating a new [virtual table] using the module and before using a | |
5166 | +** preexisting [virtual table] for the module. | |
5167 | +** | |
5168 | +** ^The module name is registered on the [database connection] specified | |
5169 | +** by the first parameter. ^The name of the module is given by the | |
5170 | +** second parameter. ^The third parameter is a pointer to | |
5171 | +** the implementation of the [virtual table module]. ^The fourth | |
5172 | +** parameter is an arbitrary client data pointer that is passed through | |
5173 | +** into the [xCreate] and [xConnect] methods of the virtual table module | |
5174 | +** when a new virtual table is be being created or reinitialized. | |
5175 | +** | |
5176 | +** ^The sqlite3_create_module_v2() interface has a fifth parameter which | |
5177 | +** is a pointer to a destructor for the pClientData. ^SQLite will | |
5178 | +** invoke the destructor function (if it is not NULL) when SQLite | |
5179 | +** no longer needs the pClientData pointer. ^The destructor will also | |
5180 | +** be invoked if the call to sqlite3_create_module_v2() fails. | |
5181 | +** ^The sqlite3_create_module() | |
5182 | +** interface is equivalent to sqlite3_create_module_v2() with a NULL | |
5183 | +** destructor. | |
5184 | +*/ | |
5185 | +SQLITE_API int sqlite3_create_module( | |
5186 | + sqlite3 *db, /* SQLite connection to register module with */ | |
5187 | + const char *zName, /* Name of the module */ | |
5188 | + const sqlite3_module *p, /* Methods for the module */ | |
5189 | + void *pClientData /* Client data for xCreate/xConnect */ | |
5190 | +); | |
5191 | +SQLITE_API int sqlite3_create_module_v2( | |
5192 | + sqlite3 *db, /* SQLite connection to register module with */ | |
5193 | + const char *zName, /* Name of the module */ | |
5194 | + const sqlite3_module *p, /* Methods for the module */ | |
5195 | + void *pClientData, /* Client data for xCreate/xConnect */ | |
5196 | + void(*xDestroy)(void*) /* Module destructor function */ | |
5197 | +); | |
5198 | + | |
5199 | +/* | |
5200 | +** CAPI3REF: Virtual Table Instance Object | |
5201 | +** KEYWORDS: sqlite3_vtab | |
5202 | +** | |
5203 | +** Every [virtual table module] implementation uses a subclass | |
5204 | +** of this object to describe a particular instance | |
5205 | +** of the [virtual table]. Each subclass will | |
5206 | +** be tailored to the specific needs of the module implementation. | |
5207 | +** The purpose of this superclass is to define certain fields that are | |
5208 | +** common to all module implementations. | |
5209 | +** | |
5210 | +** ^Virtual tables methods can set an error message by assigning a | |
5211 | +** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should | |
5212 | +** take care that any prior string is freed by a call to [sqlite3_free()] | |
5213 | +** prior to assigning a new string to zErrMsg. ^After the error message | |
5214 | +** is delivered up to the client application, the string will be automatically | |
5215 | +** freed by sqlite3_free() and the zErrMsg field will be zeroed. | |
5216 | +*/ | |
5217 | +struct sqlite3_vtab { | |
5218 | + const sqlite3_module *pModule; /* The module for this virtual table */ | |
5219 | + int nRef; /* NO LONGER USED */ | |
5220 | + char *zErrMsg; /* Error message from sqlite3_mprintf() */ | |
5221 | + /* Virtual table implementations will typically add additional fields */ | |
5222 | +}; | |
5223 | + | |
5224 | +/* | |
5225 | +** CAPI3REF: Virtual Table Cursor Object | |
5226 | +** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} | |
5227 | +** | |
5228 | +** Every [virtual table module] implementation uses a subclass of the | |
5229 | +** following structure to describe cursors that point into the | |
5230 | +** [virtual table] and are used | |
5231 | +** to loop through the virtual table. Cursors are created using the | |
5232 | +** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed | |
5233 | +** by the [sqlite3_module.xClose | xClose] method. Cursors are used | |
5234 | +** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods | |
5235 | +** of the module. Each module implementation will define | |
5236 | +** the content of a cursor structure to suit its own needs. | |
5237 | +** | |
5238 | +** This superclass exists in order to define fields of the cursor that | |
5239 | +** are common to all implementations. | |
5240 | +*/ | |
5241 | +struct sqlite3_vtab_cursor { | |
5242 | + sqlite3_vtab *pVtab; /* Virtual table of this cursor */ | |
5243 | + /* Virtual table implementations will typically add additional fields */ | |
5244 | +}; | |
5245 | + | |
5246 | +/* | |
5247 | +** CAPI3REF: Declare The Schema Of A Virtual Table | |
5248 | +** | |
5249 | +** ^The [xCreate] and [xConnect] methods of a | |
5250 | +** [virtual table module] call this interface | |
5251 | +** to declare the format (the names and datatypes of the columns) of | |
5252 | +** the virtual tables they implement. | |
5253 | +*/ | |
5254 | +SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL); | |
5255 | + | |
5256 | +/* | |
5257 | +** CAPI3REF: Overload A Function For A Virtual Table | |
5258 | +** | |
5259 | +** ^(Virtual tables can provide alternative implementations of functions | |
5260 | +** using the [xFindFunction] method of the [virtual table module]. | |
5261 | +** But global versions of those functions | |
5262 | +** must exist in order to be overloaded.)^ | |
5263 | +** | |
5264 | +** ^(This API makes sure a global version of a function with a particular | |
5265 | +** name and number of parameters exists. If no such function exists | |
5266 | +** before this API is called, a new function is created.)^ ^The implementation | |
5267 | +** of the new function always causes an exception to be thrown. So | |
5268 | +** the new function is not good for anything by itself. Its only | |
5269 | +** purpose is to be a placeholder function that can be overloaded | |
5270 | +** by a [virtual table]. | |
5271 | +*/ | |
5272 | +SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); | |
5273 | + | |
5274 | +/* | |
5275 | +** The interface to the virtual-table mechanism defined above (back up | |
5276 | +** to a comment remarkably similar to this one) is currently considered | |
5277 | +** to be experimental. The interface might change in incompatible ways. | |
5278 | +** If this is a problem for you, do not use the interface at this time. | |
5279 | +** | |
5280 | +** When the virtual-table mechanism stabilizes, we will declare the | |
5281 | +** interface fixed, support it indefinitely, and remove this comment. | |
5282 | +*/ | |
5283 | + | |
5284 | +/* | |
5285 | +** CAPI3REF: A Handle To An Open BLOB | |
5286 | +** KEYWORDS: {BLOB handle} {BLOB handles} | |
5287 | +** | |
5288 | +** An instance of this object represents an open BLOB on which | |
5289 | +** [sqlite3_blob_open | incremental BLOB I/O] can be performed. | |
5290 | +** ^Objects of this type are created by [sqlite3_blob_open()] | |
5291 | +** and destroyed by [sqlite3_blob_close()]. | |
5292 | +** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces | |
5293 | +** can be used to read or write small subsections of the BLOB. | |
5294 | +** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. | |
5295 | +*/ | |
5296 | +typedef struct sqlite3_blob sqlite3_blob; | |
5297 | + | |
5298 | +/* | |
5299 | +** CAPI3REF: Open A BLOB For Incremental I/O | |
5300 | +** | |
5301 | +** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located | |
5302 | +** in row iRow, column zColumn, table zTable in database zDb; | |
5303 | +** in other words, the same BLOB that would be selected by: | |
5304 | +** | |
5305 | +** <pre> | |
5306 | +** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; | |
5307 | +** </pre>)^ | |
5308 | +** | |
5309 | +** ^If the flags parameter is non-zero, then the BLOB is opened for read | |
5310 | +** and write access. ^If it is zero, the BLOB is opened for read access. | |
5311 | +** ^It is not possible to open a column that is part of an index or primary | |
5312 | +** key for writing. ^If [foreign key constraints] are enabled, it is | |
5313 | +** not possible to open a column that is part of a [child key] for writing. | |
5314 | +** | |
5315 | +** ^Note that the database name is not the filename that contains | |
5316 | +** the database but rather the symbolic name of the database that | |
5317 | +** appears after the AS keyword when the database is connected using [ATTACH]. | |
5318 | +** ^For the main database file, the database name is "main". | |
5319 | +** ^For TEMP tables, the database name is "temp". | |
5320 | +** | |
5321 | +** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written | |
5322 | +** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set | |
5323 | +** to be a null pointer.)^ | |
5324 | +** ^This function sets the [database connection] error code and message | |
5325 | +** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related | |
5326 | +** functions. ^Note that the *ppBlob variable is always initialized in a | |
5327 | +** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob | |
5328 | +** regardless of the success or failure of this routine. | |
5329 | +** | |
5330 | +** ^(If the row that a BLOB handle points to is modified by an | |
5331 | +** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects | |
5332 | +** then the BLOB handle is marked as "expired". | |
5333 | +** This is true if any column of the row is changed, even a column | |
5334 | +** other than the one the BLOB handle is open on.)^ | |
5335 | +** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for | |
5336 | +** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. | |
5337 | +** ^(Changes written into a BLOB prior to the BLOB expiring are not | |
5338 | +** rolled back by the expiration of the BLOB. Such changes will eventually | |
5339 | +** commit if the transaction continues to completion.)^ | |
5340 | +** | |
5341 | +** ^Use the [sqlite3_blob_bytes()] interface to determine the size of | |
5342 | +** the opened blob. ^The size of a blob may not be changed by this | |
5343 | +** interface. Use the [UPDATE] SQL command to change the size of a | |
5344 | +** blob. | |
5345 | +** | |
5346 | +** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces | |
5347 | +** and the built-in [zeroblob] SQL function can be used, if desired, | |
5348 | +** to create an empty, zero-filled blob in which to read or write using | |
5349 | +** this interface. | |
5350 | +** | |
5351 | +** To avoid a resource leak, every open [BLOB handle] should eventually | |
5352 | +** be released by a call to [sqlite3_blob_close()]. | |
5353 | +*/ | |
5354 | +SQLITE_API int sqlite3_blob_open( | |
5355 | + sqlite3*, | |
5356 | + const char *zDb, | |
5357 | + const char *zTable, | |
5358 | + const char *zColumn, | |
5359 | + sqlite3_int64 iRow, | |
5360 | + int flags, | |
5361 | + sqlite3_blob **ppBlob | |
5362 | +); | |
5363 | + | |
5364 | +/* | |
5365 | +** CAPI3REF: Move a BLOB Handle to a New Row | |
5366 | +** | |
5367 | +** ^This function is used to move an existing blob handle so that it points | |
5368 | +** to a different row of the same database table. ^The new row is identified | |
5369 | +** by the rowid value passed as the second argument. Only the row can be | |
5370 | +** changed. ^The database, table and column on which the blob handle is open | |
5371 | +** remain the same. Moving an existing blob handle to a new row can be | |
5372 | +** faster than closing the existing handle and opening a new one. | |
5373 | +** | |
5374 | +** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - | |
5375 | +** it must exist and there must be either a blob or text value stored in | |
5376 | +** the nominated column.)^ ^If the new row is not present in the table, or if | |
5377 | +** it does not contain a blob or text value, or if another error occurs, an | |
5378 | +** SQLite error code is returned and the blob handle is considered aborted. | |
5379 | +** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or | |
5380 | +** [sqlite3_blob_reopen()] on an aborted blob handle immediately return | |
5381 | +** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle | |
5382 | +** always returns zero. | |
5383 | +** | |
5384 | +** ^This function sets the database handle error code and message. | |
5385 | +*/ | |
5386 | +SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); | |
5387 | + | |
5388 | +/* | |
5389 | +** CAPI3REF: Close A BLOB Handle | |
5390 | +** | |
5391 | +** ^Closes an open [BLOB handle]. | |
5392 | +** | |
5393 | +** ^Closing a BLOB shall cause the current transaction to commit | |
5394 | +** if there are no other BLOBs, no pending prepared statements, and the | |
5395 | +** database connection is in [autocommit mode]. | |
5396 | +** ^If any writes were made to the BLOB, they might be held in cache | |
5397 | +** until the close operation if they will fit. | |
5398 | +** | |
5399 | +** ^(Closing the BLOB often forces the changes | |
5400 | +** out to disk and so if any I/O errors occur, they will likely occur | |
5401 | +** at the time when the BLOB is closed. Any errors that occur during | |
5402 | +** closing are reported as a non-zero return value.)^ | |
5403 | +** | |
5404 | +** ^(The BLOB is closed unconditionally. Even if this routine returns | |
5405 | +** an error code, the BLOB is still closed.)^ | |
5406 | +** | |
5407 | +** ^Calling this routine with a null pointer (such as would be returned | |
5408 | +** by a failed call to [sqlite3_blob_open()]) is a harmless no-op. | |
5409 | +*/ | |
5410 | +SQLITE_API int sqlite3_blob_close(sqlite3_blob *); | |
5411 | + | |
5412 | +/* | |
5413 | +** CAPI3REF: Return The Size Of An Open BLOB | |
5414 | +** | |
5415 | +** ^Returns the size in bytes of the BLOB accessible via the | |
5416 | +** successfully opened [BLOB handle] in its only argument. ^The | |
5417 | +** incremental blob I/O routines can only read or overwriting existing | |
5418 | +** blob content; they cannot change the size of a blob. | |
5419 | +** | |
5420 | +** This routine only works on a [BLOB handle] which has been created | |
5421 | +** by a prior successful call to [sqlite3_blob_open()] and which has not | |
5422 | +** been closed by [sqlite3_blob_close()]. Passing any other pointer in | |
5423 | +** to this routine results in undefined and probably undesirable behavior. | |
5424 | +*/ | |
5425 | +SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *); | |
5426 | + | |
5427 | +/* | |
5428 | +** CAPI3REF: Read Data From A BLOB Incrementally | |
5429 | +** | |
5430 | +** ^(This function is used to read data from an open [BLOB handle] into a | |
5431 | +** caller-supplied buffer. N bytes of data are copied into buffer Z | |
5432 | +** from the open BLOB, starting at offset iOffset.)^ | |
5433 | +** | |
5434 | +** ^If offset iOffset is less than N bytes from the end of the BLOB, | |
5435 | +** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is | |
5436 | +** less than zero, [SQLITE_ERROR] is returned and no data is read. | |
5437 | +** ^The size of the blob (and hence the maximum value of N+iOffset) | |
5438 | +** can be determined using the [sqlite3_blob_bytes()] interface. | |
5439 | +** | |
5440 | +** ^An attempt to read from an expired [BLOB handle] fails with an | |
5441 | +** error code of [SQLITE_ABORT]. | |
5442 | +** | |
5443 | +** ^(On success, sqlite3_blob_read() returns SQLITE_OK. | |
5444 | +** Otherwise, an [error code] or an [extended error code] is returned.)^ | |
5445 | +** | |
5446 | +** This routine only works on a [BLOB handle] which has been created | |
5447 | +** by a prior successful call to [sqlite3_blob_open()] and which has not | |
5448 | +** been closed by [sqlite3_blob_close()]. Passing any other pointer in | |
5449 | +** to this routine results in undefined and probably undesirable behavior. | |
5450 | +** | |
5451 | +** See also: [sqlite3_blob_write()]. | |
5452 | +*/ | |
5453 | +SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); | |
5454 | + | |
5455 | +/* | |
5456 | +** CAPI3REF: Write Data Into A BLOB Incrementally | |
5457 | +** | |
5458 | +** ^This function is used to write data into an open [BLOB handle] from a | |
5459 | +** caller-supplied buffer. ^N bytes of data are copied from the buffer Z | |
5460 | +** into the open BLOB, starting at offset iOffset. | |
5461 | +** | |
5462 | +** ^If the [BLOB handle] passed as the first argument was not opened for | |
5463 | +** writing (the flags parameter to [sqlite3_blob_open()] was zero), | |
5464 | +** this function returns [SQLITE_READONLY]. | |
5465 | +** | |
5466 | +** ^This function may only modify the contents of the BLOB; it is | |
5467 | +** not possible to increase the size of a BLOB using this API. | |
5468 | +** ^If offset iOffset is less than N bytes from the end of the BLOB, | |
5469 | +** [SQLITE_ERROR] is returned and no data is written. ^If N is | |
5470 | +** less than zero [SQLITE_ERROR] is returned and no data is written. | |
5471 | +** The size of the BLOB (and hence the maximum value of N+iOffset) | |
5472 | +** can be determined using the [sqlite3_blob_bytes()] interface. | |
5473 | +** | |
5474 | +** ^An attempt to write to an expired [BLOB handle] fails with an | |
5475 | +** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred | |
5476 | +** before the [BLOB handle] expired are not rolled back by the | |
5477 | +** expiration of the handle, though of course those changes might | |
5478 | +** have been overwritten by the statement that expired the BLOB handle | |
5479 | +** or by other independent statements. | |
5480 | +** | |
5481 | +** ^(On success, sqlite3_blob_write() returns SQLITE_OK. | |
5482 | +** Otherwise, an [error code] or an [extended error code] is returned.)^ | |
5483 | +** | |
5484 | +** This routine only works on a [BLOB handle] which has been created | |
5485 | +** by a prior successful call to [sqlite3_blob_open()] and which has not | |
5486 | +** been closed by [sqlite3_blob_close()]. Passing any other pointer in | |
5487 | +** to this routine results in undefined and probably undesirable behavior. | |
5488 | +** | |
5489 | +** See also: [sqlite3_blob_read()]. | |
5490 | +*/ | |
5491 | +SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); | |
5492 | + | |
5493 | +/* | |
5494 | +** CAPI3REF: Virtual File System Objects | |
5495 | +** | |
5496 | +** A virtual filesystem (VFS) is an [sqlite3_vfs] object | |
5497 | +** that SQLite uses to interact | |
5498 | +** with the underlying operating system. Most SQLite builds come with a | |
5499 | +** single default VFS that is appropriate for the host computer. | |
5500 | +** New VFSes can be registered and existing VFSes can be unregistered. | |
5501 | +** The following interfaces are provided. | |
5502 | +** | |
5503 | +** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. | |
5504 | +** ^Names are case sensitive. | |
5505 | +** ^Names are zero-terminated UTF-8 strings. | |
5506 | +** ^If there is no match, a NULL pointer is returned. | |
5507 | +** ^If zVfsName is NULL then the default VFS is returned. | |
5508 | +** | |
5509 | +** ^New VFSes are registered with sqlite3_vfs_register(). | |
5510 | +** ^Each new VFS becomes the default VFS if the makeDflt flag is set. | |
5511 | +** ^The same VFS can be registered multiple times without injury. | |
5512 | +** ^To make an existing VFS into the default VFS, register it again | |
5513 | +** with the makeDflt flag set. If two different VFSes with the | |
5514 | +** same name are registered, the behavior is undefined. If a | |
5515 | +** VFS is registered with a name that is NULL or an empty string, | |
5516 | +** then the behavior is undefined. | |
5517 | +** | |
5518 | +** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. | |
5519 | +** ^(If the default VFS is unregistered, another VFS is chosen as | |
5520 | +** the default. The choice for the new VFS is arbitrary.)^ | |
5521 | +*/ | |
5522 | +SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); | |
5523 | +SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); | |
5524 | +SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); | |
5525 | + | |
5526 | +/* | |
5527 | +** CAPI3REF: Mutexes | |
5528 | +** | |
5529 | +** The SQLite core uses these routines for thread | |
5530 | +** synchronization. Though they are intended for internal | |
5531 | +** use by SQLite, code that links against SQLite is | |
5532 | +** permitted to use any of these routines. | |
5533 | +** | |
5534 | +** The SQLite source code contains multiple implementations | |
5535 | +** of these mutex routines. An appropriate implementation | |
5536 | +** is selected automatically at compile-time. ^(The following | |
5537 | +** implementations are available in the SQLite core: | |
5538 | +** | |
5539 | +** <ul> | |
5540 | +** <li> SQLITE_MUTEX_PTHREADS | |
5541 | +** <li> SQLITE_MUTEX_W32 | |
5542 | +** <li> SQLITE_MUTEX_NOOP | |
5543 | +** </ul>)^ | |
5544 | +** | |
5545 | +** ^The SQLITE_MUTEX_NOOP implementation is a set of routines | |
5546 | +** that does no real locking and is appropriate for use in | |
5547 | +** a single-threaded application. ^The SQLITE_MUTEX_PTHREADS and | |
5548 | +** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix | |
5549 | +** and Windows. | |
5550 | +** | |
5551 | +** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor | |
5552 | +** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex | |
5553 | +** implementation is included with the library. In this case the | |
5554 | +** application must supply a custom mutex implementation using the | |
5555 | +** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function | |
5556 | +** before calling sqlite3_initialize() or any other public sqlite3_ | |
5557 | +** function that calls sqlite3_initialize().)^ | |
5558 | +** | |
5559 | +** ^The sqlite3_mutex_alloc() routine allocates a new | |
5560 | +** mutex and returns a pointer to it. ^If it returns NULL | |
5561 | +** that means that a mutex could not be allocated. ^SQLite | |
5562 | +** will unwind its stack and return an error. ^(The argument | |
5563 | +** to sqlite3_mutex_alloc() is one of these integer constants: | |
5564 | +** | |
5565 | +** <ul> | |
5566 | +** <li> SQLITE_MUTEX_FAST | |
5567 | +** <li> SQLITE_MUTEX_RECURSIVE | |
5568 | +** <li> SQLITE_MUTEX_STATIC_MASTER | |
5569 | +** <li> SQLITE_MUTEX_STATIC_MEM | |
5570 | +** <li> SQLITE_MUTEX_STATIC_MEM2 | |
5571 | +** <li> SQLITE_MUTEX_STATIC_PRNG | |
5572 | +** <li> SQLITE_MUTEX_STATIC_LRU | |
5573 | +** <li> SQLITE_MUTEX_STATIC_LRU2 | |
5574 | +** </ul>)^ | |
5575 | +** | |
5576 | +** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) | |
5577 | +** cause sqlite3_mutex_alloc() to create | |
5578 | +** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE | |
5579 | +** is used but not necessarily so when SQLITE_MUTEX_FAST is used. | |
5580 | +** The mutex implementation does not need to make a distinction | |
5581 | +** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does | |
5582 | +** not want to. ^SQLite will only request a recursive mutex in | |
5583 | +** cases where it really needs one. ^If a faster non-recursive mutex | |
5584 | +** implementation is available on the host platform, the mutex subsystem | |
5585 | +** might return such a mutex in response to SQLITE_MUTEX_FAST. | |
5586 | +** | |
5587 | +** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other | |
5588 | +** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return | |
5589 | +** a pointer to a static preexisting mutex. ^Six static mutexes are | |
5590 | +** used by the current version of SQLite. Future versions of SQLite | |
5591 | +** may add additional static mutexes. Static mutexes are for internal | |
5592 | +** use by SQLite only. Applications that use SQLite mutexes should | |
5593 | +** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or | |
5594 | +** SQLITE_MUTEX_RECURSIVE. | |
5595 | +** | |
5596 | +** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST | |
5597 | +** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() | |
5598 | +** returns a different mutex on every call. ^But for the static | |
5599 | +** mutex types, the same mutex is returned on every call that has | |
5600 | +** the same type number. | |
5601 | +** | |
5602 | +** ^The sqlite3_mutex_free() routine deallocates a previously | |
5603 | +** allocated dynamic mutex. ^SQLite is careful to deallocate every | |
5604 | +** dynamic mutex that it allocates. The dynamic mutexes must not be in | |
5605 | +** use when they are deallocated. Attempting to deallocate a static | |
5606 | +** mutex results in undefined behavior. ^SQLite never deallocates | |
5607 | +** a static mutex. | |
5608 | +** | |
5609 | +** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt | |
5610 | +** to enter a mutex. ^If another thread is already within the mutex, | |
5611 | +** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return | |
5612 | +** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] | |
5613 | +** upon successful entry. ^(Mutexes created using | |
5614 | +** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. | |
5615 | +** In such cases the, | |
5616 | +** mutex must be exited an equal number of times before another thread | |
5617 | +** can enter.)^ ^(If the same thread tries to enter any other | |
5618 | +** kind of mutex more than once, the behavior is undefined. | |
5619 | +** SQLite will never exhibit | |
5620 | +** such behavior in its own use of mutexes.)^ | |
5621 | +** | |
5622 | +** ^(Some systems (for example, Windows 95) do not support the operation | |
5623 | +** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() | |
5624 | +** will always return SQLITE_BUSY. The SQLite core only ever uses | |
5625 | +** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^ | |
5626 | +** | |
5627 | +** ^The sqlite3_mutex_leave() routine exits a mutex that was | |
5628 | +** previously entered by the same thread. ^(The behavior | |
5629 | +** is undefined if the mutex is not currently entered by the | |
5630 | +** calling thread or is not currently allocated. SQLite will | |
5631 | +** never do either.)^ | |
5632 | +** | |
5633 | +** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or | |
5634 | +** sqlite3_mutex_leave() is a NULL pointer, then all three routines | |
5635 | +** behave as no-ops. | |
5636 | +** | |
5637 | +** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. | |
5638 | +*/ | |
5639 | +SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int); | |
5640 | +SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*); | |
5641 | +SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*); | |
5642 | +SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*); | |
5643 | +SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*); | |
5644 | + | |
5645 | +/* | |
5646 | +** CAPI3REF: Mutex Methods Object | |
5647 | +** | |
5648 | +** An instance of this structure defines the low-level routines | |
5649 | +** used to allocate and use mutexes. | |
5650 | +** | |
5651 | +** Usually, the default mutex implementations provided by SQLite are | |
5652 | +** sufficient, however the user has the option of substituting a custom | |
5653 | +** implementation for specialized deployments or systems for which SQLite | |
5654 | +** does not provide a suitable implementation. In this case, the user | |
5655 | +** creates and populates an instance of this structure to pass | |
5656 | +** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. | |
5657 | +** Additionally, an instance of this structure can be used as an | |
5658 | +** output variable when querying the system for the current mutex | |
5659 | +** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. | |
5660 | +** | |
5661 | +** ^The xMutexInit method defined by this structure is invoked as | |
5662 | +** part of system initialization by the sqlite3_initialize() function. | |
5663 | +** ^The xMutexInit routine is called by SQLite exactly once for each | |
5664 | +** effective call to [sqlite3_initialize()]. | |
5665 | +** | |
5666 | +** ^The xMutexEnd method defined by this structure is invoked as | |
5667 | +** part of system shutdown by the sqlite3_shutdown() function. The | |
5668 | +** implementation of this method is expected to release all outstanding | |
5669 | +** resources obtained by the mutex methods implementation, especially | |
5670 | +** those obtained by the xMutexInit method. ^The xMutexEnd() | |
5671 | +** interface is invoked exactly once for each call to [sqlite3_shutdown()]. | |
5672 | +** | |
5673 | +** ^(The remaining seven methods defined by this structure (xMutexAlloc, | |
5674 | +** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and | |
5675 | +** xMutexNotheld) implement the following interfaces (respectively): | |
5676 | +** | |
5677 | +** <ul> | |
5678 | +** <li> [sqlite3_mutex_alloc()] </li> | |
5679 | +** <li> [sqlite3_mutex_free()] </li> | |
5680 | +** <li> [sqlite3_mutex_enter()] </li> | |
5681 | +** <li> [sqlite3_mutex_try()] </li> | |
5682 | +** <li> [sqlite3_mutex_leave()] </li> | |
5683 | +** <li> [sqlite3_mutex_held()] </li> | |
5684 | +** <li> [sqlite3_mutex_notheld()] </li> | |
5685 | +** </ul>)^ | |
5686 | +** | |
5687 | +** The only difference is that the public sqlite3_XXX functions enumerated | |
5688 | +** above silently ignore any invocations that pass a NULL pointer instead | |
5689 | +** of a valid mutex handle. The implementations of the methods defined | |
5690 | +** by this structure are not required to handle this case, the results | |
5691 | +** of passing a NULL pointer instead of a valid mutex handle are undefined | |
5692 | +** (i.e. it is acceptable to provide an implementation that segfaults if | |
5693 | +** it is passed a NULL pointer). | |
5694 | +** | |
5695 | +** The xMutexInit() method must be threadsafe. ^It must be harmless to | |
5696 | +** invoke xMutexInit() multiple times within the same process and without | |
5697 | +** intervening calls to xMutexEnd(). Second and subsequent calls to | |
5698 | +** xMutexInit() must be no-ops. | |
5699 | +** | |
5700 | +** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] | |
5701 | +** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory | |
5702 | +** allocation for a static mutex. ^However xMutexAlloc() may use SQLite | |
5703 | +** memory allocation for a fast or recursive mutex. | |
5704 | +** | |
5705 | +** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is | |
5706 | +** called, but only if the prior call to xMutexInit returned SQLITE_OK. | |
5707 | +** If xMutexInit fails in any way, it is expected to clean up after itself | |
5708 | +** prior to returning. | |
5709 | +*/ | |
5710 | +typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; | |
5711 | +struct sqlite3_mutex_methods { | |
5712 | + int (*xMutexInit)(void); | |
5713 | + int (*xMutexEnd)(void); | |
5714 | + sqlite3_mutex *(*xMutexAlloc)(int); | |
5715 | + void (*xMutexFree)(sqlite3_mutex *); | |
5716 | + void (*xMutexEnter)(sqlite3_mutex *); | |
5717 | + int (*xMutexTry)(sqlite3_mutex *); | |
5718 | + void (*xMutexLeave)(sqlite3_mutex *); | |
5719 | + int (*xMutexHeld)(sqlite3_mutex *); | |
5720 | + int (*xMutexNotheld)(sqlite3_mutex *); | |
5721 | +}; | |
5722 | + | |
5723 | +/* | |
5724 | +** CAPI3REF: Mutex Verification Routines | |
5725 | +** | |
5726 | +** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines | |
5727 | +** are intended for use inside assert() statements. ^The SQLite core | |
5728 | +** never uses these routines except inside an assert() and applications | |
5729 | +** are advised to follow the lead of the core. ^The SQLite core only | |
5730 | +** provides implementations for these routines when it is compiled | |
5731 | +** with the SQLITE_DEBUG flag. ^External mutex implementations | |
5732 | +** are only required to provide these routines if SQLITE_DEBUG is | |
5733 | +** defined and if NDEBUG is not defined. | |
5734 | +** | |
5735 | +** ^These routines should return true if the mutex in their argument | |
5736 | +** is held or not held, respectively, by the calling thread. | |
5737 | +** | |
5738 | +** ^The implementation is not required to provide versions of these | |
5739 | +** routines that actually work. If the implementation does not provide working | |
5740 | +** versions of these routines, it should at least provide stubs that always | |
5741 | +** return true so that one does not get spurious assertion failures. | |
5742 | +** | |
5743 | +** ^If the argument to sqlite3_mutex_held() is a NULL pointer then | |
5744 | +** the routine should return 1. This seems counter-intuitive since | |
5745 | +** clearly the mutex cannot be held if it does not exist. But | |
5746 | +** the reason the mutex does not exist is because the build is not | |
5747 | +** using mutexes. And we do not want the assert() containing the | |
5748 | +** call to sqlite3_mutex_held() to fail, so a non-zero return is | |
5749 | +** the appropriate thing to do. ^The sqlite3_mutex_notheld() | |
5750 | +** interface should also return 1 when given a NULL pointer. | |
5751 | +*/ | |
5752 | +#ifndef NDEBUG | |
5753 | +SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*); | |
5754 | +SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*); | |
5755 | +#endif | |
5756 | + | |
5757 | +/* | |
5758 | +** CAPI3REF: Mutex Types | |
5759 | +** | |
5760 | +** The [sqlite3_mutex_alloc()] interface takes a single argument | |
5761 | +** which is one of these integer constants. | |
5762 | +** | |
5763 | +** The set of static mutexes may change from one SQLite release to the | |
5764 | +** next. Applications that override the built-in mutex logic must be | |
5765 | +** prepared to accommodate additional static mutexes. | |
5766 | +*/ | |
5767 | +#define SQLITE_MUTEX_FAST 0 | |
5768 | +#define SQLITE_MUTEX_RECURSIVE 1 | |
5769 | +#define SQLITE_MUTEX_STATIC_MASTER 2 | |
5770 | +#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ | |
5771 | +#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ | |
5772 | +#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ | |
5773 | +#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ | |
5774 | +#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ | |
5775 | +#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ | |
5776 | +#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ | |
5777 | + | |
5778 | +/* | |
5779 | +** CAPI3REF: Retrieve the mutex for a database connection | |
5780 | +** | |
5781 | +** ^This interface returns a pointer the [sqlite3_mutex] object that | |
5782 | +** serializes access to the [database connection] given in the argument | |
5783 | +** when the [threading mode] is Serialized. | |
5784 | +** ^If the [threading mode] is Single-thread or Multi-thread then this | |
5785 | +** routine returns a NULL pointer. | |
5786 | +*/ | |
5787 | +SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*); | |
5788 | + | |
5789 | +/* | |
5790 | +** CAPI3REF: Low-Level Control Of Database Files | |
5791 | +** | |
5792 | +** ^The [sqlite3_file_control()] interface makes a direct call to the | |
5793 | +** xFileControl method for the [sqlite3_io_methods] object associated | |
5794 | +** with a particular database identified by the second argument. ^The | |
5795 | +** name of the database is "main" for the main database or "temp" for the | |
5796 | +** TEMP database, or the name that appears after the AS keyword for | |
5797 | +** databases that are added using the [ATTACH] SQL command. | |
5798 | +** ^A NULL pointer can be used in place of "main" to refer to the | |
5799 | +** main database file. | |
5800 | +** ^The third and fourth parameters to this routine | |
5801 | +** are passed directly through to the second and third parameters of | |
5802 | +** the xFileControl method. ^The return value of the xFileControl | |
5803 | +** method becomes the return value of this routine. | |
5804 | +** | |
5805 | +** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes | |
5806 | +** a pointer to the underlying [sqlite3_file] object to be written into | |
5807 | +** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER | |
5808 | +** case is a short-circuit path which does not actually invoke the | |
5809 | +** underlying sqlite3_io_methods.xFileControl method. | |
5810 | +** | |
5811 | +** ^If the second parameter (zDbName) does not match the name of any | |
5812 | +** open database file, then SQLITE_ERROR is returned. ^This error | |
5813 | +** code is not remembered and will not be recalled by [sqlite3_errcode()] | |
5814 | +** or [sqlite3_errmsg()]. The underlying xFileControl method might | |
5815 | +** also return SQLITE_ERROR. There is no way to distinguish between | |
5816 | +** an incorrect zDbName and an SQLITE_ERROR return from the underlying | |
5817 | +** xFileControl method. | |
5818 | +** | |
5819 | +** See also: [SQLITE_FCNTL_LOCKSTATE] | |
5820 | +*/ | |
5821 | +SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); | |
5822 | + | |
5823 | +/* | |
5824 | +** CAPI3REF: Testing Interface | |
5825 | +** | |
5826 | +** ^The sqlite3_test_control() interface is used to read out internal | |
5827 | +** state of SQLite and to inject faults into SQLite for testing | |
5828 | +** purposes. ^The first parameter is an operation code that determines | |
5829 | +** the number, meaning, and operation of all subsequent parameters. | |
5830 | +** | |
5831 | +** This interface is not for use by applications. It exists solely | |
5832 | +** for verifying the correct operation of the SQLite library. Depending | |
5833 | +** on how the SQLite library is compiled, this interface might not exist. | |
5834 | +** | |
5835 | +** The details of the operation codes, their meanings, the parameters | |
5836 | +** they take, and what they do are all subject to change without notice. | |
5837 | +** Unlike most of the SQLite API, this function is not guaranteed to | |
5838 | +** operate consistently from one release to the next. | |
5839 | +*/ | |
5840 | +SQLITE_API int sqlite3_test_control(int op, ...); | |
5841 | + | |
5842 | +/* | |
5843 | +** CAPI3REF: Testing Interface Operation Codes | |
5844 | +** | |
5845 | +** These constants are the valid operation code parameters used | |
5846 | +** as the first argument to [sqlite3_test_control()]. | |
5847 | +** | |
5848 | +** These parameters and their meanings are subject to change | |
5849 | +** without notice. These values are for testing purposes only. | |
5850 | +** Applications should not use any of these parameters or the | |
5851 | +** [sqlite3_test_control()] interface. | |
5852 | +*/ | |
5853 | +#define SQLITE_TESTCTRL_FIRST 5 | |
5854 | +#define SQLITE_TESTCTRL_PRNG_SAVE 5 | |
5855 | +#define SQLITE_TESTCTRL_PRNG_RESTORE 6 | |
5856 | +#define SQLITE_TESTCTRL_PRNG_RESET 7 | |
5857 | +#define SQLITE_TESTCTRL_BITVEC_TEST 8 | |
5858 | +#define SQLITE_TESTCTRL_FAULT_INSTALL 9 | |
5859 | +#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 | |
5860 | +#define SQLITE_TESTCTRL_PENDING_BYTE 11 | |
5861 | +#define SQLITE_TESTCTRL_ASSERT 12 | |
5862 | +#define SQLITE_TESTCTRL_ALWAYS 13 | |
5863 | +#define SQLITE_TESTCTRL_RESERVE 14 | |
5864 | +#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 | |
5865 | +#define SQLITE_TESTCTRL_ISKEYWORD 16 | |
5866 | +#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 | |
5867 | +#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 | |
5868 | +#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 | |
5869 | +#define SQLITE_TESTCTRL_LAST 19 | |
5870 | + | |
5871 | +/* | |
5872 | +** CAPI3REF: SQLite Runtime Status | |
5873 | +** | |
5874 | +** ^This interface is used to retrieve runtime status information | |
5875 | +** about the performance of SQLite, and optionally to reset various | |
5876 | +** highwater marks. ^The first argument is an integer code for | |
5877 | +** the specific parameter to measure. ^(Recognized integer codes | |
5878 | +** are of the form [status parameters | SQLITE_STATUS_...].)^ | |
5879 | +** ^The current value of the parameter is returned into *pCurrent. | |
5880 | +** ^The highest recorded value is returned in *pHighwater. ^If the | |
5881 | +** resetFlag is true, then the highest record value is reset after | |
5882 | +** *pHighwater is written. ^(Some parameters do not record the highest | |
5883 | +** value. For those parameters | |
5884 | +** nothing is written into *pHighwater and the resetFlag is ignored.)^ | |
5885 | +** ^(Other parameters record only the highwater mark and not the current | |
5886 | +** value. For these latter parameters nothing is written into *pCurrent.)^ | |
5887 | +** | |
5888 | +** ^The sqlite3_status() routine returns SQLITE_OK on success and a | |
5889 | +** non-zero [error code] on failure. | |
5890 | +** | |
5891 | +** This routine is threadsafe but is not atomic. This routine can be | |
5892 | +** called while other threads are running the same or different SQLite | |
5893 | +** interfaces. However the values returned in *pCurrent and | |
5894 | +** *pHighwater reflect the status of SQLite at different points in time | |
5895 | +** and it is possible that another thread might change the parameter | |
5896 | +** in between the times when *pCurrent and *pHighwater are written. | |
5897 | +** | |
5898 | +** See also: [sqlite3_db_status()] | |
5899 | +*/ | |
5900 | +SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); | |
5901 | + | |
5902 | + | |
5903 | +/* | |
5904 | +** CAPI3REF: Status Parameters | |
5905 | +** KEYWORDS: {status parameters} | |
5906 | +** | |
5907 | +** These integer constants designate various run-time status parameters | |
5908 | +** that can be returned by [sqlite3_status()]. | |
5909 | +** | |
5910 | +** <dl> | |
5911 | +** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> | |
5912 | +** <dd>This parameter is the current amount of memory checked out | |
5913 | +** using [sqlite3_malloc()], either directly or indirectly. The | |
5914 | +** figure includes calls made to [sqlite3_malloc()] by the application | |
5915 | +** and internal memory usage by the SQLite library. Scratch memory | |
5916 | +** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache | |
5917 | +** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in | |
5918 | +** this parameter. The amount returned is the sum of the allocation | |
5919 | +** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ | |
5920 | +** | |
5921 | +** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> | |
5922 | +** <dd>This parameter records the largest memory allocation request | |
5923 | +** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their | |
5924 | +** internal equivalents). Only the value returned in the | |
5925 | +** *pHighwater parameter to [sqlite3_status()] is of interest. | |
5926 | +** The value written into the *pCurrent parameter is undefined.</dd>)^ | |
5927 | +** | |
5928 | +** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> | |
5929 | +** <dd>This parameter records the number of separate memory allocations | |
5930 | +** currently checked out.</dd>)^ | |
5931 | +** | |
5932 | +** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> | |
5933 | +** <dd>This parameter returns the number of pages used out of the | |
5934 | +** [pagecache memory allocator] that was configured using | |
5935 | +** [SQLITE_CONFIG_PAGECACHE]. The | |
5936 | +** value returned is in pages, not in bytes.</dd>)^ | |
5937 | +** | |
5938 | +** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] | |
5939 | +** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> | |
5940 | +** <dd>This parameter returns the number of bytes of page cache | |
5941 | +** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] | |
5942 | +** buffer and where forced to overflow to [sqlite3_malloc()]. The | |
5943 | +** returned value includes allocations that overflowed because they | |
5944 | +** where too large (they were larger than the "sz" parameter to | |
5945 | +** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because | |
5946 | +** no space was left in the page cache.</dd>)^ | |
5947 | +** | |
5948 | +** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> | |
5949 | +** <dd>This parameter records the largest memory allocation request | |
5950 | +** handed to [pagecache memory allocator]. Only the value returned in the | |
5951 | +** *pHighwater parameter to [sqlite3_status()] is of interest. | |
5952 | +** The value written into the *pCurrent parameter is undefined.</dd>)^ | |
5953 | +** | |
5954 | +** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt> | |
5955 | +** <dd>This parameter returns the number of allocations used out of the | |
5956 | +** [scratch memory allocator] configured using | |
5957 | +** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not | |
5958 | +** in bytes. Since a single thread may only have one scratch allocation | |
5959 | +** outstanding at time, this parameter also reports the number of threads | |
5960 | +** using scratch memory at the same time.</dd>)^ | |
5961 | +** | |
5962 | +** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> | |
5963 | +** <dd>This parameter returns the number of bytes of scratch memory | |
5964 | +** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH] | |
5965 | +** buffer and where forced to overflow to [sqlite3_malloc()]. The values | |
5966 | +** returned include overflows because the requested allocation was too | |
5967 | +** larger (that is, because the requested allocation was larger than the | |
5968 | +** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer | |
5969 | +** slots were available. | |
5970 | +** </dd>)^ | |
5971 | +** | |
5972 | +** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt> | |
5973 | +** <dd>This parameter records the largest memory allocation request | |
5974 | +** handed to [scratch memory allocator]. Only the value returned in the | |
5975 | +** *pHighwater parameter to [sqlite3_status()] is of interest. | |
5976 | +** The value written into the *pCurrent parameter is undefined.</dd>)^ | |
5977 | +** | |
5978 | +** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> | |
5979 | +** <dd>This parameter records the deepest parser stack. It is only | |
5980 | +** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ | |
5981 | +** </dl> | |
5982 | +** | |
5983 | +** New status parameters may be added from time to time. | |
5984 | +*/ | |
5985 | +#define SQLITE_STATUS_MEMORY_USED 0 | |
5986 | +#define SQLITE_STATUS_PAGECACHE_USED 1 | |
5987 | +#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 | |
5988 | +#define SQLITE_STATUS_SCRATCH_USED 3 | |
5989 | +#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 | |
5990 | +#define SQLITE_STATUS_MALLOC_SIZE 5 | |
5991 | +#define SQLITE_STATUS_PARSER_STACK 6 | |
5992 | +#define SQLITE_STATUS_PAGECACHE_SIZE 7 | |
5993 | +#define SQLITE_STATUS_SCRATCH_SIZE 8 | |
5994 | +#define SQLITE_STATUS_MALLOC_COUNT 9 | |
5995 | + | |
5996 | +/* | |
5997 | +** CAPI3REF: Database Connection Status | |
5998 | +** | |
5999 | +** ^This interface is used to retrieve runtime status information | |
6000 | +** about a single [database connection]. ^The first argument is the | |
6001 | +** database connection object to be interrogated. ^The second argument | |
6002 | +** is an integer constant, taken from the set of | |
6003 | +** [SQLITE_DBSTATUS options], that | |
6004 | +** determines the parameter to interrogate. The set of | |
6005 | +** [SQLITE_DBSTATUS options] is likely | |
6006 | +** to grow in future releases of SQLite. | |
6007 | +** | |
6008 | +** ^The current value of the requested parameter is written into *pCur | |
6009 | +** and the highest instantaneous value is written into *pHiwtr. ^If | |
6010 | +** the resetFlg is true, then the highest instantaneous value is | |
6011 | +** reset back down to the current value. | |
6012 | +** | |
6013 | +** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a | |
6014 | +** non-zero [error code] on failure. | |
6015 | +** | |
6016 | +** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. | |
6017 | +*/ | |
6018 | +SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); | |
6019 | + | |
6020 | +/* | |
6021 | +** CAPI3REF: Status Parameters for database connections | |
6022 | +** KEYWORDS: {SQLITE_DBSTATUS options} | |
6023 | +** | |
6024 | +** These constants are the available integer "verbs" that can be passed as | |
6025 | +** the second argument to the [sqlite3_db_status()] interface. | |
6026 | +** | |
6027 | +** New verbs may be added in future releases of SQLite. Existing verbs | |
6028 | +** might be discontinued. Applications should check the return code from | |
6029 | +** [sqlite3_db_status()] to make sure that the call worked. | |
6030 | +** The [sqlite3_db_status()] interface will return a non-zero error code | |
6031 | +** if a discontinued or unsupported verb is invoked. | |
6032 | +** | |
6033 | +** <dl> | |
6034 | +** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> | |
6035 | +** <dd>This parameter returns the number of lookaside memory slots currently | |
6036 | +** checked out.</dd>)^ | |
6037 | +** | |
6038 | +** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> | |
6039 | +** <dd>This parameter returns the number malloc attempts that were | |
6040 | +** satisfied using lookaside memory. Only the high-water value is meaningful; | |
6041 | +** the current value is always zero.)^ | |
6042 | +** | |
6043 | +** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]] | |
6044 | +** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt> | |
6045 | +** <dd>This parameter returns the number malloc attempts that might have | |
6046 | +** been satisfied using lookaside memory but failed due to the amount of | |
6047 | +** memory requested being larger than the lookaside slot size. | |
6048 | +** Only the high-water value is meaningful; | |
6049 | +** the current value is always zero.)^ | |
6050 | +** | |
6051 | +** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]] | |
6052 | +** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt> | |
6053 | +** <dd>This parameter returns the number malloc attempts that might have | |
6054 | +** been satisfied using lookaside memory but failed due to all lookaside | |
6055 | +** memory already being in use. | |
6056 | +** Only the high-water value is meaningful; | |
6057 | +** the current value is always zero.)^ | |
6058 | +** | |
6059 | +** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> | |
6060 | +** <dd>This parameter returns the approximate number of of bytes of heap | |
6061 | +** memory used by all pager caches associated with the database connection.)^ | |
6062 | +** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. | |
6063 | +** | |
6064 | +** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> | |
6065 | +** <dd>This parameter returns the approximate number of of bytes of heap | |
6066 | +** memory used to store the schema for all databases associated | |
6067 | +** with the connection - main, temp, and any [ATTACH]-ed databases.)^ | |
6068 | +** ^The full amount of memory used by the schemas is reported, even if the | |
6069 | +** schema memory is shared with other database connections due to | |
6070 | +** [shared cache mode] being enabled. | |
6071 | +** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. | |
6072 | +** | |
6073 | +** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> | |
6074 | +** <dd>This parameter returns the approximate number of of bytes of heap | |
6075 | +** and lookaside memory used by all prepared statements associated with | |
6076 | +** the database connection.)^ | |
6077 | +** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. | |
6078 | +** </dd> | |
6079 | +** | |
6080 | +** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt> | |
6081 | +** <dd>This parameter returns the number of pager cache hits that have | |
6082 | +** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT | |
6083 | +** is always 0. | |
6084 | +** </dd> | |
6085 | +** | |
6086 | +** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt> | |
6087 | +** <dd>This parameter returns the number of pager cache misses that have | |
6088 | +** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS | |
6089 | +** is always 0. | |
6090 | +** </dd> | |
6091 | +** | |
6092 | +** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt> | |
6093 | +** <dd>This parameter returns the number of dirty cache entries that have | |
6094 | +** been written to disk. Specifically, the number of pages written to the | |
6095 | +** wal file in wal mode databases, or the number of pages written to the | |
6096 | +** database file in rollback mode databases. Any pages written as part of | |
6097 | +** transaction rollback or database recovery operations are not included. | |
6098 | +** If an IO or other error occurs while writing a page to disk, the effect | |
6099 | +** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The | |
6100 | +** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0. | |
6101 | +** </dd> | |
6102 | +** </dl> | |
6103 | +*/ | |
6104 | +#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 | |
6105 | +#define SQLITE_DBSTATUS_CACHE_USED 1 | |
6106 | +#define SQLITE_DBSTATUS_SCHEMA_USED 2 | |
6107 | +#define SQLITE_DBSTATUS_STMT_USED 3 | |
6108 | +#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 | |
6109 | +#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 | |
6110 | +#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 | |
6111 | +#define SQLITE_DBSTATUS_CACHE_HIT 7 | |
6112 | +#define SQLITE_DBSTATUS_CACHE_MISS 8 | |
6113 | +#define SQLITE_DBSTATUS_CACHE_WRITE 9 | |
6114 | +#define SQLITE_DBSTATUS_MAX 9 /* Largest defined DBSTATUS */ | |
6115 | + | |
6116 | + | |
6117 | +/* | |
6118 | +** CAPI3REF: Prepared Statement Status | |
6119 | +** | |
6120 | +** ^(Each prepared statement maintains various | |
6121 | +** [SQLITE_STMTSTATUS counters] that measure the number | |
6122 | +** of times it has performed specific operations.)^ These counters can | |
6123 | +** be used to monitor the performance characteristics of the prepared | |
6124 | +** statements. For example, if the number of table steps greatly exceeds | |
6125 | +** the number of table searches or result rows, that would tend to indicate | |
6126 | +** that the prepared statement is using a full table scan rather than | |
6127 | +** an index. | |
6128 | +** | |
6129 | +** ^(This interface is used to retrieve and reset counter values from | |
6130 | +** a [prepared statement]. The first argument is the prepared statement | |
6131 | +** object to be interrogated. The second argument | |
6132 | +** is an integer code for a specific [SQLITE_STMTSTATUS counter] | |
6133 | +** to be interrogated.)^ | |
6134 | +** ^The current value of the requested counter is returned. | |
6135 | +** ^If the resetFlg is true, then the counter is reset to zero after this | |
6136 | +** interface call returns. | |
6137 | +** | |
6138 | +** See also: [sqlite3_status()] and [sqlite3_db_status()]. | |
6139 | +*/ | |
6140 | +SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); | |
6141 | + | |
6142 | +/* | |
6143 | +** CAPI3REF: Status Parameters for prepared statements | |
6144 | +** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} | |
6145 | +** | |
6146 | +** These preprocessor macros define integer codes that name counter | |
6147 | +** values associated with the [sqlite3_stmt_status()] interface. | |
6148 | +** The meanings of the various counters are as follows: | |
6149 | +** | |
6150 | +** <dl> | |
6151 | +** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> | |
6152 | +** <dd>^This is the number of times that SQLite has stepped forward in | |
6153 | +** a table as part of a full table scan. Large numbers for this counter | |
6154 | +** may indicate opportunities for performance improvement through | |
6155 | +** careful use of indices.</dd> | |
6156 | +** | |
6157 | +** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt> | |
6158 | +** <dd>^This is the number of sort operations that have occurred. | |
6159 | +** A non-zero value in this counter may indicate an opportunity to | |
6160 | +** improvement performance through careful use of indices.</dd> | |
6161 | +** | |
6162 | +** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> | |
6163 | +** <dd>^This is the number of rows inserted into transient indices that | |
6164 | +** were created automatically in order to help joins run faster. | |
6165 | +** A non-zero value in this counter may indicate an opportunity to | |
6166 | +** improvement performance by adding permanent indices that do not | |
6167 | +** need to be reinitialized each time the statement is run.</dd> | |
6168 | +** </dl> | |
6169 | +*/ | |
6170 | +#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 | |
6171 | +#define SQLITE_STMTSTATUS_SORT 2 | |
6172 | +#define SQLITE_STMTSTATUS_AUTOINDEX 3 | |
6173 | + | |
6174 | +/* | |
6175 | +** CAPI3REF: Custom Page Cache Object | |
6176 | +** | |
6177 | +** The sqlite3_pcache type is opaque. It is implemented by | |
6178 | +** the pluggable module. The SQLite core has no knowledge of | |
6179 | +** its size or internal structure and never deals with the | |
6180 | +** sqlite3_pcache object except by holding and passing pointers | |
6181 | +** to the object. | |
6182 | +** | |
6183 | +** See [sqlite3_pcache_methods2] for additional information. | |
6184 | +*/ | |
6185 | +typedef struct sqlite3_pcache sqlite3_pcache; | |
6186 | + | |
6187 | +/* | |
6188 | +** CAPI3REF: Custom Page Cache Object | |
6189 | +** | |
6190 | +** The sqlite3_pcache_page object represents a single page in the | |
6191 | +** page cache. The page cache will allocate instances of this | |
6192 | +** object. Various methods of the page cache use pointers to instances | |
6193 | +** of this object as parameters or as their return value. | |
6194 | +** | |
6195 | +** See [sqlite3_pcache_methods2] for additional information. | |
6196 | +*/ | |
6197 | +typedef struct sqlite3_pcache_page sqlite3_pcache_page; | |
6198 | +struct sqlite3_pcache_page { | |
6199 | + void *pBuf; /* The content of the page */ | |
6200 | + void *pExtra; /* Extra information associated with the page */ | |
6201 | +}; | |
6202 | + | |
6203 | +/* | |
6204 | +** CAPI3REF: Application Defined Page Cache. | |
6205 | +** KEYWORDS: {page cache} | |
6206 | +** | |
6207 | +** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can | |
6208 | +** register an alternative page cache implementation by passing in an | |
6209 | +** instance of the sqlite3_pcache_methods2 structure.)^ | |
6210 | +** In many applications, most of the heap memory allocated by | |
6211 | +** SQLite is used for the page cache. | |
6212 | +** By implementing a | |
6213 | +** custom page cache using this API, an application can better control | |
6214 | +** the amount of memory consumed by SQLite, the way in which | |
6215 | +** that memory is allocated and released, and the policies used to | |
6216 | +** determine exactly which parts of a database file are cached and for | |
6217 | +** how long. | |
6218 | +** | |
6219 | +** The alternative page cache mechanism is an | |
6220 | +** extreme measure that is only needed by the most demanding applications. | |
6221 | +** The built-in page cache is recommended for most uses. | |
6222 | +** | |
6223 | +** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an | |
6224 | +** internal buffer by SQLite within the call to [sqlite3_config]. Hence | |
6225 | +** the application may discard the parameter after the call to | |
6226 | +** [sqlite3_config()] returns.)^ | |
6227 | +** | |
6228 | +** [[the xInit() page cache method]] | |
6229 | +** ^(The xInit() method is called once for each effective | |
6230 | +** call to [sqlite3_initialize()])^ | |
6231 | +** (usually only once during the lifetime of the process). ^(The xInit() | |
6232 | +** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^ | |
6233 | +** The intent of the xInit() method is to set up global data structures | |
6234 | +** required by the custom page cache implementation. | |
6235 | +** ^(If the xInit() method is NULL, then the | |
6236 | +** built-in default page cache is used instead of the application defined | |
6237 | +** page cache.)^ | |
6238 | +** | |
6239 | +** [[the xShutdown() page cache method]] | |
6240 | +** ^The xShutdown() method is called by [sqlite3_shutdown()]. | |
6241 | +** It can be used to clean up | |
6242 | +** any outstanding resources before process shutdown, if required. | |
6243 | +** ^The xShutdown() method may be NULL. | |
6244 | +** | |
6245 | +** ^SQLite automatically serializes calls to the xInit method, | |
6246 | +** so the xInit method need not be threadsafe. ^The | |
6247 | +** xShutdown method is only called from [sqlite3_shutdown()] so it does | |
6248 | +** not need to be threadsafe either. All other methods must be threadsafe | |
6249 | +** in multithreaded applications. | |
6250 | +** | |
6251 | +** ^SQLite will never invoke xInit() more than once without an intervening | |
6252 | +** call to xShutdown(). | |
6253 | +** | |
6254 | +** [[the xCreate() page cache methods]] | |
6255 | +** ^SQLite invokes the xCreate() method to construct a new cache instance. | |
6256 | +** SQLite will typically create one cache instance for each open database file, | |
6257 | +** though this is not guaranteed. ^The | |
6258 | +** first parameter, szPage, is the size in bytes of the pages that must | |
6259 | +** be allocated by the cache. ^szPage will always a power of two. ^The | |
6260 | +** second parameter szExtra is a number of bytes of extra storage | |
6261 | +** associated with each page cache entry. ^The szExtra parameter will | |
6262 | +** a number less than 250. SQLite will use the | |
6263 | +** extra szExtra bytes on each page to store metadata about the underlying | |
6264 | +** database page on disk. The value passed into szExtra depends | |
6265 | +** on the SQLite version, the target platform, and how SQLite was compiled. | |
6266 | +** ^The third argument to xCreate(), bPurgeable, is true if the cache being | |
6267 | +** created will be used to cache database pages of a file stored on disk, or | |
6268 | +** false if it is used for an in-memory database. The cache implementation | |
6269 | +** does not have to do anything special based with the value of bPurgeable; | |
6270 | +** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will | |
6271 | +** never invoke xUnpin() except to deliberately delete a page. | |
6272 | +** ^In other words, calls to xUnpin() on a cache with bPurgeable set to | |
6273 | +** false will always have the "discard" flag set to true. | |
6274 | +** ^Hence, a cache created with bPurgeable false will | |
6275 | +** never contain any unpinned pages. | |
6276 | +** | |
6277 | +** [[the xCachesize() page cache method]] | |
6278 | +** ^(The xCachesize() method may be called at any time by SQLite to set the | |
6279 | +** suggested maximum cache-size (number of pages stored by) the cache | |
6280 | +** instance passed as the first argument. This is the value configured using | |
6281 | +** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable | |
6282 | +** parameter, the implementation is not required to do anything with this | |
6283 | +** value; it is advisory only. | |
6284 | +** | |
6285 | +** [[the xPagecount() page cache methods]] | |
6286 | +** The xPagecount() method must return the number of pages currently | |
6287 | +** stored in the cache, both pinned and unpinned. | |
6288 | +** | |
6289 | +** [[the xFetch() page cache methods]] | |
6290 | +** The xFetch() method locates a page in the cache and returns a pointer to | |
6291 | +** an sqlite3_pcache_page object associated with that page, or a NULL pointer. | |
6292 | +** The pBuf element of the returned sqlite3_pcache_page object will be a | |
6293 | +** pointer to a buffer of szPage bytes used to store the content of a | |
6294 | +** single database page. The pExtra element of sqlite3_pcache_page will be | |
6295 | +** a pointer to the szExtra bytes of extra storage that SQLite has requested | |
6296 | +** for each entry in the page cache. | |
6297 | +** | |
6298 | +** The page to be fetched is determined by the key. ^The minimum key value | |
6299 | +** is 1. After it has been retrieved using xFetch, the page is considered | |
6300 | +** to be "pinned". | |
6301 | +** | |
6302 | +** If the requested page is already in the page cache, then the page cache | |
6303 | +** implementation must return a pointer to the page buffer with its content | |
6304 | +** intact. If the requested page is not already in the cache, then the | |
6305 | +** cache implementation should use the value of the createFlag | |
6306 | +** parameter to help it determined what action to take: | |
6307 | +** | |
6308 | +** <table border=1 width=85% align=center> | |
6309 | +** <tr><th> createFlag <th> Behaviour when page is not already in cache | |
6310 | +** <tr><td> 0 <td> Do not allocate a new page. Return NULL. | |
6311 | +** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. | |
6312 | +** Otherwise return NULL. | |
6313 | +** <tr><td> 2 <td> Make every effort to allocate a new page. Only return | |
6314 | +** NULL if allocating a new page is effectively impossible. | |
6315 | +** </table> | |
6316 | +** | |
6317 | +** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite | |
6318 | +** will only use a createFlag of 2 after a prior call with a createFlag of 1 | |
6319 | +** failed.)^ In between the to xFetch() calls, SQLite may | |
6320 | +** attempt to unpin one or more cache pages by spilling the content of | |
6321 | +** pinned pages to disk and synching the operating system disk cache. | |
6322 | +** | |
6323 | +** [[the xUnpin() page cache method]] | |
6324 | +** ^xUnpin() is called by SQLite with a pointer to a currently pinned page | |
6325 | +** as its second argument. If the third parameter, discard, is non-zero, | |
6326 | +** then the page must be evicted from the cache. | |
6327 | +** ^If the discard parameter is | |
6328 | +** zero, then the page may be discarded or retained at the discretion of | |
6329 | +** page cache implementation. ^The page cache implementation | |
6330 | +** may choose to evict unpinned pages at any time. | |
6331 | +** | |
6332 | +** The cache must not perform any reference counting. A single | |
6333 | +** call to xUnpin() unpins the page regardless of the number of prior calls | |
6334 | +** to xFetch(). | |
6335 | +** | |
6336 | +** [[the xRekey() page cache methods]] | |
6337 | +** The xRekey() method is used to change the key value associated with the | |
6338 | +** page passed as the second argument. If the cache | |
6339 | +** previously contains an entry associated with newKey, it must be | |
6340 | +** discarded. ^Any prior cache entry associated with newKey is guaranteed not | |
6341 | +** to be pinned. | |
6342 | +** | |
6343 | +** When SQLite calls the xTruncate() method, the cache must discard all | |
6344 | +** existing cache entries with page numbers (keys) greater than or equal | |
6345 | +** to the value of the iLimit parameter passed to xTruncate(). If any | |
6346 | +** of these pages are pinned, they are implicitly unpinned, meaning that | |
6347 | +** they can be safely discarded. | |
6348 | +** | |
6349 | +** [[the xDestroy() page cache method]] | |
6350 | +** ^The xDestroy() method is used to delete a cache allocated by xCreate(). | |
6351 | +** All resources associated with the specified cache should be freed. ^After | |
6352 | +** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] | |
6353 | +** handle invalid, and will not use it with any other sqlite3_pcache_methods2 | |
6354 | +** functions. | |
6355 | +** | |
6356 | +** [[the xShrink() page cache method]] | |
6357 | +** ^SQLite invokes the xShrink() method when it wants the page cache to | |
6358 | +** free up as much of heap memory as possible. The page cache implementation | |
6359 | +** is not obligated to free any memory, but well-behaved implementations should | |
6360 | +** do their best. | |
6361 | +*/ | |
6362 | +typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2; | |
6363 | +struct sqlite3_pcache_methods2 { | |
6364 | + int iVersion; | |
6365 | + void *pArg; | |
6366 | + int (*xInit)(void*); | |
6367 | + void (*xShutdown)(void*); | |
6368 | + sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable); | |
6369 | + void (*xCachesize)(sqlite3_pcache*, int nCachesize); | |
6370 | + int (*xPagecount)(sqlite3_pcache*); | |
6371 | + sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); | |
6372 | + void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard); | |
6373 | + void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*, | |
6374 | + unsigned oldKey, unsigned newKey); | |
6375 | + void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); | |
6376 | + void (*xDestroy)(sqlite3_pcache*); | |
6377 | + void (*xShrink)(sqlite3_pcache*); | |
6378 | +}; | |
6379 | + | |
6380 | +/* | |
6381 | +** This is the obsolete pcache_methods object that has now been replaced | |
6382 | +** by sqlite3_pcache_methods2. This object is not used by SQLite. It is | |
6383 | +** retained in the header file for backwards compatibility only. | |
6384 | +*/ | |
6385 | +typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; | |
6386 | +struct sqlite3_pcache_methods { | |
6387 | + void *pArg; | |
6388 | + int (*xInit)(void*); | |
6389 | + void (*xShutdown)(void*); | |
6390 | + sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); | |
6391 | + void (*xCachesize)(sqlite3_pcache*, int nCachesize); | |
6392 | + int (*xPagecount)(sqlite3_pcache*); | |
6393 | + void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); | |
6394 | + void (*xUnpin)(sqlite3_pcache*, void*, int discard); | |
6395 | + void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); | |
6396 | + void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); | |
6397 | + void (*xDestroy)(sqlite3_pcache*); | |
6398 | +}; | |
6399 | + | |
6400 | + | |
6401 | +/* | |
6402 | +** CAPI3REF: Online Backup Object | |
6403 | +** | |
6404 | +** The sqlite3_backup object records state information about an ongoing | |
6405 | +** online backup operation. ^The sqlite3_backup object is created by | |
6406 | +** a call to [sqlite3_backup_init()] and is destroyed by a call to | |
6407 | +** [sqlite3_backup_finish()]. | |
6408 | +** | |
6409 | +** See Also: [Using the SQLite Online Backup API] | |
6410 | +*/ | |
6411 | +typedef struct sqlite3_backup sqlite3_backup; | |
6412 | + | |
6413 | +/* | |
6414 | +** CAPI3REF: Online Backup API. | |
6415 | +** | |
6416 | +** The backup API copies the content of one database into another. | |
6417 | +** It is useful either for creating backups of databases or | |
6418 | +** for copying in-memory databases to or from persistent files. | |
6419 | +** | |
6420 | +** See Also: [Using the SQLite Online Backup API] | |
6421 | +** | |
6422 | +** ^SQLite holds a write transaction open on the destination database file | |
6423 | +** for the duration of the backup operation. | |
6424 | +** ^The source database is read-locked only while it is being read; | |
6425 | +** it is not locked continuously for the entire backup operation. | |
6426 | +** ^Thus, the backup may be performed on a live source database without | |
6427 | +** preventing other database connections from | |
6428 | +** reading or writing to the source database while the backup is underway. | |
6429 | +** | |
6430 | +** ^(To perform a backup operation: | |
6431 | +** <ol> | |
6432 | +** <li><b>sqlite3_backup_init()</b> is called once to initialize the | |
6433 | +** backup, | |
6434 | +** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer | |
6435 | +** the data between the two databases, and finally | |
6436 | +** <li><b>sqlite3_backup_finish()</b> is called to release all resources | |
6437 | +** associated with the backup operation. | |
6438 | +** </ol>)^ | |
6439 | +** There should be exactly one call to sqlite3_backup_finish() for each | |
6440 | +** successful call to sqlite3_backup_init(). | |
6441 | +** | |
6442 | +** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b> | |
6443 | +** | |
6444 | +** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the | |
6445 | +** [database connection] associated with the destination database | |
6446 | +** and the database name, respectively. | |
6447 | +** ^The database name is "main" for the main database, "temp" for the | |
6448 | +** temporary database, or the name specified after the AS keyword in | |
6449 | +** an [ATTACH] statement for an attached database. | |
6450 | +** ^The S and M arguments passed to | |
6451 | +** sqlite3_backup_init(D,N,S,M) identify the [database connection] | |
6452 | +** and database name of the source database, respectively. | |
6453 | +** ^The source and destination [database connections] (parameters S and D) | |
6454 | +** must be different or else sqlite3_backup_init(D,N,S,M) will fail with | |
6455 | +** an error. | |
6456 | +** | |
6457 | +** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is | |
6458 | +** returned and an error code and error message are stored in the | |
6459 | +** destination [database connection] D. | |
6460 | +** ^The error code and message for the failed call to sqlite3_backup_init() | |
6461 | +** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or | |
6462 | +** [sqlite3_errmsg16()] functions. | |
6463 | +** ^A successful call to sqlite3_backup_init() returns a pointer to an | |
6464 | +** [sqlite3_backup] object. | |
6465 | +** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and | |
6466 | +** sqlite3_backup_finish() functions to perform the specified backup | |
6467 | +** operation. | |
6468 | +** | |
6469 | +** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b> | |
6470 | +** | |
6471 | +** ^Function sqlite3_backup_step(B,N) will copy up to N pages between | |
6472 | +** the source and destination databases specified by [sqlite3_backup] object B. | |
6473 | +** ^If N is negative, all remaining source pages are copied. | |
6474 | +** ^If sqlite3_backup_step(B,N) successfully copies N pages and there | |
6475 | +** are still more pages to be copied, then the function returns [SQLITE_OK]. | |
6476 | +** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages | |
6477 | +** from source to destination, then it returns [SQLITE_DONE]. | |
6478 | +** ^If an error occurs while running sqlite3_backup_step(B,N), | |
6479 | +** then an [error code] is returned. ^As well as [SQLITE_OK] and | |
6480 | +** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], | |
6481 | +** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an | |
6482 | +** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. | |
6483 | +** | |
6484 | +** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if | |
6485 | +** <ol> | |
6486 | +** <li> the destination database was opened read-only, or | |
6487 | +** <li> the destination database is using write-ahead-log journaling | |
6488 | +** and the destination and source page sizes differ, or | |
6489 | +** <li> the destination database is an in-memory database and the | |
6490 | +** destination and source page sizes differ. | |
6491 | +** </ol>)^ | |
6492 | +** | |
6493 | +** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then | |
6494 | +** the [sqlite3_busy_handler | busy-handler function] | |
6495 | +** is invoked (if one is specified). ^If the | |
6496 | +** busy-handler returns non-zero before the lock is available, then | |
6497 | +** [SQLITE_BUSY] is returned to the caller. ^In this case the call to | |
6498 | +** sqlite3_backup_step() can be retried later. ^If the source | |
6499 | +** [database connection] | |
6500 | +** is being used to write to the source database when sqlite3_backup_step() | |
6501 | +** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this | |
6502 | +** case the call to sqlite3_backup_step() can be retried later on. ^(If | |
6503 | +** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or | |
6504 | +** [SQLITE_READONLY] is returned, then | |
6505 | +** there is no point in retrying the call to sqlite3_backup_step(). These | |
6506 | +** errors are considered fatal.)^ The application must accept | |
6507 | +** that the backup operation has failed and pass the backup operation handle | |
6508 | +** to the sqlite3_backup_finish() to release associated resources. | |
6509 | +** | |
6510 | +** ^The first call to sqlite3_backup_step() obtains an exclusive lock | |
6511 | +** on the destination file. ^The exclusive lock is not released until either | |
6512 | +** sqlite3_backup_finish() is called or the backup operation is complete | |
6513 | +** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to | |
6514 | +** sqlite3_backup_step() obtains a [shared lock] on the source database that | |
6515 | +** lasts for the duration of the sqlite3_backup_step() call. | |
6516 | +** ^Because the source database is not locked between calls to | |
6517 | +** sqlite3_backup_step(), the source database may be modified mid-way | |
6518 | +** through the backup process. ^If the source database is modified by an | |
6519 | +** external process or via a database connection other than the one being | |
6520 | +** used by the backup operation, then the backup will be automatically | |
6521 | +** restarted by the next call to sqlite3_backup_step(). ^If the source | |
6522 | +** database is modified by the using the same database connection as is used | |
6523 | +** by the backup operation, then the backup database is automatically | |
6524 | +** updated at the same time. | |
6525 | +** | |
6526 | +** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b> | |
6527 | +** | |
6528 | +** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the | |
6529 | +** application wishes to abandon the backup operation, the application | |
6530 | +** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). | |
6531 | +** ^The sqlite3_backup_finish() interfaces releases all | |
6532 | +** resources associated with the [sqlite3_backup] object. | |
6533 | +** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any | |
6534 | +** active write-transaction on the destination database is rolled back. | |
6535 | +** The [sqlite3_backup] object is invalid | |
6536 | +** and may not be used following a call to sqlite3_backup_finish(). | |
6537 | +** | |
6538 | +** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no | |
6539 | +** sqlite3_backup_step() errors occurred, regardless or whether or not | |
6540 | +** sqlite3_backup_step() completed. | |
6541 | +** ^If an out-of-memory condition or IO error occurred during any prior | |
6542 | +** sqlite3_backup_step() call on the same [sqlite3_backup] object, then | |
6543 | +** sqlite3_backup_finish() returns the corresponding [error code]. | |
6544 | +** | |
6545 | +** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() | |
6546 | +** is not a permanent error and does not affect the return value of | |
6547 | +** sqlite3_backup_finish(). | |
6548 | +** | |
6549 | +** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]] | |
6550 | +** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b> | |
6551 | +** | |
6552 | +** ^Each call to sqlite3_backup_step() sets two values inside | |
6553 | +** the [sqlite3_backup] object: the number of pages still to be backed | |
6554 | +** up and the total number of pages in the source database file. | |
6555 | +** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces | |
6556 | +** retrieve these two values, respectively. | |
6557 | +** | |
6558 | +** ^The values returned by these functions are only updated by | |
6559 | +** sqlite3_backup_step(). ^If the source database is modified during a backup | |
6560 | +** operation, then the values are not updated to account for any extra | |
6561 | +** pages that need to be updated or the size of the source database file | |
6562 | +** changing. | |
6563 | +** | |
6564 | +** <b>Concurrent Usage of Database Handles</b> | |
6565 | +** | |
6566 | +** ^The source [database connection] may be used by the application for other | |
6567 | +** purposes while a backup operation is underway or being initialized. | |
6568 | +** ^If SQLite is compiled and configured to support threadsafe database | |
6569 | +** connections, then the source database connection may be used concurrently | |
6570 | +** from within other threads. | |
6571 | +** | |
6572 | +** However, the application must guarantee that the destination | |
6573 | +** [database connection] is not passed to any other API (by any thread) after | |
6574 | +** sqlite3_backup_init() is called and before the corresponding call to | |
6575 | +** sqlite3_backup_finish(). SQLite does not currently check to see | |
6576 | +** if the application incorrectly accesses the destination [database connection] | |
6577 | +** and so no error code is reported, but the operations may malfunction | |
6578 | +** nevertheless. Use of the destination database connection while a | |
6579 | +** backup is in progress might also also cause a mutex deadlock. | |
6580 | +** | |
6581 | +** If running in [shared cache mode], the application must | |
6582 | +** guarantee that the shared cache used by the destination database | |
6583 | +** is not accessed while the backup is running. In practice this means | |
6584 | +** that the application must guarantee that the disk file being | |
6585 | +** backed up to is not accessed by any connection within the process, | |
6586 | +** not just the specific connection that was passed to sqlite3_backup_init(). | |
6587 | +** | |
6588 | +** The [sqlite3_backup] object itself is partially threadsafe. Multiple | |
6589 | +** threads may safely make multiple concurrent calls to sqlite3_backup_step(). | |
6590 | +** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() | |
6591 | +** APIs are not strictly speaking threadsafe. If they are invoked at the | |
6592 | +** same time as another thread is invoking sqlite3_backup_step() it is | |
6593 | +** possible that they return invalid values. | |
6594 | +*/ | |
6595 | +SQLITE_API sqlite3_backup *sqlite3_backup_init( | |
6596 | + sqlite3 *pDest, /* Destination database handle */ | |
6597 | + const char *zDestName, /* Destination database name */ | |
6598 | + sqlite3 *pSource, /* Source database handle */ | |
6599 | + const char *zSourceName /* Source database name */ | |
6600 | +); | |
6601 | +SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage); | |
6602 | +SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p); | |
6603 | +SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p); | |
6604 | +SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p); | |
6605 | + | |
6606 | +/* | |
6607 | +** CAPI3REF: Unlock Notification | |
6608 | +** | |
6609 | +** ^When running in shared-cache mode, a database operation may fail with | |
6610 | +** an [SQLITE_LOCKED] error if the required locks on the shared-cache or | |
6611 | +** individual tables within the shared-cache cannot be obtained. See | |
6612 | +** [SQLite Shared-Cache Mode] for a description of shared-cache locking. | |
6613 | +** ^This API may be used to register a callback that SQLite will invoke | |
6614 | +** when the connection currently holding the required lock relinquishes it. | |
6615 | +** ^This API is only available if the library was compiled with the | |
6616 | +** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. | |
6617 | +** | |
6618 | +** See Also: [Using the SQLite Unlock Notification Feature]. | |
6619 | +** | |
6620 | +** ^Shared-cache locks are released when a database connection concludes | |
6621 | +** its current transaction, either by committing it or rolling it back. | |
6622 | +** | |
6623 | +** ^When a connection (known as the blocked connection) fails to obtain a | |
6624 | +** shared-cache lock and SQLITE_LOCKED is returned to the caller, the | |
6625 | +** identity of the database connection (the blocking connection) that | |
6626 | +** has locked the required resource is stored internally. ^After an | |
6627 | +** application receives an SQLITE_LOCKED error, it may call the | |
6628 | +** sqlite3_unlock_notify() method with the blocked connection handle as | |
6629 | +** the first argument to register for a callback that will be invoked | |
6630 | +** when the blocking connections current transaction is concluded. ^The | |
6631 | +** callback is invoked from within the [sqlite3_step] or [sqlite3_close] | |
6632 | +** call that concludes the blocking connections transaction. | |
6633 | +** | |
6634 | +** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, | |
6635 | +** there is a chance that the blocking connection will have already | |
6636 | +** concluded its transaction by the time sqlite3_unlock_notify() is invoked. | |
6637 | +** If this happens, then the specified callback is invoked immediately, | |
6638 | +** from within the call to sqlite3_unlock_notify().)^ | |
6639 | +** | |
6640 | +** ^If the blocked connection is attempting to obtain a write-lock on a | |
6641 | +** shared-cache table, and more than one other connection currently holds | |
6642 | +** a read-lock on the same table, then SQLite arbitrarily selects one of | |
6643 | +** the other connections to use as the blocking connection. | |
6644 | +** | |
6645 | +** ^(There may be at most one unlock-notify callback registered by a | |
6646 | +** blocked connection. If sqlite3_unlock_notify() is called when the | |
6647 | +** blocked connection already has a registered unlock-notify callback, | |
6648 | +** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is | |
6649 | +** called with a NULL pointer as its second argument, then any existing | |
6650 | +** unlock-notify callback is canceled. ^The blocked connections | |
6651 | +** unlock-notify callback may also be canceled by closing the blocked | |
6652 | +** connection using [sqlite3_close()]. | |
6653 | +** | |
6654 | +** The unlock-notify callback is not reentrant. If an application invokes | |
6655 | +** any sqlite3_xxx API functions from within an unlock-notify callback, a | |
6656 | +** crash or deadlock may be the result. | |
6657 | +** | |
6658 | +** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always | |
6659 | +** returns SQLITE_OK. | |
6660 | +** | |
6661 | +** <b>Callback Invocation Details</b> | |
6662 | +** | |
6663 | +** When an unlock-notify callback is registered, the application provides a | |
6664 | +** single void* pointer that is passed to the callback when it is invoked. | |
6665 | +** However, the signature of the callback function allows SQLite to pass | |
6666 | +** it an array of void* context pointers. The first argument passed to | |
6667 | +** an unlock-notify callback is a pointer to an array of void* pointers, | |
6668 | +** and the second is the number of entries in the array. | |
6669 | +** | |
6670 | +** When a blocking connections transaction is concluded, there may be | |
6671 | +** more than one blocked connection that has registered for an unlock-notify | |
6672 | +** callback. ^If two or more such blocked connections have specified the | |
6673 | +** same callback function, then instead of invoking the callback function | |
6674 | +** multiple times, it is invoked once with the set of void* context pointers | |
6675 | +** specified by the blocked connections bundled together into an array. | |
6676 | +** This gives the application an opportunity to prioritize any actions | |
6677 | +** related to the set of unblocked database connections. | |
6678 | +** | |
6679 | +** <b>Deadlock Detection</b> | |
6680 | +** | |
6681 | +** Assuming that after registering for an unlock-notify callback a | |
6682 | +** database waits for the callback to be issued before taking any further | |
6683 | +** action (a reasonable assumption), then using this API may cause the | |
6684 | +** application to deadlock. For example, if connection X is waiting for | |
6685 | +** connection Y's transaction to be concluded, and similarly connection | |
6686 | +** Y is waiting on connection X's transaction, then neither connection | |
6687 | +** will proceed and the system may remain deadlocked indefinitely. | |
6688 | +** | |
6689 | +** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock | |
6690 | +** detection. ^If a given call to sqlite3_unlock_notify() would put the | |
6691 | +** system in a deadlocked state, then SQLITE_LOCKED is returned and no | |
6692 | +** unlock-notify callback is registered. The system is said to be in | |
6693 | +** a deadlocked state if connection A has registered for an unlock-notify | |
6694 | +** callback on the conclusion of connection B's transaction, and connection | |
6695 | +** B has itself registered for an unlock-notify callback when connection | |
6696 | +** A's transaction is concluded. ^Indirect deadlock is also detected, so | |
6697 | +** the system is also considered to be deadlocked if connection B has | |
6698 | +** registered for an unlock-notify callback on the conclusion of connection | |
6699 | +** C's transaction, where connection C is waiting on connection A. ^Any | |
6700 | +** number of levels of indirection are allowed. | |
6701 | +** | |
6702 | +** <b>The "DROP TABLE" Exception</b> | |
6703 | +** | |
6704 | +** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost | |
6705 | +** always appropriate to call sqlite3_unlock_notify(). There is however, | |
6706 | +** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, | |
6707 | +** SQLite checks if there are any currently executing SELECT statements | |
6708 | +** that belong to the same connection. If there are, SQLITE_LOCKED is | |
6709 | +** returned. In this case there is no "blocking connection", so invoking | |
6710 | +** sqlite3_unlock_notify() results in the unlock-notify callback being | |
6711 | +** invoked immediately. If the application then re-attempts the "DROP TABLE" | |
6712 | +** or "DROP INDEX" query, an infinite loop might be the result. | |
6713 | +** | |
6714 | +** One way around this problem is to check the extended error code returned | |
6715 | +** by an sqlite3_step() call. ^(If there is a blocking connection, then the | |
6716 | +** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in | |
6717 | +** the special "DROP TABLE/INDEX" case, the extended error code is just | |
6718 | +** SQLITE_LOCKED.)^ | |
6719 | +*/ | |
6720 | +SQLITE_API int sqlite3_unlock_notify( | |
6721 | + sqlite3 *pBlocked, /* Waiting connection */ | |
6722 | + void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ | |
6723 | + void *pNotifyArg /* Argument to pass to xNotify */ | |
6724 | +); | |
6725 | + | |
6726 | + | |
6727 | +/* | |
6728 | +** CAPI3REF: String Comparison | |
6729 | +** | |
6730 | +** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications | |
6731 | +** and extensions to compare the contents of two buffers containing UTF-8 | |
6732 | +** strings in a case-independent fashion, using the same definition of "case | |
6733 | +** independence" that SQLite uses internally when comparing identifiers. | |
6734 | +*/ | |
6735 | +SQLITE_API int sqlite3_stricmp(const char *, const char *); | |
6736 | +SQLITE_API int sqlite3_strnicmp(const char *, const char *, int); | |
6737 | + | |
6738 | +/* | |
6739 | +** CAPI3REF: Error Logging Interface | |
6740 | +** | |
6741 | +** ^The [sqlite3_log()] interface writes a message into the error log | |
6742 | +** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. | |
6743 | +** ^If logging is enabled, the zFormat string and subsequent arguments are | |
6744 | +** used with [sqlite3_snprintf()] to generate the final output string. | |
6745 | +** | |
6746 | +** The sqlite3_log() interface is intended for use by extensions such as | |
6747 | +** virtual tables, collating functions, and SQL functions. While there is | |
6748 | +** nothing to prevent an application from calling sqlite3_log(), doing so | |
6749 | +** is considered bad form. | |
6750 | +** | |
6751 | +** The zFormat string must not be NULL. | |
6752 | +** | |
6753 | +** To avoid deadlocks and other threading problems, the sqlite3_log() routine | |
6754 | +** will not use dynamically allocated memory. The log message is stored in | |
6755 | +** a fixed-length buffer on the stack. If the log message is longer than | |
6756 | +** a few hundred characters, it will be truncated to the length of the | |
6757 | +** buffer. | |
6758 | +*/ | |
6759 | +SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...); | |
6760 | + | |
6761 | +/* | |
6762 | +** CAPI3REF: Write-Ahead Log Commit Hook | |
6763 | +** | |
6764 | +** ^The [sqlite3_wal_hook()] function is used to register a callback that | |
6765 | +** will be invoked each time a database connection commits data to a | |
6766 | +** [write-ahead log] (i.e. whenever a transaction is committed in | |
6767 | +** [journal_mode | journal_mode=WAL mode]). | |
6768 | +** | |
6769 | +** ^The callback is invoked by SQLite after the commit has taken place and | |
6770 | +** the associated write-lock on the database released, so the implementation | |
6771 | +** may read, write or [checkpoint] the database as required. | |
6772 | +** | |
6773 | +** ^The first parameter passed to the callback function when it is invoked | |
6774 | +** is a copy of the third parameter passed to sqlite3_wal_hook() when | |
6775 | +** registering the callback. ^The second is a copy of the database handle. | |
6776 | +** ^The third parameter is the name of the database that was written to - | |
6777 | +** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter | |
6778 | +** is the number of pages currently in the write-ahead log file, | |
6779 | +** including those that were just committed. | |
6780 | +** | |
6781 | +** The callback function should normally return [SQLITE_OK]. ^If an error | |
6782 | +** code is returned, that error will propagate back up through the | |
6783 | +** SQLite code base to cause the statement that provoked the callback | |
6784 | +** to report an error, though the commit will have still occurred. If the | |
6785 | +** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value | |
6786 | +** that does not correspond to any valid SQLite error code, the results | |
6787 | +** are undefined. | |
6788 | +** | |
6789 | +** A single database handle may have at most a single write-ahead log callback | |
6790 | +** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any | |
6791 | +** previously registered write-ahead log callback. ^Note that the | |
6792 | +** [sqlite3_wal_autocheckpoint()] interface and the | |
6793 | +** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will | |
6794 | +** those overwrite any prior [sqlite3_wal_hook()] settings. | |
6795 | +*/ | |
6796 | +SQLITE_API void *sqlite3_wal_hook( | |
6797 | + sqlite3*, | |
6798 | + int(*)(void *,sqlite3*,const char*,int), | |
6799 | + void* | |
6800 | +); | |
6801 | + | |
6802 | +/* | |
6803 | +** CAPI3REF: Configure an auto-checkpoint | |
6804 | +** | |
6805 | +** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around | |
6806 | +** [sqlite3_wal_hook()] that causes any database on [database connection] D | |
6807 | +** to automatically [checkpoint] | |
6808 | +** after committing a transaction if there are N or | |
6809 | +** more frames in the [write-ahead log] file. ^Passing zero or | |
6810 | +** a negative value as the nFrame parameter disables automatic | |
6811 | +** checkpoints entirely. | |
6812 | +** | |
6813 | +** ^The callback registered by this function replaces any existing callback | |
6814 | +** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback | |
6815 | +** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism | |
6816 | +** configured by this function. | |
6817 | +** | |
6818 | +** ^The [wal_autocheckpoint pragma] can be used to invoke this interface | |
6819 | +** from SQL. | |
6820 | +** | |
6821 | +** ^Every new [database connection] defaults to having the auto-checkpoint | |
6822 | +** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] | |
6823 | +** pages. The use of this interface | |
6824 | +** is only necessary if the default setting is found to be suboptimal | |
6825 | +** for a particular application. | |
6826 | +*/ | |
6827 | +SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N); | |
6828 | + | |
6829 | +/* | |
6830 | +** CAPI3REF: Checkpoint a database | |
6831 | +** | |
6832 | +** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X | |
6833 | +** on [database connection] D to be [checkpointed]. ^If X is NULL or an | |
6834 | +** empty string, then a checkpoint is run on all databases of | |
6835 | +** connection D. ^If the database connection D is not in | |
6836 | +** [WAL | write-ahead log mode] then this interface is a harmless no-op. | |
6837 | +** | |
6838 | +** ^The [wal_checkpoint pragma] can be used to invoke this interface | |
6839 | +** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the | |
6840 | +** [wal_autocheckpoint pragma] can be used to cause this interface to be | |
6841 | +** run whenever the WAL reaches a certain size threshold. | |
6842 | +** | |
6843 | +** See also: [sqlite3_wal_checkpoint_v2()] | |
6844 | +*/ | |
6845 | +SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); | |
6846 | + | |
6847 | +/* | |
6848 | +** CAPI3REF: Checkpoint a database | |
6849 | +** | |
6850 | +** Run a checkpoint operation on WAL database zDb attached to database | |
6851 | +** handle db. The specific operation is determined by the value of the | |
6852 | +** eMode parameter: | |
6853 | +** | |
6854 | +** <dl> | |
6855 | +** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> | |
6856 | +** Checkpoint as many frames as possible without waiting for any database | |
6857 | +** readers or writers to finish. Sync the db file if all frames in the log | |
6858 | +** are checkpointed. This mode is the same as calling | |
6859 | +** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked. | |
6860 | +** | |
6861 | +** <dt>SQLITE_CHECKPOINT_FULL<dd> | |
6862 | +** This mode blocks (calls the busy-handler callback) until there is no | |
6863 | +** database writer and all readers are reading from the most recent database | |
6864 | +** snapshot. It then checkpoints all frames in the log file and syncs the | |
6865 | +** database file. This call blocks database writers while it is running, | |
6866 | +** but not database readers. | |
6867 | +** | |
6868 | +** <dt>SQLITE_CHECKPOINT_RESTART<dd> | |
6869 | +** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after | |
6870 | +** checkpointing the log file it blocks (calls the busy-handler callback) | |
6871 | +** until all readers are reading from the database file only. This ensures | |
6872 | +** that the next client to write to the database file restarts the log file | |
6873 | +** from the beginning. This call blocks database writers while it is running, | |
6874 | +** but not database readers. | |
6875 | +** </dl> | |
6876 | +** | |
6877 | +** If pnLog is not NULL, then *pnLog is set to the total number of frames in | |
6878 | +** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to | |
6879 | +** the total number of checkpointed frames (including any that were already | |
6880 | +** checkpointed when this function is called). *pnLog and *pnCkpt may be | |
6881 | +** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK. | |
6882 | +** If no values are available because of an error, they are both set to -1 | |
6883 | +** before returning to communicate this to the caller. | |
6884 | +** | |
6885 | +** All calls obtain an exclusive "checkpoint" lock on the database file. If | |
6886 | +** any other process is running a checkpoint operation at the same time, the | |
6887 | +** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a | |
6888 | +** busy-handler configured, it will not be invoked in this case. | |
6889 | +** | |
6890 | +** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive | |
6891 | +** "writer" lock on the database file. If the writer lock cannot be obtained | |
6892 | +** immediately, and a busy-handler is configured, it is invoked and the writer | |
6893 | +** lock retried until either the busy-handler returns 0 or the lock is | |
6894 | +** successfully obtained. The busy-handler is also invoked while waiting for | |
6895 | +** database readers as described above. If the busy-handler returns 0 before | |
6896 | +** the writer lock is obtained or while waiting for database readers, the | |
6897 | +** checkpoint operation proceeds from that point in the same way as | |
6898 | +** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible | |
6899 | +** without blocking any further. SQLITE_BUSY is returned in this case. | |
6900 | +** | |
6901 | +** If parameter zDb is NULL or points to a zero length string, then the | |
6902 | +** specified operation is attempted on all WAL databases. In this case the | |
6903 | +** values written to output parameters *pnLog and *pnCkpt are undefined. If | |
6904 | +** an SQLITE_BUSY error is encountered when processing one or more of the | |
6905 | +** attached WAL databases, the operation is still attempted on any remaining | |
6906 | +** attached databases and SQLITE_BUSY is returned to the caller. If any other | |
6907 | +** error occurs while processing an attached database, processing is abandoned | |
6908 | +** and the error code returned to the caller immediately. If no error | |
6909 | +** (SQLITE_BUSY or otherwise) is encountered while processing the attached | |
6910 | +** databases, SQLITE_OK is returned. | |
6911 | +** | |
6912 | +** If database zDb is the name of an attached database that is not in WAL | |
6913 | +** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. If | |
6914 | +** zDb is not NULL (or a zero length string) and is not the name of any | |
6915 | +** attached database, SQLITE_ERROR is returned to the caller. | |
6916 | +*/ | |
6917 | +SQLITE_API int sqlite3_wal_checkpoint_v2( | |
6918 | + sqlite3 *db, /* Database handle */ | |
6919 | + const char *zDb, /* Name of attached database (or NULL) */ | |
6920 | + int eMode, /* SQLITE_CHECKPOINT_* value */ | |
6921 | + int *pnLog, /* OUT: Size of WAL log in frames */ | |
6922 | + int *pnCkpt /* OUT: Total number of frames checkpointed */ | |
6923 | +); | |
6924 | + | |
6925 | +/* | |
6926 | +** CAPI3REF: Checkpoint operation parameters | |
6927 | +** | |
6928 | +** These constants can be used as the 3rd parameter to | |
6929 | +** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()] | |
6930 | +** documentation for additional information about the meaning and use of | |
6931 | +** each of these values. | |
6932 | +*/ | |
6933 | +#define SQLITE_CHECKPOINT_PASSIVE 0 | |
6934 | +#define SQLITE_CHECKPOINT_FULL 1 | |
6935 | +#define SQLITE_CHECKPOINT_RESTART 2 | |
6936 | + | |
6937 | +/* | |
6938 | +** CAPI3REF: Virtual Table Interface Configuration | |
6939 | +** | |
6940 | +** This function may be called by either the [xConnect] or [xCreate] method | |
6941 | +** of a [virtual table] implementation to configure | |
6942 | +** various facets of the virtual table interface. | |
6943 | +** | |
6944 | +** If this interface is invoked outside the context of an xConnect or | |
6945 | +** xCreate virtual table method then the behavior is undefined. | |
6946 | +** | |
6947 | +** At present, there is only one option that may be configured using | |
6948 | +** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options | |
6949 | +** may be added in the future. | |
6950 | +*/ | |
6951 | +SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...); | |
6952 | + | |
6953 | +/* | |
6954 | +** CAPI3REF: Virtual Table Configuration Options | |
6955 | +** | |
6956 | +** These macros define the various options to the | |
6957 | +** [sqlite3_vtab_config()] interface that [virtual table] implementations | |
6958 | +** can use to customize and optimize their behavior. | |
6959 | +** | |
6960 | +** <dl> | |
6961 | +** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT | |
6962 | +** <dd>Calls of the form | |
6963 | +** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, | |
6964 | +** where X is an integer. If X is zero, then the [virtual table] whose | |
6965 | +** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not | |
6966 | +** support constraints. In this configuration (which is the default) if | |
6967 | +** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire | |
6968 | +** statement is rolled back as if [ON CONFLICT | OR ABORT] had been | |
6969 | +** specified as part of the users SQL statement, regardless of the actual | |
6970 | +** ON CONFLICT mode specified. | |
6971 | +** | |
6972 | +** If X is non-zero, then the virtual table implementation guarantees | |
6973 | +** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before | |
6974 | +** any modifications to internal or persistent data structures have been made. | |
6975 | +** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite | |
6976 | +** is able to roll back a statement or database transaction, and abandon | |
6977 | +** or continue processing the current SQL statement as appropriate. | |
6978 | +** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns | |
6979 | +** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode | |
6980 | +** had been ABORT. | |
6981 | +** | |
6982 | +** Virtual table implementations that are required to handle OR REPLACE | |
6983 | +** must do so within the [xUpdate] method. If a call to the | |
6984 | +** [sqlite3_vtab_on_conflict()] function indicates that the current ON | |
6985 | +** CONFLICT policy is REPLACE, the virtual table implementation should | |
6986 | +** silently replace the appropriate rows within the xUpdate callback and | |
6987 | +** return SQLITE_OK. Or, if this is not possible, it may return | |
6988 | +** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT | |
6989 | +** constraint handling. | |
6990 | +** </dl> | |
6991 | +*/ | |
6992 | +#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 | |
6993 | + | |
6994 | +/* | |
6995 | +** CAPI3REF: Determine The Virtual Table Conflict Policy | |
6996 | +** | |
6997 | +** This function may only be called from within a call to the [xUpdate] method | |
6998 | +** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The | |
6999 | +** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL], | |
7000 | +** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode | |
7001 | +** of the SQL statement that triggered the call to the [xUpdate] method of the | |
7002 | +** [virtual table]. | |
7003 | +*/ | |
7004 | +SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *); | |
7005 | + | |
7006 | +/* | |
7007 | +** CAPI3REF: Conflict resolution modes | |
7008 | +** | |
7009 | +** These constants are returned by [sqlite3_vtab_on_conflict()] to | |
7010 | +** inform a [virtual table] implementation what the [ON CONFLICT] mode | |
7011 | +** is for the SQL statement being evaluated. | |
7012 | +** | |
7013 | +** Note that the [SQLITE_IGNORE] constant is also used as a potential | |
7014 | +** return value from the [sqlite3_set_authorizer()] callback and that | |
7015 | +** [SQLITE_ABORT] is also a [result code]. | |
7016 | +*/ | |
7017 | +#define SQLITE_ROLLBACK 1 | |
7018 | +/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */ | |
7019 | +#define SQLITE_FAIL 3 | |
7020 | +/* #define SQLITE_ABORT 4 // Also an error code */ | |
7021 | +#define SQLITE_REPLACE 5 | |
7022 | + | |
7023 | + | |
7024 | + | |
7025 | +/* | |
7026 | +** Undo the hack that converts floating point types to integer for | |
7027 | +** builds on processors without floating point support. | |
7028 | +*/ | |
7029 | +#ifdef SQLITE_OMIT_FLOATING_POINT | |
7030 | +# undef double | |
7031 | +#endif | |
7032 | + | |
7033 | +#ifdef __cplusplus | |
7034 | +} /* End of the 'extern "C"' block */ | |
7035 | +#endif | |
7036 | +#endif | |
7037 | + | |
7038 | +/* | |
7039 | +** 2010 August 30 | |
7040 | +** | |
7041 | +** The author disclaims copyright to this source code. In place of | |
7042 | +** a legal notice, here is a blessing: | |
7043 | +** | |
7044 | +** May you do good and not evil. | |
7045 | +** May you find forgiveness for yourself and forgive others. | |
7046 | +** May you share freely, never taking more than you give. | |
7047 | +** | |
7048 | +************************************************************************* | |
7049 | +*/ | |
7050 | + | |
7051 | +#ifndef _SQLITE3RTREE_H_ | |
7052 | +#define _SQLITE3RTREE_H_ | |
7053 | + | |
7054 | + | |
7055 | +#ifdef __cplusplus | |
7056 | +extern "C" { | |
7057 | +#endif | |
7058 | + | |
7059 | +typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry; | |
7060 | + | |
7061 | +/* | |
7062 | +** Register a geometry callback named zGeom that can be used as part of an | |
7063 | +** R-Tree geometry query as follows: | |
7064 | +** | |
7065 | +** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...) | |
7066 | +*/ | |
7067 | +SQLITE_API int sqlite3_rtree_geometry_callback( | |
7068 | + sqlite3 *db, | |
7069 | + const char *zGeom, | |
7070 | +#ifdef SQLITE_RTREE_INT_ONLY | |
7071 | + int (*xGeom)(sqlite3_rtree_geometry*, int n, sqlite3_int64 *a, int *pRes), | |
7072 | +#else | |
7073 | + int (*xGeom)(sqlite3_rtree_geometry*, int n, double *a, int *pRes), | |
7074 | +#endif | |
7075 | + void *pContext | |
7076 | +); | |
7077 | + | |
7078 | + | |
7079 | +/* | |
7080 | +** A pointer to a structure of the following type is passed as the first | |
7081 | +** argument to callbacks registered using rtree_geometry_callback(). | |
7082 | +*/ | |
7083 | +struct sqlite3_rtree_geometry { | |
7084 | + void *pContext; /* Copy of pContext passed to s_r_g_c() */ | |
7085 | + int nParam; /* Size of array aParam[] */ | |
7086 | + double *aParam; /* Parameters passed to SQL geom function */ | |
7087 | + void *pUser; /* Callback implementation user data */ | |
7088 | + void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */ | |
7089 | +}; | |
7090 | + | |
7091 | + | |
7092 | +#ifdef __cplusplus | |
7093 | +} /* end of the 'extern "C"' block */ | |
7094 | +#endif | |
7095 | + | |
7096 | +#endif /* ifndef _SQLITE3RTREE_H_ */ | |
7097 | + |
@@ -0,0 +1,210 @@ | ||
1 | +<!DOCTYPE Project SYSTEM "http://www.slickedit.com/dtd/vse/10.0/vpj.dtd"> | |
2 | +<Project | |
3 | + Version="10.0" | |
4 | + VendorName="SlickEdit" | |
5 | + WorkingDir="." | |
6 | + AssociatedFile="core_dx.vcxproj" | |
7 | + AssociatedFileType="microsoft visual studio visual c++"> | |
8 | + <Config | |
9 | + Name="Debug|Win32" | |
10 | + Type="vcproj" | |
11 | + DebugCallbackName="windbg" | |
12 | + OutputFile="" | |
13 | + CompilerConfigName="Visual Studio 2010 Express"> | |
14 | + <Includes> | |
15 | + <Include Dir="%(INCLUDE)"/> | |
16 | + </Includes> | |
17 | + <Menu> | |
18 | + <Target | |
19 | + Name="Compile" | |
20 | + MenuCaption="&Compile" | |
21 | + CaptureOutputWith="ProcessBuffer" | |
22 | + SaveOption="SaveCurrent" | |
23 | + RunFromDir="%rw"> | |
24 | + <Exec CmdLine="vstudiocompile"/> | |
25 | + </Target> | |
26 | + <Target | |
27 | + Name="Build" | |
28 | + MenuCaption="&Build" | |
29 | + CaptureOutputWith="ProcessBuffer" | |
30 | + SaveOption="SaveWorkspaceFiles" | |
31 | + RunFromDir="%rw"> | |
32 | + <Exec CmdLine='devenv "%w" /build "%bn" /project "%rm" /projectconfig "%b"'/> | |
33 | + </Target> | |
34 | + <Target | |
35 | + Name="Rebuild" | |
36 | + MenuCaption="&Rebuild" | |
37 | + CaptureOutputWith="ProcessBuffer" | |
38 | + SaveOption="SaveWorkspaceFiles" | |
39 | + RunFromDir="%rw"> | |
40 | + <Exec CmdLine='devenv "%w" /rebuild "%bn" /project "%rm" /projectconfig "%b"'/> | |
41 | + </Target> | |
42 | + <Target | |
43 | + Name="Debug" | |
44 | + MenuCaption="&Debug" | |
45 | + SaveOption="SaveNone" | |
46 | + RunFromDir="%rw"> | |
47 | + <Exec | |
48 | + CmdLine="vcproj_visual_studio_debug" | |
49 | + Type="Slick-C"/> | |
50 | + </Target> | |
51 | + <Target | |
52 | + Name="DebugVisualStudio" | |
53 | + MenuCaption="Debug - Visual Studio" | |
54 | + SaveOption="SaveNone" | |
55 | + RunFromDir="%rw"> | |
56 | + <Exec CmdLine='devenv "%w"'/> | |
57 | + </Target> | |
58 | + <Target | |
59 | + Name="DebugWinDbg" | |
60 | + MenuCaption="Debug - WinDbg" | |
61 | + SaveOption="SaveNone" | |
62 | + RunFromDir="%rw"> | |
63 | + <Exec | |
64 | + CmdLine="vcproj_windbg_debug" | |
65 | + Type="Slick-C"/> | |
66 | + </Target> | |
67 | + <Target | |
68 | + Name="Execute" | |
69 | + MenuCaption="E&xecute" | |
70 | + SaveOption="SaveNone" | |
71 | + RunFromDir="%rw"> | |
72 | + <Exec CmdLine='"%o"'/> | |
73 | + </Target> | |
74 | + <Target | |
75 | + Name="Resource Editor" | |
76 | + MenuCaption="Resource Editor" | |
77 | + ShowOnMenu="HideIfNoCmdLine" | |
78 | + SaveOption="SaveWorkspaceFiles" | |
79 | + RunFromDir="%rw"> | |
80 | + <Exec CmdLine="devenv"/> | |
81 | + </Target> | |
82 | + <Target | |
83 | + Name="Build Solution" | |
84 | + MenuCaption="Build Solution" | |
85 | + ShowOnMenu="HideIfNoCmdLine" | |
86 | + CaptureOutputWith="ProcessBuffer" | |
87 | + SaveOption="SaveWorkspaceFiles" | |
88 | + RunFromDir="%rw"> | |
89 | + <Exec CmdLine='devenv "%w" /build "%bn"'/> | |
90 | + </Target> | |
91 | + <Target | |
92 | + Name="Clean Solution" | |
93 | + MenuCaption="Clean Solution" | |
94 | + CaptureOutputWith="ProcessBuffer" | |
95 | + SaveOption="SaveNone" | |
96 | + RunFromDir="%rw"> | |
97 | + <Exec CmdLine='devenv "%w" /clean "%bn"'/> | |
98 | + </Target> | |
99 | + <Target | |
100 | + Name="Clean Project" | |
101 | + MenuCaption="Clean Project" | |
102 | + CaptureOutputWith="ProcessBuffer" | |
103 | + SaveOption="SaveNone" | |
104 | + RunFromDir="%rw"> | |
105 | + <Exec CmdLine='devenv "%w" /clean "%bn" /project "%rm" /projectconfig "%b"'/> | |
106 | + </Target> | |
107 | + </Menu> | |
108 | + </Config> | |
109 | + <Config | |
110 | + Name="Release|Win32" | |
111 | + Type="vcproj" | |
112 | + DebugCallbackName="windbg" | |
113 | + OutputFile="" | |
114 | + CompilerConfigName="Visual Studio 2010 Express"> | |
115 | + <Includes> | |
116 | + <Include Dir="%(INCLUDE)"/> | |
117 | + </Includes> | |
118 | + <Menu> | |
119 | + <Target | |
120 | + Name="Compile" | |
121 | + MenuCaption="&Compile" | |
122 | + CaptureOutputWith="ProcessBuffer" | |
123 | + SaveOption="SaveCurrent" | |
124 | + RunFromDir="%rw"> | |
125 | + <Exec CmdLine="vstudiocompile"/> | |
126 | + </Target> | |
127 | + <Target | |
128 | + Name="Build" | |
129 | + MenuCaption="&Build" | |
130 | + CaptureOutputWith="ProcessBuffer" | |
131 | + SaveOption="SaveWorkspaceFiles" | |
132 | + RunFromDir="%rw"> | |
133 | + <Exec CmdLine='devenv "%w" /build "%bn" /project "%rm" /projectconfig "%b"'/> | |
134 | + </Target> | |
135 | + <Target | |
136 | + Name="Rebuild" | |
137 | + MenuCaption="&Rebuild" | |
138 | + CaptureOutputWith="ProcessBuffer" | |
139 | + SaveOption="SaveWorkspaceFiles" | |
140 | + RunFromDir="%rw"> | |
141 | + <Exec CmdLine='devenv "%w" /rebuild "%bn" /project "%rm" /projectconfig "%b"'/> | |
142 | + </Target> | |
143 | + <Target | |
144 | + Name="Debug" | |
145 | + MenuCaption="&Debug" | |
146 | + SaveOption="SaveNone" | |
147 | + RunFromDir="%rw"> | |
148 | + <Exec | |
149 | + CmdLine="vcproj_visual_studio_debug" | |
150 | + Type="Slick-C"/> | |
151 | + </Target> | |
152 | + <Target | |
153 | + Name="DebugVisualStudio" | |
154 | + MenuCaption="Debug - Visual Studio" | |
155 | + SaveOption="SaveNone" | |
156 | + RunFromDir="%rw"> | |
157 | + <Exec CmdLine='devenv "%w"'/> | |
158 | + </Target> | |
159 | + <Target | |
160 | + Name="DebugWinDbg" | |
161 | + MenuCaption="Debug - WinDbg" | |
162 | + SaveOption="SaveNone" | |
163 | + RunFromDir="%rw"> | |
164 | + <Exec | |
165 | + CmdLine="vcproj_windbg_debug" | |
166 | + Type="Slick-C"/> | |
167 | + </Target> | |
168 | + <Target | |
169 | + Name="Execute" | |
170 | + MenuCaption="E&xecute" | |
171 | + SaveOption="SaveNone" | |
172 | + RunFromDir="%rw"> | |
173 | + <Exec CmdLine='"%o"'/> | |
174 | + </Target> | |
175 | + <Target | |
176 | + Name="Resource Editor" | |
177 | + MenuCaption="Resource Editor" | |
178 | + ShowOnMenu="HideIfNoCmdLine" | |
179 | + SaveOption="SaveWorkspaceFiles" | |
180 | + RunFromDir="%rw"> | |
181 | + <Exec CmdLine="devenv"/> | |
182 | + </Target> | |
183 | + <Target | |
184 | + Name="Build Solution" | |
185 | + MenuCaption="Build Solution" | |
186 | + ShowOnMenu="HideIfNoCmdLine" | |
187 | + CaptureOutputWith="ProcessBuffer" | |
188 | + SaveOption="SaveWorkspaceFiles" | |
189 | + RunFromDir="%rw"> | |
190 | + <Exec CmdLine='devenv "%w" /build "%bn"'/> | |
191 | + </Target> | |
192 | + <Target | |
193 | + Name="Clean Solution" | |
194 | + MenuCaption="Clean Solution" | |
195 | + CaptureOutputWith="ProcessBuffer" | |
196 | + SaveOption="SaveNone" | |
197 | + RunFromDir="%rw"> | |
198 | + <Exec CmdLine='devenv "%w" /clean "%bn"'/> | |
199 | + </Target> | |
200 | + <Target | |
201 | + Name="Clean Project" | |
202 | + MenuCaption="Clean Project" | |
203 | + CaptureOutputWith="ProcessBuffer" | |
204 | + SaveOption="SaveNone" | |
205 | + RunFromDir="%rw"> | |
206 | + <Exec CmdLine='devenv "%w" /clean "%bn" /project "%rm" /projectconfig "%b"'/> | |
207 | + </Target> | |
208 | + </Menu> | |
209 | + </Config> | |
210 | +</Project> |
@@ -0,0 +1,210 @@ | ||
1 | +<!DOCTYPE Project SYSTEM "http://www.slickedit.com/dtd/vse/10.0/vpj.dtd"> | |
2 | +<Project | |
3 | + Version="10.0" | |
4 | + VendorName="SlickEdit" | |
5 | + WorkingDir="." | |
6 | + AssociatedFile="util_dx.vcxproj" | |
7 | + AssociatedFileType="microsoft visual studio visual c++"> | |
8 | + <Config | |
9 | + Name="Debug|Win32" | |
10 | + Type="vcproj" | |
11 | + DebugCallbackName="windbg" | |
12 | + OutputFile="" | |
13 | + CompilerConfigName="Visual Studio 2010 Express"> | |
14 | + <Includes> | |
15 | + <Include Dir="%(INCLUDE)"/> | |
16 | + </Includes> | |
17 | + <Menu> | |
18 | + <Target | |
19 | + Name="Compile" | |
20 | + MenuCaption="&Compile" | |
21 | + CaptureOutputWith="ProcessBuffer" | |
22 | + SaveOption="SaveCurrent" | |
23 | + RunFromDir="%rw"> | |
24 | + <Exec CmdLine="vstudiocompile"/> | |
25 | + </Target> | |
26 | + <Target | |
27 | + Name="Build" | |
28 | + MenuCaption="&Build" | |
29 | + CaptureOutputWith="ProcessBuffer" | |
30 | + SaveOption="SaveWorkspaceFiles" | |
31 | + RunFromDir="%rw"> | |
32 | + <Exec CmdLine='devenv "%w" /build "%bn" /project "%rm" /projectconfig "%b"'/> | |
33 | + </Target> | |
34 | + <Target | |
35 | + Name="Rebuild" | |
36 | + MenuCaption="&Rebuild" | |
37 | + CaptureOutputWith="ProcessBuffer" | |
38 | + SaveOption="SaveWorkspaceFiles" | |
39 | + RunFromDir="%rw"> | |
40 | + <Exec CmdLine='devenv "%w" /rebuild "%bn" /project "%rm" /projectconfig "%b"'/> | |
41 | + </Target> | |
42 | + <Target | |
43 | + Name="Debug" | |
44 | + MenuCaption="&Debug" | |
45 | + SaveOption="SaveNone" | |
46 | + RunFromDir="%rw"> | |
47 | + <Exec | |
48 | + CmdLine="vcproj_visual_studio_debug" | |
49 | + Type="Slick-C"/> | |
50 | + </Target> | |
51 | + <Target | |
52 | + Name="DebugVisualStudio" | |
53 | + MenuCaption="Debug - Visual Studio" | |
54 | + SaveOption="SaveNone" | |
55 | + RunFromDir="%rw"> | |
56 | + <Exec CmdLine='devenv "%w"'/> | |
57 | + </Target> | |
58 | + <Target | |
59 | + Name="DebugWinDbg" | |
60 | + MenuCaption="Debug - WinDbg" | |
61 | + SaveOption="SaveNone" | |
62 | + RunFromDir="%rw"> | |
63 | + <Exec | |
64 | + CmdLine="vcproj_windbg_debug" | |
65 | + Type="Slick-C"/> | |
66 | + </Target> | |
67 | + <Target | |
68 | + Name="Execute" | |
69 | + MenuCaption="E&xecute" | |
70 | + SaveOption="SaveNone" | |
71 | + RunFromDir="%rw"> | |
72 | + <Exec CmdLine='"%o"'/> | |
73 | + </Target> | |
74 | + <Target | |
75 | + Name="Resource Editor" | |
76 | + MenuCaption="Resource Editor" | |
77 | + ShowOnMenu="HideIfNoCmdLine" | |
78 | + SaveOption="SaveWorkspaceFiles" | |
79 | + RunFromDir="%rw"> | |
80 | + <Exec CmdLine="devenv"/> | |
81 | + </Target> | |
82 | + <Target | |
83 | + Name="Build Solution" | |
84 | + MenuCaption="Build Solution" | |
85 | + ShowOnMenu="HideIfNoCmdLine" | |
86 | + CaptureOutputWith="ProcessBuffer" | |
87 | + SaveOption="SaveWorkspaceFiles" | |
88 | + RunFromDir="%rw"> | |
89 | + <Exec CmdLine='devenv "%w" /build "%bn"'/> | |
90 | + </Target> | |
91 | + <Target | |
92 | + Name="Clean Solution" | |
93 | + MenuCaption="Clean Solution" | |
94 | + CaptureOutputWith="ProcessBuffer" | |
95 | + SaveOption="SaveNone" | |
96 | + RunFromDir="%rw"> | |
97 | + <Exec CmdLine='devenv "%w" /clean "%bn"'/> | |
98 | + </Target> | |
99 | + <Target | |
100 | + Name="Clean Project" | |
101 | + MenuCaption="Clean Project" | |
102 | + CaptureOutputWith="ProcessBuffer" | |
103 | + SaveOption="SaveNone" | |
104 | + RunFromDir="%rw"> | |
105 | + <Exec CmdLine='devenv "%w" /clean "%bn" /project "%rm" /projectconfig "%b"'/> | |
106 | + </Target> | |
107 | + </Menu> | |
108 | + </Config> | |
109 | + <Config | |
110 | + Name="Release|Win32" | |
111 | + Type="vcproj" | |
112 | + DebugCallbackName="windbg" | |
113 | + OutputFile="" | |
114 | + CompilerConfigName="Visual Studio 2010 Express"> | |
115 | + <Includes> | |
116 | + <Include Dir="%(INCLUDE)"/> | |
117 | + </Includes> | |
118 | + <Menu> | |
119 | + <Target | |
120 | + Name="Compile" |