blob: b9df40b8fd35357c7c1f7b105170706ccd7fd843 [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 );
drh3d2a5292016-07-13 22:55:01 +000065 assert( db->xProfile!=0 || (db->mTrace & SQLITE_TRACE_PROFILE)!=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;
70 if( db->xProfile ){
71 db->xProfile(db->pProfileArg, p->zSql, iElapse);
72 }
73 if( db->mTrace & SQLITE_TRACE_PROFILE ){
drhfca760c2016-07-14 01:09:08 +000074 db->xTrace(SQLITE_TRACE_PROFILE, db->pTraceArg, p, (void*)&iElapse);
drh3d2a5292016-07-13 22:55:01 +000075 }
drh201e0c62015-07-14 14:48:50 +000076 p->startTime = 0;
77}
78/*
79** The checkProfileCallback(DB,P) macro checks to see if a profile callback
80** is needed, and it invokes the callback if it is needed.
81*/
82# define checkProfileCallback(DB,P) \
83 if( ((P)->startTime)>0 ){ invokeProfileCallback(DB,P); }
84#else
85# define checkProfileCallback(DB,P) /*no-op*/
86#endif
87
drh413c3d32010-02-23 20:11:56 +000088/*
drhe30f4422007-08-21 16:15:55 +000089** The following routine destroys a virtual machine that is created by
90** the sqlite3_compile() routine. The integer returned is an SQLITE_
91** success/failure code that describes the result of executing the virtual
92** machine.
93**
94** This routine sets the error code and string returned by
95** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
96*/
97int sqlite3_finalize(sqlite3_stmt *pStmt){
98 int rc;
99 if( pStmt==0 ){
drh65bafa62010-09-29 01:54:00 +0000100 /* IMPLEMENTATION-OF: R-57228-12904 Invoking sqlite3_finalize() on a NULL
101 ** pointer is a harmless no-op. */
drhe30f4422007-08-21 16:15:55 +0000102 rc = SQLITE_OK;
103 }else{
104 Vdbe *v = (Vdbe*)pStmt;
danielk1977238746a2009-03-19 18:51:06 +0000105 sqlite3 *db = v->db;
drh413c3d32010-02-23 20:11:56 +0000106 if( vdbeSafety(v) ) return SQLITE_MISUSE_BKPT;
drh4245c402012-06-02 14:32:21 +0000107 sqlite3_mutex_enter(db->mutex);
drh201e0c62015-07-14 14:48:50 +0000108 checkProfileCallback(db, v);
drhe30f4422007-08-21 16:15:55 +0000109 rc = sqlite3VdbeFinalize(v);
danielk1977238746a2009-03-19 18:51:06 +0000110 rc = sqlite3ApiExit(db, rc);
drh4245c402012-06-02 14:32:21 +0000111 sqlite3LeaveMutexAndCloseZombie(db);
drhe30f4422007-08-21 16:15:55 +0000112 }
113 return rc;
114}
115
116/*
117** Terminate the current execution of an SQL statement and reset it
118** back to its starting state so that it can be reused. A success code from
119** the prior execution is returned.
120**
121** This routine sets the error code and string returned by
122** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
123*/
124int sqlite3_reset(sqlite3_stmt *pStmt){
125 int rc;
126 if( pStmt==0 ){
127 rc = SQLITE_OK;
128 }else{
129 Vdbe *v = (Vdbe*)pStmt;
drh201e0c62015-07-14 14:48:50 +0000130 sqlite3 *db = v->db;
131 sqlite3_mutex_enter(db->mutex);
132 checkProfileCallback(db, v);
drhc890fec2008-08-01 20:10:08 +0000133 rc = sqlite3VdbeReset(v);
drh124c0b42011-06-01 18:15:55 +0000134 sqlite3VdbeRewind(v);
drh201e0c62015-07-14 14:48:50 +0000135 assert( (rc & (db->errMask))==rc );
136 rc = sqlite3ApiExit(db, rc);
137 sqlite3_mutex_leave(db->mutex);
drhe30f4422007-08-21 16:15:55 +0000138 }
139 return rc;
140}
141
142/*
143** Set all the parameters in the compiled SQL statement to NULL.
144*/
145int sqlite3_clear_bindings(sqlite3_stmt *pStmt){
146 int i;
147 int rc = SQLITE_OK;
drh7297d1f2008-05-09 14:39:44 +0000148 Vdbe *p = (Vdbe*)pStmt;
drh18472fa2008-10-07 15:25:48 +0000149#if SQLITE_THREADSAFE
drh7e8b8482008-01-23 03:03:05 +0000150 sqlite3_mutex *mutex = ((Vdbe*)pStmt)->db->mutex;
151#endif
152 sqlite3_mutex_enter(mutex);
drh7297d1f2008-05-09 14:39:44 +0000153 for(i=0; i<p->nVar; i++){
154 sqlite3VdbeMemRelease(&p->aVar[i]);
155 p->aVar[i].flags = MEM_Null;
drhe30f4422007-08-21 16:15:55 +0000156 }
drh2c2f3922017-06-01 00:54:35 +0000157 assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || p->expmask==0 );
danbda4cb82017-02-23 16:30:16 +0000158 if( p->expmask ){
danc94b8592009-10-20 07:01:24 +0000159 p->expired = 1;
160 }
drh7e8b8482008-01-23 03:03:05 +0000161 sqlite3_mutex_leave(mutex);
drhe30f4422007-08-21 16:15:55 +0000162 return rc;
163}
164
165
drh4f26d6c2004-05-26 23:25:30 +0000166/**************************** sqlite3_value_ *******************************
167** The following routines extract information from a Mem or sqlite3_value
168** structure.
169*/
170const void *sqlite3_value_blob(sqlite3_value *pVal){
171 Mem *p = (Mem*)pVal;
172 if( p->flags & (MEM_Blob|MEM_Str) ){
drhff535a22016-09-20 01:46:15 +0000173 if( ExpandBlob(p)!=SQLITE_OK ){
dana4d5ae82015-07-24 16:24:37 +0000174 assert( p->flags==MEM_Null && p->z==0 );
175 return 0;
176 }
drh1f0feef2007-05-15 13:27:07 +0000177 p->flags |= MEM_Blob;
drh42262532010-09-08 16:30:36 +0000178 return p->n ? p->z : 0;
drh4f26d6c2004-05-26 23:25:30 +0000179 }else{
180 return sqlite3_value_text(pVal);
181 }
182}
183int sqlite3_value_bytes(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000184 return sqlite3ValueBytes(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000185}
186int sqlite3_value_bytes16(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000187 return sqlite3ValueBytes(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000188}
189double sqlite3_value_double(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000190 return sqlite3VdbeRealValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000191}
192int sqlite3_value_int(sqlite3_value *pVal){
drhb27b7f52008-12-10 18:03:45 +0000193 return (int)sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000194}
drhefad9992004-06-22 12:13:55 +0000195sqlite_int64 sqlite3_value_int64(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000196 return sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000197}
drhbcdf78a2015-09-10 20:34:56 +0000198unsigned int sqlite3_value_subtype(sqlite3_value *pVal){
dan5b6c8e42016-01-30 15:46:03 +0000199 Mem *pMem = (Mem*)pVal;
200 return ((pMem->flags & MEM_Subtype) ? pMem->eSubtype : 0);
drhbcdf78a2015-09-10 20:34:56 +0000201}
drhae3ec3f2017-07-17 00:40:19 +0000202void *sqlite3_value_pointer(sqlite3_value *pVal, const char *zPType){
drh3a96a5d2017-06-30 23:09:03 +0000203 Mem *p = (Mem*)pVal;
drha0024e62017-07-27 15:53:24 +0000204 if( (p->flags&(MEM_TypeMask|MEM_Term|MEM_Subtype)) ==
205 (MEM_Null|MEM_Term|MEM_Subtype)
drhae3ec3f2017-07-17 00:40:19 +0000206 && zPType!=0
drha0024e62017-07-27 15:53:24 +0000207 && p->eSubtype=='p'
drh22930062017-07-27 03:48:02 +0000208 && strcmp(p->u.zPType, zPType)==0
drhae3ec3f2017-07-17 00:40:19 +0000209 ){
drh22930062017-07-27 03:48:02 +0000210 return (void*)p->z;
drh3a96a5d2017-06-30 23:09:03 +0000211 }else{
212 return 0;
213 }
214}
drh4f26d6c2004-05-26 23:25:30 +0000215const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000216 return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000217}
drh6c626082004-11-14 21:56:29 +0000218#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000219const void *sqlite3_value_text16(sqlite3_value* pVal){
drhb21c8cd2007-08-21 19:33:56 +0000220 return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000221}
danielk1977d8123362004-06-12 09:25:12 +0000222const void *sqlite3_value_text16be(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000223 return sqlite3ValueText(pVal, SQLITE_UTF16BE);
danielk1977d8123362004-06-12 09:25:12 +0000224}
225const void *sqlite3_value_text16le(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000226 return sqlite3ValueText(pVal, SQLITE_UTF16LE);
danielk1977d8123362004-06-12 09:25:12 +0000227}
drh6c626082004-11-14 21:56:29 +0000228#endif /* SQLITE_OMIT_UTF16 */
drh22ec1342015-02-27 00:33:15 +0000229/* EVIDENCE-OF: R-12793-43283 Every value in SQLite has one of five
230** fundamental datatypes: 64-bit signed integer 64-bit IEEE floating
231** point number string BLOB NULL
232*/
drh4f26d6c2004-05-26 23:25:30 +0000233int sqlite3_value_type(sqlite3_value* pVal){
drh1b27b8c2014-02-10 03:21:57 +0000234 static const u8 aType[] = {
235 SQLITE_BLOB, /* 0x00 */
236 SQLITE_NULL, /* 0x01 */
237 SQLITE_TEXT, /* 0x02 */
238 SQLITE_NULL, /* 0x03 */
239 SQLITE_INTEGER, /* 0x04 */
240 SQLITE_NULL, /* 0x05 */
241 SQLITE_INTEGER, /* 0x06 */
242 SQLITE_NULL, /* 0x07 */
243 SQLITE_FLOAT, /* 0x08 */
244 SQLITE_NULL, /* 0x09 */
245 SQLITE_FLOAT, /* 0x0a */
246 SQLITE_NULL, /* 0x0b */
247 SQLITE_INTEGER, /* 0x0c */
248 SQLITE_NULL, /* 0x0d */
249 SQLITE_INTEGER, /* 0x0e */
250 SQLITE_NULL, /* 0x0f */
251 SQLITE_BLOB, /* 0x10 */
252 SQLITE_NULL, /* 0x11 */
253 SQLITE_TEXT, /* 0x12 */
254 SQLITE_NULL, /* 0x13 */
255 SQLITE_INTEGER, /* 0x14 */
256 SQLITE_NULL, /* 0x15 */
257 SQLITE_INTEGER, /* 0x16 */
258 SQLITE_NULL, /* 0x17 */
259 SQLITE_FLOAT, /* 0x18 */
260 SQLITE_NULL, /* 0x19 */
261 SQLITE_FLOAT, /* 0x1a */
262 SQLITE_NULL, /* 0x1b */
263 SQLITE_INTEGER, /* 0x1c */
264 SQLITE_NULL, /* 0x1d */
265 SQLITE_INTEGER, /* 0x1e */
266 SQLITE_NULL, /* 0x1f */
267 };
mistachkinafc14f72014-03-05 01:29:18 +0000268 return aType[pVal->flags&MEM_AffMask];
drh4f26d6c2004-05-26 23:25:30 +0000269}
270
drh4f03f412015-05-20 21:28:32 +0000271/* Make a copy of an sqlite3_value object
272*/
273sqlite3_value *sqlite3_value_dup(const sqlite3_value *pOrig){
274 sqlite3_value *pNew;
275 if( pOrig==0 ) return 0;
276 pNew = sqlite3_malloc( sizeof(*pNew) );
277 if( pNew==0 ) return 0;
278 memset(pNew, 0, sizeof(*pNew));
279 memcpy(pNew, pOrig, MEMCELLSIZE);
280 pNew->flags &= ~MEM_Dyn;
281 pNew->db = 0;
282 if( pNew->flags&(MEM_Str|MEM_Blob) ){
drh10ca5b42015-05-22 21:04:54 +0000283 pNew->flags &= ~(MEM_Static|MEM_Dyn);
284 pNew->flags |= MEM_Ephem;
285 if( sqlite3VdbeMemMakeWriteable(pNew)!=SQLITE_OK ){
286 sqlite3ValueFree(pNew);
287 pNew = 0;
drh4f03f412015-05-20 21:28:32 +0000288 }
289 }
290 return pNew;
291}
292
293/* Destroy an sqlite3_value object previously obtained from
294** sqlite3_value_dup().
295*/
296void sqlite3_value_free(sqlite3_value *pOld){
297 sqlite3ValueFree(pOld);
298}
299
300
drh4f26d6c2004-05-26 23:25:30 +0000301/**************************** sqlite3_result_ *******************************
302** The following routines are used by user-defined functions to specify
303** the function result.
drh4c8555f2009-06-25 01:47:11 +0000304**
peter.d.reid60ec9142014-09-06 16:39:46 +0000305** The setStrOrError() function calls sqlite3VdbeMemSetStr() to store the
drh4c8555f2009-06-25 01:47:11 +0000306** result as a string or blob but if the string or blob is too large, it
307** then sets the error code to SQLITE_TOOBIG
drhda4ca9d2014-09-09 17:27:35 +0000308**
309** The invokeValueDestructor(P,X) routine invokes destructor function X()
310** on value P is not going to be used and need to be destroyed.
drh4f26d6c2004-05-26 23:25:30 +0000311*/
drh4c8555f2009-06-25 01:47:11 +0000312static void setResultStrOrError(
313 sqlite3_context *pCtx, /* Function context */
314 const char *z, /* String pointer */
315 int n, /* Bytes in string, or negative */
316 u8 enc, /* Encoding of z. 0 for BLOBs */
317 void (*xDel)(void*) /* Destructor function */
318){
drh9bd038f2014-08-27 14:14:06 +0000319 if( sqlite3VdbeMemSetStr(pCtx->pOut, z, n, enc, xDel)==SQLITE_TOOBIG ){
drh4c8555f2009-06-25 01:47:11 +0000320 sqlite3_result_error_toobig(pCtx);
321 }
322}
drhda4ca9d2014-09-09 17:27:35 +0000323static int invokeValueDestructor(
324 const void *p, /* Value to destroy */
325 void (*xDel)(void*), /* The destructor */
326 sqlite3_context *pCtx /* Set a SQLITE_TOOBIG error if no NULL */
327){
drhfc59a952014-09-11 23:34:55 +0000328 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000329 if( xDel==0 ){
330 /* noop */
331 }else if( xDel==SQLITE_TRANSIENT ){
332 /* noop */
drhda4ca9d2014-09-09 17:27:35 +0000333 }else{
334 xDel((void*)p);
335 }
336 if( pCtx ) sqlite3_result_error_toobig(pCtx);
337 return SQLITE_TOOBIG;
338}
drh4f26d6c2004-05-26 23:25:30 +0000339void sqlite3_result_blob(
340 sqlite3_context *pCtx,
341 const void *z,
342 int n,
danielk1977d8123362004-06-12 09:25:12 +0000343 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000344){
drh5708d2d2005-06-22 10:53:59 +0000345 assert( n>=0 );
drh9bd038f2014-08-27 14:14:06 +0000346 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000347 setResultStrOrError(pCtx, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000348}
drhda4ca9d2014-09-09 17:27:35 +0000349void sqlite3_result_blob64(
350 sqlite3_context *pCtx,
351 const void *z,
352 sqlite3_uint64 n,
353 void (*xDel)(void *)
354){
355 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000356 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000357 if( n>0x7fffffff ){
358 (void)invokeValueDestructor(z, xDel, pCtx);
359 }else{
360 setResultStrOrError(pCtx, z, (int)n, 0, xDel);
361 }
362}
drh4f26d6c2004-05-26 23:25:30 +0000363void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
drh9bd038f2014-08-27 14:14:06 +0000364 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
365 sqlite3VdbeMemSetDouble(pCtx->pOut, rVal);
drh4f26d6c2004-05-26 23:25:30 +0000366}
367void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000368 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000369 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000370 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000371 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000372}
danielk1977a1686c92006-01-23 07:52:37 +0000373#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000374void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000375 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000376 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000377 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000378 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000379}
danielk1977a1686c92006-01-23 07:52:37 +0000380#endif
drhf4479502004-05-27 03:12:53 +0000381void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh9bd038f2014-08-27 14:14:06 +0000382 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
383 sqlite3VdbeMemSetInt64(pCtx->pOut, (i64)iVal);
drh4f26d6c2004-05-26 23:25:30 +0000384}
385void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
drh9bd038f2014-08-27 14:14:06 +0000386 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
387 sqlite3VdbeMemSetInt64(pCtx->pOut, iVal);
drh4f26d6c2004-05-26 23:25:30 +0000388}
389void sqlite3_result_null(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000390 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
391 sqlite3VdbeMemSetNull(pCtx->pOut);
drh4f26d6c2004-05-26 23:25:30 +0000392}
drh22930062017-07-27 03:48:02 +0000393void sqlite3_result_pointer(
394 sqlite3_context *pCtx,
395 void *pPtr,
396 const char *zPType,
397 void (*xDestructor)(void*)
398){
drh3a96a5d2017-06-30 23:09:03 +0000399 Mem *pOut = pCtx->pOut;
400 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh526740b2017-08-24 13:55:46 +0000401 sqlite3VdbeMemRelease(pOut);
402 pOut->flags = MEM_Null;
drh22930062017-07-27 03:48:02 +0000403 sqlite3VdbeMemSetPointer(pOut, pPtr, zPType, xDestructor);
drh3a96a5d2017-06-30 23:09:03 +0000404}
drhbcdf78a2015-09-10 20:34:56 +0000405void sqlite3_result_subtype(sqlite3_context *pCtx, unsigned int eSubtype){
dan5b6c8e42016-01-30 15:46:03 +0000406 Mem *pOut = pCtx->pOut;
407 assert( sqlite3_mutex_held(pOut->db->mutex) );
408 pOut->eSubtype = eSubtype & 0xff;
409 pOut->flags |= MEM_Subtype;
drhbcdf78a2015-09-10 20:34:56 +0000410}
drh4f26d6c2004-05-26 23:25:30 +0000411void sqlite3_result_text(
412 sqlite3_context *pCtx,
413 const char *z,
414 int n,
danielk1977d8123362004-06-12 09:25:12 +0000415 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000416){
drh9bd038f2014-08-27 14:14:06 +0000417 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000418 setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000419}
drhbbf483f2014-09-09 20:30:24 +0000420void sqlite3_result_text64(
drhda4ca9d2014-09-09 17:27:35 +0000421 sqlite3_context *pCtx,
422 const char *z,
423 sqlite3_uint64 n,
424 void (*xDel)(void *),
425 unsigned char enc
426){
427 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000428 assert( xDel!=SQLITE_DYNAMIC );
drh79f7af92014-10-03 16:00:51 +0000429 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drhda4ca9d2014-09-09 17:27:35 +0000430 if( n>0x7fffffff ){
431 (void)invokeValueDestructor(z, xDel, pCtx);
432 }else{
433 setResultStrOrError(pCtx, z, (int)n, enc, xDel);
434 }
435}
drh6c626082004-11-14 21:56:29 +0000436#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000437void sqlite3_result_text16(
438 sqlite3_context *pCtx,
439 const void *z,
440 int n,
danielk1977d8123362004-06-12 09:25:12 +0000441 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000442){
drh9bd038f2014-08-27 14:14:06 +0000443 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000444 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000445}
446void sqlite3_result_text16be(
447 sqlite3_context *pCtx,
448 const void *z,
449 int n,
450 void (*xDel)(void *)
451){
drh9bd038f2014-08-27 14:14:06 +0000452 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000453 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000454}
455void sqlite3_result_text16le(
456 sqlite3_context *pCtx,
457 const void *z,
458 int n,
459 void (*xDel)(void *)
460){
drh9bd038f2014-08-27 14:14:06 +0000461 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000462 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000463}
drh6c626082004-11-14 21:56:29 +0000464#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000465void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh9bd038f2014-08-27 14:14:06 +0000466 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
467 sqlite3VdbeMemCopy(pCtx->pOut, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000468}
drhb026e052007-05-02 01:34:31 +0000469void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh9bd038f2014-08-27 14:14:06 +0000470 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
471 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
drhb026e052007-05-02 01:34:31 +0000472}
dana4d5ae82015-07-24 16:24:37 +0000473int sqlite3_result_zeroblob64(sqlite3_context *pCtx, u64 n){
474 Mem *pOut = pCtx->pOut;
475 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh6bacdc22015-07-24 17:14:03 +0000476 if( n>(u64)pOut->db->aLimit[SQLITE_LIMIT_LENGTH] ){
dana4d5ae82015-07-24 16:24:37 +0000477 return SQLITE_TOOBIG;
478 }
479 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, (int)n);
480 return SQLITE_OK;
481}
drh69544ec2008-02-06 14:11:34 +0000482void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
483 pCtx->isError = errCode;
drh9b47ee32013-08-20 03:13:51 +0000484 pCtx->fErrorOrAux = 1;
drh983b5ee2015-02-13 12:05:56 +0000485#ifdef SQLITE_DEBUG
drh96f4ad22015-03-12 21:02:36 +0000486 if( pCtx->pVdbe ) pCtx->pVdbe->rcApp = errCode;
drh983b5ee2015-02-13 12:05:56 +0000487#endif
drh9bd038f2014-08-27 14:14:06 +0000488 if( pCtx->pOut->flags & MEM_Null ){
489 sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
drh51c7d862009-04-27 18:46:06 +0000490 SQLITE_UTF8, SQLITE_STATIC);
491 }
drh69544ec2008-02-06 14:11:34 +0000492}
drh4f26d6c2004-05-26 23:25:30 +0000493
drha0206bc2007-05-08 15:15:02 +0000494/* Force an SQLITE_TOOBIG error. */
495void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000496 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000497 pCtx->isError = SQLITE_TOOBIG;
drh9b47ee32013-08-20 03:13:51 +0000498 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000499 sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
drhbb4957f2008-03-20 14:03:29 +0000500 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000501}
502
danielk1977a1644fd2007-08-29 12:31:25 +0000503/* An SQLITE_NOMEM error. */
504void sqlite3_result_error_nomem(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000505 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
506 sqlite3VdbeMemSetNull(pCtx->pOut);
mistachkinfad30392016-02-13 23:43:46 +0000507 pCtx->isError = SQLITE_NOMEM_BKPT;
drh9b47ee32013-08-20 03:13:51 +0000508 pCtx->fErrorOrAux = 1;
drh4a642b62016-02-05 01:55:27 +0000509 sqlite3OomFault(pCtx->pOut->db);
danielk1977a1644fd2007-08-29 12:31:25 +0000510}
drh4f26d6c2004-05-26 23:25:30 +0000511
dan5cf53532010-05-01 16:40:20 +0000512/*
513** This function is called after a transaction has been committed. It
514** invokes callbacks registered with sqlite3_wal_hook() as required.
515*/
drh7ed91f22010-04-29 22:34:07 +0000516static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000517 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000518#ifndef SQLITE_OMIT_WAL
519 int i;
dan8d22a172010-04-19 18:03:51 +0000520 for(i=0; i<db->nDb; i++){
521 Btree *pBt = db->aDb[i].pBt;
522 if( pBt ){
drhef15c6e2014-12-12 01:27:17 +0000523 int nEntry;
524 sqlite3BtreeEnter(pBt);
525 nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
526 sqlite3BtreeLeave(pBt);
drh59533aa2017-08-02 18:28:26 +0000527 if( nEntry>0 && db->xWalCallback && rc==SQLITE_OK ){
drh69c33822016-08-18 14:33:11 +0000528 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zDbSName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000529 }
530 }
531 }
dan5cf53532010-05-01 16:40:20 +0000532#endif
dan8d22a172010-04-19 18:03:51 +0000533 return rc;
534}
535
drh201e0c62015-07-14 14:48:50 +0000536
drh4f26d6c2004-05-26 23:25:30 +0000537/*
538** Execute the statement pStmt, either until a row of data is ready, the
539** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000540**
541** This routine implements the bulk of the logic behind the sqlite_step()
542** API. The only thing omitted is the automatic recompile if a
543** schema change has occurred. That detail is handled by the
544** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000545*/
drhb900aaf2006-11-09 00:24:53 +0000546static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000547 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000548 int rc;
549
danielk1977a185ddb2007-11-15 16:04:15 +0000550 assert(p);
551 if( p->magic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000552 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000553 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
554 ** with version 3.7.0, we changed this so that sqlite3_reset() would
555 ** be called automatically instead of throwing the SQLITE_MISUSE error.
556 ** This "automatic-reset" change is not technically an incompatibility,
557 ** since any application that receives an SQLITE_MISUSE is broken by
558 ** definition.
559 **
560 ** Nevertheless, some published applications that were originally written
561 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000562 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000563 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
564 ** legacy behavior of returning SQLITE_MISUSE for cases where the
565 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
566 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000567 */
drh602acb42011-01-17 17:42:37 +0000568#ifdef SQLITE_OMIT_AUTORESET
drh983b5ee2015-02-13 12:05:56 +0000569 if( (rc = p->rc&0xff)==SQLITE_BUSY || rc==SQLITE_LOCKED ){
drh602acb42011-01-17 17:42:37 +0000570 sqlite3_reset((sqlite3_stmt*)p);
571 }else{
572 return SQLITE_MISUSE_BKPT;
573 }
574#else
drh3674bfd2010-04-17 12:53:19 +0000575 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000576#endif
drhf1bfe9a2007-10-17 01:44:20 +0000577 }
578
dan14d4cc42010-01-20 14:25:37 +0000579 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000580 db = p->db;
drhc456e572008-08-11 18:44:58 +0000581 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000582 p->rc = SQLITE_NOMEM;
mistachkinfad30392016-02-13 23:43:46 +0000583 return SQLITE_NOMEM_BKPT;
drhc456e572008-08-11 18:44:58 +0000584 }
danielk1977261919c2005-12-06 12:52:59 +0000585
danielk1977a21c6b62005-01-24 10:25:59 +0000586 if( p->pc<=0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000587 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000588 rc = SQLITE_ERROR;
589 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000590 }
danielk19771d850a72004-05-31 08:26:49 +0000591 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000592 /* If there are no other statements currently running, then
593 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
594 ** from interrupting a statement that has not yet started.
595 */
drh4f7d3a52013-06-27 23:54:02 +0000596 if( db->nVdbeActive==0 ){
drh15ca1df2006-07-26 13:43:30 +0000597 db->u1.isInterrupted = 0;
598 }
599
drh888e16e2013-07-09 13:05:49 +0000600 assert( db->nVdbeWrite>0 || db->autoCommit==0
dancb3e4b72013-07-03 19:53:05 +0000601 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
602 );
dan1da40a32009-09-19 17:00:31 +0000603
drh19e2d372005-08-29 23:00:03 +0000604#ifndef SQLITE_OMIT_TRACE
drh3d2a5292016-07-13 22:55:01 +0000605 if( (db->xProfile || (db->mTrace & SQLITE_TRACE_PROFILE)!=0)
606 && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000607 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh201e0c62015-07-14 14:48:50 +0000608 }else{
609 assert( p->startTime==0 );
drh19e2d372005-08-29 23:00:03 +0000610 }
611#endif
drhc16a03b2004-09-15 13:38:10 +0000612
drh4f7d3a52013-06-27 23:54:02 +0000613 db->nVdbeActive++;
614 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000615 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000616 p->pc = 0;
617 }
drh983b5ee2015-02-13 12:05:56 +0000618#ifdef SQLITE_DEBUG
619 p->rcApp = SQLITE_OK;
620#endif
drhb7f91642004-10-31 02:22:47 +0000621#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000622 if( p->explain ){
623 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000624 }else
625#endif /* SQLITE_OMIT_EXPLAIN */
626 {
drh4f7d3a52013-06-27 23:54:02 +0000627 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000628 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000629 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000630 }
631
drh19e2d372005-08-29 23:00:03 +0000632#ifndef SQLITE_OMIT_TRACE
drh201e0c62015-07-14 14:48:50 +0000633 /* If the statement completed successfully, invoke the profile callback */
634 if( rc!=SQLITE_ROW ) checkProfileCallback(db, p);
drh19e2d372005-08-29 23:00:03 +0000635#endif
636
drh59533aa2017-08-02 18:28:26 +0000637 if( rc==SQLITE_DONE && db->autoCommit ){
dan8d22a172010-04-19 18:03:51 +0000638 assert( p->rc==SQLITE_OK );
drh7ed91f22010-04-29 22:34:07 +0000639 p->rc = doWalCallbacks(db);
dan8d22a172010-04-19 18:03:51 +0000640 if( p->rc!=SQLITE_OK ){
641 rc = SQLITE_ERROR;
642 }
643 }
644
drh80cc85b2008-07-23 21:07:25 +0000645 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000646 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
mistachkinfad30392016-02-13 23:43:46 +0000647 p->rc = SQLITE_NOMEM_BKPT;
drhb900aaf2006-11-09 00:24:53 +0000648 }
danielk1977357864e2009-03-25 15:43:08 +0000649end_of_step:
650 /* At this point local variable rc holds the value that should be
651 ** returned if this statement was compiled using the legacy
652 ** sqlite3_prepare() interface. According to the docs, this can only
653 ** be one of the values in the first assert() below. Variable p->rc
654 ** contains the value that would be returned if sqlite3_finalize()
655 ** were called on statement p.
656 */
657 assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
drhcbd8db32015-08-20 17:18:32 +0000658 || (rc&0xff)==SQLITE_BUSY || rc==SQLITE_MISUSE
danielk1977357864e2009-03-25 15:43:08 +0000659 );
drh983b5ee2015-02-13 12:05:56 +0000660 assert( (p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE) || p->rc==p->rcApp );
drh2c2f3922017-06-01 00:54:35 +0000661 if( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0
662 && rc!=SQLITE_ROW
663 && rc!=SQLITE_DONE
664 ){
665 /* If this statement was prepared using saved SQL and an
mistachkin48864df2013-03-21 21:20:32 +0000666 ** error has occurred, then return the error code in p->rc to the
danielk1977357864e2009-03-25 15:43:08 +0000667 ** caller. Set the error code in the database handle to the same value.
668 */
dan029ead62011-10-27 15:19:58 +0000669 rc = sqlite3VdbeTransferError(p);
danielk1977357864e2009-03-25 15:43:08 +0000670 }
671 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000672}
673
674/*
675** This is the top-level implementation of sqlite3_step(). Call
676** sqlite3Step() to do most of the work. If a schema error occurs,
677** call sqlite3Reprepare() and try again.
678*/
drhb900aaf2006-11-09 00:24:53 +0000679int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000680 int rc = SQLITE_OK; /* Result from sqlite3Step() */
drha6129fa2010-02-24 17:15:19 +0000681 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
682 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
683 sqlite3 *db; /* The database connection */
684
drh413c3d32010-02-23 20:11:56 +0000685 if( vdbeSafetyNotNull(v) ){
686 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000687 }
drh413c3d32010-02-23 20:11:56 +0000688 db = v->db;
689 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000690 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000691 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh2c7946a2014-08-19 20:27:40 +0000692 && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
693 int savedPc = v->pc;
drh754ee282017-08-02 19:04:37 +0000694 rc = sqlite3Reprepare(v);
695 if( rc!=SQLITE_OK ){
696 /* This case occurs after failing to recompile an sql statement.
697 ** The error message from the SQL compiler has already been loaded
698 ** into the database handle. This block copies the error message
699 ** from the database handle into the statement and sets the statement
700 ** program counter to 0 to ensure that when the statement is
701 ** finalized or reset the parser error message is available via
702 ** sqlite3_errmsg() and sqlite3_errcode().
703 */
704 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
705 sqlite3DbFree(db, v->zErrMsg);
706 if( !db->mallocFailed ){
707 v->zErrMsg = sqlite3DbStrDup(db, zErr);
708 v->rc = rc = sqlite3ApiExit(db, rc);
709 } else {
710 v->zErrMsg = 0;
711 v->rc = rc = SQLITE_NOMEM_BKPT;
712 }
713 break;
714 }
drh413c3d32010-02-23 20:11:56 +0000715 sqlite3_reset(pStmt);
drh5f58ae72014-08-19 20:41:36 +0000716 if( savedPc>=0 ) v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000717 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000718 }
drh413c3d32010-02-23 20:11:56 +0000719 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000720 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000721}
722
drh95a7b3e2013-09-16 12:57:19 +0000723
drh4f26d6c2004-05-26 23:25:30 +0000724/*
drheb2e1762004-05-27 01:53:56 +0000725** Extract the user data from a sqlite3_context structure and return a
726** pointer to it.
727*/
728void *sqlite3_user_data(sqlite3_context *p){
729 assert( p && p->pFunc );
730 return p->pFunc->pUserData;
731}
732
733/*
drhfa4a4b92008-03-19 21:45:51 +0000734** Extract the user data from a sqlite3_context structure and return a
735** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000736**
737** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
738** returns a copy of the pointer to the database connection (the 1st
739** parameter) of the sqlite3_create_function() and
740** sqlite3_create_function16() routines that originally registered the
741** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000742*/
743sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
drha46a4a62015-09-08 21:12:53 +0000744 assert( p && p->pOut );
drh9bd038f2014-08-27 14:14:06 +0000745 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000746}
747
748/*
drha9e03b12015-03-12 06:46:52 +0000749** Return the current time for a statement. If the current time
750** is requested more than once within the same run of a single prepared
751** statement, the exact same time is returned for each invocation regardless
752** of the amount of time that elapses between invocations. In other words,
753** the time returned is always the time of the first call.
drh95a7b3e2013-09-16 12:57:19 +0000754*/
755sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
drh95a7b3e2013-09-16 12:57:19 +0000756 int rc;
drha9e03b12015-03-12 06:46:52 +0000757#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
drh3df79a92015-03-12 23:48:27 +0000758 sqlite3_int64 *piTime = &p->pVdbe->iCurrentTime;
drha9e03b12015-03-12 06:46:52 +0000759 assert( p->pVdbe!=0 );
760#else
drh3df79a92015-03-12 23:48:27 +0000761 sqlite3_int64 iTime = 0;
drha9e03b12015-03-12 06:46:52 +0000762 sqlite3_int64 *piTime = p->pVdbe!=0 ? &p->pVdbe->iCurrentTime : &iTime;
drha9e03b12015-03-12 06:46:52 +0000763#endif
drh3df79a92015-03-12 23:48:27 +0000764 if( *piTime==0 ){
drha9e03b12015-03-12 06:46:52 +0000765 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, piTime);
766 if( rc ) *piTime = 0;
drh95a7b3e2013-09-16 12:57:19 +0000767 }
drha9e03b12015-03-12 06:46:52 +0000768 return *piTime;
drh95a7b3e2013-09-16 12:57:19 +0000769}
770
771/*
drhb7481e72006-09-16 21:45:14 +0000772** The following is the implementation of an SQL function that always
773** fails with an error message stating that the function is used in the
774** wrong context. The sqlite3_overload_function() API might construct
775** SQL function that use this routine so that the functions will exist
776** for name resolution but are actually overloaded by the xFindFunction
777** method of virtual tables.
778*/
779void sqlite3InvalidFunction(
780 sqlite3_context *context, /* The function calling context */
danielk197762c14b32008-11-19 09:05:26 +0000781 int NotUsed, /* Number of arguments to the function */
782 sqlite3_value **NotUsed2 /* Value of each argument */
drhb7481e72006-09-16 21:45:14 +0000783){
784 const char *zName = context->pFunc->zName;
785 char *zErr;
danielk197762c14b32008-11-19 09:05:26 +0000786 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhbc6160b2009-04-08 15:45:31 +0000787 zErr = sqlite3_mprintf(
drhb7481e72006-09-16 21:45:14 +0000788 "unable to use function %s in the requested context", zName);
789 sqlite3_result_error(context, zErr, -1);
danielk19771e536952007-08-16 10:09:01 +0000790 sqlite3_free(zErr);
drhb7481e72006-09-16 21:45:14 +0000791}
792
793/*
drh9de4a172014-08-23 18:17:19 +0000794** Create a new aggregate context for p and return a pointer to
795** its pMem->z element.
796*/
797static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
798 Mem *pMem = p->pMem;
799 assert( (pMem->flags & MEM_Agg)==0 );
800 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000801 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000802 pMem->z = 0;
803 }else{
drh322f2852014-09-19 00:43:39 +0000804 sqlite3VdbeMemClearAndResize(pMem, nByte);
drh9de4a172014-08-23 18:17:19 +0000805 pMem->flags = MEM_Agg;
806 pMem->u.pDef = p->pFunc;
807 if( pMem->z ){
808 memset(pMem->z, 0, nByte);
809 }
810 }
811 return (void*)pMem->z;
812}
813
814/*
drheb2e1762004-05-27 01:53:56 +0000815** Allocate or return the aggregate context for a user function. A new
816** context is allocated on the first call. Subsequent calls return the
817** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000818*/
819void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh2d801512016-01-14 22:19:58 +0000820 assert( p && p->pFunc && p->pFunc->xFinalize );
drh9bd038f2014-08-27 14:14:06 +0000821 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000822 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000823 if( (p->pMem->flags & MEM_Agg)==0 ){
824 return createAggContext(p, nByte);
825 }else{
826 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000827 }
drheb2e1762004-05-27 01:53:56 +0000828}
829
830/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000831** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000832** the user-function defined by pCtx.
drhf7fa4e72017-05-11 15:20:18 +0000833**
834** The left-most argument is 0.
835**
836** Undocumented behavior: If iArg is negative then access a cache of
837** auxiliary data pointers that is available to all functions within a
838** single prepared statement. The iArg values must match.
danielk1977682f68b2004-06-05 10:22:17 +0000839*/
840void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000841 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000842
drh9bd038f2014-08-27 14:14:06 +0000843 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drha9e03b12015-03-12 06:46:52 +0000844#if SQLITE_ENABLE_STAT3_OR_STAT4
dan18bf8072015-03-11 20:06:40 +0000845 if( pCtx->pVdbe==0 ) return 0;
drha9e03b12015-03-12 06:46:52 +0000846#else
847 assert( pCtx->pVdbe!=0 );
848#endif
drhe6941392017-05-10 19:42:52 +0000849 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
drhf7fa4e72017-05-11 15:20:18 +0000850 if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
drhe6941392017-05-10 19:42:52 +0000851 return pAuxData->pAux;
852 }
danielk1977682f68b2004-06-05 10:22:17 +0000853 }
drhe6941392017-05-10 19:42:52 +0000854 return 0;
danielk1977682f68b2004-06-05 10:22:17 +0000855}
856
857/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000858** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000859** argument to the user-function defined by pCtx. Any previous value is
860** deleted by calling the delete function specified when it was set.
drhf7fa4e72017-05-11 15:20:18 +0000861**
862** The left-most argument is 0.
863**
864** Undocumented behavior: If iArg is negative then make the data available
865** to all functions within the current prepared statement using iArg as an
866** access code.
danielk1977682f68b2004-06-05 10:22:17 +0000867*/
868void sqlite3_set_auxdata(
869 sqlite3_context *pCtx,
870 int iArg,
871 void *pAux,
872 void (*xDelete)(void*)
873){
dan0c547792013-07-18 17:12:08 +0000874 AuxData *pAuxData;
875 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000876
drh9bd038f2014-08-27 14:14:06 +0000877 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drha9e03b12015-03-12 06:46:52 +0000878#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan18bf8072015-03-11 20:06:40 +0000879 if( pVdbe==0 ) goto failed;
drha9e03b12015-03-12 06:46:52 +0000880#else
881 assert( pVdbe!=0 );
882#endif
danielk1977682f68b2004-06-05 10:22:17 +0000883
drhe6941392017-05-10 19:42:52 +0000884 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
drhf7fa4e72017-05-11 15:20:18 +0000885 if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
886 break;
887 }
dan0c547792013-07-18 17:12:08 +0000888 }
889 if( pAuxData==0 ){
890 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
891 if( !pAuxData ) goto failed;
drhe6941392017-05-10 19:42:52 +0000892 pAuxData->iAuxOp = pCtx->iOp;
893 pAuxData->iAuxArg = iArg;
894 pAuxData->pNextAux = pVdbe->pAuxData;
dan0c547792013-07-18 17:12:08 +0000895 pVdbe->pAuxData = pAuxData;
drh9b47ee32013-08-20 03:13:51 +0000896 if( pCtx->fErrorOrAux==0 ){
897 pCtx->isError = 0;
898 pCtx->fErrorOrAux = 1;
899 }
drhe6941392017-05-10 19:42:52 +0000900 }else if( pAuxData->xDeleteAux ){
901 pAuxData->xDeleteAux(pAuxData->pAux);
danielk1977682f68b2004-06-05 10:22:17 +0000902 }
dan0c547792013-07-18 17:12:08 +0000903
danielk1977682f68b2004-06-05 10:22:17 +0000904 pAuxData->pAux = pAux;
drhe6941392017-05-10 19:42:52 +0000905 pAuxData->xDeleteAux = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000906 return;
907
908failed:
909 if( xDelete ){
910 xDelete(pAux);
911 }
danielk1977682f68b2004-06-05 10:22:17 +0000912}
913
shaneeec556d2008-10-12 00:27:53 +0000914#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000915/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000916** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000917** called.
918**
drhcf85a512006-02-09 18:35:29 +0000919** This function is deprecated. Do not use it for new code. It is
920** provide only to avoid breaking legacy code. New aggregate function
921** implementations should keep their own counts within their aggregate
922** context.
drheb2e1762004-05-27 01:53:56 +0000923*/
924int sqlite3_aggregate_count(sqlite3_context *p){
drh2d801512016-01-14 22:19:58 +0000925 assert( p && p->pMem && p->pFunc && p->pFunc->xFinalize );
drhabfcea22005-09-06 20:36:48 +0000926 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000927}
shaneeec556d2008-10-12 00:27:53 +0000928#endif
drheb2e1762004-05-27 01:53:56 +0000929
930/*
drh4f26d6c2004-05-26 23:25:30 +0000931** Return the number of columns in the result set for the statement pStmt.
932*/
933int sqlite3_column_count(sqlite3_stmt *pStmt){
934 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000935 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000936}
937
938/*
939** Return the number of values available from the current row of the
940** currently executing statement pStmt.
941*/
942int sqlite3_data_count(sqlite3_stmt *pStmt){
943 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000944 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000945 return pVm->nResColumn;
946}
947
dan46c47d42011-03-01 18:42:07 +0000948/*
949** Return a pointer to static memory containing an SQL NULL value.
950*/
951static const Mem *columnNullValue(void){
952 /* Even though the Mem structure contains an element
drhb1a1c292014-03-05 12:47:55 +0000953 ** of type i64, on certain architectures (x86) with certain compiler
dan46c47d42011-03-01 18:42:07 +0000954 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
955 ** instead of an 8-byte one. This all works fine, except that when
956 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
957 ** that a Mem structure is located on an 8-byte boundary. To prevent
drhb1a1c292014-03-05 12:47:55 +0000958 ** these assert()s from failing, when building with SQLITE_DEBUG defined
959 ** using gcc, we force nullMem to be 8-byte aligned using the magical
dan46c47d42011-03-01 18:42:07 +0000960 ** __attribute__((aligned(8))) macro. */
961 static const Mem nullMem
962#if defined(SQLITE_DEBUG) && defined(__GNUC__)
drhb1a1c292014-03-05 12:47:55 +0000963 __attribute__((aligned(8)))
dan46c47d42011-03-01 18:42:07 +0000964#endif
drh035e5632014-09-16 14:16:31 +0000965 = {
drh3329a632014-09-18 01:21:43 +0000966 /* .u = */ {0},
drh8faee872015-09-19 18:08:13 +0000967 /* .flags = */ (u16)MEM_Null,
968 /* .enc = */ (u8)0,
969 /* .eSubtype = */ (u8)0,
970 /* .n = */ (int)0,
971 /* .z = */ (char*)0,
972 /* .zMalloc = */ (char*)0,
973 /* .szMalloc = */ (int)0,
974 /* .uTemp = */ (u32)0,
975 /* .db = */ (sqlite3*)0,
976 /* .xDel = */ (void(*)(void*))0,
drhb1a1c292014-03-05 12:47:55 +0000977#ifdef SQLITE_DEBUG
drh8faee872015-09-19 18:08:13 +0000978 /* .pScopyFrom = */ (Mem*)0,
979 /* .pFiller = */ (void*)0,
drhb1a1c292014-03-05 12:47:55 +0000980#endif
drh035e5632014-09-16 14:16:31 +0000981 };
dan46c47d42011-03-01 18:42:07 +0000982 return &nullMem;
983}
drh4f26d6c2004-05-26 23:25:30 +0000984
985/*
986** Check to see if column iCol of the given statement is valid. If
987** it is, return a pointer to the Mem for the value of that column.
988** If iCol is not valid, return a pointer to a Mem which has a value
989** of NULL.
990*/
991static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000992 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000993 Mem *pOut;
994
995 pVm = (Vdbe *)pStmt;
drh28f17012016-09-22 21:37:18 +0000996 if( pVm==0 ) return (Mem*)columnNullValue();
997 assert( pVm->db );
998 sqlite3_mutex_enter(pVm->db->mutex);
999 if( pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drhd4e70eb2008-01-02 00:34:36 +00001000 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +00001001 }else{
drh28f17012016-09-22 21:37:18 +00001002 sqlite3Error(pVm->db, SQLITE_RANGE);
dan46c47d42011-03-01 18:42:07 +00001003 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +00001004 }
drh32bc3f62007-08-21 20:25:39 +00001005 return pOut;
drh4f26d6c2004-05-26 23:25:30 +00001006}
1007
danielk19772e588c72005-12-09 14:25:08 +00001008/*
1009** This function is called after invoking an sqlite3_value_XXX function on a
1010** column value (i.e. a value returned by evaluating an SQL expression in the
1011** select list of a SELECT statement) that may cause a malloc() failure. If
1012** malloc() has failed, the threads mallocFailed flag is cleared and the result
1013** code of statement pStmt set to SQLITE_NOMEM.
1014**
drh32bc3f62007-08-21 20:25:39 +00001015** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +00001016**
1017** sqlite3_column_int()
1018** sqlite3_column_int64()
1019** sqlite3_column_text()
1020** sqlite3_column_text16()
1021** sqlite3_column_real()
1022** sqlite3_column_bytes()
1023** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +00001024** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +00001025*/
1026static void columnMallocFailure(sqlite3_stmt *pStmt)
1027{
1028 /* If malloc() failed during an encoding conversion within an
1029 ** sqlite3_column_XXX API, then set the return code of the statement to
1030 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
1031 ** and _finalize() will return NOMEM.
1032 */
danielk197754f01982006-01-18 15:25:17 +00001033 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +00001034 if( p ){
drh28f17012016-09-22 21:37:18 +00001035 assert( p->db!=0 );
1036 assert( sqlite3_mutex_held(p->db->mutex) );
drh32bc3f62007-08-21 20:25:39 +00001037 p->rc = sqlite3ApiExit(p->db, p->rc);
1038 sqlite3_mutex_leave(p->db->mutex);
1039 }
danielk19772e588c72005-12-09 14:25:08 +00001040}
1041
drh4f26d6c2004-05-26 23:25:30 +00001042/**************************** sqlite3_column_ *******************************
1043** The following routines are used to access elements of the current row
1044** in the result set.
1045*/
danielk1977c572ef72004-05-27 09:28:41 +00001046const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001047 const void *val;
danielk19772e588c72005-12-09 14:25:08 +00001048 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +00001049 /* Even though there is no encoding conversion, value_blob() might
1050 ** need to call malloc() to expand the result of a zeroblob()
1051 ** expression.
1052 */
1053 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +00001054 return val;
danielk1977c572ef72004-05-27 09:28:41 +00001055}
drh4f26d6c2004-05-26 23:25:30 +00001056int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001057 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
1058 columnMallocFailure(pStmt);
1059 return val;
drh4f26d6c2004-05-26 23:25:30 +00001060}
1061int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001062 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
1063 columnMallocFailure(pStmt);
1064 return val;
drh4f26d6c2004-05-26 23:25:30 +00001065}
1066double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001067 double val = sqlite3_value_double( columnMem(pStmt,i) );
1068 columnMallocFailure(pStmt);
1069 return val;
drh4f26d6c2004-05-26 23:25:30 +00001070}
1071int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001072 int val = sqlite3_value_int( columnMem(pStmt,i) );
1073 columnMallocFailure(pStmt);
1074 return val;
drh4f26d6c2004-05-26 23:25:30 +00001075}
drhefad9992004-06-22 12:13:55 +00001076sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001077 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
1078 columnMallocFailure(pStmt);
1079 return val;
drh4f26d6c2004-05-26 23:25:30 +00001080}
1081const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001082 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
1083 columnMallocFailure(pStmt);
1084 return val;
drh4f26d6c2004-05-26 23:25:30 +00001085}
drhd1e47332005-06-26 17:55:33 +00001086sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +00001087 Mem *pOut = columnMem(pStmt, i);
1088 if( pOut->flags&MEM_Static ){
1089 pOut->flags &= ~MEM_Static;
1090 pOut->flags |= MEM_Ephem;
1091 }
drh32bc3f62007-08-21 20:25:39 +00001092 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +00001093 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +00001094}
drh6c626082004-11-14 21:56:29 +00001095#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001096const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001097 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
1098 columnMallocFailure(pStmt);
1099 return val;
drh4f26d6c2004-05-26 23:25:30 +00001100}
drh6c626082004-11-14 21:56:29 +00001101#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +00001102int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +00001103 int iType = sqlite3_value_type( columnMem(pStmt,i) );
1104 columnMallocFailure(pStmt);
1105 return iType;
drh4f26d6c2004-05-26 23:25:30 +00001106}
1107
drh5e2517e2004-09-24 23:59:12 +00001108/*
1109** Convert the N-th element of pStmt->pColName[] into a string using
1110** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +00001111**
1112** There are up to 5 names for each column. useType determines which
1113** name is returned. Here are the names:
1114**
1115** 0 The column name as it should be displayed for output
1116** 1 The datatype name for the column
1117** 2 The name of the database that the column derives from
1118** 3 The name of the table that the column derives from
1119** 4 The name of the table column that the result column derives from
1120**
1121** If the result is not a simple column reference (if it is an expression
1122** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +00001123*/
1124static const void *columnName(
1125 sqlite3_stmt *pStmt,
1126 int N,
1127 const void *(*xFunc)(Mem*),
1128 int useType
1129){
drh9ca95732014-10-24 00:35:58 +00001130 const void *ret;
1131 Vdbe *p;
drh32bc3f62007-08-21 20:25:39 +00001132 int n;
drh9ca95732014-10-24 00:35:58 +00001133 sqlite3 *db;
1134#ifdef SQLITE_ENABLE_API_ARMOR
1135 if( pStmt==0 ){
1136 (void)SQLITE_MISUSE_BKPT;
1137 return 0;
1138 }
1139#endif
1140 ret = 0;
1141 p = (Vdbe *)pStmt;
1142 db = p->db;
drh9b4ea4a2009-04-10 20:32:00 +00001143 assert( db!=0 );
1144 n = sqlite3_column_count(pStmt);
1145 if( N<n && N>=0 ){
1146 N += useType*n;
1147 sqlite3_mutex_enter(db->mutex);
1148 assert( db->mallocFailed==0 );
1149 ret = xFunc(&p->aColName[N]);
1150 /* A malloc may have failed inside of the xFunc() call. If this
1151 ** is the case, clear the mallocFailed flag and return NULL.
1152 */
1153 if( db->mallocFailed ){
drh4a642b62016-02-05 01:55:27 +00001154 sqlite3OomClear(db);
drh9b4ea4a2009-04-10 20:32:00 +00001155 ret = 0;
drh32bc3f62007-08-21 20:25:39 +00001156 }
drh9b4ea4a2009-04-10 20:32:00 +00001157 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +00001158 }
danielk197700fd9572005-12-07 06:27:43 +00001159 return ret;
drh5e2517e2004-09-24 23:59:12 +00001160}
1161
drh4f26d6c2004-05-26 23:25:30 +00001162/*
1163** Return the name of the Nth column of the result set returned by SQL
1164** statement pStmt.
1165*/
1166const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001167 return columnName(
1168 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +00001169}
drhe590fbd2005-05-20 19:36:01 +00001170#ifndef SQLITE_OMIT_UTF16
1171const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001172 return columnName(
1173 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001174}
1175#endif
drh4f26d6c2004-05-26 23:25:30 +00001176
1177/*
drh3f913572008-03-22 01:07:17 +00001178** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1179** not define OMIT_DECLTYPE.
1180*/
1181#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1182# error "Must not define both SQLITE_OMIT_DECLTYPE \
1183 and SQLITE_ENABLE_COLUMN_METADATA"
1184#endif
1185
1186#ifndef SQLITE_OMIT_DECLTYPE
1187/*
drh6c626082004-11-14 21:56:29 +00001188** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001189** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001190*/
1191const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001192 return columnName(
1193 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001194}
drh6c626082004-11-14 21:56:29 +00001195#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001196const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001197 return columnName(
1198 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001199}
drh6c626082004-11-14 21:56:29 +00001200#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001201#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001202
danielk19774b1ae992006-02-10 03:06:10 +00001203#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001204/*
1205** Return the name of the database from which a result column derives.
1206** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001207** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001208*/
1209const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001210 return columnName(
1211 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001212}
1213#ifndef SQLITE_OMIT_UTF16
1214const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001215 return columnName(
1216 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001217}
1218#endif /* SQLITE_OMIT_UTF16 */
1219
1220/*
1221** Return the name of the table from which a result column derives.
1222** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001223** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001224*/
1225const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001226 return columnName(
1227 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001228}
1229#ifndef SQLITE_OMIT_UTF16
1230const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001231 return columnName(
1232 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001233}
1234#endif /* SQLITE_OMIT_UTF16 */
1235
1236/*
1237** Return the name of the table column from which a result column derives.
1238** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001239** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001240*/
1241const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001242 return columnName(
1243 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001244}
1245#ifndef SQLITE_OMIT_UTF16
1246const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001247 return columnName(
1248 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001249}
1250#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001251#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001252
1253
drh4f26d6c2004-05-26 23:25:30 +00001254/******************************* sqlite3_bind_ ***************************
1255**
1256** Routines used to attach values to wildcards in a compiled SQL statement.
1257*/
1258/*
1259** Unbind the value bound to variable i in virtual machine p. This is the
1260** the same as binding a NULL value to the column. If the "i" parameter is
1261** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1262**
drh488e7b62008-10-06 12:46:43 +00001263** A successful evaluation of this routine acquires the mutex on p.
1264** the mutex is released if any kind of error occurs.
1265**
drh4f26d6c2004-05-26 23:25:30 +00001266** The error code stored in database p->db is overwritten with the return
1267** value in any case.
1268*/
1269static int vdbeUnbind(Vdbe *p, int i){
1270 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001271 if( vdbeSafetyNotNull(p) ){
1272 return SQLITE_MISUSE_BKPT;
1273 }
drh488e7b62008-10-06 12:46:43 +00001274 sqlite3_mutex_enter(p->db->mutex);
1275 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001276 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001277 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001278 sqlite3_log(SQLITE_MISUSE,
1279 "bind on a busy prepared statement: [%s]", p->zSql);
1280 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001281 }
1282 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001283 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001284 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001285 return SQLITE_RANGE;
1286 }
1287 i--;
drh290c1942004-08-21 17:54:45 +00001288 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001289 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001290 pVar->flags = MEM_Null;
drh13f40da2014-08-22 18:00:11 +00001291 sqlite3Error(p->db, SQLITE_OK);
dan937d0de2009-10-15 18:35:38 +00001292
dan1d2ce4f2009-10-19 18:11:09 +00001293 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1294 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001295 **
1296 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1297 ** parameter in the WHERE clause might influence the choice of query plan
1298 ** for a statement, then the statement will be automatically recompiled,
1299 ** as if there had been a schema change, on the first sqlite3_step() call
1300 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001301 */
drh2c2f3922017-06-01 00:54:35 +00001302 assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || p->expmask==0 );
drh29967962017-03-03 21:51:40 +00001303 if( p->expmask!=0 && (p->expmask & (i>=31 ? 0x80000000 : (u32)1<<i))!=0 ){
dan937d0de2009-10-15 18:35:38 +00001304 p->expired = 1;
1305 }
drh4f26d6c2004-05-26 23:25:30 +00001306 return SQLITE_OK;
1307}
1308
1309/*
drh5e2517e2004-09-24 23:59:12 +00001310** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001311*/
drh5e2517e2004-09-24 23:59:12 +00001312static int bindText(
drh605264d2007-08-21 15:13:19 +00001313 sqlite3_stmt *pStmt, /* The statement to bind against */
1314 int i, /* Index of the parameter to bind */
1315 const void *zData, /* Pointer to the data to be bound */
1316 int nData, /* Number of bytes of data to be bound */
1317 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001318 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001319){
1320 Vdbe *p = (Vdbe *)pStmt;
1321 Mem *pVar;
1322 int rc;
1323
1324 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001325 if( rc==SQLITE_OK ){
1326 if( zData!=0 ){
1327 pVar = &p->aVar[i-1];
1328 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1329 if( rc==SQLITE_OK && encoding!=0 ){
1330 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1331 }
drhe70d01f2017-05-29 22:44:18 +00001332 if( rc ){
1333 sqlite3Error(p->db, rc);
1334 rc = sqlite3ApiExit(p->db, rc);
1335 }
drh27641702007-08-22 02:56:42 +00001336 }
drh488e7b62008-10-06 12:46:43 +00001337 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001338 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001339 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001340 }
drh605264d2007-08-21 15:13:19 +00001341 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001342}
drh5e2517e2004-09-24 23:59:12 +00001343
1344
1345/*
1346** Bind a blob value to an SQL statement variable.
1347*/
1348int sqlite3_bind_blob(
1349 sqlite3_stmt *pStmt,
1350 int i,
1351 const void *zData,
1352 int nData,
1353 void (*xDel)(void*)
1354){
drh5b081d82016-02-18 01:29:12 +00001355#ifdef SQLITE_ENABLE_API_ARMOR
1356 if( nData<0 ) return SQLITE_MISUSE_BKPT;
1357#endif
drh5e2517e2004-09-24 23:59:12 +00001358 return bindText(pStmt, i, zData, nData, xDel, 0);
1359}
drhda4ca9d2014-09-09 17:27:35 +00001360int sqlite3_bind_blob64(
1361 sqlite3_stmt *pStmt,
1362 int i,
1363 const void *zData,
1364 sqlite3_uint64 nData,
1365 void (*xDel)(void*)
1366){
drhfc59a952014-09-11 23:34:55 +00001367 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001368 if( nData>0x7fffffff ){
1369 return invokeValueDestructor(zData, xDel, 0);
1370 }else{
drh3329a632014-09-18 01:21:43 +00001371 return bindText(pStmt, i, zData, (int)nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001372 }
1373}
drh4f26d6c2004-05-26 23:25:30 +00001374int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1375 int rc;
1376 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001377 rc = vdbeUnbind(p, i);
1378 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001379 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001380 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001381 }
danielk1977f4618892004-06-28 13:09:11 +00001382 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001383}
1384int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001385 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001386}
drhefad9992004-06-22 12:13:55 +00001387int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001388 int rc;
1389 Vdbe *p = (Vdbe *)pStmt;
1390 rc = vdbeUnbind(p, i);
1391 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001392 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001393 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001394 }
1395 return rc;
1396}
drh605264d2007-08-21 15:13:19 +00001397int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1398 int rc;
1399 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001400 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001401 if( rc==SQLITE_OK ){
1402 sqlite3_mutex_leave(p->db->mutex);
1403 }
drh605264d2007-08-21 15:13:19 +00001404 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001405}
drh22930062017-07-27 03:48:02 +00001406int sqlite3_bind_pointer(
1407 sqlite3_stmt *pStmt,
1408 int i,
1409 void *pPtr,
1410 const char *zPTtype,
1411 void (*xDestructor)(void*)
1412){
drh3a96a5d2017-06-30 23:09:03 +00001413 int rc;
1414 Vdbe *p = (Vdbe*)pStmt;
1415 rc = vdbeUnbind(p, i);
1416 if( rc==SQLITE_OK ){
drh22930062017-07-27 03:48:02 +00001417 sqlite3VdbeMemSetPointer(&p->aVar[i-1], pPtr, zPTtype, xDestructor);
drh3a96a5d2017-06-30 23:09:03 +00001418 sqlite3_mutex_leave(p->db->mutex);
drh34fcf362017-07-27 16:42:36 +00001419 }else if( xDestructor ){
1420 xDestructor(pPtr);
drh3a96a5d2017-06-30 23:09:03 +00001421 }
1422 return rc;
1423}
drh4f26d6c2004-05-26 23:25:30 +00001424int sqlite3_bind_text(
1425 sqlite3_stmt *pStmt,
1426 int i,
1427 const char *zData,
1428 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001429 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001430){
drh5e2517e2004-09-24 23:59:12 +00001431 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001432}
drhbbf483f2014-09-09 20:30:24 +00001433int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001434 sqlite3_stmt *pStmt,
1435 int i,
1436 const char *zData,
1437 sqlite3_uint64 nData,
1438 void (*xDel)(void*),
1439 unsigned char enc
1440){
drhfc59a952014-09-11 23:34:55 +00001441 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001442 if( nData>0x7fffffff ){
1443 return invokeValueDestructor(zData, xDel, 0);
1444 }else{
drhfc59a952014-09-11 23:34:55 +00001445 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drh3329a632014-09-18 01:21:43 +00001446 return bindText(pStmt, i, zData, (int)nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001447 }
1448}
drh6c626082004-11-14 21:56:29 +00001449#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001450int sqlite3_bind_text16(
1451 sqlite3_stmt *pStmt,
1452 int i,
1453 const void *zData,
1454 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001455 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001456){
drh5e2517e2004-09-24 23:59:12 +00001457 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001458}
drh6c626082004-11-14 21:56:29 +00001459#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001460int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1461 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001462 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001463 case SQLITE_INTEGER: {
1464 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1465 break;
1466 }
1467 case SQLITE_FLOAT: {
drh74eaba42014-09-18 17:52:15 +00001468 rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
drh29def562009-04-14 12:43:33 +00001469 break;
1470 }
1471 case SQLITE_BLOB: {
1472 if( pValue->flags & MEM_Zero ){
1473 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1474 }else{
1475 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1476 }
1477 break;
1478 }
1479 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001480 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1481 pValue->enc);
1482 break;
1483 }
1484 default: {
1485 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001486 break;
1487 }
danielk197726e41442006-06-14 15:16:35 +00001488 }
1489 return rc;
1490}
drhb026e052007-05-02 01:34:31 +00001491int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1492 int rc;
1493 Vdbe *p = (Vdbe *)pStmt;
1494 rc = vdbeUnbind(p, i);
1495 if( rc==SQLITE_OK ){
1496 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001497 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001498 }
1499 return rc;
1500}
dan80c03022015-07-24 17:36:34 +00001501int sqlite3_bind_zeroblob64(sqlite3_stmt *pStmt, int i, sqlite3_uint64 n){
1502 int rc;
1503 Vdbe *p = (Vdbe *)pStmt;
1504 sqlite3_mutex_enter(p->db->mutex);
1505 if( n>(u64)p->db->aLimit[SQLITE_LIMIT_LENGTH] ){
1506 rc = SQLITE_TOOBIG;
1507 }else{
1508 assert( (n & 0x7FFFFFFF)==n );
1509 rc = sqlite3_bind_zeroblob(pStmt, i, n);
1510 }
1511 rc = sqlite3ApiExit(p->db, rc);
1512 sqlite3_mutex_leave(p->db->mutex);
1513 return rc;
1514}
drh75f6a032004-07-15 14:15:00 +00001515
1516/*
1517** Return the number of wildcards that can be potentially bound to.
1518** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001519*/
1520int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001521 Vdbe *p = (Vdbe*)pStmt;
1522 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001523}
drh895d7472004-08-20 16:02:39 +00001524
1525/*
drhfa6bc002004-09-07 16:19:52 +00001526** Return the name of a wildcard parameter. Return NULL if the index
1527** is out of range or if the wildcard is unnamed.
1528**
1529** The result is always UTF-8.
1530*/
1531const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1532 Vdbe *p = (Vdbe*)pStmt;
drh9bf755c2016-12-23 03:59:31 +00001533 if( p==0 ) return 0;
1534 return sqlite3VListNumToName(p->pVList, i);
drh895d7472004-08-20 16:02:39 +00001535}
drhfa6bc002004-09-07 16:19:52 +00001536
1537/*
1538** Given a wildcard parameter name, return the index of the variable
1539** with that name. If there is no variable with the given name,
1540** return 0.
1541*/
drh5f18a222009-11-26 14:01:53 +00001542int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drh9bf755c2016-12-23 03:59:31 +00001543 if( p==0 || zName==0 ) return 0;
1544 return sqlite3VListNameToNum(p->pVList, zName, nName);
drhfa6bc002004-09-07 16:19:52 +00001545}
drh5f18a222009-11-26 14:01:53 +00001546int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1547 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1548}
drhf8db1bc2005-04-22 02:38:37 +00001549
drh51942bc2005-06-12 22:01:42 +00001550/*
drhf8db1bc2005-04-22 02:38:37 +00001551** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001552*/
shane145834a2008-09-04 12:03:42 +00001553int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001554 Vdbe *pFrom = (Vdbe*)pFromStmt;
1555 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001556 int i;
1557 assert( pTo->db==pFrom->db );
1558 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001559 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001560 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001561 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001562 }
drh27641702007-08-22 02:56:42 +00001563 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001564 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001565}
drh51942bc2005-06-12 22:01:42 +00001566
shaneeec556d2008-10-12 00:27:53 +00001567#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001568/*
shane145834a2008-09-04 12:03:42 +00001569** Deprecated external interface. Internal/core SQLite code
1570** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001571**
peter.d.reid60ec9142014-09-06 16:39:46 +00001572** It is misuse to call this routine with statements from different
drh0f5ea0b2009-04-09 14:02:44 +00001573** database connections. But as this is a deprecated interface, we
1574** will not bother to check for that condition.
1575**
1576** If the two statements contain a different number of bindings, then
1577** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1578** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001579*/
1580int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001581 Vdbe *pFrom = (Vdbe*)pFromStmt;
1582 Vdbe *pTo = (Vdbe*)pToStmt;
1583 if( pFrom->nVar!=pTo->nVar ){
1584 return SQLITE_ERROR;
1585 }
drh2c2f3922017-06-01 00:54:35 +00001586 assert( (pTo->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || pTo->expmask==0 );
danbda4cb82017-02-23 16:30:16 +00001587 if( pTo->expmask ){
danc94b8592009-10-20 07:01:24 +00001588 pTo->expired = 1;
1589 }
drh2c2f3922017-06-01 00:54:35 +00001590 assert( (pFrom->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || pFrom->expmask==0 );
danbda4cb82017-02-23 16:30:16 +00001591 if( pFrom->expmask ){
danc94b8592009-10-20 07:01:24 +00001592 pFrom->expired = 1;
1593 }
shane145834a2008-09-04 12:03:42 +00001594 return sqlite3TransferBindings(pFromStmt, pToStmt);
1595}
shaneeec556d2008-10-12 00:27:53 +00001596#endif
shane145834a2008-09-04 12:03:42 +00001597
1598/*
drh51942bc2005-06-12 22:01:42 +00001599** Return the sqlite3* database handle to which the prepared statement given
1600** in the argument belongs. This is the same database handle that was
1601** the first argument to the sqlite3_prepare() that was used to create
1602** the statement in the first place.
1603*/
1604sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1605 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1606}
drhbb5a9c32008-06-19 02:52:25 +00001607
1608/*
drhf03d9cc2010-11-16 23:10:25 +00001609** Return true if the prepared statement is guaranteed to not modify the
1610** database.
1611*/
1612int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1613 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1614}
1615
1616/*
drh2fb66932011-11-25 17:21:47 +00001617** Return true if the prepared statement is in need of being reset.
1618*/
1619int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1620 Vdbe *v = (Vdbe*)pStmt;
drh76336d52016-10-01 11:39:53 +00001621 return v!=0 && v->magic==VDBE_MAGIC_RUN && v->pc>=0;
drh2fb66932011-11-25 17:21:47 +00001622}
1623
1624/*
drhbb5a9c32008-06-19 02:52:25 +00001625** Return a pointer to the next prepared statement after pStmt associated
1626** with database connection pDb. If pStmt is NULL, return the first
1627** prepared statement for the database connection. Return NULL if there
1628** are no more.
1629*/
1630sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1631 sqlite3_stmt *pNext;
drh9ca95732014-10-24 00:35:58 +00001632#ifdef SQLITE_ENABLE_API_ARMOR
1633 if( !sqlite3SafetyCheckOk(pDb) ){
1634 (void)SQLITE_MISUSE_BKPT;
1635 return 0;
1636 }
1637#endif
drhbb5a9c32008-06-19 02:52:25 +00001638 sqlite3_mutex_enter(pDb->mutex);
1639 if( pStmt==0 ){
1640 pNext = (sqlite3_stmt*)pDb->pVdbe;
1641 }else{
1642 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1643 }
1644 sqlite3_mutex_leave(pDb->mutex);
1645 return pNext;
1646}
drhd1d38482008-10-07 23:46:38 +00001647
1648/*
1649** Return the value of a status counter for a prepared statement
1650*/
1651int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1652 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9ca95732014-10-24 00:35:58 +00001653 u32 v;
1654#ifdef SQLITE_ENABLE_API_ARMOR
1655 if( !pStmt ){
1656 (void)SQLITE_MISUSE_BKPT;
1657 return 0;
1658 }
1659#endif
drh3528f6b2017-05-31 16:21:54 +00001660 if( op==SQLITE_STMTSTATUS_MEMUSED ){
1661 sqlite3 *db = pVdbe->db;
1662 sqlite3_mutex_enter(db->mutex);
1663 v = 0;
1664 db->pnBytesFreed = (int*)&v;
1665 sqlite3VdbeClearObject(db, pVdbe);
1666 sqlite3DbFree(db, pVdbe);
1667 db->pnBytesFreed = 0;
1668 sqlite3_mutex_leave(db->mutex);
1669 }else{
1670 v = pVdbe->aCounter[op];
1671 if( resetFlag ) pVdbe->aCounter[op] = 0;
1672 }
drh9b47ee32013-08-20 03:13:51 +00001673 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001674}
dan46c47d42011-03-01 18:42:07 +00001675
drh557341e2016-07-23 02:07:26 +00001676/*
1677** Return the SQL associated with a prepared statement
1678*/
1679const char *sqlite3_sql(sqlite3_stmt *pStmt){
1680 Vdbe *p = (Vdbe *)pStmt;
1681 return p ? p->zSql : 0;
1682}
1683
1684/*
1685** Return the SQL associated with a prepared statement with
1686** bound parameters expanded. Space to hold the returned string is
1687** obtained from sqlite3_malloc(). The caller is responsible for
1688** freeing the returned string by passing it to sqlite3_free().
1689**
1690** The SQLITE_TRACE_SIZE_LIMIT puts an upper bound on the size of
1691** expanded bound parameters.
1692*/
1693char *sqlite3_expanded_sql(sqlite3_stmt *pStmt){
1694#ifdef SQLITE_OMIT_TRACE
1695 return 0;
1696#else
1697 char *z = 0;
1698 const char *zSql = sqlite3_sql(pStmt);
1699 if( zSql ){
1700 Vdbe *p = (Vdbe *)pStmt;
1701 sqlite3_mutex_enter(p->db->mutex);
1702 z = sqlite3VdbeExpandSql(p, zSql);
1703 sqlite3_mutex_leave(p->db->mutex);
1704 }
1705 return z;
1706#endif
1707}
1708
drh9b1c62d2011-03-30 21:04:43 +00001709#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001710/*
dan93bca692011-09-14 19:41:44 +00001711** Allocate and populate an UnpackedRecord structure based on the serialized
1712** record in nKey/pKey. Return a pointer to the new UnpackedRecord structure
1713** if successful, or a NULL pointer if an OOM error is encountered.
1714*/
1715static UnpackedRecord *vdbeUnpackRecord(
1716 KeyInfo *pKeyInfo,
1717 int nKey,
1718 const void *pKey
1719){
dan93bca692011-09-14 19:41:44 +00001720 UnpackedRecord *pRet; /* Return value */
1721
drha582b012016-12-21 19:45:54 +00001722 pRet = sqlite3VdbeAllocUnpackedRecord(pKeyInfo);
dan93bca692011-09-14 19:41:44 +00001723 if( pRet ){
drha485ad12017-08-02 22:43:14 +00001724 memset(pRet->aMem, 0, sizeof(Mem)*(pKeyInfo->nKeyField+1));
dan93bca692011-09-14 19:41:44 +00001725 sqlite3VdbeRecordUnpack(pKeyInfo, nKey, pKey, pRet);
1726 }
1727 return pRet;
1728}
1729
1730/*
dan37db03b2011-03-16 19:59:18 +00001731** This function is called from within a pre-update callback to retrieve
1732** a field of the row currently being updated or deleted.
1733*/
dan46c47d42011-03-01 18:42:07 +00001734int sqlite3_preupdate_old(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
1735 PreUpdate *p = db->pPreUpdate;
dan7271d7a2017-01-25 18:53:27 +00001736 Mem *pMem;
dan46c47d42011-03-01 18:42:07 +00001737 int rc = SQLITE_OK;
1738
dan37db03b2011-03-16 19:59:18 +00001739 /* Test that this call is being made from within an SQLITE_DELETE or
1740 ** SQLITE_UPDATE pre-update callback, and that iIdx is within range. */
dan46c47d42011-03-01 18:42:07 +00001741 if( !p || p->op==SQLITE_INSERT ){
1742 rc = SQLITE_MISUSE_BKPT;
1743 goto preupdate_old_out;
1744 }
dancb9a3642017-01-30 19:44:53 +00001745 if( p->pPk ){
1746 iIdx = sqlite3ColumnOfIndex(p->pPk, iIdx);
1747 }
dan46c47d42011-03-01 18:42:07 +00001748 if( iIdx>=p->pCsr->nField || iIdx<0 ){
1749 rc = SQLITE_RANGE;
1750 goto preupdate_old_out;
1751 }
1752
dan37db03b2011-03-16 19:59:18 +00001753 /* If the old.* record has not yet been loaded into memory, do so now. */
dan46c47d42011-03-01 18:42:07 +00001754 if( p->pUnpacked==0 ){
dan12ca0b52011-03-21 16:17:42 +00001755 u32 nRec;
1756 u8 *aRec;
dan46c47d42011-03-01 18:42:07 +00001757
drha7c90c42016-06-04 20:37:10 +00001758 nRec = sqlite3BtreePayloadSize(p->pCsr->uc.pCursor);
dan12ca0b52011-03-21 16:17:42 +00001759 aRec = sqlite3DbMallocRaw(db, nRec);
1760 if( !aRec ) goto preupdate_old_out;
drhcb3cabd2016-11-25 19:18:28 +00001761 rc = sqlite3BtreePayload(p->pCsr->uc.pCursor, 0, nRec, aRec);
dan12ca0b52011-03-21 16:17:42 +00001762 if( rc==SQLITE_OK ){
dan93bca692011-09-14 19:41:44 +00001763 p->pUnpacked = vdbeUnpackRecord(&p->keyinfo, nRec, aRec);
dan12ca0b52011-03-21 16:17:42 +00001764 if( !p->pUnpacked ) rc = SQLITE_NOMEM;
1765 }
dan46c47d42011-03-01 18:42:07 +00001766 if( rc!=SQLITE_OK ){
dan12ca0b52011-03-21 16:17:42 +00001767 sqlite3DbFree(db, aRec);
dan46c47d42011-03-01 18:42:07 +00001768 goto preupdate_old_out;
1769 }
dan12ca0b52011-03-21 16:17:42 +00001770 p->aRecord = aRec;
dan46c47d42011-03-01 18:42:07 +00001771 }
1772
dan7271d7a2017-01-25 18:53:27 +00001773 pMem = *ppValue = &p->pUnpacked->aMem[iIdx];
1774 if( iIdx==p->pTab->iPKey ){
1775 sqlite3VdbeMemSetInt64(pMem, p->iKey1);
1776 }else if( iIdx>=p->pUnpacked->nField ){
dan46c47d42011-03-01 18:42:07 +00001777 *ppValue = (sqlite3_value *)columnNullValue();
dan7271d7a2017-01-25 18:53:27 +00001778 }else if( p->pTab->aCol[iIdx].affinity==SQLITE_AFF_REAL ){
1779 if( pMem->flags & MEM_Int ){
1780 sqlite3VdbeMemRealify(pMem);
dan319eeb72011-03-19 08:38:50 +00001781 }
dan46c47d42011-03-01 18:42:07 +00001782 }
1783
1784 preupdate_old_out:
drhe1ed0b02014-08-26 02:15:07 +00001785 sqlite3Error(db, rc);
dan46c47d42011-03-01 18:42:07 +00001786 return sqlite3ApiExit(db, rc);
1787}
drh9b1c62d2011-03-30 21:04:43 +00001788#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00001789
drh9b1c62d2011-03-30 21:04:43 +00001790#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001791/*
1792** This function is called from within a pre-update callback to retrieve
1793** the number of columns in the row being updated, deleted or inserted.
1794*/
dan46c47d42011-03-01 18:42:07 +00001795int sqlite3_preupdate_count(sqlite3 *db){
1796 PreUpdate *p = db->pPreUpdate;
drha485ad12017-08-02 22:43:14 +00001797 return (p ? p->keyinfo.nKeyField : 0);
dan46c47d42011-03-01 18:42:07 +00001798}
drh9b1c62d2011-03-30 21:04:43 +00001799#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00001800
drh9b1c62d2011-03-30 21:04:43 +00001801#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001802/*
dan1e7a2d42011-03-22 18:45:29 +00001803** This function is designed to be called from within a pre-update callback
1804** only. It returns zero if the change that caused the callback was made
1805** immediately by a user SQL statement. Or, if the change was made by a
1806** trigger program, it returns the number of trigger programs currently
1807** on the stack (1 for a top-level trigger, 2 for a trigger fired by a
1808** top-level trigger etc.).
1809**
1810** For the purposes of the previous paragraph, a foreign key CASCADE, SET NULL
1811** or SET DEFAULT action is considered a trigger.
1812*/
1813int sqlite3_preupdate_depth(sqlite3 *db){
1814 PreUpdate *p = db->pPreUpdate;
1815 return (p ? p->v->nFrame : 0);
1816}
drh9b1c62d2011-03-30 21:04:43 +00001817#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan1e7a2d42011-03-22 18:45:29 +00001818
drh9b1c62d2011-03-30 21:04:43 +00001819#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan1e7a2d42011-03-22 18:45:29 +00001820/*
dan37db03b2011-03-16 19:59:18 +00001821** This function is called from within a pre-update callback to retrieve
1822** a field of the row currently being updated or inserted.
1823*/
1824int sqlite3_preupdate_new(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
dan46c47d42011-03-01 18:42:07 +00001825 PreUpdate *p = db->pPreUpdate;
1826 int rc = SQLITE_OK;
dan37db03b2011-03-16 19:59:18 +00001827 Mem *pMem;
dan46c47d42011-03-01 18:42:07 +00001828
dan37db03b2011-03-16 19:59:18 +00001829 if( !p || p->op==SQLITE_DELETE ){
dan46c47d42011-03-01 18:42:07 +00001830 rc = SQLITE_MISUSE_BKPT;
dan37db03b2011-03-16 19:59:18 +00001831 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001832 }
dancb9a3642017-01-30 19:44:53 +00001833 if( p->pPk && p->op!=SQLITE_UPDATE ){
1834 iIdx = sqlite3ColumnOfIndex(p->pPk, iIdx);
1835 }
dan46c47d42011-03-01 18:42:07 +00001836 if( iIdx>=p->pCsr->nField || iIdx<0 ){
1837 rc = SQLITE_RANGE;
dan37db03b2011-03-16 19:59:18 +00001838 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001839 }
dan46c47d42011-03-01 18:42:07 +00001840
dan37db03b2011-03-16 19:59:18 +00001841 if( p->op==SQLITE_INSERT ){
1842 /* For an INSERT, memory cell p->iNewReg contains the serialized record
1843 ** that is being inserted. Deserialize it. */
1844 UnpackedRecord *pUnpack = p->pNewUnpacked;
1845 if( !pUnpack ){
1846 Mem *pData = &p->v->aMem[p->iNewReg];
drhff535a22016-09-20 01:46:15 +00001847 rc = ExpandBlob(pData);
dan37db03b2011-03-16 19:59:18 +00001848 if( rc!=SQLITE_OK ) goto preupdate_new_out;
dan93bca692011-09-14 19:41:44 +00001849 pUnpack = vdbeUnpackRecord(&p->keyinfo, pData->n, pData->z);
dan37db03b2011-03-16 19:59:18 +00001850 if( !pUnpack ){
1851 rc = SQLITE_NOMEM;
1852 goto preupdate_new_out;
1853 }
1854 p->pNewUnpacked = pUnpack;
1855 }
dan2a86c192017-01-25 17:44:13 +00001856 pMem = &pUnpack->aMem[iIdx];
1857 if( iIdx==p->pTab->iPKey ){
1858 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1859 }else if( iIdx>=pUnpack->nField ){
dan37db03b2011-03-16 19:59:18 +00001860 pMem = (sqlite3_value *)columnNullValue();
dan37db03b2011-03-16 19:59:18 +00001861 }
1862 }else{
1863 /* For an UPDATE, memory cell (p->iNewReg+1+iIdx) contains the required
1864 ** value. Make a copy of the cell contents and return a pointer to it.
1865 ** It is not safe to return a pointer to the memory cell itself as the
1866 ** caller may modify the value text encoding.
1867 */
1868 assert( p->op==SQLITE_UPDATE );
1869 if( !p->aNew ){
1870 p->aNew = (Mem *)sqlite3DbMallocZero(db, sizeof(Mem) * p->pCsr->nField);
1871 if( !p->aNew ){
1872 rc = SQLITE_NOMEM;
1873 goto preupdate_new_out;
1874 }
1875 }
drh304637c2011-03-18 16:47:27 +00001876 assert( iIdx>=0 && iIdx<p->pCsr->nField );
dan37db03b2011-03-16 19:59:18 +00001877 pMem = &p->aNew[iIdx];
1878 if( pMem->flags==0 ){
dane43635a2016-10-21 21:21:45 +00001879 if( iIdx==p->pTab->iPKey ){
dan319eeb72011-03-19 08:38:50 +00001880 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1881 }else{
1882 rc = sqlite3VdbeMemCopy(pMem, &p->v->aMem[p->iNewReg+1+iIdx]);
1883 if( rc!=SQLITE_OK ) goto preupdate_new_out;
1884 }
dan37db03b2011-03-16 19:59:18 +00001885 }
1886 }
1887 *ppValue = pMem;
1888
1889 preupdate_new_out:
drhe1ed0b02014-08-26 02:15:07 +00001890 sqlite3Error(db, rc);
dan46c47d42011-03-01 18:42:07 +00001891 return sqlite3ApiExit(db, rc);
1892}
drh9b1c62d2011-03-30 21:04:43 +00001893#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
drh04e8a582014-11-18 21:20:57 +00001894
dan6f9702e2014-11-01 20:38:06 +00001895#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan04489b62014-10-31 20:11:32 +00001896/*
1897** Return status data for a single loop within query pStmt.
1898*/
1899int sqlite3_stmt_scanstatus(
drhd1a1c232014-11-03 16:35:55 +00001900 sqlite3_stmt *pStmt, /* Prepared statement being queried */
dan04489b62014-10-31 20:11:32 +00001901 int idx, /* Index of loop to report on */
drhd1a1c232014-11-03 16:35:55 +00001902 int iScanStatusOp, /* Which metric to return */
1903 void *pOut /* OUT: Write the answer here */
dan04489b62014-10-31 20:11:32 +00001904){
1905 Vdbe *p = (Vdbe*)pStmt;
dan037b5322014-11-03 11:25:32 +00001906 ScanStatus *pScan;
dan6f9702e2014-11-01 20:38:06 +00001907 if( idx<0 || idx>=p->nScan ) return 1;
1908 pScan = &p->aScan[idx];
drhd1a1c232014-11-03 16:35:55 +00001909 switch( iScanStatusOp ){
1910 case SQLITE_SCANSTAT_NLOOP: {
1911 *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
1912 break;
1913 }
1914 case SQLITE_SCANSTAT_NVISIT: {
1915 *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
1916 break;
1917 }
1918 case SQLITE_SCANSTAT_EST: {
drh518140e2014-11-06 03:55:10 +00001919 double r = 1.0;
1920 LogEst x = pScan->nEst;
1921 while( x<100 ){
1922 x += 10;
1923 r *= 0.5;
1924 }
1925 *(double*)pOut = r*sqlite3LogEstToInt(x);
drhd1a1c232014-11-03 16:35:55 +00001926 break;
1927 }
1928 case SQLITE_SCANSTAT_NAME: {
dand72219d2014-11-03 16:39:37 +00001929 *(const char**)pOut = pScan->zName;
drhd1a1c232014-11-03 16:35:55 +00001930 break;
1931 }
1932 case SQLITE_SCANSTAT_EXPLAIN: {
1933 if( pScan->addrExplain ){
1934 *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
1935 }else{
1936 *(const char**)pOut = 0;
1937 }
1938 break;
1939 }
drhc6652b12014-11-06 04:42:20 +00001940 case SQLITE_SCANSTAT_SELECTID: {
1941 if( pScan->addrExplain ){
1942 *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
1943 }else{
1944 *(int*)pOut = -1;
1945 }
1946 break;
1947 }
drhd1a1c232014-11-03 16:35:55 +00001948 default: {
1949 return 1;
dan6f9702e2014-11-01 20:38:06 +00001950 }
1951 }
dan04489b62014-10-31 20:11:32 +00001952 return 0;
1953}
1954
1955/*
1956** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
1957*/
1958void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
1959 Vdbe *p = (Vdbe*)pStmt;
dan6f9702e2014-11-01 20:38:06 +00001960 memset(p->anExec, 0, p->nOp * sizeof(i64));
dan04489b62014-10-31 20:11:32 +00001961}
dan6f9702e2014-11-01 20:38:06 +00001962#endif /* SQLITE_ENABLE_STMT_SCANSTATUS */