blob: ba3bdf6a5f54614f30f44e35a4dd9a00d5b3171a [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
drh4c8555f2009-06-25 01:47:11 +0000365** result as a string or blob but if the string or blob is too large, it
366** then sets the error code to SQLITE_TOOBIG
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){
drh9bd038f2014-08-27 14:14:06 +0000378 if( sqlite3VdbeMemSetStr(pCtx->pOut, z, n, enc, xDel)==SQLITE_TOOBIG ){
drh4c8555f2009-06-25 01:47:11 +0000379 sqlite3_result_error_toobig(pCtx);
380 }
381}
drhda4ca9d2014-09-09 17:27:35 +0000382static int invokeValueDestructor(
383 const void *p, /* Value to destroy */
384 void (*xDel)(void*), /* The destructor */
385 sqlite3_context *pCtx /* Set a SQLITE_TOOBIG error if no NULL */
386){
drhfc59a952014-09-11 23:34:55 +0000387 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000388 if( xDel==0 ){
389 /* noop */
390 }else if( xDel==SQLITE_TRANSIENT ){
391 /* noop */
drhda4ca9d2014-09-09 17:27:35 +0000392 }else{
393 xDel((void*)p);
394 }
395 if( pCtx ) sqlite3_result_error_toobig(pCtx);
396 return SQLITE_TOOBIG;
397}
drh4f26d6c2004-05-26 23:25:30 +0000398void sqlite3_result_blob(
399 sqlite3_context *pCtx,
400 const void *z,
401 int n,
danielk1977d8123362004-06-12 09:25:12 +0000402 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000403){
drh5708d2d2005-06-22 10:53:59 +0000404 assert( n>=0 );
drh9bd038f2014-08-27 14:14:06 +0000405 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000406 setResultStrOrError(pCtx, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000407}
drhda4ca9d2014-09-09 17:27:35 +0000408void sqlite3_result_blob64(
409 sqlite3_context *pCtx,
410 const void *z,
411 sqlite3_uint64 n,
412 void (*xDel)(void *)
413){
414 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000415 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000416 if( n>0x7fffffff ){
417 (void)invokeValueDestructor(z, xDel, pCtx);
418 }else{
419 setResultStrOrError(pCtx, z, (int)n, 0, xDel);
420 }
421}
drh4f26d6c2004-05-26 23:25:30 +0000422void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
drh9bd038f2014-08-27 14:14:06 +0000423 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
424 sqlite3VdbeMemSetDouble(pCtx->pOut, rVal);
drh4f26d6c2004-05-26 23:25:30 +0000425}
426void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000427 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000428 pCtx->isError = SQLITE_ERROR;
drh9bd038f2014-08-27 14:14:06 +0000429 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000430}
danielk1977a1686c92006-01-23 07:52:37 +0000431#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000432void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000433 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000434 pCtx->isError = SQLITE_ERROR;
drh9bd038f2014-08-27 14:14:06 +0000435 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000436}
danielk1977a1686c92006-01-23 07:52:37 +0000437#endif
drhf4479502004-05-27 03:12:53 +0000438void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh9bd038f2014-08-27 14:14:06 +0000439 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
440 sqlite3VdbeMemSetInt64(pCtx->pOut, (i64)iVal);
drh4f26d6c2004-05-26 23:25:30 +0000441}
442void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
drh9bd038f2014-08-27 14:14:06 +0000443 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
444 sqlite3VdbeMemSetInt64(pCtx->pOut, iVal);
drh4f26d6c2004-05-26 23:25:30 +0000445}
446void sqlite3_result_null(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000447 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
448 sqlite3VdbeMemSetNull(pCtx->pOut);
drh4f26d6c2004-05-26 23:25:30 +0000449}
drh22930062017-07-27 03:48:02 +0000450void sqlite3_result_pointer(
451 sqlite3_context *pCtx,
452 void *pPtr,
453 const char *zPType,
454 void (*xDestructor)(void*)
455){
drh3a96a5d2017-06-30 23:09:03 +0000456 Mem *pOut = pCtx->pOut;
457 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh526740b2017-08-24 13:55:46 +0000458 sqlite3VdbeMemRelease(pOut);
459 pOut->flags = MEM_Null;
drh22930062017-07-27 03:48:02 +0000460 sqlite3VdbeMemSetPointer(pOut, pPtr, zPType, xDestructor);
drh3a96a5d2017-06-30 23:09:03 +0000461}
drhbcdf78a2015-09-10 20:34:56 +0000462void sqlite3_result_subtype(sqlite3_context *pCtx, unsigned int eSubtype){
dan5b6c8e42016-01-30 15:46:03 +0000463 Mem *pOut = pCtx->pOut;
464 assert( sqlite3_mutex_held(pOut->db->mutex) );
465 pOut->eSubtype = eSubtype & 0xff;
466 pOut->flags |= MEM_Subtype;
drhbcdf78a2015-09-10 20:34:56 +0000467}
drh4f26d6c2004-05-26 23:25:30 +0000468void sqlite3_result_text(
469 sqlite3_context *pCtx,
470 const char *z,
471 int n,
danielk1977d8123362004-06-12 09:25:12 +0000472 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000473){
drh9bd038f2014-08-27 14:14:06 +0000474 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000475 setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000476}
drhbbf483f2014-09-09 20:30:24 +0000477void sqlite3_result_text64(
drhda4ca9d2014-09-09 17:27:35 +0000478 sqlite3_context *pCtx,
479 const char *z,
480 sqlite3_uint64 n,
481 void (*xDel)(void *),
482 unsigned char enc
483){
484 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000485 assert( xDel!=SQLITE_DYNAMIC );
drh79f7af92014-10-03 16:00:51 +0000486 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drhda4ca9d2014-09-09 17:27:35 +0000487 if( n>0x7fffffff ){
488 (void)invokeValueDestructor(z, xDel, pCtx);
489 }else{
490 setResultStrOrError(pCtx, z, (int)n, enc, xDel);
491 }
492}
drh6c626082004-11-14 21:56:29 +0000493#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000494void sqlite3_result_text16(
495 sqlite3_context *pCtx,
496 const void *z,
497 int n,
danielk1977d8123362004-06-12 09:25:12 +0000498 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000499){
drh9bd038f2014-08-27 14:14:06 +0000500 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000501 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000502}
503void sqlite3_result_text16be(
504 sqlite3_context *pCtx,
505 const void *z,
506 int n,
507 void (*xDel)(void *)
508){
drh9bd038f2014-08-27 14:14:06 +0000509 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000510 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000511}
512void sqlite3_result_text16le(
513 sqlite3_context *pCtx,
514 const void *z,
515 int n,
516 void (*xDel)(void *)
517){
drh9bd038f2014-08-27 14:14:06 +0000518 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000519 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000520}
drh6c626082004-11-14 21:56:29 +0000521#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000522void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh9bd038f2014-08-27 14:14:06 +0000523 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
524 sqlite3VdbeMemCopy(pCtx->pOut, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000525}
drhb026e052007-05-02 01:34:31 +0000526void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh9bd038f2014-08-27 14:14:06 +0000527 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
528 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
drhb026e052007-05-02 01:34:31 +0000529}
dana4d5ae82015-07-24 16:24:37 +0000530int sqlite3_result_zeroblob64(sqlite3_context *pCtx, u64 n){
531 Mem *pOut = pCtx->pOut;
532 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh6bacdc22015-07-24 17:14:03 +0000533 if( n>(u64)pOut->db->aLimit[SQLITE_LIMIT_LENGTH] ){
dana4d5ae82015-07-24 16:24:37 +0000534 return SQLITE_TOOBIG;
535 }
536 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, (int)n);
537 return SQLITE_OK;
538}
drh69544ec2008-02-06 14:11:34 +0000539void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
drhf09ac0b2018-01-23 03:44:06 +0000540 pCtx->isError = errCode ? errCode : -1;
drh983b5ee2015-02-13 12:05:56 +0000541#ifdef SQLITE_DEBUG
drh96f4ad22015-03-12 21:02:36 +0000542 if( pCtx->pVdbe ) pCtx->pVdbe->rcApp = errCode;
drh983b5ee2015-02-13 12:05:56 +0000543#endif
drh9bd038f2014-08-27 14:14:06 +0000544 if( pCtx->pOut->flags & MEM_Null ){
545 sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
drh51c7d862009-04-27 18:46:06 +0000546 SQLITE_UTF8, SQLITE_STATIC);
547 }
drh69544ec2008-02-06 14:11:34 +0000548}
drh4f26d6c2004-05-26 23:25:30 +0000549
drha0206bc2007-05-08 15:15:02 +0000550/* Force an SQLITE_TOOBIG error. */
551void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000552 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000553 pCtx->isError = SQLITE_TOOBIG;
drh9bd038f2014-08-27 14:14:06 +0000554 sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
drhbb4957f2008-03-20 14:03:29 +0000555 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000556}
557
danielk1977a1644fd2007-08-29 12:31:25 +0000558/* An SQLITE_NOMEM error. */
559void sqlite3_result_error_nomem(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000560 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
561 sqlite3VdbeMemSetNull(pCtx->pOut);
mistachkinfad30392016-02-13 23:43:46 +0000562 pCtx->isError = SQLITE_NOMEM_BKPT;
drh4a642b62016-02-05 01:55:27 +0000563 sqlite3OomFault(pCtx->pOut->db);
danielk1977a1644fd2007-08-29 12:31:25 +0000564}
drh4f26d6c2004-05-26 23:25:30 +0000565
drh0c8f4032019-05-03 21:17:28 +0000566#ifndef SQLITE_UNTESTABLE
567/* Force the INT64 value currently stored as the result to be
568** a MEM_IntReal value. See the SQLITE_TESTCTRL_RESULT_INTREAL
569** test-control.
570*/
571void sqlite3ResultIntReal(sqlite3_context *pCtx){
572 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
573 if( pCtx->pOut->flags & MEM_Int ){
574 pCtx->pOut->flags &= ~MEM_Int;
575 pCtx->pOut->flags |= MEM_IntReal;
576 }
577}
578#endif
579
580
dan5cf53532010-05-01 16:40:20 +0000581/*
582** This function is called after a transaction has been committed. It
583** invokes callbacks registered with sqlite3_wal_hook() as required.
584*/
drh7ed91f22010-04-29 22:34:07 +0000585static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000586 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000587#ifndef SQLITE_OMIT_WAL
588 int i;
dan8d22a172010-04-19 18:03:51 +0000589 for(i=0; i<db->nDb; i++){
590 Btree *pBt = db->aDb[i].pBt;
591 if( pBt ){
drhef15c6e2014-12-12 01:27:17 +0000592 int nEntry;
593 sqlite3BtreeEnter(pBt);
594 nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
595 sqlite3BtreeLeave(pBt);
drh59533aa2017-08-02 18:28:26 +0000596 if( nEntry>0 && db->xWalCallback && rc==SQLITE_OK ){
drh69c33822016-08-18 14:33:11 +0000597 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zDbSName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000598 }
599 }
600 }
dan5cf53532010-05-01 16:40:20 +0000601#endif
dan8d22a172010-04-19 18:03:51 +0000602 return rc;
603}
604
drh201e0c62015-07-14 14:48:50 +0000605
drh4f26d6c2004-05-26 23:25:30 +0000606/*
607** Execute the statement pStmt, either until a row of data is ready, the
608** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000609**
610** This routine implements the bulk of the logic behind the sqlite_step()
611** API. The only thing omitted is the automatic recompile if a
612** schema change has occurred. That detail is handled by the
613** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000614*/
drhb900aaf2006-11-09 00:24:53 +0000615static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000616 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000617 int rc;
618
danielk1977a185ddb2007-11-15 16:04:15 +0000619 assert(p);
drh17b74812021-02-03 18:32:25 +0000620 if( p->iVdbeMagic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000621 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000622 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
623 ** with version 3.7.0, we changed this so that sqlite3_reset() would
624 ** be called automatically instead of throwing the SQLITE_MISUSE error.
625 ** This "automatic-reset" change is not technically an incompatibility,
626 ** since any application that receives an SQLITE_MISUSE is broken by
627 ** definition.
628 **
629 ** Nevertheless, some published applications that were originally written
630 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000631 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000632 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
633 ** legacy behavior of returning SQLITE_MISUSE for cases where the
634 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
635 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000636 */
drh602acb42011-01-17 17:42:37 +0000637#ifdef SQLITE_OMIT_AUTORESET
drh983b5ee2015-02-13 12:05:56 +0000638 if( (rc = p->rc&0xff)==SQLITE_BUSY || rc==SQLITE_LOCKED ){
drh602acb42011-01-17 17:42:37 +0000639 sqlite3_reset((sqlite3_stmt*)p);
640 }else{
641 return SQLITE_MISUSE_BKPT;
642 }
643#else
drh3674bfd2010-04-17 12:53:19 +0000644 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000645#endif
drhf1bfe9a2007-10-17 01:44:20 +0000646 }
647
dan14d4cc42010-01-20 14:25:37 +0000648 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000649 db = p->db;
drhc456e572008-08-11 18:44:58 +0000650 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000651 p->rc = SQLITE_NOMEM;
mistachkinfad30392016-02-13 23:43:46 +0000652 return SQLITE_NOMEM_BKPT;
drhc456e572008-08-11 18:44:58 +0000653 }
danielk1977261919c2005-12-06 12:52:59 +0000654
drhcfc07832018-12-11 12:51:46 +0000655 if( p->pc<0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000656 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000657 rc = SQLITE_ERROR;
drh5cbb4422020-06-29 13:12:42 +0000658 if( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 ){
659 /* If this statement was prepared using saved SQL and an
660 ** error has occurred, then return the error code in p->rc to the
661 ** caller. Set the error code in the database handle to the same value.
662 */
663 rc = sqlite3VdbeTransferError(p);
664 }
drhb900aaf2006-11-09 00:24:53 +0000665 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000666 }
danielk19771d850a72004-05-31 08:26:49 +0000667 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000668 /* If there are no other statements currently running, then
669 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
670 ** from interrupting a statement that has not yet started.
671 */
drh4f7d3a52013-06-27 23:54:02 +0000672 if( db->nVdbeActive==0 ){
dan892edb62020-03-30 13:35:05 +0000673 AtomicStore(&db->u1.isInterrupted, 0);
drh15ca1df2006-07-26 13:43:30 +0000674 }
675
drh888e16e2013-07-09 13:05:49 +0000676 assert( db->nVdbeWrite>0 || db->autoCommit==0
dancb3e4b72013-07-03 19:53:05 +0000677 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
678 );
dan1da40a32009-09-19 17:00:31 +0000679
drh19e2d372005-08-29 23:00:03 +0000680#ifndef SQLITE_OMIT_TRACE
drh04c67472018-12-04 14:33:02 +0000681 if( (db->mTrace & (SQLITE_TRACE_PROFILE|SQLITE_TRACE_XPROFILE))!=0
drh3d2a5292016-07-13 22:55:01 +0000682 && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000683 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh201e0c62015-07-14 14:48:50 +0000684 }else{
685 assert( p->startTime==0 );
drh19e2d372005-08-29 23:00:03 +0000686 }
687#endif
drhc16a03b2004-09-15 13:38:10 +0000688
drh4f7d3a52013-06-27 23:54:02 +0000689 db->nVdbeActive++;
690 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000691 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000692 p->pc = 0;
693 }
drh983b5ee2015-02-13 12:05:56 +0000694#ifdef SQLITE_DEBUG
695 p->rcApp = SQLITE_OK;
696#endif
drhb7f91642004-10-31 02:22:47 +0000697#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000698 if( p->explain ){
699 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000700 }else
701#endif /* SQLITE_OMIT_EXPLAIN */
702 {
drh4f7d3a52013-06-27 23:54:02 +0000703 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000704 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000705 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000706 }
707
drhb7de8272018-12-04 13:51:26 +0000708 if( rc!=SQLITE_ROW ){
drh19e2d372005-08-29 23:00:03 +0000709#ifndef SQLITE_OMIT_TRACE
drhb7de8272018-12-04 13:51:26 +0000710 /* If the statement completed successfully, invoke the profile callback */
711 checkProfileCallback(db, p);
drh19e2d372005-08-29 23:00:03 +0000712#endif
713
drhb7de8272018-12-04 13:51:26 +0000714 if( rc==SQLITE_DONE && db->autoCommit ){
715 assert( p->rc==SQLITE_OK );
716 p->rc = doWalCallbacks(db);
717 if( p->rc!=SQLITE_OK ){
718 rc = SQLITE_ERROR;
719 }
drh5cbb4422020-06-29 13:12:42 +0000720 }else if( rc!=SQLITE_DONE && (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 ){
721 /* If this statement was prepared using saved SQL and an
722 ** error has occurred, then return the error code in p->rc to the
723 ** caller. Set the error code in the database handle to the same value.
724 */
725 rc = sqlite3VdbeTransferError(p);
dan8d22a172010-04-19 18:03:51 +0000726 }
727 }
728
drh80cc85b2008-07-23 21:07:25 +0000729 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000730 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
mistachkinfad30392016-02-13 23:43:46 +0000731 p->rc = SQLITE_NOMEM_BKPT;
drh5cbb4422020-06-29 13:12:42 +0000732 if( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 ) rc = p->rc;
drhb900aaf2006-11-09 00:24:53 +0000733 }
danielk1977357864e2009-03-25 15:43:08 +0000734end_of_step:
drh5cbb4422020-06-29 13:12:42 +0000735 /* There are only a limited number of result codes allowed from the
736 ** statements prepared using the legacy sqlite3_prepare() interface */
737 assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0
738 || rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
drhcbd8db32015-08-20 17:18:32 +0000739 || (rc&0xff)==SQLITE_BUSY || rc==SQLITE_MISUSE
danielk1977357864e2009-03-25 15:43:08 +0000740 );
danielk1977357864e2009-03-25 15:43:08 +0000741 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000742}
743
744/*
745** This is the top-level implementation of sqlite3_step(). Call
746** sqlite3Step() to do most of the work. If a schema error occurs,
747** call sqlite3Reprepare() and try again.
748*/
drhb900aaf2006-11-09 00:24:53 +0000749int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000750 int rc = SQLITE_OK; /* Result from sqlite3Step() */
drha6129fa2010-02-24 17:15:19 +0000751 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
752 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
753 sqlite3 *db; /* The database connection */
754
drh413c3d32010-02-23 20:11:56 +0000755 if( vdbeSafetyNotNull(v) ){
756 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000757 }
drh413c3d32010-02-23 20:11:56 +0000758 db = v->db;
759 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000760 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000761 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh2c7946a2014-08-19 20:27:40 +0000762 && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
763 int savedPc = v->pc;
drh754ee282017-08-02 19:04:37 +0000764 rc = sqlite3Reprepare(v);
765 if( rc!=SQLITE_OK ){
766 /* This case occurs after failing to recompile an sql statement.
767 ** The error message from the SQL compiler has already been loaded
768 ** into the database handle. This block copies the error message
769 ** from the database handle into the statement and sets the statement
770 ** program counter to 0 to ensure that when the statement is
771 ** finalized or reset the parser error message is available via
772 ** sqlite3_errmsg() and sqlite3_errcode().
773 */
774 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
775 sqlite3DbFree(db, v->zErrMsg);
776 if( !db->mallocFailed ){
777 v->zErrMsg = sqlite3DbStrDup(db, zErr);
778 v->rc = rc = sqlite3ApiExit(db, rc);
779 } else {
780 v->zErrMsg = 0;
781 v->rc = rc = SQLITE_NOMEM_BKPT;
782 }
783 break;
784 }
drh413c3d32010-02-23 20:11:56 +0000785 sqlite3_reset(pStmt);
drh5f58ae72014-08-19 20:41:36 +0000786 if( savedPc>=0 ) v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000787 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000788 }
drh413c3d32010-02-23 20:11:56 +0000789 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000790 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000791}
792
drh95a7b3e2013-09-16 12:57:19 +0000793
drh4f26d6c2004-05-26 23:25:30 +0000794/*
drheb2e1762004-05-27 01:53:56 +0000795** Extract the user data from a sqlite3_context structure and return a
796** pointer to it.
797*/
798void *sqlite3_user_data(sqlite3_context *p){
799 assert( p && p->pFunc );
800 return p->pFunc->pUserData;
801}
802
803/*
drhfa4a4b92008-03-19 21:45:51 +0000804** Extract the user data from a sqlite3_context structure and return a
805** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000806**
807** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
808** returns a copy of the pointer to the database connection (the 1st
809** parameter) of the sqlite3_create_function() and
810** sqlite3_create_function16() routines that originally registered the
811** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000812*/
813sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
drha46a4a62015-09-08 21:12:53 +0000814 assert( p && p->pOut );
drh9bd038f2014-08-27 14:14:06 +0000815 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000816}
817
818/*
drh6f390be2018-01-11 17:04:26 +0000819** If this routine is invoked from within an xColumn method of a virtual
820** table, then it returns true if and only if the the call is during an
821** UPDATE operation and the value of the column will not be modified
822** by the UPDATE.
823**
824** If this routine is called from any context other than within the
825** xColumn method of a virtual table, then the return value is meaningless
826** and arbitrary.
827**
828** Virtual table implements might use this routine to optimize their
829** performance by substituting a NULL result, or some other light-weight
830** value, as a signal to the xUpdate routine that the column is unchanged.
831*/
832int sqlite3_vtab_nochange(sqlite3_context *p){
833 assert( p );
drhce2fbd12018-01-12 21:00:14 +0000834 return sqlite3_value_nochange(p->pOut);
drh6f390be2018-01-11 17:04:26 +0000835}
836
837/*
drha9e03b12015-03-12 06:46:52 +0000838** Return the current time for a statement. If the current time
839** is requested more than once within the same run of a single prepared
840** statement, the exact same time is returned for each invocation regardless
841** of the amount of time that elapses between invocations. In other words,
842** the time returned is always the time of the first call.
drh95a7b3e2013-09-16 12:57:19 +0000843*/
844sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
drh95a7b3e2013-09-16 12:57:19 +0000845 int rc;
drh175b8f02019-08-08 15:24:17 +0000846#ifndef SQLITE_ENABLE_STAT4
drh3df79a92015-03-12 23:48:27 +0000847 sqlite3_int64 *piTime = &p->pVdbe->iCurrentTime;
drha9e03b12015-03-12 06:46:52 +0000848 assert( p->pVdbe!=0 );
849#else
drh3df79a92015-03-12 23:48:27 +0000850 sqlite3_int64 iTime = 0;
drha9e03b12015-03-12 06:46:52 +0000851 sqlite3_int64 *piTime = p->pVdbe!=0 ? &p->pVdbe->iCurrentTime : &iTime;
drha9e03b12015-03-12 06:46:52 +0000852#endif
drh3df79a92015-03-12 23:48:27 +0000853 if( *piTime==0 ){
drha9e03b12015-03-12 06:46:52 +0000854 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, piTime);
855 if( rc ) *piTime = 0;
drh95a7b3e2013-09-16 12:57:19 +0000856 }
drha9e03b12015-03-12 06:46:52 +0000857 return *piTime;
drh95a7b3e2013-09-16 12:57:19 +0000858}
859
860/*
drh9de4a172014-08-23 18:17:19 +0000861** Create a new aggregate context for p and return a pointer to
862** its pMem->z element.
863*/
864static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
865 Mem *pMem = p->pMem;
866 assert( (pMem->flags & MEM_Agg)==0 );
867 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000868 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000869 pMem->z = 0;
870 }else{
drh322f2852014-09-19 00:43:39 +0000871 sqlite3VdbeMemClearAndResize(pMem, nByte);
drh9de4a172014-08-23 18:17:19 +0000872 pMem->flags = MEM_Agg;
873 pMem->u.pDef = p->pFunc;
874 if( pMem->z ){
875 memset(pMem->z, 0, nByte);
876 }
877 }
878 return (void*)pMem->z;
879}
880
881/*
drheb2e1762004-05-27 01:53:56 +0000882** Allocate or return the aggregate context for a user function. A new
883** context is allocated on the first call. Subsequent calls return the
884** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000885*/
886void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh2d801512016-01-14 22:19:58 +0000887 assert( p && p->pFunc && p->pFunc->xFinalize );
drh9bd038f2014-08-27 14:14:06 +0000888 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000889 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000890 if( (p->pMem->flags & MEM_Agg)==0 ){
891 return createAggContext(p, nByte);
892 }else{
893 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000894 }
drheb2e1762004-05-27 01:53:56 +0000895}
896
897/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000898** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000899** the user-function defined by pCtx.
drhf7fa4e72017-05-11 15:20:18 +0000900**
901** The left-most argument is 0.
902**
903** Undocumented behavior: If iArg is negative then access a cache of
904** auxiliary data pointers that is available to all functions within a
905** single prepared statement. The iArg values must match.
danielk1977682f68b2004-06-05 10:22:17 +0000906*/
907void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000908 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000909
drh9bd038f2014-08-27 14:14:06 +0000910 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh175b8f02019-08-08 15:24:17 +0000911#if SQLITE_ENABLE_STAT4
dan18bf8072015-03-11 20:06:40 +0000912 if( pCtx->pVdbe==0 ) return 0;
drha9e03b12015-03-12 06:46:52 +0000913#else
914 assert( pCtx->pVdbe!=0 );
915#endif
drhe6941392017-05-10 19:42:52 +0000916 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
drhf7fa4e72017-05-11 15:20:18 +0000917 if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
drhe6941392017-05-10 19:42:52 +0000918 return pAuxData->pAux;
919 }
danielk1977682f68b2004-06-05 10:22:17 +0000920 }
drhe6941392017-05-10 19:42:52 +0000921 return 0;
danielk1977682f68b2004-06-05 10:22:17 +0000922}
923
924/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000925** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000926** argument to the user-function defined by pCtx. Any previous value is
927** deleted by calling the delete function specified when it was set.
drhf7fa4e72017-05-11 15:20:18 +0000928**
929** The left-most argument is 0.
930**
931** Undocumented behavior: If iArg is negative then make the data available
932** to all functions within the current prepared statement using iArg as an
933** access code.
danielk1977682f68b2004-06-05 10:22:17 +0000934*/
935void sqlite3_set_auxdata(
936 sqlite3_context *pCtx,
937 int iArg,
938 void *pAux,
939 void (*xDelete)(void*)
940){
dan0c547792013-07-18 17:12:08 +0000941 AuxData *pAuxData;
942 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000943
drh9bd038f2014-08-27 14:14:06 +0000944 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh175b8f02019-08-08 15:24:17 +0000945#ifdef SQLITE_ENABLE_STAT4
dan18bf8072015-03-11 20:06:40 +0000946 if( pVdbe==0 ) goto failed;
drha9e03b12015-03-12 06:46:52 +0000947#else
948 assert( pVdbe!=0 );
949#endif
danielk1977682f68b2004-06-05 10:22:17 +0000950
drhe6941392017-05-10 19:42:52 +0000951 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
drhf7fa4e72017-05-11 15:20:18 +0000952 if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
953 break;
954 }
dan0c547792013-07-18 17:12:08 +0000955 }
956 if( pAuxData==0 ){
957 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
958 if( !pAuxData ) goto failed;
drhe6941392017-05-10 19:42:52 +0000959 pAuxData->iAuxOp = pCtx->iOp;
960 pAuxData->iAuxArg = iArg;
961 pAuxData->pNextAux = pVdbe->pAuxData;
dan0c547792013-07-18 17:12:08 +0000962 pVdbe->pAuxData = pAuxData;
drhf09ac0b2018-01-23 03:44:06 +0000963 if( pCtx->isError==0 ) pCtx->isError = -1;
drhe6941392017-05-10 19:42:52 +0000964 }else if( pAuxData->xDeleteAux ){
965 pAuxData->xDeleteAux(pAuxData->pAux);
danielk1977682f68b2004-06-05 10:22:17 +0000966 }
dan0c547792013-07-18 17:12:08 +0000967
danielk1977682f68b2004-06-05 10:22:17 +0000968 pAuxData->pAux = pAux;
drhe6941392017-05-10 19:42:52 +0000969 pAuxData->xDeleteAux = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000970 return;
971
972failed:
973 if( xDelete ){
974 xDelete(pAux);
975 }
danielk1977682f68b2004-06-05 10:22:17 +0000976}
977
shaneeec556d2008-10-12 00:27:53 +0000978#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000979/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000980** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000981** called.
982**
drhcf85a512006-02-09 18:35:29 +0000983** This function is deprecated. Do not use it for new code. It is
984** provide only to avoid breaking legacy code. New aggregate function
985** implementations should keep their own counts within their aggregate
986** context.
drheb2e1762004-05-27 01:53:56 +0000987*/
988int sqlite3_aggregate_count(sqlite3_context *p){
drh2d801512016-01-14 22:19:58 +0000989 assert( p && p->pMem && p->pFunc && p->pFunc->xFinalize );
drhabfcea22005-09-06 20:36:48 +0000990 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000991}
shaneeec556d2008-10-12 00:27:53 +0000992#endif
drheb2e1762004-05-27 01:53:56 +0000993
994/*
drh4f26d6c2004-05-26 23:25:30 +0000995** Return the number of columns in the result set for the statement pStmt.
996*/
997int sqlite3_column_count(sqlite3_stmt *pStmt){
998 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000999 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +00001000}
1001
1002/*
1003** Return the number of values available from the current row of the
1004** currently executing statement pStmt.
1005*/
1006int sqlite3_data_count(sqlite3_stmt *pStmt){
1007 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +00001008 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +00001009 return pVm->nResColumn;
1010}
1011
dan46c47d42011-03-01 18:42:07 +00001012/*
1013** Return a pointer to static memory containing an SQL NULL value.
1014*/
1015static const Mem *columnNullValue(void){
1016 /* Even though the Mem structure contains an element
drhb1a1c292014-03-05 12:47:55 +00001017 ** of type i64, on certain architectures (x86) with certain compiler
dan46c47d42011-03-01 18:42:07 +00001018 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
1019 ** instead of an 8-byte one. This all works fine, except that when
1020 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
1021 ** that a Mem structure is located on an 8-byte boundary. To prevent
drhb1a1c292014-03-05 12:47:55 +00001022 ** these assert()s from failing, when building with SQLITE_DEBUG defined
1023 ** using gcc, we force nullMem to be 8-byte aligned using the magical
dan46c47d42011-03-01 18:42:07 +00001024 ** __attribute__((aligned(8))) macro. */
1025 static const Mem nullMem
1026#if defined(SQLITE_DEBUG) && defined(__GNUC__)
drhb1a1c292014-03-05 12:47:55 +00001027 __attribute__((aligned(8)))
dan46c47d42011-03-01 18:42:07 +00001028#endif
drh035e5632014-09-16 14:16:31 +00001029 = {
drh3329a632014-09-18 01:21:43 +00001030 /* .u = */ {0},
drh8faee872015-09-19 18:08:13 +00001031 /* .flags = */ (u16)MEM_Null,
1032 /* .enc = */ (u8)0,
1033 /* .eSubtype = */ (u8)0,
1034 /* .n = */ (int)0,
1035 /* .z = */ (char*)0,
1036 /* .zMalloc = */ (char*)0,
1037 /* .szMalloc = */ (int)0,
1038 /* .uTemp = */ (u32)0,
1039 /* .db = */ (sqlite3*)0,
1040 /* .xDel = */ (void(*)(void*))0,
drhb1a1c292014-03-05 12:47:55 +00001041#ifdef SQLITE_DEBUG
drh8faee872015-09-19 18:08:13 +00001042 /* .pScopyFrom = */ (Mem*)0,
drh58773a52018-06-12 13:52:23 +00001043 /* .mScopyFlags= */ 0,
1044#endif
drh035e5632014-09-16 14:16:31 +00001045 };
dan46c47d42011-03-01 18:42:07 +00001046 return &nullMem;
1047}
drh4f26d6c2004-05-26 23:25:30 +00001048
1049/*
1050** Check to see if column iCol of the given statement is valid. If
1051** it is, return a pointer to the Mem for the value of that column.
1052** If iCol is not valid, return a pointer to a Mem which has a value
1053** of NULL.
1054*/
1055static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +00001056 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +00001057 Mem *pOut;
1058
1059 pVm = (Vdbe *)pStmt;
drh28f17012016-09-22 21:37:18 +00001060 if( pVm==0 ) return (Mem*)columnNullValue();
1061 assert( pVm->db );
1062 sqlite3_mutex_enter(pVm->db->mutex);
1063 if( pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drhd4e70eb2008-01-02 00:34:36 +00001064 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +00001065 }else{
drh28f17012016-09-22 21:37:18 +00001066 sqlite3Error(pVm->db, SQLITE_RANGE);
dan46c47d42011-03-01 18:42:07 +00001067 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +00001068 }
drh32bc3f62007-08-21 20:25:39 +00001069 return pOut;
drh4f26d6c2004-05-26 23:25:30 +00001070}
1071
danielk19772e588c72005-12-09 14:25:08 +00001072/*
1073** This function is called after invoking an sqlite3_value_XXX function on a
1074** column value (i.e. a value returned by evaluating an SQL expression in the
1075** select list of a SELECT statement) that may cause a malloc() failure. If
1076** malloc() has failed, the threads mallocFailed flag is cleared and the result
1077** code of statement pStmt set to SQLITE_NOMEM.
1078**
drh32bc3f62007-08-21 20:25:39 +00001079** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +00001080**
1081** sqlite3_column_int()
1082** sqlite3_column_int64()
1083** sqlite3_column_text()
1084** sqlite3_column_text16()
1085** sqlite3_column_real()
1086** sqlite3_column_bytes()
1087** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +00001088** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +00001089*/
1090static void columnMallocFailure(sqlite3_stmt *pStmt)
1091{
1092 /* If malloc() failed during an encoding conversion within an
1093 ** sqlite3_column_XXX API, then set the return code of the statement to
1094 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
1095 ** and _finalize() will return NOMEM.
1096 */
danielk197754f01982006-01-18 15:25:17 +00001097 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +00001098 if( p ){
drh28f17012016-09-22 21:37:18 +00001099 assert( p->db!=0 );
1100 assert( sqlite3_mutex_held(p->db->mutex) );
drh32bc3f62007-08-21 20:25:39 +00001101 p->rc = sqlite3ApiExit(p->db, p->rc);
1102 sqlite3_mutex_leave(p->db->mutex);
1103 }
danielk19772e588c72005-12-09 14:25:08 +00001104}
1105
drh4f26d6c2004-05-26 23:25:30 +00001106/**************************** sqlite3_column_ *******************************
1107** The following routines are used to access elements of the current row
1108** in the result set.
1109*/
danielk1977c572ef72004-05-27 09:28:41 +00001110const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001111 const void *val;
danielk19772e588c72005-12-09 14:25:08 +00001112 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +00001113 /* Even though there is no encoding conversion, value_blob() might
1114 ** need to call malloc() to expand the result of a zeroblob()
1115 ** expression.
1116 */
1117 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +00001118 return val;
danielk1977c572ef72004-05-27 09:28:41 +00001119}
drh4f26d6c2004-05-26 23:25:30 +00001120int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001121 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
1122 columnMallocFailure(pStmt);
1123 return val;
drh4f26d6c2004-05-26 23:25:30 +00001124}
1125int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001126 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
1127 columnMallocFailure(pStmt);
1128 return val;
drh4f26d6c2004-05-26 23:25:30 +00001129}
1130double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001131 double val = sqlite3_value_double( columnMem(pStmt,i) );
1132 columnMallocFailure(pStmt);
1133 return val;
drh4f26d6c2004-05-26 23:25:30 +00001134}
1135int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001136 int val = sqlite3_value_int( columnMem(pStmt,i) );
1137 columnMallocFailure(pStmt);
1138 return val;
drh4f26d6c2004-05-26 23:25:30 +00001139}
drhefad9992004-06-22 12:13:55 +00001140sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001141 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
1142 columnMallocFailure(pStmt);
1143 return val;
drh4f26d6c2004-05-26 23:25:30 +00001144}
1145const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001146 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
1147 columnMallocFailure(pStmt);
1148 return val;
drh4f26d6c2004-05-26 23:25:30 +00001149}
drhd1e47332005-06-26 17:55:33 +00001150sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +00001151 Mem *pOut = columnMem(pStmt, i);
1152 if( pOut->flags&MEM_Static ){
1153 pOut->flags &= ~MEM_Static;
1154 pOut->flags |= MEM_Ephem;
1155 }
drh32bc3f62007-08-21 20:25:39 +00001156 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +00001157 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +00001158}
drh6c626082004-11-14 21:56:29 +00001159#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001160const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001161 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
1162 columnMallocFailure(pStmt);
1163 return val;
drh4f26d6c2004-05-26 23:25:30 +00001164}
drh6c626082004-11-14 21:56:29 +00001165#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +00001166int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +00001167 int iType = sqlite3_value_type( columnMem(pStmt,i) );
1168 columnMallocFailure(pStmt);
1169 return iType;
drh4f26d6c2004-05-26 23:25:30 +00001170}
1171
drh5e2517e2004-09-24 23:59:12 +00001172/*
1173** Convert the N-th element of pStmt->pColName[] into a string using
1174** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +00001175**
1176** There are up to 5 names for each column. useType determines which
1177** name is returned. Here are the names:
1178**
1179** 0 The column name as it should be displayed for output
1180** 1 The datatype name for the column
1181** 2 The name of the database that the column derives from
1182** 3 The name of the table that the column derives from
1183** 4 The name of the table column that the result column derives from
1184**
1185** If the result is not a simple column reference (if it is an expression
1186** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +00001187*/
1188static const void *columnName(
drh8cf92892019-02-20 18:13:57 +00001189 sqlite3_stmt *pStmt, /* The statement */
1190 int N, /* Which column to get the name for */
1191 int useUtf16, /* True to return the name as UTF16 */
1192 int useType /* What type of name */
drh5e2517e2004-09-24 23:59:12 +00001193){
drh9ca95732014-10-24 00:35:58 +00001194 const void *ret;
1195 Vdbe *p;
drh32bc3f62007-08-21 20:25:39 +00001196 int n;
drh9ca95732014-10-24 00:35:58 +00001197 sqlite3 *db;
1198#ifdef SQLITE_ENABLE_API_ARMOR
1199 if( pStmt==0 ){
1200 (void)SQLITE_MISUSE_BKPT;
1201 return 0;
1202 }
1203#endif
1204 ret = 0;
1205 p = (Vdbe *)pStmt;
1206 db = p->db;
drh9b4ea4a2009-04-10 20:32:00 +00001207 assert( db!=0 );
1208 n = sqlite3_column_count(pStmt);
1209 if( N<n && N>=0 ){
1210 N += useType*n;
1211 sqlite3_mutex_enter(db->mutex);
1212 assert( db->mallocFailed==0 );
dan4474e862019-03-04 07:15:57 +00001213#ifndef SQLITE_OMIT_UTF16
drh8cf92892019-02-20 18:13:57 +00001214 if( useUtf16 ){
1215 ret = sqlite3_value_text16((sqlite3_value*)&p->aColName[N]);
dan4474e862019-03-04 07:15:57 +00001216 }else
1217#endif
1218 {
drh8cf92892019-02-20 18:13:57 +00001219 ret = sqlite3_value_text((sqlite3_value*)&p->aColName[N]);
1220 }
1221 /* A malloc may have failed inside of the _text() call. If this
drh9b4ea4a2009-04-10 20:32:00 +00001222 ** is the case, clear the mallocFailed flag and return NULL.
1223 */
1224 if( db->mallocFailed ){
drh4a642b62016-02-05 01:55:27 +00001225 sqlite3OomClear(db);
drh9b4ea4a2009-04-10 20:32:00 +00001226 ret = 0;
drh32bc3f62007-08-21 20:25:39 +00001227 }
drh9b4ea4a2009-04-10 20:32:00 +00001228 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +00001229 }
danielk197700fd9572005-12-07 06:27:43 +00001230 return ret;
drh5e2517e2004-09-24 23:59:12 +00001231}
1232
drh4f26d6c2004-05-26 23:25:30 +00001233/*
1234** Return the name of the Nth column of the result set returned by SQL
1235** statement pStmt.
1236*/
1237const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001238 return columnName(pStmt, N, 0, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +00001239}
drhe590fbd2005-05-20 19:36:01 +00001240#ifndef SQLITE_OMIT_UTF16
1241const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001242 return columnName(pStmt, N, 1, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001243}
1244#endif
drh4f26d6c2004-05-26 23:25:30 +00001245
1246/*
drh3f913572008-03-22 01:07:17 +00001247** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1248** not define OMIT_DECLTYPE.
1249*/
1250#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1251# error "Must not define both SQLITE_OMIT_DECLTYPE \
1252 and SQLITE_ENABLE_COLUMN_METADATA"
1253#endif
1254
1255#ifndef SQLITE_OMIT_DECLTYPE
1256/*
drh6c626082004-11-14 21:56:29 +00001257** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001258** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001259*/
1260const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001261 return columnName(pStmt, N, 0, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001262}
drh6c626082004-11-14 21:56:29 +00001263#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001264const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001265 return columnName(pStmt, N, 1, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001266}
drh6c626082004-11-14 21:56:29 +00001267#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001268#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001269
danielk19774b1ae992006-02-10 03:06:10 +00001270#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001271/*
1272** Return the name of the database from which a result column derives.
1273** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001274** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001275*/
1276const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001277 return columnName(pStmt, N, 0, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001278}
1279#ifndef SQLITE_OMIT_UTF16
1280const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001281 return columnName(pStmt, N, 1, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001282}
1283#endif /* SQLITE_OMIT_UTF16 */
1284
1285/*
1286** Return the name of the table from which a result column derives.
1287** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001288** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001289*/
1290const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001291 return columnName(pStmt, N, 0, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001292}
1293#ifndef SQLITE_OMIT_UTF16
1294const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001295 return columnName(pStmt, N, 1, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001296}
1297#endif /* SQLITE_OMIT_UTF16 */
1298
1299/*
1300** Return the name of the table column from which a result column derives.
1301** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001302** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001303*/
1304const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001305 return columnName(pStmt, N, 0, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001306}
1307#ifndef SQLITE_OMIT_UTF16
1308const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
drh8cf92892019-02-20 18:13:57 +00001309 return columnName(pStmt, N, 1, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001310}
1311#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001312#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001313
1314
drh4f26d6c2004-05-26 23:25:30 +00001315/******************************* sqlite3_bind_ ***************************
1316**
1317** Routines used to attach values to wildcards in a compiled SQL statement.
1318*/
1319/*
1320** Unbind the value bound to variable i in virtual machine p. This is the
1321** the same as binding a NULL value to the column. If the "i" parameter is
1322** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1323**
drh488e7b62008-10-06 12:46:43 +00001324** A successful evaluation of this routine acquires the mutex on p.
1325** the mutex is released if any kind of error occurs.
1326**
drh4f26d6c2004-05-26 23:25:30 +00001327** The error code stored in database p->db is overwritten with the return
1328** value in any case.
1329*/
1330static int vdbeUnbind(Vdbe *p, int i){
1331 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001332 if( vdbeSafetyNotNull(p) ){
1333 return SQLITE_MISUSE_BKPT;
1334 }
drh488e7b62008-10-06 12:46:43 +00001335 sqlite3_mutex_enter(p->db->mutex);
drh17b74812021-02-03 18:32:25 +00001336 if( p->iVdbeMagic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001337 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001338 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001339 sqlite3_log(SQLITE_MISUSE,
1340 "bind on a busy prepared statement: [%s]", p->zSql);
1341 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001342 }
1343 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001344 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001345 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001346 return SQLITE_RANGE;
1347 }
1348 i--;
drh290c1942004-08-21 17:54:45 +00001349 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001350 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001351 pVar->flags = MEM_Null;
drh368bfe82018-12-11 12:20:41 +00001352 p->db->errCode = SQLITE_OK;
dan937d0de2009-10-15 18:35:38 +00001353
dan1d2ce4f2009-10-19 18:11:09 +00001354 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1355 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001356 **
drhbbf6d432020-05-15 15:03:51 +00001357 ** IMPLEMENTATION-OF: R-57496-20354 If the specific value bound to a host
drha7044002010-09-14 18:22:59 +00001358 ** parameter in the WHERE clause might influence the choice of query plan
1359 ** for a statement, then the statement will be automatically recompiled,
1360 ** as if there had been a schema change, on the first sqlite3_step() call
1361 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001362 */
drh2c2f3922017-06-01 00:54:35 +00001363 assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || p->expmask==0 );
drh29967962017-03-03 21:51:40 +00001364 if( p->expmask!=0 && (p->expmask & (i>=31 ? 0x80000000 : (u32)1<<i))!=0 ){
dan937d0de2009-10-15 18:35:38 +00001365 p->expired = 1;
1366 }
drh4f26d6c2004-05-26 23:25:30 +00001367 return SQLITE_OK;
1368}
1369
1370/*
drh5e2517e2004-09-24 23:59:12 +00001371** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001372*/
drh5e2517e2004-09-24 23:59:12 +00001373static int bindText(
drh605264d2007-08-21 15:13:19 +00001374 sqlite3_stmt *pStmt, /* The statement to bind against */
1375 int i, /* Index of the parameter to bind */
1376 const void *zData, /* Pointer to the data to be bound */
1377 int nData, /* Number of bytes of data to be bound */
1378 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001379 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001380){
1381 Vdbe *p = (Vdbe *)pStmt;
1382 Mem *pVar;
1383 int rc;
1384
1385 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001386 if( rc==SQLITE_OK ){
1387 if( zData!=0 ){
1388 pVar = &p->aVar[i-1];
1389 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1390 if( rc==SQLITE_OK && encoding!=0 ){
1391 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1392 }
drhe70d01f2017-05-29 22:44:18 +00001393 if( rc ){
1394 sqlite3Error(p->db, rc);
1395 rc = sqlite3ApiExit(p->db, rc);
1396 }
drh27641702007-08-22 02:56:42 +00001397 }
drh488e7b62008-10-06 12:46:43 +00001398 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001399 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001400 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001401 }
drh605264d2007-08-21 15:13:19 +00001402 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001403}
drh5e2517e2004-09-24 23:59:12 +00001404
1405
1406/*
1407** Bind a blob value to an SQL statement variable.
1408*/
1409int sqlite3_bind_blob(
1410 sqlite3_stmt *pStmt,
1411 int i,
1412 const void *zData,
1413 int nData,
1414 void (*xDel)(void*)
1415){
drh5b081d82016-02-18 01:29:12 +00001416#ifdef SQLITE_ENABLE_API_ARMOR
1417 if( nData<0 ) return SQLITE_MISUSE_BKPT;
1418#endif
drh5e2517e2004-09-24 23:59:12 +00001419 return bindText(pStmt, i, zData, nData, xDel, 0);
1420}
drhda4ca9d2014-09-09 17:27:35 +00001421int sqlite3_bind_blob64(
1422 sqlite3_stmt *pStmt,
1423 int i,
1424 const void *zData,
1425 sqlite3_uint64 nData,
1426 void (*xDel)(void*)
1427){
drhfc59a952014-09-11 23:34:55 +00001428 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001429 if( nData>0x7fffffff ){
1430 return invokeValueDestructor(zData, xDel, 0);
1431 }else{
drh3329a632014-09-18 01:21:43 +00001432 return bindText(pStmt, i, zData, (int)nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001433 }
1434}
drh4f26d6c2004-05-26 23:25:30 +00001435int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1436 int rc;
1437 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001438 rc = vdbeUnbind(p, i);
1439 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001440 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001441 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001442 }
danielk1977f4618892004-06-28 13:09:11 +00001443 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001444}
1445int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001446 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001447}
drhefad9992004-06-22 12:13:55 +00001448int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001449 int rc;
1450 Vdbe *p = (Vdbe *)pStmt;
1451 rc = vdbeUnbind(p, i);
1452 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001453 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001454 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001455 }
1456 return rc;
1457}
drh605264d2007-08-21 15:13:19 +00001458int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1459 int rc;
1460 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001461 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001462 if( rc==SQLITE_OK ){
1463 sqlite3_mutex_leave(p->db->mutex);
1464 }
drh605264d2007-08-21 15:13:19 +00001465 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001466}
drh22930062017-07-27 03:48:02 +00001467int sqlite3_bind_pointer(
1468 sqlite3_stmt *pStmt,
1469 int i,
1470 void *pPtr,
1471 const char *zPTtype,
1472 void (*xDestructor)(void*)
1473){
drh3a96a5d2017-06-30 23:09:03 +00001474 int rc;
1475 Vdbe *p = (Vdbe*)pStmt;
1476 rc = vdbeUnbind(p, i);
1477 if( rc==SQLITE_OK ){
drh22930062017-07-27 03:48:02 +00001478 sqlite3VdbeMemSetPointer(&p->aVar[i-1], pPtr, zPTtype, xDestructor);
drh3a96a5d2017-06-30 23:09:03 +00001479 sqlite3_mutex_leave(p->db->mutex);
drh34fcf362017-07-27 16:42:36 +00001480 }else if( xDestructor ){
1481 xDestructor(pPtr);
drh3a96a5d2017-06-30 23:09:03 +00001482 }
1483 return rc;
1484}
drh4f26d6c2004-05-26 23:25:30 +00001485int sqlite3_bind_text(
1486 sqlite3_stmt *pStmt,
1487 int i,
1488 const char *zData,
1489 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001490 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001491){
drh5e2517e2004-09-24 23:59:12 +00001492 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001493}
drhbbf483f2014-09-09 20:30:24 +00001494int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001495 sqlite3_stmt *pStmt,
1496 int i,
1497 const char *zData,
1498 sqlite3_uint64 nData,
1499 void (*xDel)(void*),
1500 unsigned char enc
1501){
drhfc59a952014-09-11 23:34:55 +00001502 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001503 if( nData>0x7fffffff ){
1504 return invokeValueDestructor(zData, xDel, 0);
1505 }else{
drhfc59a952014-09-11 23:34:55 +00001506 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drh3329a632014-09-18 01:21:43 +00001507 return bindText(pStmt, i, zData, (int)nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001508 }
1509}
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/*
dan37db03b2011-03-16 19:59:18 +00001910** This function is called from within a pre-update callback to retrieve
1911** a field of the row currently being updated or inserted.
1912*/
1913int sqlite3_preupdate_new(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
dan46c47d42011-03-01 18:42:07 +00001914 PreUpdate *p = db->pPreUpdate;
1915 int rc = SQLITE_OK;
dan37db03b2011-03-16 19:59:18 +00001916 Mem *pMem;
dan46c47d42011-03-01 18:42:07 +00001917
dan37db03b2011-03-16 19:59:18 +00001918 if( !p || p->op==SQLITE_DELETE ){
dan46c47d42011-03-01 18:42:07 +00001919 rc = SQLITE_MISUSE_BKPT;
dan37db03b2011-03-16 19:59:18 +00001920 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001921 }
dancb9a3642017-01-30 19:44:53 +00001922 if( p->pPk && p->op!=SQLITE_UPDATE ){
drhb9bcf7c2019-10-19 13:29:10 +00001923 iIdx = sqlite3TableColumnToIndex(p->pPk, iIdx);
dancb9a3642017-01-30 19:44:53 +00001924 }
dan46c47d42011-03-01 18:42:07 +00001925 if( iIdx>=p->pCsr->nField || iIdx<0 ){
1926 rc = SQLITE_RANGE;
dan37db03b2011-03-16 19:59:18 +00001927 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001928 }
dan46c47d42011-03-01 18:42:07 +00001929
dan37db03b2011-03-16 19:59:18 +00001930 if( p->op==SQLITE_INSERT ){
1931 /* For an INSERT, memory cell p->iNewReg contains the serialized record
1932 ** that is being inserted. Deserialize it. */
1933 UnpackedRecord *pUnpack = p->pNewUnpacked;
1934 if( !pUnpack ){
1935 Mem *pData = &p->v->aMem[p->iNewReg];
drhff535a22016-09-20 01:46:15 +00001936 rc = ExpandBlob(pData);
dan37db03b2011-03-16 19:59:18 +00001937 if( rc!=SQLITE_OK ) goto preupdate_new_out;
dan93bca692011-09-14 19:41:44 +00001938 pUnpack = vdbeUnpackRecord(&p->keyinfo, pData->n, pData->z);
dan37db03b2011-03-16 19:59:18 +00001939 if( !pUnpack ){
1940 rc = SQLITE_NOMEM;
1941 goto preupdate_new_out;
1942 }
1943 p->pNewUnpacked = pUnpack;
1944 }
dan2a86c192017-01-25 17:44:13 +00001945 pMem = &pUnpack->aMem[iIdx];
1946 if( iIdx==p->pTab->iPKey ){
1947 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1948 }else if( iIdx>=pUnpack->nField ){
dan37db03b2011-03-16 19:59:18 +00001949 pMem = (sqlite3_value *)columnNullValue();
dan37db03b2011-03-16 19:59:18 +00001950 }
1951 }else{
1952 /* For an UPDATE, memory cell (p->iNewReg+1+iIdx) contains the required
1953 ** value. Make a copy of the cell contents and return a pointer to it.
1954 ** It is not safe to return a pointer to the memory cell itself as the
1955 ** caller may modify the value text encoding.
1956 */
1957 assert( p->op==SQLITE_UPDATE );
1958 if( !p->aNew ){
1959 p->aNew = (Mem *)sqlite3DbMallocZero(db, sizeof(Mem) * p->pCsr->nField);
1960 if( !p->aNew ){
1961 rc = SQLITE_NOMEM;
1962 goto preupdate_new_out;
1963 }
1964 }
drh304637c2011-03-18 16:47:27 +00001965 assert( iIdx>=0 && iIdx<p->pCsr->nField );
dan37db03b2011-03-16 19:59:18 +00001966 pMem = &p->aNew[iIdx];
1967 if( pMem->flags==0 ){
dane43635a2016-10-21 21:21:45 +00001968 if( iIdx==p->pTab->iPKey ){
dan319eeb72011-03-19 08:38:50 +00001969 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1970 }else{
1971 rc = sqlite3VdbeMemCopy(pMem, &p->v->aMem[p->iNewReg+1+iIdx]);
1972 if( rc!=SQLITE_OK ) goto preupdate_new_out;
1973 }
dan37db03b2011-03-16 19:59:18 +00001974 }
1975 }
1976 *ppValue = pMem;
1977
1978 preupdate_new_out:
drhe1ed0b02014-08-26 02:15:07 +00001979 sqlite3Error(db, rc);
dan46c47d42011-03-01 18:42:07 +00001980 return sqlite3ApiExit(db, rc);
1981}
drh9b1c62d2011-03-30 21:04:43 +00001982#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
drh04e8a582014-11-18 21:20:57 +00001983
dan6f9702e2014-11-01 20:38:06 +00001984#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan04489b62014-10-31 20:11:32 +00001985/*
1986** Return status data for a single loop within query pStmt.
1987*/
1988int sqlite3_stmt_scanstatus(
drhd1a1c232014-11-03 16:35:55 +00001989 sqlite3_stmt *pStmt, /* Prepared statement being queried */
dan04489b62014-10-31 20:11:32 +00001990 int idx, /* Index of loop to report on */
drhd1a1c232014-11-03 16:35:55 +00001991 int iScanStatusOp, /* Which metric to return */
1992 void *pOut /* OUT: Write the answer here */
dan04489b62014-10-31 20:11:32 +00001993){
1994 Vdbe *p = (Vdbe*)pStmt;
dan037b5322014-11-03 11:25:32 +00001995 ScanStatus *pScan;
dan6f9702e2014-11-01 20:38:06 +00001996 if( idx<0 || idx>=p->nScan ) return 1;
1997 pScan = &p->aScan[idx];
drhd1a1c232014-11-03 16:35:55 +00001998 switch( iScanStatusOp ){
1999 case SQLITE_SCANSTAT_NLOOP: {
2000 *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
2001 break;
2002 }
2003 case SQLITE_SCANSTAT_NVISIT: {
2004 *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
2005 break;
2006 }
2007 case SQLITE_SCANSTAT_EST: {
drh518140e2014-11-06 03:55:10 +00002008 double r = 1.0;
2009 LogEst x = pScan->nEst;
2010 while( x<100 ){
2011 x += 10;
2012 r *= 0.5;
2013 }
2014 *(double*)pOut = r*sqlite3LogEstToInt(x);
drhd1a1c232014-11-03 16:35:55 +00002015 break;
2016 }
2017 case SQLITE_SCANSTAT_NAME: {
dand72219d2014-11-03 16:39:37 +00002018 *(const char**)pOut = pScan->zName;
drhd1a1c232014-11-03 16:35:55 +00002019 break;
2020 }
2021 case SQLITE_SCANSTAT_EXPLAIN: {
2022 if( pScan->addrExplain ){
2023 *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
2024 }else{
2025 *(const char**)pOut = 0;
2026 }
2027 break;
2028 }
drhc6652b12014-11-06 04:42:20 +00002029 case SQLITE_SCANSTAT_SELECTID: {
2030 if( pScan->addrExplain ){
2031 *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
2032 }else{
2033 *(int*)pOut = -1;
2034 }
2035 break;
2036 }
drhd1a1c232014-11-03 16:35:55 +00002037 default: {
2038 return 1;
dan6f9702e2014-11-01 20:38:06 +00002039 }
2040 }
dan04489b62014-10-31 20:11:32 +00002041 return 0;
2042}
2043
2044/*
2045** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
2046*/
2047void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
2048 Vdbe *p = (Vdbe*)pStmt;
dan6f9702e2014-11-01 20:38:06 +00002049 memset(p->anExec, 0, p->nOp * sizeof(i64));
dan04489b62014-10-31 20:11:32 +00002050}
dan6f9702e2014-11-01 20:38:06 +00002051#endif /* SQLITE_ENABLE_STMT_SCANSTATUS */