blob: 5c4c321b394b2912e8d72533d5f175a419a7abd4 [file] [log] [blame]
drh4f26d6c2004-05-26 23:25:30 +00001/*
2** 2004 May 26
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**
13** This file contains code use to implement APIs that are part of the
14** VDBE.
15*/
16#include "sqliteInt.h"
17#include "vdbeInt.h"
18
shaneeec556d2008-10-12 00:27:53 +000019#ifndef SQLITE_OMIT_DEPRECATED
drhd89bd002005-01-22 03:03:54 +000020/*
21** Return TRUE (non-zero) of the statement supplied as an argument needs
22** to be recompiled. A statement needs to be recompiled whenever the
23** execution environment changes in a way that would alter the program
24** that sqlite3_prepare() generates. For example, if new functions or
25** collating sequences are registered or if an authorizer function is
26** added or changed.
drhd89bd002005-01-22 03:03:54 +000027*/
28int sqlite3_expired(sqlite3_stmt *pStmt){
29 Vdbe *p = (Vdbe*)pStmt;
30 return p==0 || p->expired;
31}
shaneeec556d2008-10-12 00:27:53 +000032#endif
drhd89bd002005-01-22 03:03:54 +000033
drhe30f4422007-08-21 16:15:55 +000034/*
drh413c3d32010-02-23 20:11:56 +000035** Check on a Vdbe to make sure it has not been finalized. Log
36** an error and return true if it has been finalized (or is otherwise
37** invalid). Return false if it is ok.
38*/
39static int vdbeSafety(Vdbe *p){
40 if( p->db==0 ){
41 sqlite3_log(SQLITE_MISUSE, "API called with finalized prepared statement");
42 return 1;
43 }else{
44 return 0;
45 }
46}
47static int vdbeSafetyNotNull(Vdbe *p){
48 if( p==0 ){
49 sqlite3_log(SQLITE_MISUSE, "API called with NULL prepared statement");
50 return 1;
51 }else{
52 return vdbeSafety(p);
53 }
54}
55
drh201e0c62015-07-14 14:48:50 +000056#ifndef SQLITE_OMIT_TRACE
57/*
58** Invoke the profile callback. This routine is only called if we already
59** know that the profile callback is defined and needs to be invoked.
60*/
61static SQLITE_NOINLINE void invokeProfileCallback(sqlite3 *db, Vdbe *p){
62 sqlite3_int64 iNow;
drh3d2a5292016-07-13 22:55:01 +000063 sqlite3_int64 iElapse;
drh201e0c62015-07-14 14:48:50 +000064 assert( p->startTime>0 );
drh04c67472018-12-04 14:33:02 +000065 assert( (db->mTrace & (SQLITE_TRACE_PROFILE|SQLITE_TRACE_XPROFILE))!=0 );
drh201e0c62015-07-14 14:48:50 +000066 assert( db->init.busy==0 );
67 assert( p->zSql!=0 );
68 sqlite3OsCurrentTimeInt64(db->pVfs, &iNow);
drh3d2a5292016-07-13 22:55:01 +000069 iElapse = (iNow - p->startTime)*1000000;
drh07891f02019-04-14 00:40:29 +000070#ifndef SQLITE_OMIT_DEPRECATED
drh3d2a5292016-07-13 22:55:01 +000071 if( db->xProfile ){
72 db->xProfile(db->pProfileArg, p->zSql, iElapse);
73 }
drh04c67472018-12-04 14:33:02 +000074#endif
drh3d2a5292016-07-13 22:55:01 +000075 if( db->mTrace & SQLITE_TRACE_PROFILE ){
drh08b92082020-08-10 14:18:00 +000076 db->trace.xV2(SQLITE_TRACE_PROFILE, db->pTraceArg, p, (void*)&iElapse);
drh3d2a5292016-07-13 22:55:01 +000077 }
drh201e0c62015-07-14 14:48:50 +000078 p->startTime = 0;
79}
80/*
81** The checkProfileCallback(DB,P) macro checks to see if a profile callback
82** is needed, and it invokes the callback if it is needed.
83*/
84# define checkProfileCallback(DB,P) \
85 if( ((P)->startTime)>0 ){ invokeProfileCallback(DB,P); }
86#else
87# define checkProfileCallback(DB,P) /*no-op*/
88#endif
89
drh413c3d32010-02-23 20:11:56 +000090/*
drhe30f4422007-08-21 16:15:55 +000091** The following routine destroys a virtual machine that is created by
92** the sqlite3_compile() routine. The integer returned is an SQLITE_
93** success/failure code that describes the result of executing the virtual
94** machine.
95**
96** This routine sets the error code and string returned by
97** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
98*/
99int sqlite3_finalize(sqlite3_stmt *pStmt){
100 int rc;
101 if( pStmt==0 ){
drh65bafa62010-09-29 01:54:00 +0000102 /* IMPLEMENTATION-OF: R-57228-12904 Invoking sqlite3_finalize() on a NULL
103 ** pointer is a harmless no-op. */
drhe30f4422007-08-21 16:15:55 +0000104 rc = SQLITE_OK;
105 }else{
106 Vdbe *v = (Vdbe*)pStmt;
danielk1977238746a2009-03-19 18:51:06 +0000107 sqlite3 *db = v->db;
drh413c3d32010-02-23 20:11:56 +0000108 if( vdbeSafety(v) ) return SQLITE_MISUSE_BKPT;
drh4245c402012-06-02 14:32:21 +0000109 sqlite3_mutex_enter(db->mutex);
drh201e0c62015-07-14 14:48:50 +0000110 checkProfileCallback(db, v);
drhe30f4422007-08-21 16:15:55 +0000111 rc = sqlite3VdbeFinalize(v);
danielk1977238746a2009-03-19 18:51:06 +0000112 rc = sqlite3ApiExit(db, rc);
drh4245c402012-06-02 14:32:21 +0000113 sqlite3LeaveMutexAndCloseZombie(db);
drhe30f4422007-08-21 16:15:55 +0000114 }
115 return rc;
116}
117
118/*
119** Terminate the current execution of an SQL statement and reset it
120** back to its starting state so that it can be reused. A success code from
121** the prior execution is returned.
122**
123** This routine sets the error code and string returned by
124** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
125*/
126int sqlite3_reset(sqlite3_stmt *pStmt){
127 int rc;
128 if( pStmt==0 ){
129 rc = SQLITE_OK;
130 }else{
131 Vdbe *v = (Vdbe*)pStmt;
drh201e0c62015-07-14 14:48:50 +0000132 sqlite3 *db = v->db;
133 sqlite3_mutex_enter(db->mutex);
134 checkProfileCallback(db, v);
drhc890fec2008-08-01 20:10:08 +0000135 rc = sqlite3VdbeReset(v);
drh124c0b42011-06-01 18:15:55 +0000136 sqlite3VdbeRewind(v);
drh201e0c62015-07-14 14:48:50 +0000137 assert( (rc & (db->errMask))==rc );
138 rc = sqlite3ApiExit(db, rc);
139 sqlite3_mutex_leave(db->mutex);
drhe30f4422007-08-21 16:15:55 +0000140 }
141 return rc;
142}
143
144/*
145** Set all the parameters in the compiled SQL statement to NULL.
146*/
147int sqlite3_clear_bindings(sqlite3_stmt *pStmt){
148 int i;
149 int rc = SQLITE_OK;
drh7297d1f2008-05-09 14:39:44 +0000150 Vdbe *p = (Vdbe*)pStmt;
drh18472fa2008-10-07 15:25:48 +0000151#if SQLITE_THREADSAFE
drh7e8b8482008-01-23 03:03:05 +0000152 sqlite3_mutex *mutex = ((Vdbe*)pStmt)->db->mutex;
153#endif
154 sqlite3_mutex_enter(mutex);
drh7297d1f2008-05-09 14:39:44 +0000155 for(i=0; i<p->nVar; i++){
156 sqlite3VdbeMemRelease(&p->aVar[i]);
157 p->aVar[i].flags = MEM_Null;
drhe30f4422007-08-21 16:15:55 +0000158 }
drh2c2f3922017-06-01 00:54:35 +0000159 assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || p->expmask==0 );
danbda4cb82017-02-23 16:30:16 +0000160 if( p->expmask ){
danc94b8592009-10-20 07:01:24 +0000161 p->expired = 1;
162 }
drh7e8b8482008-01-23 03:03:05 +0000163 sqlite3_mutex_leave(mutex);
drhe30f4422007-08-21 16:15:55 +0000164 return rc;
165}
166
167
drh4f26d6c2004-05-26 23:25:30 +0000168/**************************** sqlite3_value_ *******************************
169** The following routines extract information from a Mem or sqlite3_value
170** structure.
171*/
172const void *sqlite3_value_blob(sqlite3_value *pVal){
173 Mem *p = (Mem*)pVal;
174 if( p->flags & (MEM_Blob|MEM_Str) ){
drhff535a22016-09-20 01:46:15 +0000175 if( ExpandBlob(p)!=SQLITE_OK ){
dana4d5ae82015-07-24 16:24:37 +0000176 assert( p->flags==MEM_Null && p->z==0 );
177 return 0;
178 }
drh1f0feef2007-05-15 13:27:07 +0000179 p->flags |= MEM_Blob;
drh42262532010-09-08 16:30:36 +0000180 return p->n ? p->z : 0;
drh4f26d6c2004-05-26 23:25:30 +0000181 }else{
182 return sqlite3_value_text(pVal);
183 }
184}
185int sqlite3_value_bytes(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000186 return sqlite3ValueBytes(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000187}
188int sqlite3_value_bytes16(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000189 return sqlite3ValueBytes(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000190}
191double sqlite3_value_double(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000192 return sqlite3VdbeRealValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000193}
194int sqlite3_value_int(sqlite3_value *pVal){
drhb27b7f52008-12-10 18:03:45 +0000195 return (int)sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000196}
drhefad9992004-06-22 12:13:55 +0000197sqlite_int64 sqlite3_value_int64(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000198 return sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000199}
drhbcdf78a2015-09-10 20:34:56 +0000200unsigned int sqlite3_value_subtype(sqlite3_value *pVal){
dan5b6c8e42016-01-30 15:46:03 +0000201 Mem *pMem = (Mem*)pVal;
202 return ((pMem->flags & MEM_Subtype) ? pMem->eSubtype : 0);
drhbcdf78a2015-09-10 20:34:56 +0000203}
drhae3ec3f2017-07-17 00:40:19 +0000204void *sqlite3_value_pointer(sqlite3_value *pVal, const char *zPType){
drh3a96a5d2017-06-30 23:09:03 +0000205 Mem *p = (Mem*)pVal;
drha0024e62017-07-27 15:53:24 +0000206 if( (p->flags&(MEM_TypeMask|MEM_Term|MEM_Subtype)) ==
207 (MEM_Null|MEM_Term|MEM_Subtype)
drhae3ec3f2017-07-17 00:40:19 +0000208 && zPType!=0
drha0024e62017-07-27 15:53:24 +0000209 && p->eSubtype=='p'
drh22930062017-07-27 03:48:02 +0000210 && strcmp(p->u.zPType, zPType)==0
drhae3ec3f2017-07-17 00:40:19 +0000211 ){
drh22930062017-07-27 03:48:02 +0000212 return (void*)p->z;
drh3a96a5d2017-06-30 23:09:03 +0000213 }else{
214 return 0;
215 }
216}
drh4f26d6c2004-05-26 23:25:30 +0000217const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000218 return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000219}
drh6c626082004-11-14 21:56:29 +0000220#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000221const void *sqlite3_value_text16(sqlite3_value* pVal){
drhb21c8cd2007-08-21 19:33:56 +0000222 return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000223}
danielk1977d8123362004-06-12 09:25:12 +0000224const void *sqlite3_value_text16be(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000225 return sqlite3ValueText(pVal, SQLITE_UTF16BE);
danielk1977d8123362004-06-12 09:25:12 +0000226}
227const void *sqlite3_value_text16le(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000228 return sqlite3ValueText(pVal, SQLITE_UTF16LE);
danielk1977d8123362004-06-12 09:25:12 +0000229}
drh6c626082004-11-14 21:56:29 +0000230#endif /* SQLITE_OMIT_UTF16 */
drh22ec1342015-02-27 00:33:15 +0000231/* EVIDENCE-OF: R-12793-43283 Every value in SQLite has one of five
232** fundamental datatypes: 64-bit signed integer 64-bit IEEE floating
233** point number string BLOB NULL
234*/
drh4f26d6c2004-05-26 23:25:30 +0000235int sqlite3_value_type(sqlite3_value* pVal){
drh1b27b8c2014-02-10 03:21:57 +0000236 static const u8 aType[] = {
drhf2566c42019-05-03 17:08:16 +0000237 SQLITE_BLOB, /* 0x00 (not possible) */
238 SQLITE_NULL, /* 0x01 NULL */
239 SQLITE_TEXT, /* 0x02 TEXT */
240 SQLITE_NULL, /* 0x03 (not possible) */
241 SQLITE_INTEGER, /* 0x04 INTEGER */
242 SQLITE_NULL, /* 0x05 (not possible) */
243 SQLITE_INTEGER, /* 0x06 INTEGER + TEXT */
244 SQLITE_NULL, /* 0x07 (not possible) */
245 SQLITE_FLOAT, /* 0x08 FLOAT */
246 SQLITE_NULL, /* 0x09 (not possible) */
247 SQLITE_FLOAT, /* 0x0a FLOAT + TEXT */
248 SQLITE_NULL, /* 0x0b (not possible) */
249 SQLITE_INTEGER, /* 0x0c (not possible) */
250 SQLITE_NULL, /* 0x0d (not possible) */
251 SQLITE_INTEGER, /* 0x0e (not possible) */
252 SQLITE_NULL, /* 0x0f (not possible) */
253 SQLITE_BLOB, /* 0x10 BLOB */
254 SQLITE_NULL, /* 0x11 (not possible) */
255 SQLITE_TEXT, /* 0x12 (not possible) */
256 SQLITE_NULL, /* 0x13 (not possible) */
257 SQLITE_INTEGER, /* 0x14 INTEGER + BLOB */
258 SQLITE_NULL, /* 0x15 (not possible) */
259 SQLITE_INTEGER, /* 0x16 (not possible) */
260 SQLITE_NULL, /* 0x17 (not possible) */
261 SQLITE_FLOAT, /* 0x18 FLOAT + BLOB */
262 SQLITE_NULL, /* 0x19 (not possible) */
263 SQLITE_FLOAT, /* 0x1a (not possible) */
264 SQLITE_NULL, /* 0x1b (not possible) */
265 SQLITE_INTEGER, /* 0x1c (not possible) */
266 SQLITE_NULL, /* 0x1d (not possible) */
267 SQLITE_INTEGER, /* 0x1e (not possible) */
268 SQLITE_NULL, /* 0x1f (not possible) */
269 SQLITE_FLOAT, /* 0x20 INTREAL */
270 SQLITE_NULL, /* 0x21 (not possible) */
271 SQLITE_TEXT, /* 0x22 INTREAL + TEXT */
272 SQLITE_NULL, /* 0x23 (not possible) */
273 SQLITE_FLOAT, /* 0x24 (not possible) */
274 SQLITE_NULL, /* 0x25 (not possible) */
275 SQLITE_FLOAT, /* 0x26 (not possible) */
276 SQLITE_NULL, /* 0x27 (not possible) */
277 SQLITE_FLOAT, /* 0x28 (not possible) */
278 SQLITE_NULL, /* 0x29 (not possible) */
279 SQLITE_FLOAT, /* 0x2a (not possible) */
280 SQLITE_NULL, /* 0x2b (not possible) */
281 SQLITE_FLOAT, /* 0x2c (not possible) */
282 SQLITE_NULL, /* 0x2d (not possible) */
283 SQLITE_FLOAT, /* 0x2e (not possible) */
284 SQLITE_NULL, /* 0x2f (not possible) */
285 SQLITE_BLOB, /* 0x30 (not possible) */
286 SQLITE_NULL, /* 0x31 (not possible) */
287 SQLITE_TEXT, /* 0x32 (not possible) */
288 SQLITE_NULL, /* 0x33 (not possible) */
289 SQLITE_FLOAT, /* 0x34 (not possible) */
290 SQLITE_NULL, /* 0x35 (not possible) */
291 SQLITE_FLOAT, /* 0x36 (not possible) */
292 SQLITE_NULL, /* 0x37 (not possible) */
293 SQLITE_FLOAT, /* 0x38 (not possible) */
294 SQLITE_NULL, /* 0x39 (not possible) */
295 SQLITE_FLOAT, /* 0x3a (not possible) */
296 SQLITE_NULL, /* 0x3b (not possible) */
297 SQLITE_FLOAT, /* 0x3c (not possible) */
298 SQLITE_NULL, /* 0x3d (not possible) */
299 SQLITE_FLOAT, /* 0x3e (not possible) */
300 SQLITE_NULL, /* 0x3f (not possible) */
drh1b27b8c2014-02-10 03:21:57 +0000301 };
drhde7109e2019-05-02 17:45:52 +0000302#ifdef SQLITE_DEBUG
303 {
304 int eType = SQLITE_BLOB;
305 if( pVal->flags & MEM_Null ){
306 eType = SQLITE_NULL;
drh169f0772019-05-02 21:36:26 +0000307 }else if( pVal->flags & (MEM_Real|MEM_IntReal) ){
drhde7109e2019-05-02 17:45:52 +0000308 eType = SQLITE_FLOAT;
drh169f0772019-05-02 21:36:26 +0000309 }else if( pVal->flags & MEM_Int ){
310 eType = SQLITE_INTEGER;
drhde7109e2019-05-02 17:45:52 +0000311 }else if( pVal->flags & MEM_Str ){
312 eType = SQLITE_TEXT;
313 }
314 assert( eType == aType[pVal->flags&MEM_AffMask] );
315 }
316#endif
mistachkinafc14f72014-03-05 01:29:18 +0000317 return aType[pVal->flags&MEM_AffMask];
drh4f26d6c2004-05-26 23:25:30 +0000318}
319
drhce2fbd12018-01-12 21:00:14 +0000320/* Return true if a parameter to xUpdate represents an unchanged column */
321int sqlite3_value_nochange(sqlite3_value *pVal){
322 return (pVal->flags&(MEM_Null|MEM_Zero))==(MEM_Null|MEM_Zero);
323}
324
drh57b1a3e2019-03-29 11:13:37 +0000325/* Return true if a parameter value originated from an sqlite3_bind() */
326int sqlite3_value_frombind(sqlite3_value *pVal){
327 return (pVal->flags&MEM_FromBind)!=0;
328}
329
drh4f03f412015-05-20 21:28:32 +0000330/* Make a copy of an sqlite3_value object
331*/
332sqlite3_value *sqlite3_value_dup(const sqlite3_value *pOrig){
333 sqlite3_value *pNew;
334 if( pOrig==0 ) return 0;
335 pNew = sqlite3_malloc( sizeof(*pNew) );
336 if( pNew==0 ) return 0;
337 memset(pNew, 0, sizeof(*pNew));
338 memcpy(pNew, pOrig, MEMCELLSIZE);
339 pNew->flags &= ~MEM_Dyn;
340 pNew->db = 0;
341 if( pNew->flags&(MEM_Str|MEM_Blob) ){
drh10ca5b42015-05-22 21:04:54 +0000342 pNew->flags &= ~(MEM_Static|MEM_Dyn);
343 pNew->flags |= MEM_Ephem;
344 if( sqlite3VdbeMemMakeWriteable(pNew)!=SQLITE_OK ){
345 sqlite3ValueFree(pNew);
346 pNew = 0;
drh4f03f412015-05-20 21:28:32 +0000347 }
348 }
349 return pNew;
350}
351
352/* Destroy an sqlite3_value object previously obtained from
353** sqlite3_value_dup().
354*/
355void sqlite3_value_free(sqlite3_value *pOld){
356 sqlite3ValueFree(pOld);
357}
358
359
drh4f26d6c2004-05-26 23:25:30 +0000360/**************************** sqlite3_result_ *******************************
361** The following routines are used by user-defined functions to specify
362** the function result.
drh4c8555f2009-06-25 01:47:11 +0000363**
peter.d.reid60ec9142014-09-06 16:39:46 +0000364** The setStrOrError() function calls sqlite3VdbeMemSetStr() to store the
drhdbe349d2021-10-13 13:00:34 +0000365** result as a string or blob. Appropriate errors are set if the string/blob
366** is too big or if an OOM occurs.
drhda4ca9d2014-09-09 17:27:35 +0000367**
368** The invokeValueDestructor(P,X) routine invokes destructor function X()
369** on value P is not going to be used and need to be destroyed.
drh4f26d6c2004-05-26 23:25:30 +0000370*/
drh4c8555f2009-06-25 01:47:11 +0000371static void setResultStrOrError(
372 sqlite3_context *pCtx, /* Function context */
373 const char *z, /* String pointer */
374 int n, /* Bytes in string, or negative */
375 u8 enc, /* Encoding of z. 0 for BLOBs */
376 void (*xDel)(void*) /* Destructor function */
377){
drhdbe349d2021-10-13 13:00:34 +0000378 int rc = sqlite3VdbeMemSetStr(pCtx->pOut, z, n, enc, xDel);
379 if( rc ){
380 if( rc==SQLITE_TOOBIG ){
381 sqlite3_result_error_toobig(pCtx);
382 }else{
383 /* The only errors possible from sqlite3VdbeMemSetStr are
384 ** SQLITE_TOOBIG and SQLITE_NOMEM */
385 assert( rc==SQLITE_NOMEM );
386 sqlite3_result_error_nomem(pCtx);
387 }
drh4c8555f2009-06-25 01:47:11 +0000388 }
389}
drhda4ca9d2014-09-09 17:27:35 +0000390static int invokeValueDestructor(
391 const void *p, /* Value to destroy */
392 void (*xDel)(void*), /* The destructor */
393 sqlite3_context *pCtx /* Set a SQLITE_TOOBIG error if no NULL */
394){
drhfc59a952014-09-11 23:34:55 +0000395 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000396 if( xDel==0 ){
397 /* noop */
398 }else if( xDel==SQLITE_TRANSIENT ){
399 /* noop */
drhda4ca9d2014-09-09 17:27:35 +0000400 }else{
401 xDel((void*)p);
402 }
drhd6228552021-06-09 14:45:02 +0000403 sqlite3_result_error_toobig(pCtx);
drhda4ca9d2014-09-09 17:27:35 +0000404 return SQLITE_TOOBIG;
405}
drh4f26d6c2004-05-26 23:25:30 +0000406void sqlite3_result_blob(
407 sqlite3_context *pCtx,
408 const void *z,
409 int n,
danielk1977d8123362004-06-12 09:25:12 +0000410 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000411){
drh5708d2d2005-06-22 10:53:59 +0000412 assert( n>=0 );
drh9bd038f2014-08-27 14:14:06 +0000413 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000414 setResultStrOrError(pCtx, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000415}
drhda4ca9d2014-09-09 17:27:35 +0000416void sqlite3_result_blob64(
417 sqlite3_context *pCtx,
418 const void *z,
419 sqlite3_uint64 n,
420 void (*xDel)(void *)
421){
422 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000423 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000424 if( n>0x7fffffff ){
425 (void)invokeValueDestructor(z, xDel, pCtx);
426 }else{
427 setResultStrOrError(pCtx, z, (int)n, 0, xDel);
428 }
429}
drh4f26d6c2004-05-26 23:25:30 +0000430void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
drh9bd038f2014-08-27 14:14:06 +0000431 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
432 sqlite3VdbeMemSetDouble(pCtx->pOut, rVal);
drh4f26d6c2004-05-26 23:25:30 +0000433}
434void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000435 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000436 pCtx->isError = SQLITE_ERROR;
drh9bd038f2014-08-27 14:14:06 +0000437 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000438}
danielk1977a1686c92006-01-23 07:52:37 +0000439#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000440void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000441 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000442 pCtx->isError = SQLITE_ERROR;
drh9bd038f2014-08-27 14:14:06 +0000443 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000444}
danielk1977a1686c92006-01-23 07:52:37 +0000445#endif
drhf4479502004-05-27 03:12:53 +0000446void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh9bd038f2014-08-27 14:14:06 +0000447 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
448 sqlite3VdbeMemSetInt64(pCtx->pOut, (i64)iVal);
drh4f26d6c2004-05-26 23:25:30 +0000449}
450void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
drh9bd038f2014-08-27 14:14:06 +0000451 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
452 sqlite3VdbeMemSetInt64(pCtx->pOut, iVal);
drh4f26d6c2004-05-26 23:25:30 +0000453}
454void sqlite3_result_null(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000455 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
456 sqlite3VdbeMemSetNull(pCtx->pOut);
drh4f26d6c2004-05-26 23:25:30 +0000457}
drh22930062017-07-27 03:48:02 +0000458void sqlite3_result_pointer(
459 sqlite3_context *pCtx,
460 void *pPtr,
461 const char *zPType,
462 void (*xDestructor)(void*)
463){
drh3a96a5d2017-06-30 23:09:03 +0000464 Mem *pOut = pCtx->pOut;
465 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh526740b2017-08-24 13:55:46 +0000466 sqlite3VdbeMemRelease(pOut);
467 pOut->flags = MEM_Null;
drh22930062017-07-27 03:48:02 +0000468 sqlite3VdbeMemSetPointer(pOut, pPtr, zPType, xDestructor);
drh3a96a5d2017-06-30 23:09:03 +0000469}
drhbcdf78a2015-09-10 20:34:56 +0000470void sqlite3_result_subtype(sqlite3_context *pCtx, unsigned int eSubtype){
dan5b6c8e42016-01-30 15:46:03 +0000471 Mem *pOut = pCtx->pOut;
472 assert( sqlite3_mutex_held(pOut->db->mutex) );
473 pOut->eSubtype = eSubtype & 0xff;
474 pOut->flags |= MEM_Subtype;
drhbcdf78a2015-09-10 20:34:56 +0000475}
drh4f26d6c2004-05-26 23:25:30 +0000476void sqlite3_result_text(
477 sqlite3_context *pCtx,
478 const char *z,
479 int n,
danielk1977d8123362004-06-12 09:25:12 +0000480 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000481){
drh9bd038f2014-08-27 14:14:06 +0000482 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000483 setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000484}
drhbbf483f2014-09-09 20:30:24 +0000485void sqlite3_result_text64(
drhda4ca9d2014-09-09 17:27:35 +0000486 sqlite3_context *pCtx,
487 const char *z,
488 sqlite3_uint64 n,
489 void (*xDel)(void *),
490 unsigned char enc
491){
492 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000493 assert( xDel!=SQLITE_DYNAMIC );
drh79f7af92014-10-03 16:00:51 +0000494 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drhda4ca9d2014-09-09 17:27:35 +0000495 if( n>0x7fffffff ){
496 (void)invokeValueDestructor(z, xDel, pCtx);
497 }else{
498 setResultStrOrError(pCtx, z, (int)n, enc, xDel);
499 }
500}
drh6c626082004-11-14 21:56:29 +0000501#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000502void sqlite3_result_text16(
503 sqlite3_context *pCtx,
504 const void *z,
505 int n,
danielk1977d8123362004-06-12 09:25:12 +0000506 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000507){
drh9bd038f2014-08-27 14:14:06 +0000508 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000509 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000510}
511void sqlite3_result_text16be(
512 sqlite3_context *pCtx,
513 const void *z,
514 int n,
515 void (*xDel)(void *)
516){
drh9bd038f2014-08-27 14:14:06 +0000517 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000518 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000519}
520void sqlite3_result_text16le(
521 sqlite3_context *pCtx,
522 const void *z,
523 int n,
524 void (*xDel)(void *)
525){
drh9bd038f2014-08-27 14:14:06 +0000526 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000527 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000528}
drh6c626082004-11-14 21:56:29 +0000529#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000530void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh9bd038f2014-08-27 14:14:06 +0000531 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
532 sqlite3VdbeMemCopy(pCtx->pOut, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000533}
drhb026e052007-05-02 01:34:31 +0000534void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh9bd038f2014-08-27 14:14:06 +0000535 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
536 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
drhb026e052007-05-02 01:34:31 +0000537}
dana4d5ae82015-07-24 16:24:37 +0000538int sqlite3_result_zeroblob64(sqlite3_context *pCtx, u64 n){
539 Mem *pOut = pCtx->pOut;
540 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh6bacdc22015-07-24 17:14:03 +0000541 if( n>(u64)pOut->db->aLimit[SQLITE_LIMIT_LENGTH] ){
dana4d5ae82015-07-24 16:24:37 +0000542 return SQLITE_TOOBIG;
543 }
544 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, (int)n);
545 return SQLITE_OK;
546}
drh69544ec2008-02-06 14:11:34 +0000547void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
drhf09ac0b2018-01-23 03:44:06 +0000548 pCtx->isError = errCode ? errCode : -1;
drh983b5ee2015-02-13 12:05:56 +0000549#ifdef SQLITE_DEBUG
drh96f4ad22015-03-12 21:02:36 +0000550 if( pCtx->pVdbe ) pCtx->pVdbe->rcApp = errCode;
drh983b5ee2015-02-13 12:05:56 +0000551#endif
drh9bd038f2014-08-27 14:14:06 +0000552 if( pCtx->pOut->flags & MEM_Null ){
553 sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
drh51c7d862009-04-27 18:46:06 +0000554 SQLITE_UTF8, SQLITE_STATIC);
555 }
drh69544ec2008-02-06 14:11:34 +0000556}
drh4f26d6c2004-05-26 23:25:30 +0000557
drha0206bc2007-05-08 15:15:02 +0000558/* Force an SQLITE_TOOBIG error. */
559void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000560 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000561 pCtx->isError = SQLITE_TOOBIG;
drh9bd038f2014-08-27 14:14:06 +0000562 sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
drhbb4957f2008-03-20 14:03:29 +0000563 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000564}
565
danielk1977a1644fd2007-08-29 12:31:25 +0000566/* An SQLITE_NOMEM error. */
567void sqlite3_result_error_nomem(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000568 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
569 sqlite3VdbeMemSetNull(pCtx->pOut);
mistachkinfad30392016-02-13 23:43:46 +0000570 pCtx->isError = SQLITE_NOMEM_BKPT;
drh4a642b62016-02-05 01:55:27 +0000571 sqlite3OomFault(pCtx->pOut->db);
danielk1977a1644fd2007-08-29 12:31:25 +0000572}
drh4f26d6c2004-05-26 23:25:30 +0000573
drh0c8f4032019-05-03 21:17:28 +0000574#ifndef SQLITE_UNTESTABLE
575/* Force the INT64 value currently stored as the result to be
576** a MEM_IntReal value. See the SQLITE_TESTCTRL_RESULT_INTREAL
577** test-control.
578*/
579void sqlite3ResultIntReal(sqlite3_context *pCtx){
580 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
581 if( pCtx->pOut->flags & MEM_Int ){
582 pCtx->pOut->flags &= ~MEM_Int;
583 pCtx->pOut->flags |= MEM_IntReal;
584 }
585}
586#endif
587
588
dan5cf53532010-05-01 16:40:20 +0000589/*
590** This function is called after a transaction has been committed. It
591** invokes callbacks registered with sqlite3_wal_hook() as required.
592*/
drh7ed91f22010-04-29 22:34:07 +0000593static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000594 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000595#ifndef SQLITE_OMIT_WAL
596 int i;
dan8d22a172010-04-19 18:03:51 +0000597 for(i=0; i<db->nDb; i++){
598 Btree *pBt = db->aDb[i].pBt;
599 if( pBt ){
drhef15c6e2014-12-12 01:27:17 +0000600 int nEntry;
601 sqlite3BtreeEnter(pBt);
602 nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
603 sqlite3BtreeLeave(pBt);
drh59533aa2017-08-02 18:28:26 +0000604 if( nEntry>0 && db->xWalCallback && rc==SQLITE_OK ){
drh69c33822016-08-18 14:33:11 +0000605 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zDbSName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000606 }
607 }
608 }
dan5cf53532010-05-01 16:40:20 +0000609#endif
dan8d22a172010-04-19 18:03:51 +0000610 return rc;
611}
612
drh201e0c62015-07-14 14:48:50 +0000613
drh4f26d6c2004-05-26 23:25:30 +0000614/*
615** Execute the statement pStmt, either until a row of data is ready, the
616** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000617**
618** This routine implements the bulk of the logic behind the sqlite_step()
619** API. The only thing omitted is the automatic recompile if a
620** schema change has occurred. That detail is handled by the
621** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000622*/
drhb900aaf2006-11-09 00:24:53 +0000623static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000624 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000625 int rc;
626
danielk1977a185ddb2007-11-15 16:04:15 +0000627 assert(p);
drh17b74812021-02-03 18:32:25 +0000628 if( p->iVdbeMagic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000629 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000630 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
631 ** with version 3.7.0, we changed this so that sqlite3_reset() would
632 ** be called automatically instead of throwing the SQLITE_MISUSE error.
633 ** This "automatic-reset" change is not technically an incompatibility,
634 ** since any application that receives an SQLITE_MISUSE is broken by
635 ** definition.
636 **
637 ** Nevertheless, some published applications that were originally written
638 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000639 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000640 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
641 ** legacy behavior of returning SQLITE_MISUSE for cases where the
642 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
643 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000644 */
drh602acb42011-01-17 17:42:37 +0000645#ifdef SQLITE_OMIT_AUTORESET
drh983b5ee2015-02-13 12:05:56 +0000646 if( (rc = p->rc&0xff)==SQLITE_BUSY || rc==SQLITE_LOCKED ){
drh602acb42011-01-17 17:42:37 +0000647 sqlite3_reset((sqlite3_stmt*)p);
648 }else{
649 return SQLITE_MISUSE_BKPT;
650 }
651#else
drh3674bfd2010-04-17 12:53:19 +0000652 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000653#endif
drhf1bfe9a2007-10-17 01:44:20 +0000654 }
655
dan14d4cc42010-01-20 14:25:37 +0000656 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000657 db = p->db;
drhc456e572008-08-11 18:44:58 +0000658 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000659 p->rc = SQLITE_NOMEM;
mistachkinfad30392016-02-13 23:43:46 +0000660 return SQLITE_NOMEM_BKPT;
drhc456e572008-08-11 18:44:58 +0000661 }
danielk1977261919c2005-12-06 12:52:59 +0000662
drhcfc07832018-12-11 12:51:46 +0000663 if( p->pc<0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000664 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000665 rc = SQLITE_ERROR;
drh5cbb4422020-06-29 13:12:42 +0000666 if( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 ){
667 /* If this statement was prepared using saved SQL and an
668 ** error has occurred, then return the error code in p->rc to the
669 ** caller. Set the error code in the database handle to the same value.
670 */
671 rc = sqlite3VdbeTransferError(p);
672 }
drhb900aaf2006-11-09 00:24:53 +0000673 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000674 }
danielk19771d850a72004-05-31 08:26:49 +0000675 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000676 /* If there are no other statements currently running, then
677 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
678 ** from interrupting a statement that has not yet started.
679 */
drh4f7d3a52013-06-27 23:54:02 +0000680 if( db->nVdbeActive==0 ){
dan892edb62020-03-30 13:35:05 +0000681 AtomicStore(&db->u1.isInterrupted, 0);
drh15ca1df2006-07-26 13:43:30 +0000682 }
683
drh888e16e2013-07-09 13:05:49 +0000684 assert( db->nVdbeWrite>0 || db->autoCommit==0
dancb3e4b72013-07-03 19:53:05 +0000685 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
686 );
dan1da40a32009-09-19 17:00:31 +0000687
drh19e2d372005-08-29 23:00:03 +0000688#ifndef SQLITE_OMIT_TRACE
drh04c67472018-12-04 14:33:02 +0000689 if( (db->mTrace & (SQLITE_TRACE_PROFILE|SQLITE_TRACE_XPROFILE))!=0
drh3d2a5292016-07-13 22:55:01 +0000690 && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000691 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh201e0c62015-07-14 14:48:50 +0000692 }else{
693 assert( p->startTime==0 );
drh19e2d372005-08-29 23:00:03 +0000694 }
695#endif
drhc16a03b2004-09-15 13:38:10 +0000696
drh4f7d3a52013-06-27 23:54:02 +0000697 db->nVdbeActive++;
698 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000699 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000700 p->pc = 0;
701 }
drh983b5ee2015-02-13 12:05:56 +0000702#ifdef SQLITE_DEBUG
703 p->rcApp = SQLITE_OK;
704#endif
drhb7f91642004-10-31 02:22:47 +0000705#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000706 if( p->explain ){
707 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000708 }else
709#endif /* SQLITE_OMIT_EXPLAIN */
710 {
drh4f7d3a52013-06-27 23:54:02 +0000711 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000712 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000713 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000714 }
715
drhb7de8272018-12-04 13:51:26 +0000716 if( rc!=SQLITE_ROW ){
drh19e2d372005-08-29 23:00:03 +0000717#ifndef SQLITE_OMIT_TRACE
drhb7de8272018-12-04 13:51:26 +0000718 /* If the statement completed successfully, invoke the profile callback */
719 checkProfileCallback(db, p);
drh19e2d372005-08-29 23:00:03 +0000720#endif
721
drhb7de8272018-12-04 13:51:26 +0000722 if( rc==SQLITE_DONE && db->autoCommit ){
723 assert( p->rc==SQLITE_OK );
724 p->rc = doWalCallbacks(db);
725 if( p->rc!=SQLITE_OK ){
726 rc = SQLITE_ERROR;
727 }
drh5cbb4422020-06-29 13:12:42 +0000728 }else if( rc!=SQLITE_DONE && (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 ){
729 /* If this statement was prepared using saved SQL and an
730 ** error has occurred, then return the error code in p->rc to the
731 ** caller. Set the error code in the database handle to the same value.
732 */
733 rc = sqlite3VdbeTransferError(p);
dan8d22a172010-04-19 18:03:51 +0000734 }
735 }
736
drh80cc85b2008-07-23 21:07:25 +0000737 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000738 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
mistachkinfad30392016-02-13 23:43:46 +0000739 p->rc = SQLITE_NOMEM_BKPT;
drh5cbb4422020-06-29 13:12:42 +0000740 if( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 ) rc = p->rc;
drhb900aaf2006-11-09 00:24:53 +0000741 }
danielk1977357864e2009-03-25 15:43:08 +0000742end_of_step:
drh5cbb4422020-06-29 13:12:42 +0000743 /* There are only a limited number of result codes allowed from the
744 ** statements prepared using the legacy sqlite3_prepare() interface */
745 assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0
746 || rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
drhcbd8db32015-08-20 17:18:32 +0000747 || (rc&0xff)==SQLITE_BUSY || rc==SQLITE_MISUSE
danielk1977357864e2009-03-25 15:43:08 +0000748 );
danielk1977357864e2009-03-25 15:43:08 +0000749 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000750}
751
752/*
753** This is the top-level implementation of sqlite3_step(). Call
754** sqlite3Step() to do most of the work. If a schema error occurs,
755** call sqlite3Reprepare() and try again.
756*/
drhb900aaf2006-11-09 00:24:53 +0000757int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000758 int rc = SQLITE_OK; /* Result from sqlite3Step() */
drha6129fa2010-02-24 17:15:19 +0000759 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
760 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
761 sqlite3 *db; /* The database connection */
762
drh413c3d32010-02-23 20:11:56 +0000763 if( vdbeSafetyNotNull(v) ){
764 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000765 }
drh413c3d32010-02-23 20:11:56 +0000766 db = v->db;
767 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000768 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000769 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh2c7946a2014-08-19 20:27:40 +0000770 && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
771 int savedPc = v->pc;
drh754ee282017-08-02 19:04:37 +0000772 rc = sqlite3Reprepare(v);
773 if( rc!=SQLITE_OK ){
774 /* This case occurs after failing to recompile an sql statement.
775 ** The error message from the SQL compiler has already been loaded
776 ** into the database handle. This block copies the error message
777 ** from the database handle into the statement and sets the statement
778 ** program counter to 0 to ensure that when the statement is
779 ** finalized or reset the parser error message is available via
780 ** sqlite3_errmsg() and sqlite3_errcode().
781 */
782 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
783 sqlite3DbFree(db, v->zErrMsg);
784 if( !db->mallocFailed ){
785 v->zErrMsg = sqlite3DbStrDup(db, zErr);
786 v->rc = rc = sqlite3ApiExit(db, rc);
787 } else {
788 v->zErrMsg = 0;
789 v->rc = rc = SQLITE_NOMEM_BKPT;
790 }
791 break;
792 }
drh413c3d32010-02-23 20:11:56 +0000793 sqlite3_reset(pStmt);
drh5f58ae72014-08-19 20:41:36 +0000794 if( savedPc>=0 ) v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000795 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000796 }
drh413c3d32010-02-23 20:11:56 +0000797 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000798 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000799}
800
drh95a7b3e2013-09-16 12:57:19 +0000801
drh4f26d6c2004-05-26 23:25:30 +0000802/*
drheb2e1762004-05-27 01:53:56 +0000803** Extract the user data from a sqlite3_context structure and return a
804** pointer to it.
805*/
806void *sqlite3_user_data(sqlite3_context *p){
807 assert( p && p->pFunc );
808 return p->pFunc->pUserData;
809}
810
811/*
drhfa4a4b92008-03-19 21:45:51 +0000812** Extract the user data from a sqlite3_context structure and return a
813** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000814**
815** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
816** returns a copy of the pointer to the database connection (the 1st
817** parameter) of the sqlite3_create_function() and
818** sqlite3_create_function16() routines that originally registered the
819** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000820*/
821sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
drha46a4a62015-09-08 21:12:53 +0000822 assert( p && p->pOut );
drh9bd038f2014-08-27 14:14:06 +0000823 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000824}
825
826/*
drh6f390be2018-01-11 17:04:26 +0000827** If this routine is invoked from within an xColumn method of a virtual
828** table, then it returns true if and only if the the call is during an
829** UPDATE operation and the value of the column will not be modified
830** by the UPDATE.
831**
832** If this routine is called from any context other than within the
833** xColumn method of a virtual table, then the return value is meaningless
834** and arbitrary.
835**
836** Virtual table implements might use this routine to optimize their
837** performance by substituting a NULL result, or some other light-weight
838** value, as a signal to the xUpdate routine that the column is unchanged.
839*/
840int sqlite3_vtab_nochange(sqlite3_context *p){
841 assert( p );
drhce2fbd12018-01-12 21:00:14 +0000842 return sqlite3_value_nochange(p->pOut);
drh6f390be2018-01-11 17:04:26 +0000843}
844
845/*
drha9e03b12015-03-12 06:46:52 +0000846** Return the current time for a statement. If the current time
847** is requested more than once within the same run of a single prepared
848** statement, the exact same time is returned for each invocation regardless
849** of the amount of time that elapses between invocations. In other words,
850** the time returned is always the time of the first call.
drh95a7b3e2013-09-16 12:57:19 +0000851*/
852sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
drh95a7b3e2013-09-16 12:57:19 +0000853 int rc;
drh175b8f02019-08-08 15:24:17 +0000854#ifndef SQLITE_ENABLE_STAT4
drh3df79a92015-03-12 23:48:27 +0000855 sqlite3_int64 *piTime = &p->pVdbe->iCurrentTime;
drha9e03b12015-03-12 06:46:52 +0000856 assert( p->pVdbe!=0 );
857#else
drh3df79a92015-03-12 23:48:27 +0000858 sqlite3_int64 iTime = 0;
drha9e03b12015-03-12 06:46:52 +0000859 sqlite3_int64 *piTime = p->pVdbe!=0 ? &p->pVdbe->iCurrentTime : &iTime;
drha9e03b12015-03-12 06:46:52 +0000860#endif
drh3df79a92015-03-12 23:48:27 +0000861 if( *piTime==0 ){
drha9e03b12015-03-12 06:46:52 +0000862 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, piTime);
863 if( rc ) *piTime = 0;
drh95a7b3e2013-09-16 12:57:19 +0000864 }
drha9e03b12015-03-12 06:46:52 +0000865 return *piTime;
drh95a7b3e2013-09-16 12:57:19 +0000866}
867
868/*
drh9de4a172014-08-23 18:17:19 +0000869** Create a new aggregate context for p and return a pointer to
870** its pMem->z element.
871*/
872static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
873 Mem *pMem = p->pMem;
874 assert( (pMem->flags & MEM_Agg)==0 );
875 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000876 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000877 pMem->z = 0;
878 }else{
drh322f2852014-09-19 00:43:39 +0000879 sqlite3VdbeMemClearAndResize(pMem, nByte);
drh9de4a172014-08-23 18:17:19 +0000880 pMem->flags = MEM_Agg;
881 pMem->u.pDef = p->pFunc;
882 if( pMem->z ){
883 memset(pMem->z, 0, nByte);
884 }
885 }
886 return (void*)pMem->z;
887}
888
889/*
drheb2e1762004-05-27 01:53:56 +0000890** Allocate or return the aggregate context for a user function. A new
891** context is allocated on the first call. Subsequent calls return the
892** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000893*/
894void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh2d801512016-01-14 22:19:58 +0000895 assert( p && p->pFunc && p->pFunc->xFinalize );
drh9bd038f2014-08-27 14:14:06 +0000896 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000897 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000898 if( (p->pMem->flags & MEM_Agg)==0 ){
899 return createAggContext(p, nByte);
900 }else{
901 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000902 }
drheb2e1762004-05-27 01:53:56 +0000903}
904
905/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000906** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000907** the user-function defined by pCtx.
drhf7fa4e72017-05-11 15:20:18 +0000908**
909** The left-most argument is 0.
910**
911** Undocumented behavior: If iArg is negative then access a cache of
912** auxiliary data pointers that is available to all functions within a
913** single prepared statement. The iArg values must match.
danielk1977682f68b2004-06-05 10:22:17 +0000914*/
915void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000916 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000917
drh9bd038f2014-08-27 14:14:06 +0000918 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh175b8f02019-08-08 15:24:17 +0000919#if SQLITE_ENABLE_STAT4
dan18bf8072015-03-11 20:06:40 +0000920 if( pCtx->pVdbe==0 ) return 0;
drha9e03b12015-03-12 06:46:52 +0000921#else
922 assert( pCtx->pVdbe!=0 );
923#endif
drhe6941392017-05-10 19:42:52 +0000924 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
drhf7fa4e72017-05-11 15:20:18 +0000925 if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
drhe6941392017-05-10 19:42:52 +0000926 return pAuxData->pAux;
927 }
danielk1977682f68b2004-06-05 10:22:17 +0000928 }
drhe6941392017-05-10 19:42:52 +0000929 return 0;
danielk1977682f68b2004-06-05 10:22:17 +0000930}
931
932/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000933** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000934** argument to the user-function defined by pCtx. Any previous value is
935** deleted by calling the delete function specified when it was set.
drhf7fa4e72017-05-11 15:20:18 +0000936**
937** The left-most argument is 0.
938**
939** Undocumented behavior: If iArg is negative then make the data available
940** to all functions within the current prepared statement using iArg as an
941** access code.
danielk1977682f68b2004-06-05 10:22:17 +0000942*/
943void sqlite3_set_auxdata(
944 sqlite3_context *pCtx,
945 int iArg,
946 void *pAux,
947 void (*xDelete)(void*)
948){
dan0c547792013-07-18 17:12:08 +0000949 AuxData *pAuxData;
950 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000951
drh9bd038f2014-08-27 14:14:06 +0000952 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh175b8f02019-08-08 15:24:17 +0000953#ifdef SQLITE_ENABLE_STAT4
dan18bf8072015-03-11 20:06:40 +0000954 if( pVdbe==0 ) goto failed;
drha9e03b12015-03-12 06:46:52 +0000955#else
956 assert( pVdbe!=0 );
957#endif
danielk1977682f68b2004-06-05 10:22:17 +0000958
drhe6941392017-05-10 19:42:52 +0000959 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
drhf7fa4e72017-05-11 15:20:18 +0000960 if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
961 break;
962 }
dan0c547792013-07-18 17:12:08 +0000963 }
964 if( pAuxData==0 ){
965 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
966 if( !pAuxData ) goto failed;
drhe6941392017-05-10 19:42:52 +0000967 pAuxData->iAuxOp = pCtx->iOp;
968 pAuxData->iAuxArg = iArg;
969 pAuxData->pNextAux = pVdbe->pAuxData;
dan0c547792013-07-18 17:12:08 +0000970 pVdbe->pAuxData = pAuxData;
drhf09ac0b2018-01-23 03:44:06 +0000971 if( pCtx->isError==0 ) pCtx->isError = -1;
drhe6941392017-05-10 19:42:52 +0000972 }else if( pAuxData->xDeleteAux ){
973 pAuxData->xDeleteAux(pAuxData->pAux);
danielk1977682f68b2004-06-05 10:22:17 +0000974 }
dan0c547792013-07-18 17:12:08 +0000975
danielk1977682f68b2004-06-05 10:22:17 +0000976 pAuxData->pAux = pAux;
drhe6941392017-05-10 19:42:52 +0000977 pAuxData->xDeleteAux = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000978 return;
979
980failed:
981 if( xDelete ){
982 xDelete(pAux);
983 }
danielk1977682f68b2004-06-05 10:22:17 +0000984}
985
shaneeec556d2008-10-12 00:27:53 +0000986#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000987/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000988** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000989** called.
990**
drhcf85a512006-02-09 18:35:29 +0000991** This function is deprecated. Do not use it for new code. It is
992** provide only to avoid breaking legacy code. New aggregate function
993** implementations should keep their own counts within their aggregate
994** context.
drheb2e1762004-05-27 01:53:56 +0000995*/
996int sqlite3_aggregate_count(sqlite3_context *p){
drh2d801512016-01-14 22:19:58 +0000997 assert( p && p->pMem && p->pFunc && p->pFunc->xFinalize );
drhabfcea22005-09-06 20:36:48 +0000998 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000999}
shaneeec556d2008-10-12 00:27:53 +00001000#endif
drheb2e1762004-05-27 01:53:56 +00001001
1002/*
drh4f26d6c2004-05-26 23:25:30 +00001003** Return the number of columns in the result set for the statement pStmt.
1004*/
1005int sqlite3_column_count(sqlite3_stmt *pStmt){
1006 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +00001007 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +00001008}
1009
1010/*
1011** Return the number of values available from the current row of the
1012** currently executing statement pStmt.
1013*/
1014int sqlite3_data_count(sqlite3_stmt *pStmt){
1015 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +00001016 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +00001017 return pVm->nResColumn;
1018}
1019
dan46c47d42011-03-01 18:42:07 +00001020/*
1021** Return a pointer to static memory containing an SQL NULL value.
1022*/
1023static const Mem *columnNullValue(void){
1024 /* Even though the Mem structure contains an element
drhb1a1c292014-03-05 12:47:55 +00001025 ** of type i64, on certain architectures (x86) with certain compiler
dan46c47d42011-03-01 18:42:07 +00001026 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
1027 ** instead of an 8-byte one. This all works fine, except that when
1028 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
1029 ** that a Mem structure is located on an 8-byte boundary. To prevent
drhb1a1c292014-03-05 12:47:55 +00001030 ** these assert()s from failing, when building with SQLITE_DEBUG defined
1031 ** using gcc, we force nullMem to be 8-byte aligned using the magical
dan46c47d42011-03-01 18:42:07 +00001032 ** __attribute__((aligned(8))) macro. */
1033 static const Mem nullMem
1034#if defined(SQLITE_DEBUG) && defined(__GNUC__)
drhb1a1c292014-03-05 12:47:55 +00001035 __attribute__((aligned(8)))
dan46c47d42011-03-01 18:42:07 +00001036#endif
drh035e5632014-09-16 14:16:31 +00001037 = {
drh3329a632014-09-18 01:21:43 +00001038 /* .u = */ {0},
drh8faee872015-09-19 18:08:13 +00001039 /* .flags = */ (u16)MEM_Null,
1040 /* .enc = */ (u8)0,
1041 /* .eSubtype = */ (u8)0,
1042 /* .n = */ (int)0,
1043 /* .z = */ (char*)0,
1044 /* .zMalloc = */ (char*)0,
1045 /* .szMalloc = */ (int)0,
1046 /* .uTemp = */ (u32)0,
1047 /* .db = */ (sqlite3*)0,
1048 /* .xDel = */ (void(*)(void*))0,
drhb1a1c292014-03-05 12:47:55 +00001049#ifdef SQLITE_DEBUG
drh8faee872015-09-19 18:08:13 +00001050 /* .pScopyFrom = */ (Mem*)0,
drh58773a52018-06-12 13:52:23 +00001051 /* .mScopyFlags= */ 0,
1052#endif
drh035e5632014-09-16 14:16:31 +00001053 };
dan46c47d42011-03-01 18:42:07 +00001054 return &nullMem;
1055}
drh4f26d6c2004-05-26 23:25:30 +00001056
1057/*
1058** Check to see if column iCol of the given statement is valid. If
1059** it is, return a pointer to the Mem for the value of that column.
1060** If iCol is not valid, return a pointer to a Mem which has a value
1061** of NULL.
1062*/
1063static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +00001064 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +00001065 Mem *pOut;
1066
1067 pVm = (Vdbe *)pStmt;
drh28f17012016-09-22 21:37:18 +00001068 if( pVm==0 ) return (Mem*)columnNullValue();
1069 assert( pVm->db );
1070 sqlite3_mutex_enter(pVm->db->mutex);
1071 if( pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drhd4e70eb2008-01-02 00:34:36 +00001072 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +00001073 }else{
drh28f17012016-09-22 21:37:18 +00001074 sqlite3Error(pVm->db, SQLITE_RANGE);
dan46c47d42011-03-01 18:42:07 +00001075 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +00001076 }
drh32bc3f62007-08-21 20:25:39 +00001077 return pOut;
drh4f26d6c2004-05-26 23:25:30 +00001078}
1079
danielk19772e588c72005-12-09 14:25:08 +00001080/*
1081** This function is called after invoking an sqlite3_value_XXX function on a
1082** column value (i.e. a value returned by evaluating an SQL expression in the
1083** select list of a SELECT statement) that may cause a malloc() failure. If
1084** malloc() has failed, the threads mallocFailed flag is cleared and the result
1085** code of statement pStmt set to SQLITE_NOMEM.
1086**
drh32bc3f62007-08-21 20:25:39 +00001087** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +00001088**
1089** sqlite3_column_int()
1090** sqlite3_column_int64()
1091** sqlite3_column_text()
1092** sqlite3_column_text16()
1093** sqlite3_column_real()
1094** sqlite3_column_bytes()
1095** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +00001096** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +00001097*/
1098static void columnMallocFailure(sqlite3_stmt *pStmt)
1099{
1100 /* If malloc() failed during an encoding conversion within an
1101 ** sqlite3_column_XXX API, then set the return code of the statement to
1102 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
1103 ** and _finalize() will return NOMEM.
1104 */
danielk197754f01982006-01-18 15:25:17 +00001105 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +00001106 if( p ){
drh28f17012016-09-22 21:37:18 +00001107 assert( p->db!=0 );
1108 assert( sqlite3_mutex_held(p->db->mutex) );
drh32bc3f62007-08-21 20:25:39 +00001109 p->rc = sqlite3ApiExit(p->db, p->rc);
1110 sqlite3_mutex_leave(p->db->mutex);
1111 }
danielk19772e588c72005-12-09 14:25:08 +00001112}
1113
drh4f26d6c2004-05-26 23:25:30 +00001114/**************************** sqlite3_column_ *******************************
1115** The following routines are used to access elements of the current row
1116** in the result set.
1117*/
danielk1977c572ef72004-05-27 09:28:41 +00001118const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001119 const void *val;
danielk19772e588c72005-12-09 14:25:08 +00001120 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +00001121 /* Even though there is no encoding conversion, value_blob() might
1122 ** need to call malloc() to expand the result of a zeroblob()
1123 ** expression.
1124 */
1125 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +00001126 return val;
danielk1977c572ef72004-05-27 09:28:41 +00001127}
drh4f26d6c2004-05-26 23:25:30 +00001128int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001129 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
1130 columnMallocFailure(pStmt);
1131 return val;
drh4f26d6c2004-05-26 23:25:30 +00001132}
1133int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001134 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
1135 columnMallocFailure(pStmt);
1136 return val;
drh4f26d6c2004-05-26 23:25:30 +00001137}
1138double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001139 double val = sqlite3_value_double( columnMem(pStmt,i) );
1140 columnMallocFailure(pStmt);
1141 return val;
drh4f26d6c2004-05-26 23:25:30 +00001142}
1143int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001144 int val = sqlite3_value_int( columnMem(pStmt,i) );
1145 columnMallocFailure(pStmt);
1146 return val;
drh4f26d6c2004-05-26 23:25:30 +00001147}
drhefad9992004-06-22 12:13:55 +00001148sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001149 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
1150 columnMallocFailure(pStmt);
1151 return val;
drh4f26d6c2004-05-26 23:25:30 +00001152}
1153const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001154 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
1155 columnMallocFailure(pStmt);
1156 return val;
drh4f26d6c2004-05-26 23:25:30 +00001157}
drhd1e47332005-06-26 17:55:33 +00001158sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +00001159 Mem *pOut = columnMem(pStmt, i);
1160 if( pOut->flags&MEM_Static ){
1161 pOut->flags &= ~MEM_Static;
1162 pOut->flags |= MEM_Ephem;
1163 }
drh32bc3f62007-08-21 20:25:39 +00001164 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +00001165 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +00001166}
drh6c626082004-11-14 21:56:29 +00001167#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001168const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001169 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
1170 columnMallocFailure(pStmt);
1171 return val;
drh4f26d6c2004-05-26 23:25:30 +00001172}
drh6c626082004-11-14 21:56:29 +00001173#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +00001174int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +00001175 int iType = sqlite3_value_type( columnMem(pStmt,i) );
1176 columnMallocFailure(pStmt);
1177 return iType;
drh4f26d6c2004-05-26 23:25:30 +00001178}
1179
drh5e2517e2004-09-24 23:59:12 +00001180/*
1181** Convert the N-th element of pStmt->pColName[] into a string using
1182** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +00001183**
1184** There are up to 5 names for each column. useType determines which
1185** name is returned. Here are the names:
1186**
1187** 0 The column name as it should be displayed for output
1188** 1 The datatype name for the column
1189** 2 The name of the database that the column derives from
1190** 3 The name of the table that the column derives from
1191** 4 The name of the table column that the result column derives from
1192**
1193** If the result is not a simple column reference (if it is an expression
1194** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +00001195*/
1196static const void *columnName(
drh8cf92892019-02-20 18:13:57 +00001197 sqlite3_stmt *pStmt, /* The statement */
1198 int N, /* Which column to get the name for */
1199 int useUtf16, /* True to return the name as UTF16 */
1200 int useType /* What type of name */
drh5e2517e2004-09-24 23:59:12 +00001201){
drh9ca95732014-10-24 00:35:58 +00001202 const void *ret;
1203 Vdbe *p;
drh32bc3f62007-08-21 20:25:39 +00001204 int n;
drh9ca95732014-10-24 00:35:58 +00001205 sqlite3 *db;
1206#ifdef SQLITE_ENABLE_API_ARMOR
1207 if( pStmt==0 ){
1208 (void)SQLITE_MISUSE_BKPT;
1209 return 0;
1210 }
1211#endif
1212 ret = 0;
1213 p = (Vdbe *)pStmt;
1214 db = p->db;
drh9b4ea4a2009-04-10 20:32:00 +00001215 assert( db!=0 );
1216 n = sqlite3_column_count(pStmt);
1217 if( N<n && N>=0 ){
1218 N += useType*n;
1219 sqlite3_mutex_enter(db->mutex);
1220 assert( db->mallocFailed==0 );
dan4474e862019-03-04 07:15:57 +00001221#ifndef SQLITE_OMIT_UTF16
drh8cf92892019-02-20 18:13:57 +00001222 if( useUtf16 ){
1223 ret = sqlite3_value_text16((sqlite3_value*)&p->aColName[N]);
dan4474e862019-03-04 07:15:57 +00001224 }else
1225#endif
1226 {
drh8cf92892019-02-20 18:13:57 +00001227 ret = sqlite3_value_text((sqlite3_value*)&p->aColName[N]);
1228 }
1229 /* A malloc may have failed inside of the _text() call. If this
drh9b4ea4a2009-04-10 20:32:00 +00001230 ** is the case, clear the mallocFailed flag and return NULL.
1231 */
1232 if( db->mallocFailed ){
drh4a642b62016-02-05 01:55:27 +00001233 sqlite3OomClear(db);
drh9b4ea4a2009-04-10 20:32:00 +00001234 ret = 0;
drh32bc3f62007-08-21 20:25:39 +00001235 }
drh9b4ea4a2009-04-10 20:32:00 +00001236 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +00001237 }
danielk197700fd9572005-12-07 06:27:43 +00001238 return ret;
drh5e2517e2004-09-24 23:59:12 +00001239}
1240
drh4f26d6c2004-05-26 23:25:30 +00001241/*
1242** Return the name of the Nth column of the result set returned by SQL
1243** statement pStmt.
1244*/
1245const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001246 return columnName(pStmt, N, 0, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +00001247}
drhe590fbd2005-05-20 19:36:01 +00001248#ifndef SQLITE_OMIT_UTF16
1249const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001250 return columnName(pStmt, N, 1, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001251}
1252#endif
drh4f26d6c2004-05-26 23:25:30 +00001253
1254/*
drh3f913572008-03-22 01:07:17 +00001255** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1256** not define OMIT_DECLTYPE.
1257*/
1258#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1259# error "Must not define both SQLITE_OMIT_DECLTYPE \
1260 and SQLITE_ENABLE_COLUMN_METADATA"
1261#endif
1262
1263#ifndef SQLITE_OMIT_DECLTYPE
1264/*
drh6c626082004-11-14 21:56:29 +00001265** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001266** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001267*/
1268const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001269 return columnName(pStmt, N, 0, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001270}
drh6c626082004-11-14 21:56:29 +00001271#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001272const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001273 return columnName(pStmt, N, 1, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001274}
drh6c626082004-11-14 21:56:29 +00001275#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001276#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001277
danielk19774b1ae992006-02-10 03:06:10 +00001278#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001279/*
1280** Return the name of the database from which a result column derives.
1281** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001282** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001283*/
1284const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001285 return columnName(pStmt, N, 0, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001286}
1287#ifndef SQLITE_OMIT_UTF16
1288const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001289 return columnName(pStmt, N, 1, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001290}
1291#endif /* SQLITE_OMIT_UTF16 */
1292
1293/*
1294** Return the name of the table from which a result column derives.
1295** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001296** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001297*/
1298const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001299 return columnName(pStmt, N, 0, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001300}
1301#ifndef SQLITE_OMIT_UTF16
1302const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001303 return columnName(pStmt, N, 1, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001304}
1305#endif /* SQLITE_OMIT_UTF16 */
1306
1307/*
1308** Return the name of the table column from which a result column derives.
1309** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001310** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001311*/
1312const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001313 return columnName(pStmt, N, 0, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001314}
1315#ifndef SQLITE_OMIT_UTF16
1316const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001317 return columnName(pStmt, N, 1, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001318}
1319#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001320#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001321
1322
drh4f26d6c2004-05-26 23:25:30 +00001323/******************************* sqlite3_bind_ ***************************
1324**
1325** Routines used to attach values to wildcards in a compiled SQL statement.
1326*/
1327/*
1328** Unbind the value bound to variable i in virtual machine p. This is the
1329** the same as binding a NULL value to the column. If the "i" parameter is
1330** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1331**
drh488e7b62008-10-06 12:46:43 +00001332** A successful evaluation of this routine acquires the mutex on p.
1333** the mutex is released if any kind of error occurs.
1334**
drh4f26d6c2004-05-26 23:25:30 +00001335** The error code stored in database p->db is overwritten with the return
1336** value in any case.
1337*/
1338static int vdbeUnbind(Vdbe *p, int i){
1339 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001340 if( vdbeSafetyNotNull(p) ){
1341 return SQLITE_MISUSE_BKPT;
1342 }
drh488e7b62008-10-06 12:46:43 +00001343 sqlite3_mutex_enter(p->db->mutex);
drh17b74812021-02-03 18:32:25 +00001344 if( p->iVdbeMagic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001345 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001346 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001347 sqlite3_log(SQLITE_MISUSE,
1348 "bind on a busy prepared statement: [%s]", p->zSql);
1349 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001350 }
1351 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001352 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001353 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001354 return SQLITE_RANGE;
1355 }
1356 i--;
drh290c1942004-08-21 17:54:45 +00001357 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001358 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001359 pVar->flags = MEM_Null;
drh368bfe82018-12-11 12:20:41 +00001360 p->db->errCode = SQLITE_OK;
dan937d0de2009-10-15 18:35:38 +00001361
dan1d2ce4f2009-10-19 18:11:09 +00001362 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1363 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001364 **
drhbbf6d432020-05-15 15:03:51 +00001365 ** IMPLEMENTATION-OF: R-57496-20354 If the specific value bound to a host
drha7044002010-09-14 18:22:59 +00001366 ** parameter in the WHERE clause might influence the choice of query plan
1367 ** for a statement, then the statement will be automatically recompiled,
1368 ** as if there had been a schema change, on the first sqlite3_step() call
1369 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001370 */
drh2c2f3922017-06-01 00:54:35 +00001371 assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || p->expmask==0 );
drh29967962017-03-03 21:51:40 +00001372 if( p->expmask!=0 && (p->expmask & (i>=31 ? 0x80000000 : (u32)1<<i))!=0 ){
dan937d0de2009-10-15 18:35:38 +00001373 p->expired = 1;
1374 }
drh4f26d6c2004-05-26 23:25:30 +00001375 return SQLITE_OK;
1376}
1377
1378/*
drh5e2517e2004-09-24 23:59:12 +00001379** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001380*/
drh5e2517e2004-09-24 23:59:12 +00001381static int bindText(
drh605264d2007-08-21 15:13:19 +00001382 sqlite3_stmt *pStmt, /* The statement to bind against */
1383 int i, /* Index of the parameter to bind */
1384 const void *zData, /* Pointer to the data to be bound */
drhd6228552021-06-09 14:45:02 +00001385 i64 nData, /* Number of bytes of data to be bound */
drh605264d2007-08-21 15:13:19 +00001386 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001387 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001388){
1389 Vdbe *p = (Vdbe *)pStmt;
1390 Mem *pVar;
1391 int rc;
1392
1393 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001394 if( rc==SQLITE_OK ){
1395 if( zData!=0 ){
1396 pVar = &p->aVar[i-1];
1397 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1398 if( rc==SQLITE_OK && encoding!=0 ){
1399 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1400 }
drhe70d01f2017-05-29 22:44:18 +00001401 if( rc ){
1402 sqlite3Error(p->db, rc);
1403 rc = sqlite3ApiExit(p->db, rc);
1404 }
drh27641702007-08-22 02:56:42 +00001405 }
drh488e7b62008-10-06 12:46:43 +00001406 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001407 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001408 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001409 }
drh605264d2007-08-21 15:13:19 +00001410 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001411}
drh5e2517e2004-09-24 23:59:12 +00001412
1413
1414/*
1415** Bind a blob value to an SQL statement variable.
1416*/
1417int sqlite3_bind_blob(
1418 sqlite3_stmt *pStmt,
1419 int i,
1420 const void *zData,
1421 int nData,
1422 void (*xDel)(void*)
1423){
drh5b081d82016-02-18 01:29:12 +00001424#ifdef SQLITE_ENABLE_API_ARMOR
1425 if( nData<0 ) return SQLITE_MISUSE_BKPT;
1426#endif
drh5e2517e2004-09-24 23:59:12 +00001427 return bindText(pStmt, i, zData, nData, xDel, 0);
1428}
drhda4ca9d2014-09-09 17:27:35 +00001429int sqlite3_bind_blob64(
1430 sqlite3_stmt *pStmt,
1431 int i,
1432 const void *zData,
1433 sqlite3_uint64 nData,
1434 void (*xDel)(void*)
1435){
drhfc59a952014-09-11 23:34:55 +00001436 assert( xDel!=SQLITE_DYNAMIC );
drhd6228552021-06-09 14:45:02 +00001437 return bindText(pStmt, i, zData, nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001438}
drh4f26d6c2004-05-26 23:25:30 +00001439int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1440 int rc;
1441 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001442 rc = vdbeUnbind(p, i);
1443 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001444 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001445 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001446 }
danielk1977f4618892004-06-28 13:09:11 +00001447 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001448}
1449int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001450 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001451}
drhefad9992004-06-22 12:13:55 +00001452int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001453 int rc;
1454 Vdbe *p = (Vdbe *)pStmt;
1455 rc = vdbeUnbind(p, i);
1456 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001457 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001458 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001459 }
1460 return rc;
1461}
drh605264d2007-08-21 15:13:19 +00001462int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1463 int rc;
1464 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001465 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001466 if( rc==SQLITE_OK ){
1467 sqlite3_mutex_leave(p->db->mutex);
1468 }
drh605264d2007-08-21 15:13:19 +00001469 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001470}
drh22930062017-07-27 03:48:02 +00001471int sqlite3_bind_pointer(
1472 sqlite3_stmt *pStmt,
1473 int i,
1474 void *pPtr,
1475 const char *zPTtype,
1476 void (*xDestructor)(void*)
1477){
drh3a96a5d2017-06-30 23:09:03 +00001478 int rc;
1479 Vdbe *p = (Vdbe*)pStmt;
1480 rc = vdbeUnbind(p, i);
1481 if( rc==SQLITE_OK ){
drh22930062017-07-27 03:48:02 +00001482 sqlite3VdbeMemSetPointer(&p->aVar[i-1], pPtr, zPTtype, xDestructor);
drh3a96a5d2017-06-30 23:09:03 +00001483 sqlite3_mutex_leave(p->db->mutex);
drh34fcf362017-07-27 16:42:36 +00001484 }else if( xDestructor ){
1485 xDestructor(pPtr);
drh3a96a5d2017-06-30 23:09:03 +00001486 }
1487 return rc;
1488}
drh4f26d6c2004-05-26 23:25:30 +00001489int sqlite3_bind_text(
1490 sqlite3_stmt *pStmt,
1491 int i,
1492 const char *zData,
1493 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001494 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001495){
drh5e2517e2004-09-24 23:59:12 +00001496 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001497}
drhbbf483f2014-09-09 20:30:24 +00001498int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001499 sqlite3_stmt *pStmt,
1500 int i,
1501 const char *zData,
1502 sqlite3_uint64 nData,
1503 void (*xDel)(void*),
1504 unsigned char enc
1505){
drhfc59a952014-09-11 23:34:55 +00001506 assert( xDel!=SQLITE_DYNAMIC );
drhd6228552021-06-09 14:45:02 +00001507 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
1508 return bindText(pStmt, i, zData, nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001509}
drh6c626082004-11-14 21:56:29 +00001510#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001511int sqlite3_bind_text16(
1512 sqlite3_stmt *pStmt,
1513 int i,
1514 const void *zData,
1515 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001516 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001517){
drh5e2517e2004-09-24 23:59:12 +00001518 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001519}
drh6c626082004-11-14 21:56:29 +00001520#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001521int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1522 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001523 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001524 case SQLITE_INTEGER: {
1525 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1526 break;
1527 }
1528 case SQLITE_FLOAT: {
drh74eaba42014-09-18 17:52:15 +00001529 rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
drh29def562009-04-14 12:43:33 +00001530 break;
1531 }
1532 case SQLITE_BLOB: {
1533 if( pValue->flags & MEM_Zero ){
1534 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1535 }else{
1536 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1537 }
1538 break;
1539 }
1540 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001541 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1542 pValue->enc);
1543 break;
1544 }
1545 default: {
1546 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001547 break;
1548 }
danielk197726e41442006-06-14 15:16:35 +00001549 }
1550 return rc;
1551}
drhb026e052007-05-02 01:34:31 +00001552int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1553 int rc;
1554 Vdbe *p = (Vdbe *)pStmt;
1555 rc = vdbeUnbind(p, i);
1556 if( rc==SQLITE_OK ){
1557 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001558 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001559 }
1560 return rc;
1561}
dan80c03022015-07-24 17:36:34 +00001562int sqlite3_bind_zeroblob64(sqlite3_stmt *pStmt, int i, sqlite3_uint64 n){
1563 int rc;
1564 Vdbe *p = (Vdbe *)pStmt;
1565 sqlite3_mutex_enter(p->db->mutex);
1566 if( n>(u64)p->db->aLimit[SQLITE_LIMIT_LENGTH] ){
1567 rc = SQLITE_TOOBIG;
1568 }else{
1569 assert( (n & 0x7FFFFFFF)==n );
1570 rc = sqlite3_bind_zeroblob(pStmt, i, n);
1571 }
1572 rc = sqlite3ApiExit(p->db, rc);
1573 sqlite3_mutex_leave(p->db->mutex);
1574 return rc;
1575}
drh75f6a032004-07-15 14:15:00 +00001576
1577/*
1578** Return the number of wildcards that can be potentially bound to.
1579** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001580*/
1581int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001582 Vdbe *p = (Vdbe*)pStmt;
1583 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001584}
drh895d7472004-08-20 16:02:39 +00001585
1586/*
drhfa6bc002004-09-07 16:19:52 +00001587** Return the name of a wildcard parameter. Return NULL if the index
1588** is out of range or if the wildcard is unnamed.
1589**
1590** The result is always UTF-8.
1591*/
1592const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1593 Vdbe *p = (Vdbe*)pStmt;
drh9bf755c2016-12-23 03:59:31 +00001594 if( p==0 ) return 0;
1595 return sqlite3VListNumToName(p->pVList, i);
drh895d7472004-08-20 16:02:39 +00001596}
drhfa6bc002004-09-07 16:19:52 +00001597
1598/*
1599** Given a wildcard parameter name, return the index of the variable
1600** with that name. If there is no variable with the given name,
1601** return 0.
1602*/
drh5f18a222009-11-26 14:01:53 +00001603int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drh9bf755c2016-12-23 03:59:31 +00001604 if( p==0 || zName==0 ) return 0;
1605 return sqlite3VListNameToNum(p->pVList, zName, nName);
drhfa6bc002004-09-07 16:19:52 +00001606}
drh5f18a222009-11-26 14:01:53 +00001607int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1608 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1609}
drhf8db1bc2005-04-22 02:38:37 +00001610
drh51942bc2005-06-12 22:01:42 +00001611/*
drhf8db1bc2005-04-22 02:38:37 +00001612** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001613*/
shane145834a2008-09-04 12:03:42 +00001614int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001615 Vdbe *pFrom = (Vdbe*)pFromStmt;
1616 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001617 int i;
1618 assert( pTo->db==pFrom->db );
1619 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001620 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001621 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001622 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001623 }
drh27641702007-08-22 02:56:42 +00001624 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001625 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001626}
drh51942bc2005-06-12 22:01:42 +00001627
shaneeec556d2008-10-12 00:27:53 +00001628#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001629/*
shane145834a2008-09-04 12:03:42 +00001630** Deprecated external interface. Internal/core SQLite code
1631** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001632**
peter.d.reid60ec9142014-09-06 16:39:46 +00001633** It is misuse to call this routine with statements from different
drh0f5ea0b2009-04-09 14:02:44 +00001634** database connections. But as this is a deprecated interface, we
1635** will not bother to check for that condition.
1636**
1637** If the two statements contain a different number of bindings, then
1638** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1639** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001640*/
1641int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001642 Vdbe *pFrom = (Vdbe*)pFromStmt;
1643 Vdbe *pTo = (Vdbe*)pToStmt;
1644 if( pFrom->nVar!=pTo->nVar ){
1645 return SQLITE_ERROR;
1646 }
drh2c2f3922017-06-01 00:54:35 +00001647 assert( (pTo->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || pTo->expmask==0 );
danbda4cb82017-02-23 16:30:16 +00001648 if( pTo->expmask ){
danc94b8592009-10-20 07:01:24 +00001649 pTo->expired = 1;
1650 }
drh2c2f3922017-06-01 00:54:35 +00001651 assert( (pFrom->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || pFrom->expmask==0 );
danbda4cb82017-02-23 16:30:16 +00001652 if( pFrom->expmask ){
danc94b8592009-10-20 07:01:24 +00001653 pFrom->expired = 1;
1654 }
shane145834a2008-09-04 12:03:42 +00001655 return sqlite3TransferBindings(pFromStmt, pToStmt);
1656}
shaneeec556d2008-10-12 00:27:53 +00001657#endif
shane145834a2008-09-04 12:03:42 +00001658
1659/*
drh51942bc2005-06-12 22:01:42 +00001660** Return the sqlite3* database handle to which the prepared statement given
1661** in the argument belongs. This is the same database handle that was
1662** the first argument to the sqlite3_prepare() that was used to create
1663** the statement in the first place.
1664*/
1665sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1666 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1667}
drhbb5a9c32008-06-19 02:52:25 +00001668
1669/*
drhf03d9cc2010-11-16 23:10:25 +00001670** Return true if the prepared statement is guaranteed to not modify the
1671** database.
1672*/
1673int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1674 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1675}
1676
1677/*
drh39c5c4a2019-03-06 14:53:27 +00001678** Return 1 if the statement is an EXPLAIN and return 2 if the
1679** statement is an EXPLAIN QUERY PLAN
1680*/
1681int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt){
1682 return pStmt ? ((Vdbe*)pStmt)->explain : 0;
1683}
1684
1685/*
drh2fb66932011-11-25 17:21:47 +00001686** Return true if the prepared statement is in need of being reset.
1687*/
1688int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1689 Vdbe *v = (Vdbe*)pStmt;
drh17b74812021-02-03 18:32:25 +00001690 return v!=0 && v->iVdbeMagic==VDBE_MAGIC_RUN && v->pc>=0;
drh2fb66932011-11-25 17:21:47 +00001691}
1692
1693/*
drhbb5a9c32008-06-19 02:52:25 +00001694** Return a pointer to the next prepared statement after pStmt associated
1695** with database connection pDb. If pStmt is NULL, return the first
1696** prepared statement for the database connection. Return NULL if there
1697** are no more.
1698*/
1699sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1700 sqlite3_stmt *pNext;
drh9ca95732014-10-24 00:35:58 +00001701#ifdef SQLITE_ENABLE_API_ARMOR
1702 if( !sqlite3SafetyCheckOk(pDb) ){
1703 (void)SQLITE_MISUSE_BKPT;
1704 return 0;
1705 }
1706#endif
drhbb5a9c32008-06-19 02:52:25 +00001707 sqlite3_mutex_enter(pDb->mutex);
1708 if( pStmt==0 ){
1709 pNext = (sqlite3_stmt*)pDb->pVdbe;
1710 }else{
1711 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1712 }
1713 sqlite3_mutex_leave(pDb->mutex);
1714 return pNext;
1715}
drhd1d38482008-10-07 23:46:38 +00001716
1717/*
1718** Return the value of a status counter for a prepared statement
1719*/
1720int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1721 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9ca95732014-10-24 00:35:58 +00001722 u32 v;
1723#ifdef SQLITE_ENABLE_API_ARMOR
dan68cf69e2018-03-14 08:27:39 +00001724 if( !pStmt
1725 || (op!=SQLITE_STMTSTATUS_MEMUSED && (op<0||op>=ArraySize(pVdbe->aCounter)))
1726 ){
drh9ca95732014-10-24 00:35:58 +00001727 (void)SQLITE_MISUSE_BKPT;
1728 return 0;
1729 }
1730#endif
drh3528f6b2017-05-31 16:21:54 +00001731 if( op==SQLITE_STMTSTATUS_MEMUSED ){
1732 sqlite3 *db = pVdbe->db;
1733 sqlite3_mutex_enter(db->mutex);
1734 v = 0;
1735 db->pnBytesFreed = (int*)&v;
1736 sqlite3VdbeClearObject(db, pVdbe);
1737 sqlite3DbFree(db, pVdbe);
1738 db->pnBytesFreed = 0;
1739 sqlite3_mutex_leave(db->mutex);
1740 }else{
1741 v = pVdbe->aCounter[op];
1742 if( resetFlag ) pVdbe->aCounter[op] = 0;
1743 }
drh9b47ee32013-08-20 03:13:51 +00001744 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001745}
dan46c47d42011-03-01 18:42:07 +00001746
drh557341e2016-07-23 02:07:26 +00001747/*
1748** Return the SQL associated with a prepared statement
1749*/
1750const char *sqlite3_sql(sqlite3_stmt *pStmt){
1751 Vdbe *p = (Vdbe *)pStmt;
1752 return p ? p->zSql : 0;
1753}
1754
1755/*
1756** Return the SQL associated with a prepared statement with
1757** bound parameters expanded. Space to hold the returned string is
1758** obtained from sqlite3_malloc(). The caller is responsible for
1759** freeing the returned string by passing it to sqlite3_free().
1760**
1761** The SQLITE_TRACE_SIZE_LIMIT puts an upper bound on the size of
1762** expanded bound parameters.
1763*/
1764char *sqlite3_expanded_sql(sqlite3_stmt *pStmt){
1765#ifdef SQLITE_OMIT_TRACE
1766 return 0;
1767#else
1768 char *z = 0;
1769 const char *zSql = sqlite3_sql(pStmt);
1770 if( zSql ){
1771 Vdbe *p = (Vdbe *)pStmt;
1772 sqlite3_mutex_enter(p->db->mutex);
1773 z = sqlite3VdbeExpandSql(p, zSql);
1774 sqlite3_mutex_leave(p->db->mutex);
1775 }
1776 return z;
1777#endif
1778}
1779
mistachkin8bee11a2018-10-29 17:53:23 +00001780#ifdef SQLITE_ENABLE_NORMALIZE
1781/*
1782** Return the normalized SQL associated with a prepared statement.
1783*/
1784const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt){
1785 Vdbe *p = (Vdbe *)pStmt;
drh707821f2018-12-05 13:39:06 +00001786 if( p==0 ) return 0;
drh1a6c2b12018-12-10 20:01:40 +00001787 if( p->zNormSql==0 && ALWAYS(p->zSql!=0) ){
drh1f169fe2018-12-06 01:08:58 +00001788 sqlite3_mutex_enter(p->db->mutex);
drh1a6c2b12018-12-10 20:01:40 +00001789 p->zNormSql = sqlite3Normalize(p, p->zSql);
drh1f169fe2018-12-06 01:08:58 +00001790 sqlite3_mutex_leave(p->db->mutex);
drh707821f2018-12-05 13:39:06 +00001791 }
1792 return p->zNormSql;
mistachkin8bee11a2018-10-29 17:53:23 +00001793}
1794#endif /* SQLITE_ENABLE_NORMALIZE */
1795
drh9b1c62d2011-03-30 21:04:43 +00001796#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001797/*
dan93bca692011-09-14 19:41:44 +00001798** Allocate and populate an UnpackedRecord structure based on the serialized
1799** record in nKey/pKey. Return a pointer to the new UnpackedRecord structure
1800** if successful, or a NULL pointer if an OOM error is encountered.
1801*/
1802static UnpackedRecord *vdbeUnpackRecord(
1803 KeyInfo *pKeyInfo,
1804 int nKey,
1805 const void *pKey
1806){
dan93bca692011-09-14 19:41:44 +00001807 UnpackedRecord *pRet; /* Return value */
1808
drha582b012016-12-21 19:45:54 +00001809 pRet = sqlite3VdbeAllocUnpackedRecord(pKeyInfo);
dan93bca692011-09-14 19:41:44 +00001810 if( pRet ){
drha485ad12017-08-02 22:43:14 +00001811 memset(pRet->aMem, 0, sizeof(Mem)*(pKeyInfo->nKeyField+1));
dan93bca692011-09-14 19:41:44 +00001812 sqlite3VdbeRecordUnpack(pKeyInfo, nKey, pKey, pRet);
1813 }
1814 return pRet;
1815}
1816
1817/*
dan37db03b2011-03-16 19:59:18 +00001818** This function is called from within a pre-update callback to retrieve
1819** a field of the row currently being updated or deleted.
1820*/
dan46c47d42011-03-01 18:42:07 +00001821int sqlite3_preupdate_old(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
1822 PreUpdate *p = db->pPreUpdate;
dan7271d7a2017-01-25 18:53:27 +00001823 Mem *pMem;
dan46c47d42011-03-01 18:42:07 +00001824 int rc = SQLITE_OK;
1825
dan37db03b2011-03-16 19:59:18 +00001826 /* Test that this call is being made from within an SQLITE_DELETE or
1827 ** SQLITE_UPDATE pre-update callback, and that iIdx is within range. */
dan46c47d42011-03-01 18:42:07 +00001828 if( !p || p->op==SQLITE_INSERT ){
1829 rc = SQLITE_MISUSE_BKPT;
1830 goto preupdate_old_out;
1831 }
dancb9a3642017-01-30 19:44:53 +00001832 if( p->pPk ){
drhb9bcf7c2019-10-19 13:29:10 +00001833 iIdx = sqlite3TableColumnToIndex(p->pPk, iIdx);
dancb9a3642017-01-30 19:44:53 +00001834 }
dan46c47d42011-03-01 18:42:07 +00001835 if( iIdx>=p->pCsr->nField || iIdx<0 ){
1836 rc = SQLITE_RANGE;
1837 goto preupdate_old_out;
1838 }
1839
dan37db03b2011-03-16 19:59:18 +00001840 /* If the old.* record has not yet been loaded into memory, do so now. */
dan46c47d42011-03-01 18:42:07 +00001841 if( p->pUnpacked==0 ){
dan12ca0b52011-03-21 16:17:42 +00001842 u32 nRec;
1843 u8 *aRec;
dan46c47d42011-03-01 18:42:07 +00001844
drha7c90c42016-06-04 20:37:10 +00001845 nRec = sqlite3BtreePayloadSize(p->pCsr->uc.pCursor);
dan12ca0b52011-03-21 16:17:42 +00001846 aRec = sqlite3DbMallocRaw(db, nRec);
1847 if( !aRec ) goto preupdate_old_out;
drhcb3cabd2016-11-25 19:18:28 +00001848 rc = sqlite3BtreePayload(p->pCsr->uc.pCursor, 0, nRec, aRec);
dan12ca0b52011-03-21 16:17:42 +00001849 if( rc==SQLITE_OK ){
dan93bca692011-09-14 19:41:44 +00001850 p->pUnpacked = vdbeUnpackRecord(&p->keyinfo, nRec, aRec);
dan12ca0b52011-03-21 16:17:42 +00001851 if( !p->pUnpacked ) rc = SQLITE_NOMEM;
1852 }
dan46c47d42011-03-01 18:42:07 +00001853 if( rc!=SQLITE_OK ){
dan12ca0b52011-03-21 16:17:42 +00001854 sqlite3DbFree(db, aRec);
dan46c47d42011-03-01 18:42:07 +00001855 goto preupdate_old_out;
1856 }
dan12ca0b52011-03-21 16:17:42 +00001857 p->aRecord = aRec;
dan46c47d42011-03-01 18:42:07 +00001858 }
1859
dan7271d7a2017-01-25 18:53:27 +00001860 pMem = *ppValue = &p->pUnpacked->aMem[iIdx];
1861 if( iIdx==p->pTab->iPKey ){
1862 sqlite3VdbeMemSetInt64(pMem, p->iKey1);
1863 }else if( iIdx>=p->pUnpacked->nField ){
dan46c47d42011-03-01 18:42:07 +00001864 *ppValue = (sqlite3_value *)columnNullValue();
dan7271d7a2017-01-25 18:53:27 +00001865 }else if( p->pTab->aCol[iIdx].affinity==SQLITE_AFF_REAL ){
drh169f0772019-05-02 21:36:26 +00001866 if( pMem->flags & (MEM_Int|MEM_IntReal) ){
drh3242c692019-05-04 01:29:13 +00001867 testcase( pMem->flags & MEM_Int );
1868 testcase( pMem->flags & MEM_IntReal );
dan7271d7a2017-01-25 18:53:27 +00001869 sqlite3VdbeMemRealify(pMem);
dan319eeb72011-03-19 08:38:50 +00001870 }
dan46c47d42011-03-01 18:42:07 +00001871 }
1872
1873 preupdate_old_out:
drhe1ed0b02014-08-26 02:15:07 +00001874 sqlite3Error(db, rc);
dan46c47d42011-03-01 18:42:07 +00001875 return sqlite3ApiExit(db, rc);
1876}
drh9b1c62d2011-03-30 21:04:43 +00001877#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00001878
drh9b1c62d2011-03-30 21:04:43 +00001879#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001880/*
1881** This function is called from within a pre-update callback to retrieve
1882** the number of columns in the row being updated, deleted or inserted.
1883*/
dan46c47d42011-03-01 18:42:07 +00001884int sqlite3_preupdate_count(sqlite3 *db){
1885 PreUpdate *p = db->pPreUpdate;
drha485ad12017-08-02 22:43:14 +00001886 return (p ? p->keyinfo.nKeyField : 0);
dan46c47d42011-03-01 18:42:07 +00001887}
drh9b1c62d2011-03-30 21:04:43 +00001888#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00001889
drh9b1c62d2011-03-30 21:04:43 +00001890#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001891/*
dan1e7a2d42011-03-22 18:45:29 +00001892** This function is designed to be called from within a pre-update callback
1893** only. It returns zero if the change that caused the callback was made
1894** immediately by a user SQL statement. Or, if the change was made by a
1895** trigger program, it returns the number of trigger programs currently
1896** on the stack (1 for a top-level trigger, 2 for a trigger fired by a
1897** top-level trigger etc.).
1898**
1899** For the purposes of the previous paragraph, a foreign key CASCADE, SET NULL
1900** or SET DEFAULT action is considered a trigger.
1901*/
1902int sqlite3_preupdate_depth(sqlite3 *db){
1903 PreUpdate *p = db->pPreUpdate;
1904 return (p ? p->v->nFrame : 0);
1905}
drh9b1c62d2011-03-30 21:04:43 +00001906#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan1e7a2d42011-03-22 18:45:29 +00001907
drh9b1c62d2011-03-30 21:04:43 +00001908#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan1e7a2d42011-03-22 18:45:29 +00001909/*
dana23a8732021-04-21 20:52:17 +00001910** This function is designed to be called from within a pre-update callback
1911** only.
1912*/
1913int sqlite3_preupdate_blobwrite(sqlite3 *db){
1914 PreUpdate *p = db->pPreUpdate;
1915 return (p ? p->iBlobWrite : -1);
1916}
1917#endif
1918
1919#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1920/*
dan37db03b2011-03-16 19:59:18 +00001921** This function is called from within a pre-update callback to retrieve
1922** a field of the row currently being updated or inserted.
1923*/
1924int sqlite3_preupdate_new(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
dan46c47d42011-03-01 18:42:07 +00001925 PreUpdate *p = db->pPreUpdate;
1926 int rc = SQLITE_OK;
dan37db03b2011-03-16 19:59:18 +00001927 Mem *pMem;
dan46c47d42011-03-01 18:42:07 +00001928
dan37db03b2011-03-16 19:59:18 +00001929 if( !p || p->op==SQLITE_DELETE ){
dan46c47d42011-03-01 18:42:07 +00001930 rc = SQLITE_MISUSE_BKPT;
dan37db03b2011-03-16 19:59:18 +00001931 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001932 }
dancb9a3642017-01-30 19:44:53 +00001933 if( p->pPk && p->op!=SQLITE_UPDATE ){
drhb9bcf7c2019-10-19 13:29:10 +00001934 iIdx = sqlite3TableColumnToIndex(p->pPk, iIdx);
dancb9a3642017-01-30 19:44:53 +00001935 }
dan46c47d42011-03-01 18:42:07 +00001936 if( iIdx>=p->pCsr->nField || iIdx<0 ){
1937 rc = SQLITE_RANGE;
dan37db03b2011-03-16 19:59:18 +00001938 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001939 }
dan46c47d42011-03-01 18:42:07 +00001940
dan37db03b2011-03-16 19:59:18 +00001941 if( p->op==SQLITE_INSERT ){
1942 /* For an INSERT, memory cell p->iNewReg contains the serialized record
1943 ** that is being inserted. Deserialize it. */
1944 UnpackedRecord *pUnpack = p->pNewUnpacked;
1945 if( !pUnpack ){
1946 Mem *pData = &p->v->aMem[p->iNewReg];
drhff535a22016-09-20 01:46:15 +00001947 rc = ExpandBlob(pData);
dan37db03b2011-03-16 19:59:18 +00001948 if( rc!=SQLITE_OK ) goto preupdate_new_out;
dan93bca692011-09-14 19:41:44 +00001949 pUnpack = vdbeUnpackRecord(&p->keyinfo, pData->n, pData->z);
dan37db03b2011-03-16 19:59:18 +00001950 if( !pUnpack ){
1951 rc = SQLITE_NOMEM;
1952 goto preupdate_new_out;
1953 }
1954 p->pNewUnpacked = pUnpack;
1955 }
dan2a86c192017-01-25 17:44:13 +00001956 pMem = &pUnpack->aMem[iIdx];
1957 if( iIdx==p->pTab->iPKey ){
1958 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1959 }else if( iIdx>=pUnpack->nField ){
dan37db03b2011-03-16 19:59:18 +00001960 pMem = (sqlite3_value *)columnNullValue();
dan37db03b2011-03-16 19:59:18 +00001961 }
1962 }else{
1963 /* For an UPDATE, memory cell (p->iNewReg+1+iIdx) contains the required
1964 ** value. Make a copy of the cell contents and return a pointer to it.
1965 ** It is not safe to return a pointer to the memory cell itself as the
1966 ** caller may modify the value text encoding.
1967 */
1968 assert( p->op==SQLITE_UPDATE );
1969 if( !p->aNew ){
1970 p->aNew = (Mem *)sqlite3DbMallocZero(db, sizeof(Mem) * p->pCsr->nField);
1971 if( !p->aNew ){
1972 rc = SQLITE_NOMEM;
1973 goto preupdate_new_out;
1974 }
1975 }
drh304637c2011-03-18 16:47:27 +00001976 assert( iIdx>=0 && iIdx<p->pCsr->nField );
dan37db03b2011-03-16 19:59:18 +00001977 pMem = &p->aNew[iIdx];
1978 if( pMem->flags==0 ){
dane43635a2016-10-21 21:21:45 +00001979 if( iIdx==p->pTab->iPKey ){
dan319eeb72011-03-19 08:38:50 +00001980 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1981 }else{
1982 rc = sqlite3VdbeMemCopy(pMem, &p->v->aMem[p->iNewReg+1+iIdx]);
1983 if( rc!=SQLITE_OK ) goto preupdate_new_out;
1984 }
dan37db03b2011-03-16 19:59:18 +00001985 }
1986 }
1987 *ppValue = pMem;
1988
1989 preupdate_new_out:
drhe1ed0b02014-08-26 02:15:07 +00001990 sqlite3Error(db, rc);
dan46c47d42011-03-01 18:42:07 +00001991 return sqlite3ApiExit(db, rc);
1992}
drh9b1c62d2011-03-30 21:04:43 +00001993#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
drh04e8a582014-11-18 21:20:57 +00001994
dan6f9702e2014-11-01 20:38:06 +00001995#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan04489b62014-10-31 20:11:32 +00001996/*
1997** Return status data for a single loop within query pStmt.
1998*/
1999int sqlite3_stmt_scanstatus(
drhd1a1c232014-11-03 16:35:55 +00002000 sqlite3_stmt *pStmt, /* Prepared statement being queried */
dan04489b62014-10-31 20:11:32 +00002001 int idx, /* Index of loop to report on */
drhd1a1c232014-11-03 16:35:55 +00002002 int iScanStatusOp, /* Which metric to return */
2003 void *pOut /* OUT: Write the answer here */
dan04489b62014-10-31 20:11:32 +00002004){
2005 Vdbe *p = (Vdbe*)pStmt;
dan037b5322014-11-03 11:25:32 +00002006 ScanStatus *pScan;
dan6f9702e2014-11-01 20:38:06 +00002007 if( idx<0 || idx>=p->nScan ) return 1;
2008 pScan = &p->aScan[idx];
drhd1a1c232014-11-03 16:35:55 +00002009 switch( iScanStatusOp ){
2010 case SQLITE_SCANSTAT_NLOOP: {
2011 *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
2012 break;
2013 }
2014 case SQLITE_SCANSTAT_NVISIT: {
2015 *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
2016 break;
2017 }
2018 case SQLITE_SCANSTAT_EST: {
drh518140e2014-11-06 03:55:10 +00002019 double r = 1.0;
2020 LogEst x = pScan->nEst;
2021 while( x<100 ){
2022 x += 10;
2023 r *= 0.5;
2024 }
2025 *(double*)pOut = r*sqlite3LogEstToInt(x);
drhd1a1c232014-11-03 16:35:55 +00002026 break;
2027 }
2028 case SQLITE_SCANSTAT_NAME: {
dand72219d2014-11-03 16:39:37 +00002029 *(const char**)pOut = pScan->zName;
drhd1a1c232014-11-03 16:35:55 +00002030 break;
2031 }
2032 case SQLITE_SCANSTAT_EXPLAIN: {
2033 if( pScan->addrExplain ){
2034 *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
2035 }else{
2036 *(const char**)pOut = 0;
2037 }
2038 break;
2039 }
drhc6652b12014-11-06 04:42:20 +00002040 case SQLITE_SCANSTAT_SELECTID: {
2041 if( pScan->addrExplain ){
2042 *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
2043 }else{
2044 *(int*)pOut = -1;
2045 }
2046 break;
2047 }
drhd1a1c232014-11-03 16:35:55 +00002048 default: {
2049 return 1;
dan6f9702e2014-11-01 20:38:06 +00002050 }
2051 }
dan04489b62014-10-31 20:11:32 +00002052 return 0;
2053}
2054
2055/*
2056** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
2057*/
2058void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
2059 Vdbe *p = (Vdbe*)pStmt;
dan6f9702e2014-11-01 20:38:06 +00002060 memset(p->anExec, 0, p->nOp * sizeof(i64));
dan04489b62014-10-31 20:11:32 +00002061}
dan6f9702e2014-11-01 20:38:06 +00002062#endif /* SQLITE_ENABLE_STMT_SCANSTATUS */