blob: 91379a1469df641c7941d6f8ef898229f03226ab [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;
drh04c67472018-12-04 14:33:02 +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 ){
drhfca760c2016-07-14 01:09:08 +000076 db->xTrace(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[] = {
237 SQLITE_BLOB, /* 0x00 */
238 SQLITE_NULL, /* 0x01 */
239 SQLITE_TEXT, /* 0x02 */
240 SQLITE_NULL, /* 0x03 */
241 SQLITE_INTEGER, /* 0x04 */
242 SQLITE_NULL, /* 0x05 */
243 SQLITE_INTEGER, /* 0x06 */
244 SQLITE_NULL, /* 0x07 */
245 SQLITE_FLOAT, /* 0x08 */
246 SQLITE_NULL, /* 0x09 */
247 SQLITE_FLOAT, /* 0x0a */
248 SQLITE_NULL, /* 0x0b */
249 SQLITE_INTEGER, /* 0x0c */
250 SQLITE_NULL, /* 0x0d */
251 SQLITE_INTEGER, /* 0x0e */
252 SQLITE_NULL, /* 0x0f */
253 SQLITE_BLOB, /* 0x10 */
254 SQLITE_NULL, /* 0x11 */
255 SQLITE_TEXT, /* 0x12 */
256 SQLITE_NULL, /* 0x13 */
257 SQLITE_INTEGER, /* 0x14 */
258 SQLITE_NULL, /* 0x15 */
259 SQLITE_INTEGER, /* 0x16 */
260 SQLITE_NULL, /* 0x17 */
261 SQLITE_FLOAT, /* 0x18 */
262 SQLITE_NULL, /* 0x19 */
263 SQLITE_FLOAT, /* 0x1a */
264 SQLITE_NULL, /* 0x1b */
265 SQLITE_INTEGER, /* 0x1c */
266 SQLITE_NULL, /* 0x1d */
267 SQLITE_INTEGER, /* 0x1e */
268 SQLITE_NULL, /* 0x1f */
269 };
mistachkinafc14f72014-03-05 01:29:18 +0000270 return aType[pVal->flags&MEM_AffMask];
drh4f26d6c2004-05-26 23:25:30 +0000271}
272
drhce2fbd12018-01-12 21:00:14 +0000273/* Return true if a parameter to xUpdate represents an unchanged column */
274int sqlite3_value_nochange(sqlite3_value *pVal){
275 return (pVal->flags&(MEM_Null|MEM_Zero))==(MEM_Null|MEM_Zero);
276}
277
drh4f03f412015-05-20 21:28:32 +0000278/* Make a copy of an sqlite3_value object
279*/
280sqlite3_value *sqlite3_value_dup(const sqlite3_value *pOrig){
281 sqlite3_value *pNew;
282 if( pOrig==0 ) return 0;
283 pNew = sqlite3_malloc( sizeof(*pNew) );
284 if( pNew==0 ) return 0;
285 memset(pNew, 0, sizeof(*pNew));
286 memcpy(pNew, pOrig, MEMCELLSIZE);
287 pNew->flags &= ~MEM_Dyn;
288 pNew->db = 0;
289 if( pNew->flags&(MEM_Str|MEM_Blob) ){
drh10ca5b42015-05-22 21:04:54 +0000290 pNew->flags &= ~(MEM_Static|MEM_Dyn);
291 pNew->flags |= MEM_Ephem;
292 if( sqlite3VdbeMemMakeWriteable(pNew)!=SQLITE_OK ){
293 sqlite3ValueFree(pNew);
294 pNew = 0;
drh4f03f412015-05-20 21:28:32 +0000295 }
296 }
297 return pNew;
298}
299
300/* Destroy an sqlite3_value object previously obtained from
301** sqlite3_value_dup().
302*/
303void sqlite3_value_free(sqlite3_value *pOld){
304 sqlite3ValueFree(pOld);
305}
306
307
drh4f26d6c2004-05-26 23:25:30 +0000308/**************************** sqlite3_result_ *******************************
309** The following routines are used by user-defined functions to specify
310** the function result.
drh4c8555f2009-06-25 01:47:11 +0000311**
peter.d.reid60ec9142014-09-06 16:39:46 +0000312** The setStrOrError() function calls sqlite3VdbeMemSetStr() to store the
drh4c8555f2009-06-25 01:47:11 +0000313** result as a string or blob but if the string or blob is too large, it
314** then sets the error code to SQLITE_TOOBIG
drhda4ca9d2014-09-09 17:27:35 +0000315**
316** The invokeValueDestructor(P,X) routine invokes destructor function X()
317** on value P is not going to be used and need to be destroyed.
drh4f26d6c2004-05-26 23:25:30 +0000318*/
drh4c8555f2009-06-25 01:47:11 +0000319static void setResultStrOrError(
320 sqlite3_context *pCtx, /* Function context */
321 const char *z, /* String pointer */
322 int n, /* Bytes in string, or negative */
323 u8 enc, /* Encoding of z. 0 for BLOBs */
324 void (*xDel)(void*) /* Destructor function */
325){
drh9bd038f2014-08-27 14:14:06 +0000326 if( sqlite3VdbeMemSetStr(pCtx->pOut, z, n, enc, xDel)==SQLITE_TOOBIG ){
drh4c8555f2009-06-25 01:47:11 +0000327 sqlite3_result_error_toobig(pCtx);
328 }
329}
drhda4ca9d2014-09-09 17:27:35 +0000330static int invokeValueDestructor(
331 const void *p, /* Value to destroy */
332 void (*xDel)(void*), /* The destructor */
333 sqlite3_context *pCtx /* Set a SQLITE_TOOBIG error if no NULL */
334){
drhfc59a952014-09-11 23:34:55 +0000335 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000336 if( xDel==0 ){
337 /* noop */
338 }else if( xDel==SQLITE_TRANSIENT ){
339 /* noop */
drhda4ca9d2014-09-09 17:27:35 +0000340 }else{
341 xDel((void*)p);
342 }
343 if( pCtx ) sqlite3_result_error_toobig(pCtx);
344 return SQLITE_TOOBIG;
345}
drh4f26d6c2004-05-26 23:25:30 +0000346void sqlite3_result_blob(
347 sqlite3_context *pCtx,
348 const void *z,
349 int n,
danielk1977d8123362004-06-12 09:25:12 +0000350 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000351){
drh5708d2d2005-06-22 10:53:59 +0000352 assert( n>=0 );
drh9bd038f2014-08-27 14:14:06 +0000353 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000354 setResultStrOrError(pCtx, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000355}
drhda4ca9d2014-09-09 17:27:35 +0000356void sqlite3_result_blob64(
357 sqlite3_context *pCtx,
358 const void *z,
359 sqlite3_uint64 n,
360 void (*xDel)(void *)
361){
362 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000363 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000364 if( n>0x7fffffff ){
365 (void)invokeValueDestructor(z, xDel, pCtx);
366 }else{
367 setResultStrOrError(pCtx, z, (int)n, 0, xDel);
368 }
369}
drh4f26d6c2004-05-26 23:25:30 +0000370void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
drh9bd038f2014-08-27 14:14:06 +0000371 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
372 sqlite3VdbeMemSetDouble(pCtx->pOut, rVal);
drh4f26d6c2004-05-26 23:25:30 +0000373}
374void sqlite3_result_error(sqlite3_context *pCtx, const char *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;
drh9bd038f2014-08-27 14:14:06 +0000377 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000378}
danielk1977a1686c92006-01-23 07:52:37 +0000379#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000380void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000381 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000382 pCtx->isError = SQLITE_ERROR;
drh9bd038f2014-08-27 14:14:06 +0000383 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000384}
danielk1977a1686c92006-01-23 07:52:37 +0000385#endif
drhf4479502004-05-27 03:12:53 +0000386void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh9bd038f2014-08-27 14:14:06 +0000387 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
388 sqlite3VdbeMemSetInt64(pCtx->pOut, (i64)iVal);
drh4f26d6c2004-05-26 23:25:30 +0000389}
390void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
drh9bd038f2014-08-27 14:14:06 +0000391 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
392 sqlite3VdbeMemSetInt64(pCtx->pOut, iVal);
drh4f26d6c2004-05-26 23:25:30 +0000393}
394void sqlite3_result_null(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000395 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
396 sqlite3VdbeMemSetNull(pCtx->pOut);
drh4f26d6c2004-05-26 23:25:30 +0000397}
drh22930062017-07-27 03:48:02 +0000398void sqlite3_result_pointer(
399 sqlite3_context *pCtx,
400 void *pPtr,
401 const char *zPType,
402 void (*xDestructor)(void*)
403){
drh3a96a5d2017-06-30 23:09:03 +0000404 Mem *pOut = pCtx->pOut;
405 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh526740b2017-08-24 13:55:46 +0000406 sqlite3VdbeMemRelease(pOut);
407 pOut->flags = MEM_Null;
drh22930062017-07-27 03:48:02 +0000408 sqlite3VdbeMemSetPointer(pOut, pPtr, zPType, xDestructor);
drh3a96a5d2017-06-30 23:09:03 +0000409}
drhbcdf78a2015-09-10 20:34:56 +0000410void sqlite3_result_subtype(sqlite3_context *pCtx, unsigned int eSubtype){
dan5b6c8e42016-01-30 15:46:03 +0000411 Mem *pOut = pCtx->pOut;
412 assert( sqlite3_mutex_held(pOut->db->mutex) );
413 pOut->eSubtype = eSubtype & 0xff;
414 pOut->flags |= MEM_Subtype;
drhbcdf78a2015-09-10 20:34:56 +0000415}
drh4f26d6c2004-05-26 23:25:30 +0000416void sqlite3_result_text(
417 sqlite3_context *pCtx,
418 const char *z,
419 int n,
danielk1977d8123362004-06-12 09:25:12 +0000420 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000421){
drh9bd038f2014-08-27 14:14:06 +0000422 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000423 setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000424}
drhbbf483f2014-09-09 20:30:24 +0000425void sqlite3_result_text64(
drhda4ca9d2014-09-09 17:27:35 +0000426 sqlite3_context *pCtx,
427 const char *z,
428 sqlite3_uint64 n,
429 void (*xDel)(void *),
430 unsigned char enc
431){
432 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000433 assert( xDel!=SQLITE_DYNAMIC );
drh79f7af92014-10-03 16:00:51 +0000434 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drhda4ca9d2014-09-09 17:27:35 +0000435 if( n>0x7fffffff ){
436 (void)invokeValueDestructor(z, xDel, pCtx);
437 }else{
438 setResultStrOrError(pCtx, z, (int)n, enc, xDel);
439 }
440}
drh6c626082004-11-14 21:56:29 +0000441#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000442void sqlite3_result_text16(
443 sqlite3_context *pCtx,
444 const void *z,
445 int n,
danielk1977d8123362004-06-12 09:25:12 +0000446 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000447){
drh9bd038f2014-08-27 14:14:06 +0000448 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000449 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000450}
451void sqlite3_result_text16be(
452 sqlite3_context *pCtx,
453 const void *z,
454 int n,
455 void (*xDel)(void *)
456){
drh9bd038f2014-08-27 14:14:06 +0000457 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000458 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000459}
460void sqlite3_result_text16le(
461 sqlite3_context *pCtx,
462 const void *z,
463 int n,
464 void (*xDel)(void *)
465){
drh9bd038f2014-08-27 14:14:06 +0000466 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000467 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000468}
drh6c626082004-11-14 21:56:29 +0000469#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000470void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh9bd038f2014-08-27 14:14:06 +0000471 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
472 sqlite3VdbeMemCopy(pCtx->pOut, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000473}
drhb026e052007-05-02 01:34:31 +0000474void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh9bd038f2014-08-27 14:14:06 +0000475 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
476 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
drhb026e052007-05-02 01:34:31 +0000477}
dana4d5ae82015-07-24 16:24:37 +0000478int sqlite3_result_zeroblob64(sqlite3_context *pCtx, u64 n){
479 Mem *pOut = pCtx->pOut;
480 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh6bacdc22015-07-24 17:14:03 +0000481 if( n>(u64)pOut->db->aLimit[SQLITE_LIMIT_LENGTH] ){
dana4d5ae82015-07-24 16:24:37 +0000482 return SQLITE_TOOBIG;
483 }
484 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, (int)n);
485 return SQLITE_OK;
486}
drh69544ec2008-02-06 14:11:34 +0000487void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
drhf09ac0b2018-01-23 03:44:06 +0000488 pCtx->isError = errCode ? errCode : -1;
drh983b5ee2015-02-13 12:05:56 +0000489#ifdef SQLITE_DEBUG
drh96f4ad22015-03-12 21:02:36 +0000490 if( pCtx->pVdbe ) pCtx->pVdbe->rcApp = errCode;
drh983b5ee2015-02-13 12:05:56 +0000491#endif
drh9bd038f2014-08-27 14:14:06 +0000492 if( pCtx->pOut->flags & MEM_Null ){
493 sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
drh51c7d862009-04-27 18:46:06 +0000494 SQLITE_UTF8, SQLITE_STATIC);
495 }
drh69544ec2008-02-06 14:11:34 +0000496}
drh4f26d6c2004-05-26 23:25:30 +0000497
drha0206bc2007-05-08 15:15:02 +0000498/* Force an SQLITE_TOOBIG error. */
499void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000500 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000501 pCtx->isError = SQLITE_TOOBIG;
drh9bd038f2014-08-27 14:14:06 +0000502 sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
drhbb4957f2008-03-20 14:03:29 +0000503 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000504}
505
danielk1977a1644fd2007-08-29 12:31:25 +0000506/* An SQLITE_NOMEM error. */
507void sqlite3_result_error_nomem(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000508 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
509 sqlite3VdbeMemSetNull(pCtx->pOut);
mistachkinfad30392016-02-13 23:43:46 +0000510 pCtx->isError = SQLITE_NOMEM_BKPT;
drh4a642b62016-02-05 01:55:27 +0000511 sqlite3OomFault(pCtx->pOut->db);
danielk1977a1644fd2007-08-29 12:31:25 +0000512}
drh4f26d6c2004-05-26 23:25:30 +0000513
dan5cf53532010-05-01 16:40:20 +0000514/*
515** This function is called after a transaction has been committed. It
516** invokes callbacks registered with sqlite3_wal_hook() as required.
517*/
drh7ed91f22010-04-29 22:34:07 +0000518static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000519 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000520#ifndef SQLITE_OMIT_WAL
521 int i;
dan8d22a172010-04-19 18:03:51 +0000522 for(i=0; i<db->nDb; i++){
523 Btree *pBt = db->aDb[i].pBt;
524 if( pBt ){
drhef15c6e2014-12-12 01:27:17 +0000525 int nEntry;
526 sqlite3BtreeEnter(pBt);
527 nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
528 sqlite3BtreeLeave(pBt);
drh59533aa2017-08-02 18:28:26 +0000529 if( nEntry>0 && db->xWalCallback && rc==SQLITE_OK ){
drh69c33822016-08-18 14:33:11 +0000530 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zDbSName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000531 }
532 }
533 }
dan5cf53532010-05-01 16:40:20 +0000534#endif
dan8d22a172010-04-19 18:03:51 +0000535 return rc;
536}
537
drh201e0c62015-07-14 14:48:50 +0000538
drh4f26d6c2004-05-26 23:25:30 +0000539/*
540** Execute the statement pStmt, either until a row of data is ready, the
541** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000542**
543** This routine implements the bulk of the logic behind the sqlite_step()
544** API. The only thing omitted is the automatic recompile if a
545** schema change has occurred. That detail is handled by the
546** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000547*/
drhb900aaf2006-11-09 00:24:53 +0000548static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000549 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000550 int rc;
551
danielk1977a185ddb2007-11-15 16:04:15 +0000552 assert(p);
553 if( p->magic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000554 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000555 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
556 ** with version 3.7.0, we changed this so that sqlite3_reset() would
557 ** be called automatically instead of throwing the SQLITE_MISUSE error.
558 ** This "automatic-reset" change is not technically an incompatibility,
559 ** since any application that receives an SQLITE_MISUSE is broken by
560 ** definition.
561 **
562 ** Nevertheless, some published applications that were originally written
563 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000564 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000565 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
566 ** legacy behavior of returning SQLITE_MISUSE for cases where the
567 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
568 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000569 */
drh602acb42011-01-17 17:42:37 +0000570#ifdef SQLITE_OMIT_AUTORESET
drh983b5ee2015-02-13 12:05:56 +0000571 if( (rc = p->rc&0xff)==SQLITE_BUSY || rc==SQLITE_LOCKED ){
drh602acb42011-01-17 17:42:37 +0000572 sqlite3_reset((sqlite3_stmt*)p);
573 }else{
574 return SQLITE_MISUSE_BKPT;
575 }
576#else
drh3674bfd2010-04-17 12:53:19 +0000577 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000578#endif
drhf1bfe9a2007-10-17 01:44:20 +0000579 }
580
dan14d4cc42010-01-20 14:25:37 +0000581 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000582 db = p->db;
drhc456e572008-08-11 18:44:58 +0000583 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000584 p->rc = SQLITE_NOMEM;
mistachkinfad30392016-02-13 23:43:46 +0000585 return SQLITE_NOMEM_BKPT;
drhc456e572008-08-11 18:44:58 +0000586 }
danielk1977261919c2005-12-06 12:52:59 +0000587
danielk1977a21c6b62005-01-24 10:25:59 +0000588 if( p->pc<=0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000589 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000590 rc = SQLITE_ERROR;
591 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000592 }
danielk19771d850a72004-05-31 08:26:49 +0000593 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000594 /* If there are no other statements currently running, then
595 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
596 ** from interrupting a statement that has not yet started.
597 */
drh4f7d3a52013-06-27 23:54:02 +0000598 if( db->nVdbeActive==0 ){
drh15ca1df2006-07-26 13:43:30 +0000599 db->u1.isInterrupted = 0;
600 }
601
drh888e16e2013-07-09 13:05:49 +0000602 assert( db->nVdbeWrite>0 || db->autoCommit==0
dancb3e4b72013-07-03 19:53:05 +0000603 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
604 );
dan1da40a32009-09-19 17:00:31 +0000605
drh19e2d372005-08-29 23:00:03 +0000606#ifndef SQLITE_OMIT_TRACE
drh04c67472018-12-04 14:33:02 +0000607 if( (db->mTrace & (SQLITE_TRACE_PROFILE|SQLITE_TRACE_XPROFILE))!=0
drh3d2a5292016-07-13 22:55:01 +0000608 && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000609 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh201e0c62015-07-14 14:48:50 +0000610 }else{
611 assert( p->startTime==0 );
drh19e2d372005-08-29 23:00:03 +0000612 }
613#endif
drhc16a03b2004-09-15 13:38:10 +0000614
drh4f7d3a52013-06-27 23:54:02 +0000615 db->nVdbeActive++;
616 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000617 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000618 p->pc = 0;
619 }
drh983b5ee2015-02-13 12:05:56 +0000620#ifdef SQLITE_DEBUG
621 p->rcApp = SQLITE_OK;
622#endif
drhb7f91642004-10-31 02:22:47 +0000623#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000624 if( p->explain ){
625 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000626 }else
627#endif /* SQLITE_OMIT_EXPLAIN */
628 {
drh4f7d3a52013-06-27 23:54:02 +0000629 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000630 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000631 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000632 }
633
drhb7de8272018-12-04 13:51:26 +0000634 if( rc!=SQLITE_ROW ){
drh19e2d372005-08-29 23:00:03 +0000635#ifndef SQLITE_OMIT_TRACE
drhb7de8272018-12-04 13:51:26 +0000636 /* If the statement completed successfully, invoke the profile callback */
637 checkProfileCallback(db, p);
drh19e2d372005-08-29 23:00:03 +0000638#endif
639
drhb7de8272018-12-04 13:51:26 +0000640 if( rc==SQLITE_DONE && db->autoCommit ){
641 assert( p->rc==SQLITE_OK );
642 p->rc = doWalCallbacks(db);
643 if( p->rc!=SQLITE_OK ){
644 rc = SQLITE_ERROR;
645 }
dan8d22a172010-04-19 18:03:51 +0000646 }
647 }
648
drh80cc85b2008-07-23 21:07:25 +0000649 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000650 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
mistachkinfad30392016-02-13 23:43:46 +0000651 p->rc = SQLITE_NOMEM_BKPT;
drhb900aaf2006-11-09 00:24:53 +0000652 }
danielk1977357864e2009-03-25 15:43:08 +0000653end_of_step:
654 /* At this point local variable rc holds the value that should be
655 ** returned if this statement was compiled using the legacy
656 ** sqlite3_prepare() interface. According to the docs, this can only
657 ** be one of the values in the first assert() below. Variable p->rc
658 ** contains the value that would be returned if sqlite3_finalize()
659 ** were called on statement p.
660 */
661 assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
drhcbd8db32015-08-20 17:18:32 +0000662 || (rc&0xff)==SQLITE_BUSY || rc==SQLITE_MISUSE
danielk1977357864e2009-03-25 15:43:08 +0000663 );
drh983b5ee2015-02-13 12:05:56 +0000664 assert( (p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE) || p->rc==p->rcApp );
drh2c2f3922017-06-01 00:54:35 +0000665 if( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0
666 && rc!=SQLITE_ROW
667 && rc!=SQLITE_DONE
668 ){
669 /* If this statement was prepared using saved SQL and an
mistachkin48864df2013-03-21 21:20:32 +0000670 ** error has occurred, then return the error code in p->rc to the
danielk1977357864e2009-03-25 15:43:08 +0000671 ** caller. Set the error code in the database handle to the same value.
672 */
dan029ead62011-10-27 15:19:58 +0000673 rc = sqlite3VdbeTransferError(p);
danielk1977357864e2009-03-25 15:43:08 +0000674 }
675 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000676}
677
678/*
679** This is the top-level implementation of sqlite3_step(). Call
680** sqlite3Step() to do most of the work. If a schema error occurs,
681** call sqlite3Reprepare() and try again.
682*/
drhb900aaf2006-11-09 00:24:53 +0000683int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000684 int rc = SQLITE_OK; /* Result from sqlite3Step() */
drha6129fa2010-02-24 17:15:19 +0000685 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
686 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
687 sqlite3 *db; /* The database connection */
688
drh413c3d32010-02-23 20:11:56 +0000689 if( vdbeSafetyNotNull(v) ){
690 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000691 }
drh413c3d32010-02-23 20:11:56 +0000692 db = v->db;
693 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000694 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000695 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh2c7946a2014-08-19 20:27:40 +0000696 && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
697 int savedPc = v->pc;
drh754ee282017-08-02 19:04:37 +0000698 rc = sqlite3Reprepare(v);
699 if( rc!=SQLITE_OK ){
700 /* This case occurs after failing to recompile an sql statement.
701 ** The error message from the SQL compiler has already been loaded
702 ** into the database handle. This block copies the error message
703 ** from the database handle into the statement and sets the statement
704 ** program counter to 0 to ensure that when the statement is
705 ** finalized or reset the parser error message is available via
706 ** sqlite3_errmsg() and sqlite3_errcode().
707 */
708 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
709 sqlite3DbFree(db, v->zErrMsg);
710 if( !db->mallocFailed ){
711 v->zErrMsg = sqlite3DbStrDup(db, zErr);
712 v->rc = rc = sqlite3ApiExit(db, rc);
713 } else {
714 v->zErrMsg = 0;
715 v->rc = rc = SQLITE_NOMEM_BKPT;
716 }
717 break;
718 }
drh413c3d32010-02-23 20:11:56 +0000719 sqlite3_reset(pStmt);
drh5f58ae72014-08-19 20:41:36 +0000720 if( savedPc>=0 ) v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000721 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000722 }
drh413c3d32010-02-23 20:11:56 +0000723 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000724 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000725}
726
drh95a7b3e2013-09-16 12:57:19 +0000727
drh4f26d6c2004-05-26 23:25:30 +0000728/*
drheb2e1762004-05-27 01:53:56 +0000729** Extract the user data from a sqlite3_context structure and return a
730** pointer to it.
731*/
732void *sqlite3_user_data(sqlite3_context *p){
733 assert( p && p->pFunc );
734 return p->pFunc->pUserData;
735}
736
737/*
drhfa4a4b92008-03-19 21:45:51 +0000738** Extract the user data from a sqlite3_context structure and return a
739** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000740**
741** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
742** returns a copy of the pointer to the database connection (the 1st
743** parameter) of the sqlite3_create_function() and
744** sqlite3_create_function16() routines that originally registered the
745** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000746*/
747sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
drha46a4a62015-09-08 21:12:53 +0000748 assert( p && p->pOut );
drh9bd038f2014-08-27 14:14:06 +0000749 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000750}
751
752/*
drh6f390be2018-01-11 17:04:26 +0000753** If this routine is invoked from within an xColumn method of a virtual
754** table, then it returns true if and only if the the call is during an
755** UPDATE operation and the value of the column will not be modified
756** by the UPDATE.
757**
758** If this routine is called from any context other than within the
759** xColumn method of a virtual table, then the return value is meaningless
760** and arbitrary.
761**
762** Virtual table implements might use this routine to optimize their
763** performance by substituting a NULL result, or some other light-weight
764** value, as a signal to the xUpdate routine that the column is unchanged.
765*/
766int sqlite3_vtab_nochange(sqlite3_context *p){
767 assert( p );
drhce2fbd12018-01-12 21:00:14 +0000768 return sqlite3_value_nochange(p->pOut);
drh6f390be2018-01-11 17:04:26 +0000769}
770
771/*
drha9e03b12015-03-12 06:46:52 +0000772** Return the current time for a statement. If the current time
773** is requested more than once within the same run of a single prepared
774** statement, the exact same time is returned for each invocation regardless
775** of the amount of time that elapses between invocations. In other words,
776** the time returned is always the time of the first call.
drh95a7b3e2013-09-16 12:57:19 +0000777*/
778sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
drh95a7b3e2013-09-16 12:57:19 +0000779 int rc;
drha9e03b12015-03-12 06:46:52 +0000780#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
drh3df79a92015-03-12 23:48:27 +0000781 sqlite3_int64 *piTime = &p->pVdbe->iCurrentTime;
drha9e03b12015-03-12 06:46:52 +0000782 assert( p->pVdbe!=0 );
783#else
drh3df79a92015-03-12 23:48:27 +0000784 sqlite3_int64 iTime = 0;
drha9e03b12015-03-12 06:46:52 +0000785 sqlite3_int64 *piTime = p->pVdbe!=0 ? &p->pVdbe->iCurrentTime : &iTime;
drha9e03b12015-03-12 06:46:52 +0000786#endif
drh3df79a92015-03-12 23:48:27 +0000787 if( *piTime==0 ){
drha9e03b12015-03-12 06:46:52 +0000788 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, piTime);
789 if( rc ) *piTime = 0;
drh95a7b3e2013-09-16 12:57:19 +0000790 }
drha9e03b12015-03-12 06:46:52 +0000791 return *piTime;
drh95a7b3e2013-09-16 12:57:19 +0000792}
793
794/*
drh9de4a172014-08-23 18:17:19 +0000795** Create a new aggregate context for p and return a pointer to
796** its pMem->z element.
797*/
798static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
799 Mem *pMem = p->pMem;
800 assert( (pMem->flags & MEM_Agg)==0 );
801 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000802 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000803 pMem->z = 0;
804 }else{
drh322f2852014-09-19 00:43:39 +0000805 sqlite3VdbeMemClearAndResize(pMem, nByte);
drh9de4a172014-08-23 18:17:19 +0000806 pMem->flags = MEM_Agg;
807 pMem->u.pDef = p->pFunc;
808 if( pMem->z ){
809 memset(pMem->z, 0, nByte);
810 }
811 }
812 return (void*)pMem->z;
813}
814
815/*
drheb2e1762004-05-27 01:53:56 +0000816** Allocate or return the aggregate context for a user function. A new
817** context is allocated on the first call. Subsequent calls return the
818** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000819*/
820void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh2d801512016-01-14 22:19:58 +0000821 assert( p && p->pFunc && p->pFunc->xFinalize );
drh9bd038f2014-08-27 14:14:06 +0000822 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000823 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000824 if( (p->pMem->flags & MEM_Agg)==0 ){
825 return createAggContext(p, nByte);
826 }else{
827 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000828 }
drheb2e1762004-05-27 01:53:56 +0000829}
830
831/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000832** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000833** the user-function defined by pCtx.
drhf7fa4e72017-05-11 15:20:18 +0000834**
835** The left-most argument is 0.
836**
837** Undocumented behavior: If iArg is negative then access a cache of
838** auxiliary data pointers that is available to all functions within a
839** single prepared statement. The iArg values must match.
danielk1977682f68b2004-06-05 10:22:17 +0000840*/
841void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000842 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000843
drh9bd038f2014-08-27 14:14:06 +0000844 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drha9e03b12015-03-12 06:46:52 +0000845#if SQLITE_ENABLE_STAT3_OR_STAT4
dan18bf8072015-03-11 20:06:40 +0000846 if( pCtx->pVdbe==0 ) return 0;
drha9e03b12015-03-12 06:46:52 +0000847#else
848 assert( pCtx->pVdbe!=0 );
849#endif
drhe6941392017-05-10 19:42:52 +0000850 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
drhf7fa4e72017-05-11 15:20:18 +0000851 if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
drhe6941392017-05-10 19:42:52 +0000852 return pAuxData->pAux;
853 }
danielk1977682f68b2004-06-05 10:22:17 +0000854 }
drhe6941392017-05-10 19:42:52 +0000855 return 0;
danielk1977682f68b2004-06-05 10:22:17 +0000856}
857
858/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000859** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000860** argument to the user-function defined by pCtx. Any previous value is
861** deleted by calling the delete function specified when it was set.
drhf7fa4e72017-05-11 15:20:18 +0000862**
863** The left-most argument is 0.
864**
865** Undocumented behavior: If iArg is negative then make the data available
866** to all functions within the current prepared statement using iArg as an
867** access code.
danielk1977682f68b2004-06-05 10:22:17 +0000868*/
869void sqlite3_set_auxdata(
870 sqlite3_context *pCtx,
871 int iArg,
872 void *pAux,
873 void (*xDelete)(void*)
874){
dan0c547792013-07-18 17:12:08 +0000875 AuxData *pAuxData;
876 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000877
drh9bd038f2014-08-27 14:14:06 +0000878 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drha9e03b12015-03-12 06:46:52 +0000879#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan18bf8072015-03-11 20:06:40 +0000880 if( pVdbe==0 ) goto failed;
drha9e03b12015-03-12 06:46:52 +0000881#else
882 assert( pVdbe!=0 );
883#endif
danielk1977682f68b2004-06-05 10:22:17 +0000884
drhe6941392017-05-10 19:42:52 +0000885 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
drhf7fa4e72017-05-11 15:20:18 +0000886 if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
887 break;
888 }
dan0c547792013-07-18 17:12:08 +0000889 }
890 if( pAuxData==0 ){
891 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
892 if( !pAuxData ) goto failed;
drhe6941392017-05-10 19:42:52 +0000893 pAuxData->iAuxOp = pCtx->iOp;
894 pAuxData->iAuxArg = iArg;
895 pAuxData->pNextAux = pVdbe->pAuxData;
dan0c547792013-07-18 17:12:08 +0000896 pVdbe->pAuxData = pAuxData;
drhf09ac0b2018-01-23 03:44:06 +0000897 if( pCtx->isError==0 ) pCtx->isError = -1;
drhe6941392017-05-10 19:42:52 +0000898 }else if( pAuxData->xDeleteAux ){
899 pAuxData->xDeleteAux(pAuxData->pAux);
danielk1977682f68b2004-06-05 10:22:17 +0000900 }
dan0c547792013-07-18 17:12:08 +0000901
danielk1977682f68b2004-06-05 10:22:17 +0000902 pAuxData->pAux = pAux;
drhe6941392017-05-10 19:42:52 +0000903 pAuxData->xDeleteAux = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000904 return;
905
906failed:
907 if( xDelete ){
908 xDelete(pAux);
909 }
danielk1977682f68b2004-06-05 10:22:17 +0000910}
911
shaneeec556d2008-10-12 00:27:53 +0000912#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000913/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000914** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000915** called.
916**
drhcf85a512006-02-09 18:35:29 +0000917** This function is deprecated. Do not use it for new code. It is
918** provide only to avoid breaking legacy code. New aggregate function
919** implementations should keep their own counts within their aggregate
920** context.
drheb2e1762004-05-27 01:53:56 +0000921*/
922int sqlite3_aggregate_count(sqlite3_context *p){
drh2d801512016-01-14 22:19:58 +0000923 assert( p && p->pMem && p->pFunc && p->pFunc->xFinalize );
drhabfcea22005-09-06 20:36:48 +0000924 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000925}
shaneeec556d2008-10-12 00:27:53 +0000926#endif
drheb2e1762004-05-27 01:53:56 +0000927
928/*
drh4f26d6c2004-05-26 23:25:30 +0000929** Return the number of columns in the result set for the statement pStmt.
930*/
931int sqlite3_column_count(sqlite3_stmt *pStmt){
932 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000933 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000934}
935
936/*
937** Return the number of values available from the current row of the
938** currently executing statement pStmt.
939*/
940int sqlite3_data_count(sqlite3_stmt *pStmt){
941 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000942 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000943 return pVm->nResColumn;
944}
945
dan46c47d42011-03-01 18:42:07 +0000946/*
947** Return a pointer to static memory containing an SQL NULL value.
948*/
949static const Mem *columnNullValue(void){
950 /* Even though the Mem structure contains an element
drhb1a1c292014-03-05 12:47:55 +0000951 ** of type i64, on certain architectures (x86) with certain compiler
dan46c47d42011-03-01 18:42:07 +0000952 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
953 ** instead of an 8-byte one. This all works fine, except that when
954 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
955 ** that a Mem structure is located on an 8-byte boundary. To prevent
drhb1a1c292014-03-05 12:47:55 +0000956 ** these assert()s from failing, when building with SQLITE_DEBUG defined
957 ** using gcc, we force nullMem to be 8-byte aligned using the magical
dan46c47d42011-03-01 18:42:07 +0000958 ** __attribute__((aligned(8))) macro. */
959 static const Mem nullMem
960#if defined(SQLITE_DEBUG) && defined(__GNUC__)
drhb1a1c292014-03-05 12:47:55 +0000961 __attribute__((aligned(8)))
dan46c47d42011-03-01 18:42:07 +0000962#endif
drh035e5632014-09-16 14:16:31 +0000963 = {
drh3329a632014-09-18 01:21:43 +0000964 /* .u = */ {0},
drh8faee872015-09-19 18:08:13 +0000965 /* .flags = */ (u16)MEM_Null,
966 /* .enc = */ (u8)0,
967 /* .eSubtype = */ (u8)0,
968 /* .n = */ (int)0,
969 /* .z = */ (char*)0,
970 /* .zMalloc = */ (char*)0,
971 /* .szMalloc = */ (int)0,
972 /* .uTemp = */ (u32)0,
973 /* .db = */ (sqlite3*)0,
974 /* .xDel = */ (void(*)(void*))0,
drhb1a1c292014-03-05 12:47:55 +0000975#ifdef SQLITE_DEBUG
drh8faee872015-09-19 18:08:13 +0000976 /* .pScopyFrom = */ (Mem*)0,
drh58773a52018-06-12 13:52:23 +0000977 /* .mScopyFlags= */ 0,
978#endif
drh035e5632014-09-16 14:16:31 +0000979 };
dan46c47d42011-03-01 18:42:07 +0000980 return &nullMem;
981}
drh4f26d6c2004-05-26 23:25:30 +0000982
983/*
984** Check to see if column iCol of the given statement is valid. If
985** it is, return a pointer to the Mem for the value of that column.
986** If iCol is not valid, return a pointer to a Mem which has a value
987** of NULL.
988*/
989static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000990 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000991 Mem *pOut;
992
993 pVm = (Vdbe *)pStmt;
drh28f17012016-09-22 21:37:18 +0000994 if( pVm==0 ) return (Mem*)columnNullValue();
995 assert( pVm->db );
996 sqlite3_mutex_enter(pVm->db->mutex);
997 if( pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drhd4e70eb2008-01-02 00:34:36 +0000998 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +0000999 }else{
drh28f17012016-09-22 21:37:18 +00001000 sqlite3Error(pVm->db, SQLITE_RANGE);
dan46c47d42011-03-01 18:42:07 +00001001 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +00001002 }
drh32bc3f62007-08-21 20:25:39 +00001003 return pOut;
drh4f26d6c2004-05-26 23:25:30 +00001004}
1005
danielk19772e588c72005-12-09 14:25:08 +00001006/*
1007** This function is called after invoking an sqlite3_value_XXX function on a
1008** column value (i.e. a value returned by evaluating an SQL expression in the
1009** select list of a SELECT statement) that may cause a malloc() failure. If
1010** malloc() has failed, the threads mallocFailed flag is cleared and the result
1011** code of statement pStmt set to SQLITE_NOMEM.
1012**
drh32bc3f62007-08-21 20:25:39 +00001013** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +00001014**
1015** sqlite3_column_int()
1016** sqlite3_column_int64()
1017** sqlite3_column_text()
1018** sqlite3_column_text16()
1019** sqlite3_column_real()
1020** sqlite3_column_bytes()
1021** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +00001022** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +00001023*/
1024static void columnMallocFailure(sqlite3_stmt *pStmt)
1025{
1026 /* If malloc() failed during an encoding conversion within an
1027 ** sqlite3_column_XXX API, then set the return code of the statement to
1028 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
1029 ** and _finalize() will return NOMEM.
1030 */
danielk197754f01982006-01-18 15:25:17 +00001031 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +00001032 if( p ){
drh28f17012016-09-22 21:37:18 +00001033 assert( p->db!=0 );
1034 assert( sqlite3_mutex_held(p->db->mutex) );
drh32bc3f62007-08-21 20:25:39 +00001035 p->rc = sqlite3ApiExit(p->db, p->rc);
1036 sqlite3_mutex_leave(p->db->mutex);
1037 }
danielk19772e588c72005-12-09 14:25:08 +00001038}
1039
drh4f26d6c2004-05-26 23:25:30 +00001040/**************************** sqlite3_column_ *******************************
1041** The following routines are used to access elements of the current row
1042** in the result set.
1043*/
danielk1977c572ef72004-05-27 09:28:41 +00001044const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001045 const void *val;
danielk19772e588c72005-12-09 14:25:08 +00001046 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +00001047 /* Even though there is no encoding conversion, value_blob() might
1048 ** need to call malloc() to expand the result of a zeroblob()
1049 ** expression.
1050 */
1051 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +00001052 return val;
danielk1977c572ef72004-05-27 09:28:41 +00001053}
drh4f26d6c2004-05-26 23:25:30 +00001054int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001055 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
1056 columnMallocFailure(pStmt);
1057 return val;
drh4f26d6c2004-05-26 23:25:30 +00001058}
1059int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001060 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
1061 columnMallocFailure(pStmt);
1062 return val;
drh4f26d6c2004-05-26 23:25:30 +00001063}
1064double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001065 double val = sqlite3_value_double( columnMem(pStmt,i) );
1066 columnMallocFailure(pStmt);
1067 return val;
drh4f26d6c2004-05-26 23:25:30 +00001068}
1069int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001070 int val = sqlite3_value_int( columnMem(pStmt,i) );
1071 columnMallocFailure(pStmt);
1072 return val;
drh4f26d6c2004-05-26 23:25:30 +00001073}
drhefad9992004-06-22 12:13:55 +00001074sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001075 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
1076 columnMallocFailure(pStmt);
1077 return val;
drh4f26d6c2004-05-26 23:25:30 +00001078}
1079const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001080 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
1081 columnMallocFailure(pStmt);
1082 return val;
drh4f26d6c2004-05-26 23:25:30 +00001083}
drhd1e47332005-06-26 17:55:33 +00001084sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +00001085 Mem *pOut = columnMem(pStmt, i);
1086 if( pOut->flags&MEM_Static ){
1087 pOut->flags &= ~MEM_Static;
1088 pOut->flags |= MEM_Ephem;
1089 }
drh32bc3f62007-08-21 20:25:39 +00001090 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +00001091 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +00001092}
drh6c626082004-11-14 21:56:29 +00001093#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001094const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001095 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
1096 columnMallocFailure(pStmt);
1097 return val;
drh4f26d6c2004-05-26 23:25:30 +00001098}
drh6c626082004-11-14 21:56:29 +00001099#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +00001100int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +00001101 int iType = sqlite3_value_type( columnMem(pStmt,i) );
1102 columnMallocFailure(pStmt);
1103 return iType;
drh4f26d6c2004-05-26 23:25:30 +00001104}
1105
drh5e2517e2004-09-24 23:59:12 +00001106/*
1107** Convert the N-th element of pStmt->pColName[] into a string using
1108** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +00001109**
1110** There are up to 5 names for each column. useType determines which
1111** name is returned. Here are the names:
1112**
1113** 0 The column name as it should be displayed for output
1114** 1 The datatype name for the column
1115** 2 The name of the database that the column derives from
1116** 3 The name of the table that the column derives from
1117** 4 The name of the table column that the result column derives from
1118**
1119** If the result is not a simple column reference (if it is an expression
1120** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +00001121*/
1122static const void *columnName(
1123 sqlite3_stmt *pStmt,
1124 int N,
1125 const void *(*xFunc)(Mem*),
1126 int useType
1127){
drh9ca95732014-10-24 00:35:58 +00001128 const void *ret;
1129 Vdbe *p;
drh32bc3f62007-08-21 20:25:39 +00001130 int n;
drh9ca95732014-10-24 00:35:58 +00001131 sqlite3 *db;
1132#ifdef SQLITE_ENABLE_API_ARMOR
1133 if( pStmt==0 ){
1134 (void)SQLITE_MISUSE_BKPT;
1135 return 0;
1136 }
1137#endif
1138 ret = 0;
1139 p = (Vdbe *)pStmt;
1140 db = p->db;
drh9b4ea4a2009-04-10 20:32:00 +00001141 assert( db!=0 );
1142 n = sqlite3_column_count(pStmt);
1143 if( N<n && N>=0 ){
1144 N += useType*n;
1145 sqlite3_mutex_enter(db->mutex);
1146 assert( db->mallocFailed==0 );
1147 ret = xFunc(&p->aColName[N]);
1148 /* A malloc may have failed inside of the xFunc() call. If this
1149 ** is the case, clear the mallocFailed flag and return NULL.
1150 */
1151 if( db->mallocFailed ){
drh4a642b62016-02-05 01:55:27 +00001152 sqlite3OomClear(db);
drh9b4ea4a2009-04-10 20:32:00 +00001153 ret = 0;
drh32bc3f62007-08-21 20:25:39 +00001154 }
drh9b4ea4a2009-04-10 20:32:00 +00001155 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +00001156 }
danielk197700fd9572005-12-07 06:27:43 +00001157 return ret;
drh5e2517e2004-09-24 23:59:12 +00001158}
1159
drh4f26d6c2004-05-26 23:25:30 +00001160/*
1161** Return the name of the Nth column of the result set returned by SQL
1162** statement pStmt.
1163*/
1164const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001165 return columnName(
1166 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +00001167}
drhe590fbd2005-05-20 19:36:01 +00001168#ifndef SQLITE_OMIT_UTF16
1169const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001170 return columnName(
1171 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001172}
1173#endif
drh4f26d6c2004-05-26 23:25:30 +00001174
1175/*
drh3f913572008-03-22 01:07:17 +00001176** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1177** not define OMIT_DECLTYPE.
1178*/
1179#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1180# error "Must not define both SQLITE_OMIT_DECLTYPE \
1181 and SQLITE_ENABLE_COLUMN_METADATA"
1182#endif
1183
1184#ifndef SQLITE_OMIT_DECLTYPE
1185/*
drh6c626082004-11-14 21:56:29 +00001186** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001187** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001188*/
1189const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001190 return columnName(
1191 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001192}
drh6c626082004-11-14 21:56:29 +00001193#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001194const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001195 return columnName(
1196 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001197}
drh6c626082004-11-14 21:56:29 +00001198#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001199#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001200
danielk19774b1ae992006-02-10 03:06:10 +00001201#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001202/*
1203** Return the name of the database from which a result column derives.
1204** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001205** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001206*/
1207const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001208 return columnName(
1209 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001210}
1211#ifndef SQLITE_OMIT_UTF16
1212const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001213 return columnName(
1214 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001215}
1216#endif /* SQLITE_OMIT_UTF16 */
1217
1218/*
1219** Return the name of the table from which a result column derives.
1220** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001221** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001222*/
1223const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001224 return columnName(
1225 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001226}
1227#ifndef SQLITE_OMIT_UTF16
1228const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001229 return columnName(
1230 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001231}
1232#endif /* SQLITE_OMIT_UTF16 */
1233
1234/*
1235** Return the name of the table column from which a result column derives.
1236** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001237** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001238*/
1239const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001240 return columnName(
1241 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001242}
1243#ifndef SQLITE_OMIT_UTF16
1244const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001245 return columnName(
1246 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001247}
1248#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001249#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001250
1251
drh4f26d6c2004-05-26 23:25:30 +00001252/******************************* sqlite3_bind_ ***************************
1253**
1254** Routines used to attach values to wildcards in a compiled SQL statement.
1255*/
1256/*
1257** Unbind the value bound to variable i in virtual machine p. This is the
1258** the same as binding a NULL value to the column. If the "i" parameter is
1259** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1260**
drh488e7b62008-10-06 12:46:43 +00001261** A successful evaluation of this routine acquires the mutex on p.
1262** the mutex is released if any kind of error occurs.
1263**
drh4f26d6c2004-05-26 23:25:30 +00001264** The error code stored in database p->db is overwritten with the return
1265** value in any case.
1266*/
1267static int vdbeUnbind(Vdbe *p, int i){
1268 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001269 if( vdbeSafetyNotNull(p) ){
1270 return SQLITE_MISUSE_BKPT;
1271 }
drh488e7b62008-10-06 12:46:43 +00001272 sqlite3_mutex_enter(p->db->mutex);
1273 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001274 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001275 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001276 sqlite3_log(SQLITE_MISUSE,
1277 "bind on a busy prepared statement: [%s]", p->zSql);
1278 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001279 }
1280 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001281 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001282 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001283 return SQLITE_RANGE;
1284 }
1285 i--;
drh290c1942004-08-21 17:54:45 +00001286 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001287 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001288 pVar->flags = MEM_Null;
drh13f40da2014-08-22 18:00:11 +00001289 sqlite3Error(p->db, SQLITE_OK);
dan937d0de2009-10-15 18:35:38 +00001290
dan1d2ce4f2009-10-19 18:11:09 +00001291 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1292 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001293 **
1294 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1295 ** parameter in the WHERE clause might influence the choice of query plan
1296 ** for a statement, then the statement will be automatically recompiled,
1297 ** as if there had been a schema change, on the first sqlite3_step() call
1298 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001299 */
drh2c2f3922017-06-01 00:54:35 +00001300 assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || p->expmask==0 );
drh29967962017-03-03 21:51:40 +00001301 if( p->expmask!=0 && (p->expmask & (i>=31 ? 0x80000000 : (u32)1<<i))!=0 ){
dan937d0de2009-10-15 18:35:38 +00001302 p->expired = 1;
1303 }
drh4f26d6c2004-05-26 23:25:30 +00001304 return SQLITE_OK;
1305}
1306
1307/*
drh5e2517e2004-09-24 23:59:12 +00001308** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001309*/
drh5e2517e2004-09-24 23:59:12 +00001310static int bindText(
drh605264d2007-08-21 15:13:19 +00001311 sqlite3_stmt *pStmt, /* The statement to bind against */
1312 int i, /* Index of the parameter to bind */
1313 const void *zData, /* Pointer to the data to be bound */
1314 int nData, /* Number of bytes of data to be bound */
1315 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001316 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001317){
1318 Vdbe *p = (Vdbe *)pStmt;
1319 Mem *pVar;
1320 int rc;
1321
1322 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001323 if( rc==SQLITE_OK ){
1324 if( zData!=0 ){
1325 pVar = &p->aVar[i-1];
1326 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1327 if( rc==SQLITE_OK && encoding!=0 ){
1328 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1329 }
drhe70d01f2017-05-29 22:44:18 +00001330 if( rc ){
1331 sqlite3Error(p->db, rc);
1332 rc = sqlite3ApiExit(p->db, rc);
1333 }
drh27641702007-08-22 02:56:42 +00001334 }
drh488e7b62008-10-06 12:46:43 +00001335 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001336 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001337 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001338 }
drh605264d2007-08-21 15:13:19 +00001339 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001340}
drh5e2517e2004-09-24 23:59:12 +00001341
1342
1343/*
1344** Bind a blob value to an SQL statement variable.
1345*/
1346int sqlite3_bind_blob(
1347 sqlite3_stmt *pStmt,
1348 int i,
1349 const void *zData,
1350 int nData,
1351 void (*xDel)(void*)
1352){
drh5b081d82016-02-18 01:29:12 +00001353#ifdef SQLITE_ENABLE_API_ARMOR
1354 if( nData<0 ) return SQLITE_MISUSE_BKPT;
1355#endif
drh5e2517e2004-09-24 23:59:12 +00001356 return bindText(pStmt, i, zData, nData, xDel, 0);
1357}
drhda4ca9d2014-09-09 17:27:35 +00001358int sqlite3_bind_blob64(
1359 sqlite3_stmt *pStmt,
1360 int i,
1361 const void *zData,
1362 sqlite3_uint64 nData,
1363 void (*xDel)(void*)
1364){
drhfc59a952014-09-11 23:34:55 +00001365 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001366 if( nData>0x7fffffff ){
1367 return invokeValueDestructor(zData, xDel, 0);
1368 }else{
drh3329a632014-09-18 01:21:43 +00001369 return bindText(pStmt, i, zData, (int)nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001370 }
1371}
drh4f26d6c2004-05-26 23:25:30 +00001372int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1373 int rc;
1374 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001375 rc = vdbeUnbind(p, i);
1376 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001377 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001378 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001379 }
danielk1977f4618892004-06-28 13:09:11 +00001380 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001381}
1382int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001383 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001384}
drhefad9992004-06-22 12:13:55 +00001385int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001386 int rc;
1387 Vdbe *p = (Vdbe *)pStmt;
1388 rc = vdbeUnbind(p, i);
1389 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001390 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001391 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001392 }
1393 return rc;
1394}
drh605264d2007-08-21 15:13:19 +00001395int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1396 int rc;
1397 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001398 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001399 if( rc==SQLITE_OK ){
1400 sqlite3_mutex_leave(p->db->mutex);
1401 }
drh605264d2007-08-21 15:13:19 +00001402 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001403}
drh22930062017-07-27 03:48:02 +00001404int sqlite3_bind_pointer(
1405 sqlite3_stmt *pStmt,
1406 int i,
1407 void *pPtr,
1408 const char *zPTtype,
1409 void (*xDestructor)(void*)
1410){
drh3a96a5d2017-06-30 23:09:03 +00001411 int rc;
1412 Vdbe *p = (Vdbe*)pStmt;
1413 rc = vdbeUnbind(p, i);
1414 if( rc==SQLITE_OK ){
drh22930062017-07-27 03:48:02 +00001415 sqlite3VdbeMemSetPointer(&p->aVar[i-1], pPtr, zPTtype, xDestructor);
drh3a96a5d2017-06-30 23:09:03 +00001416 sqlite3_mutex_leave(p->db->mutex);
drh34fcf362017-07-27 16:42:36 +00001417 }else if( xDestructor ){
1418 xDestructor(pPtr);
drh3a96a5d2017-06-30 23:09:03 +00001419 }
1420 return rc;
1421}
drh4f26d6c2004-05-26 23:25:30 +00001422int sqlite3_bind_text(
1423 sqlite3_stmt *pStmt,
1424 int i,
1425 const char *zData,
1426 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001427 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001428){
drh5e2517e2004-09-24 23:59:12 +00001429 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001430}
drhbbf483f2014-09-09 20:30:24 +00001431int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001432 sqlite3_stmt *pStmt,
1433 int i,
1434 const char *zData,
1435 sqlite3_uint64 nData,
1436 void (*xDel)(void*),
1437 unsigned char enc
1438){
drhfc59a952014-09-11 23:34:55 +00001439 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001440 if( nData>0x7fffffff ){
1441 return invokeValueDestructor(zData, xDel, 0);
1442 }else{
drhfc59a952014-09-11 23:34:55 +00001443 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drh3329a632014-09-18 01:21:43 +00001444 return bindText(pStmt, i, zData, (int)nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001445 }
1446}
drh6c626082004-11-14 21:56:29 +00001447#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001448int sqlite3_bind_text16(
1449 sqlite3_stmt *pStmt,
1450 int i,
1451 const void *zData,
1452 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001453 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001454){
drh5e2517e2004-09-24 23:59:12 +00001455 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001456}
drh6c626082004-11-14 21:56:29 +00001457#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001458int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1459 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001460 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001461 case SQLITE_INTEGER: {
1462 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1463 break;
1464 }
1465 case SQLITE_FLOAT: {
drh74eaba42014-09-18 17:52:15 +00001466 rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
drh29def562009-04-14 12:43:33 +00001467 break;
1468 }
1469 case SQLITE_BLOB: {
1470 if( pValue->flags & MEM_Zero ){
1471 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1472 }else{
1473 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1474 }
1475 break;
1476 }
1477 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001478 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1479 pValue->enc);
1480 break;
1481 }
1482 default: {
1483 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001484 break;
1485 }
danielk197726e41442006-06-14 15:16:35 +00001486 }
1487 return rc;
1488}
drhb026e052007-05-02 01:34:31 +00001489int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1490 int rc;
1491 Vdbe *p = (Vdbe *)pStmt;
1492 rc = vdbeUnbind(p, i);
1493 if( rc==SQLITE_OK ){
1494 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001495 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001496 }
1497 return rc;
1498}
dan80c03022015-07-24 17:36:34 +00001499int sqlite3_bind_zeroblob64(sqlite3_stmt *pStmt, int i, sqlite3_uint64 n){
1500 int rc;
1501 Vdbe *p = (Vdbe *)pStmt;
1502 sqlite3_mutex_enter(p->db->mutex);
1503 if( n>(u64)p->db->aLimit[SQLITE_LIMIT_LENGTH] ){
1504 rc = SQLITE_TOOBIG;
1505 }else{
1506 assert( (n & 0x7FFFFFFF)==n );
1507 rc = sqlite3_bind_zeroblob(pStmt, i, n);
1508 }
1509 rc = sqlite3ApiExit(p->db, rc);
1510 sqlite3_mutex_leave(p->db->mutex);
1511 return rc;
1512}
drh75f6a032004-07-15 14:15:00 +00001513
1514/*
1515** Return the number of wildcards that can be potentially bound to.
1516** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001517*/
1518int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001519 Vdbe *p = (Vdbe*)pStmt;
1520 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001521}
drh895d7472004-08-20 16:02:39 +00001522
1523/*
drhfa6bc002004-09-07 16:19:52 +00001524** Return the name of a wildcard parameter. Return NULL if the index
1525** is out of range or if the wildcard is unnamed.
1526**
1527** The result is always UTF-8.
1528*/
1529const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1530 Vdbe *p = (Vdbe*)pStmt;
drh9bf755c2016-12-23 03:59:31 +00001531 if( p==0 ) return 0;
1532 return sqlite3VListNumToName(p->pVList, i);
drh895d7472004-08-20 16:02:39 +00001533}
drhfa6bc002004-09-07 16:19:52 +00001534
1535/*
1536** Given a wildcard parameter name, return the index of the variable
1537** with that name. If there is no variable with the given name,
1538** return 0.
1539*/
drh5f18a222009-11-26 14:01:53 +00001540int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drh9bf755c2016-12-23 03:59:31 +00001541 if( p==0 || zName==0 ) return 0;
1542 return sqlite3VListNameToNum(p->pVList, zName, nName);
drhfa6bc002004-09-07 16:19:52 +00001543}
drh5f18a222009-11-26 14:01:53 +00001544int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1545 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1546}
drhf8db1bc2005-04-22 02:38:37 +00001547
drh51942bc2005-06-12 22:01:42 +00001548/*
drhf8db1bc2005-04-22 02:38:37 +00001549** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001550*/
shane145834a2008-09-04 12:03:42 +00001551int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001552 Vdbe *pFrom = (Vdbe*)pFromStmt;
1553 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001554 int i;
1555 assert( pTo->db==pFrom->db );
1556 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001557 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001558 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001559 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001560 }
drh27641702007-08-22 02:56:42 +00001561 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001562 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001563}
drh51942bc2005-06-12 22:01:42 +00001564
shaneeec556d2008-10-12 00:27:53 +00001565#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001566/*
shane145834a2008-09-04 12:03:42 +00001567** Deprecated external interface. Internal/core SQLite code
1568** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001569**
peter.d.reid60ec9142014-09-06 16:39:46 +00001570** It is misuse to call this routine with statements from different
drh0f5ea0b2009-04-09 14:02:44 +00001571** database connections. But as this is a deprecated interface, we
1572** will not bother to check for that condition.
1573**
1574** If the two statements contain a different number of bindings, then
1575** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1576** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001577*/
1578int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001579 Vdbe *pFrom = (Vdbe*)pFromStmt;
1580 Vdbe *pTo = (Vdbe*)pToStmt;
1581 if( pFrom->nVar!=pTo->nVar ){
1582 return SQLITE_ERROR;
1583 }
drh2c2f3922017-06-01 00:54:35 +00001584 assert( (pTo->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || pTo->expmask==0 );
danbda4cb82017-02-23 16:30:16 +00001585 if( pTo->expmask ){
danc94b8592009-10-20 07:01:24 +00001586 pTo->expired = 1;
1587 }
drh2c2f3922017-06-01 00:54:35 +00001588 assert( (pFrom->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || pFrom->expmask==0 );
danbda4cb82017-02-23 16:30:16 +00001589 if( pFrom->expmask ){
danc94b8592009-10-20 07:01:24 +00001590 pFrom->expired = 1;
1591 }
shane145834a2008-09-04 12:03:42 +00001592 return sqlite3TransferBindings(pFromStmt, pToStmt);
1593}
shaneeec556d2008-10-12 00:27:53 +00001594#endif
shane145834a2008-09-04 12:03:42 +00001595
1596/*
drh51942bc2005-06-12 22:01:42 +00001597** Return the sqlite3* database handle to which the prepared statement given
1598** in the argument belongs. This is the same database handle that was
1599** the first argument to the sqlite3_prepare() that was used to create
1600** the statement in the first place.
1601*/
1602sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1603 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1604}
drhbb5a9c32008-06-19 02:52:25 +00001605
1606/*
drhf03d9cc2010-11-16 23:10:25 +00001607** Return true if the prepared statement is guaranteed to not modify the
1608** database.
1609*/
1610int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1611 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1612}
1613
1614/*
drh2fb66932011-11-25 17:21:47 +00001615** Return true if the prepared statement is in need of being reset.
1616*/
1617int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1618 Vdbe *v = (Vdbe*)pStmt;
drh76336d52016-10-01 11:39:53 +00001619 return v!=0 && v->magic==VDBE_MAGIC_RUN && v->pc>=0;
drh2fb66932011-11-25 17:21:47 +00001620}
1621
1622/*
drhbb5a9c32008-06-19 02:52:25 +00001623** Return a pointer to the next prepared statement after pStmt associated
1624** with database connection pDb. If pStmt is NULL, return the first
1625** prepared statement for the database connection. Return NULL if there
1626** are no more.
1627*/
1628sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1629 sqlite3_stmt *pNext;
drh9ca95732014-10-24 00:35:58 +00001630#ifdef SQLITE_ENABLE_API_ARMOR
1631 if( !sqlite3SafetyCheckOk(pDb) ){
1632 (void)SQLITE_MISUSE_BKPT;
1633 return 0;
1634 }
1635#endif
drhbb5a9c32008-06-19 02:52:25 +00001636 sqlite3_mutex_enter(pDb->mutex);
1637 if( pStmt==0 ){
1638 pNext = (sqlite3_stmt*)pDb->pVdbe;
1639 }else{
1640 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1641 }
1642 sqlite3_mutex_leave(pDb->mutex);
1643 return pNext;
1644}
drhd1d38482008-10-07 23:46:38 +00001645
1646/*
1647** Return the value of a status counter for a prepared statement
1648*/
1649int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1650 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9ca95732014-10-24 00:35:58 +00001651 u32 v;
1652#ifdef SQLITE_ENABLE_API_ARMOR
dan68cf69e2018-03-14 08:27:39 +00001653 if( !pStmt
1654 || (op!=SQLITE_STMTSTATUS_MEMUSED && (op<0||op>=ArraySize(pVdbe->aCounter)))
1655 ){
drh9ca95732014-10-24 00:35:58 +00001656 (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
mistachkin8bee11a2018-10-29 17:53:23 +00001709#ifdef SQLITE_ENABLE_NORMALIZE
1710/*
1711** Return the normalized SQL associated with a prepared statement.
1712*/
1713const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt){
1714 Vdbe *p = (Vdbe *)pStmt;
drh707821f2018-12-05 13:39:06 +00001715 if( p==0 ) return 0;
drh1a6c2b12018-12-10 20:01:40 +00001716 if( p->zNormSql==0 && ALWAYS(p->zSql!=0) ){
drh1f169fe2018-12-06 01:08:58 +00001717 sqlite3_mutex_enter(p->db->mutex);
drh1a6c2b12018-12-10 20:01:40 +00001718 p->zNormSql = sqlite3Normalize(p, p->zSql);
drh1f169fe2018-12-06 01:08:58 +00001719 sqlite3_mutex_leave(p->db->mutex);
drh707821f2018-12-05 13:39:06 +00001720 }
1721 return p->zNormSql;
mistachkin8bee11a2018-10-29 17:53:23 +00001722}
1723#endif /* SQLITE_ENABLE_NORMALIZE */
1724
drh9b1c62d2011-03-30 21:04:43 +00001725#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001726/*
dan93bca692011-09-14 19:41:44 +00001727** Allocate and populate an UnpackedRecord structure based on the serialized
1728** record in nKey/pKey. Return a pointer to the new UnpackedRecord structure
1729** if successful, or a NULL pointer if an OOM error is encountered.
1730*/
1731static UnpackedRecord *vdbeUnpackRecord(
1732 KeyInfo *pKeyInfo,
1733 int nKey,
1734 const void *pKey
1735){
dan93bca692011-09-14 19:41:44 +00001736 UnpackedRecord *pRet; /* Return value */
1737
drha582b012016-12-21 19:45:54 +00001738 pRet = sqlite3VdbeAllocUnpackedRecord(pKeyInfo);
dan93bca692011-09-14 19:41:44 +00001739 if( pRet ){
drha485ad12017-08-02 22:43:14 +00001740 memset(pRet->aMem, 0, sizeof(Mem)*(pKeyInfo->nKeyField+1));
dan93bca692011-09-14 19:41:44 +00001741 sqlite3VdbeRecordUnpack(pKeyInfo, nKey, pKey, pRet);
1742 }
1743 return pRet;
1744}
1745
1746/*
dan37db03b2011-03-16 19:59:18 +00001747** This function is called from within a pre-update callback to retrieve
1748** a field of the row currently being updated or deleted.
1749*/
dan46c47d42011-03-01 18:42:07 +00001750int sqlite3_preupdate_old(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
1751 PreUpdate *p = db->pPreUpdate;
dan7271d7a2017-01-25 18:53:27 +00001752 Mem *pMem;
dan46c47d42011-03-01 18:42:07 +00001753 int rc = SQLITE_OK;
1754
dan37db03b2011-03-16 19:59:18 +00001755 /* Test that this call is being made from within an SQLITE_DELETE or
1756 ** SQLITE_UPDATE pre-update callback, and that iIdx is within range. */
dan46c47d42011-03-01 18:42:07 +00001757 if( !p || p->op==SQLITE_INSERT ){
1758 rc = SQLITE_MISUSE_BKPT;
1759 goto preupdate_old_out;
1760 }
dancb9a3642017-01-30 19:44:53 +00001761 if( p->pPk ){
1762 iIdx = sqlite3ColumnOfIndex(p->pPk, iIdx);
1763 }
dan46c47d42011-03-01 18:42:07 +00001764 if( iIdx>=p->pCsr->nField || iIdx<0 ){
1765 rc = SQLITE_RANGE;
1766 goto preupdate_old_out;
1767 }
1768
dan37db03b2011-03-16 19:59:18 +00001769 /* If the old.* record has not yet been loaded into memory, do so now. */
dan46c47d42011-03-01 18:42:07 +00001770 if( p->pUnpacked==0 ){
dan12ca0b52011-03-21 16:17:42 +00001771 u32 nRec;
1772 u8 *aRec;
dan46c47d42011-03-01 18:42:07 +00001773
drha7c90c42016-06-04 20:37:10 +00001774 nRec = sqlite3BtreePayloadSize(p->pCsr->uc.pCursor);
dan12ca0b52011-03-21 16:17:42 +00001775 aRec = sqlite3DbMallocRaw(db, nRec);
1776 if( !aRec ) goto preupdate_old_out;
drhcb3cabd2016-11-25 19:18:28 +00001777 rc = sqlite3BtreePayload(p->pCsr->uc.pCursor, 0, nRec, aRec);
dan12ca0b52011-03-21 16:17:42 +00001778 if( rc==SQLITE_OK ){
dan93bca692011-09-14 19:41:44 +00001779 p->pUnpacked = vdbeUnpackRecord(&p->keyinfo, nRec, aRec);
dan12ca0b52011-03-21 16:17:42 +00001780 if( !p->pUnpacked ) rc = SQLITE_NOMEM;
1781 }
dan46c47d42011-03-01 18:42:07 +00001782 if( rc!=SQLITE_OK ){
dan12ca0b52011-03-21 16:17:42 +00001783 sqlite3DbFree(db, aRec);
dan46c47d42011-03-01 18:42:07 +00001784 goto preupdate_old_out;
1785 }
dan12ca0b52011-03-21 16:17:42 +00001786 p->aRecord = aRec;
dan46c47d42011-03-01 18:42:07 +00001787 }
1788
dan7271d7a2017-01-25 18:53:27 +00001789 pMem = *ppValue = &p->pUnpacked->aMem[iIdx];
1790 if( iIdx==p->pTab->iPKey ){
1791 sqlite3VdbeMemSetInt64(pMem, p->iKey1);
1792 }else if( iIdx>=p->pUnpacked->nField ){
dan46c47d42011-03-01 18:42:07 +00001793 *ppValue = (sqlite3_value *)columnNullValue();
dan7271d7a2017-01-25 18:53:27 +00001794 }else if( p->pTab->aCol[iIdx].affinity==SQLITE_AFF_REAL ){
1795 if( pMem->flags & MEM_Int ){
1796 sqlite3VdbeMemRealify(pMem);
dan319eeb72011-03-19 08:38:50 +00001797 }
dan46c47d42011-03-01 18:42:07 +00001798 }
1799
1800 preupdate_old_out:
drhe1ed0b02014-08-26 02:15:07 +00001801 sqlite3Error(db, rc);
dan46c47d42011-03-01 18:42:07 +00001802 return sqlite3ApiExit(db, rc);
1803}
drh9b1c62d2011-03-30 21:04:43 +00001804#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00001805
drh9b1c62d2011-03-30 21:04:43 +00001806#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001807/*
1808** This function is called from within a pre-update callback to retrieve
1809** the number of columns in the row being updated, deleted or inserted.
1810*/
dan46c47d42011-03-01 18:42:07 +00001811int sqlite3_preupdate_count(sqlite3 *db){
1812 PreUpdate *p = db->pPreUpdate;
drha485ad12017-08-02 22:43:14 +00001813 return (p ? p->keyinfo.nKeyField : 0);
dan46c47d42011-03-01 18:42:07 +00001814}
drh9b1c62d2011-03-30 21:04:43 +00001815#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00001816
drh9b1c62d2011-03-30 21:04:43 +00001817#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001818/*
dan1e7a2d42011-03-22 18:45:29 +00001819** This function is designed to be called from within a pre-update callback
1820** only. It returns zero if the change that caused the callback was made
1821** immediately by a user SQL statement. Or, if the change was made by a
1822** trigger program, it returns the number of trigger programs currently
1823** on the stack (1 for a top-level trigger, 2 for a trigger fired by a
1824** top-level trigger etc.).
1825**
1826** For the purposes of the previous paragraph, a foreign key CASCADE, SET NULL
1827** or SET DEFAULT action is considered a trigger.
1828*/
1829int sqlite3_preupdate_depth(sqlite3 *db){
1830 PreUpdate *p = db->pPreUpdate;
1831 return (p ? p->v->nFrame : 0);
1832}
drh9b1c62d2011-03-30 21:04:43 +00001833#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan1e7a2d42011-03-22 18:45:29 +00001834
drh9b1c62d2011-03-30 21:04:43 +00001835#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan1e7a2d42011-03-22 18:45:29 +00001836/*
dan37db03b2011-03-16 19:59:18 +00001837** This function is called from within a pre-update callback to retrieve
1838** a field of the row currently being updated or inserted.
1839*/
1840int sqlite3_preupdate_new(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
dan46c47d42011-03-01 18:42:07 +00001841 PreUpdate *p = db->pPreUpdate;
1842 int rc = SQLITE_OK;
dan37db03b2011-03-16 19:59:18 +00001843 Mem *pMem;
dan46c47d42011-03-01 18:42:07 +00001844
dan37db03b2011-03-16 19:59:18 +00001845 if( !p || p->op==SQLITE_DELETE ){
dan46c47d42011-03-01 18:42:07 +00001846 rc = SQLITE_MISUSE_BKPT;
dan37db03b2011-03-16 19:59:18 +00001847 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001848 }
dancb9a3642017-01-30 19:44:53 +00001849 if( p->pPk && p->op!=SQLITE_UPDATE ){
1850 iIdx = sqlite3ColumnOfIndex(p->pPk, iIdx);
1851 }
dan46c47d42011-03-01 18:42:07 +00001852 if( iIdx>=p->pCsr->nField || iIdx<0 ){
1853 rc = SQLITE_RANGE;
dan37db03b2011-03-16 19:59:18 +00001854 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001855 }
dan46c47d42011-03-01 18:42:07 +00001856
dan37db03b2011-03-16 19:59:18 +00001857 if( p->op==SQLITE_INSERT ){
1858 /* For an INSERT, memory cell p->iNewReg contains the serialized record
1859 ** that is being inserted. Deserialize it. */
1860 UnpackedRecord *pUnpack = p->pNewUnpacked;
1861 if( !pUnpack ){
1862 Mem *pData = &p->v->aMem[p->iNewReg];
drhff535a22016-09-20 01:46:15 +00001863 rc = ExpandBlob(pData);
dan37db03b2011-03-16 19:59:18 +00001864 if( rc!=SQLITE_OK ) goto preupdate_new_out;
dan93bca692011-09-14 19:41:44 +00001865 pUnpack = vdbeUnpackRecord(&p->keyinfo, pData->n, pData->z);
dan37db03b2011-03-16 19:59:18 +00001866 if( !pUnpack ){
1867 rc = SQLITE_NOMEM;
1868 goto preupdate_new_out;
1869 }
1870 p->pNewUnpacked = pUnpack;
1871 }
dan2a86c192017-01-25 17:44:13 +00001872 pMem = &pUnpack->aMem[iIdx];
1873 if( iIdx==p->pTab->iPKey ){
1874 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1875 }else if( iIdx>=pUnpack->nField ){
dan37db03b2011-03-16 19:59:18 +00001876 pMem = (sqlite3_value *)columnNullValue();
dan37db03b2011-03-16 19:59:18 +00001877 }
1878 }else{
1879 /* For an UPDATE, memory cell (p->iNewReg+1+iIdx) contains the required
1880 ** value. Make a copy of the cell contents and return a pointer to it.
1881 ** It is not safe to return a pointer to the memory cell itself as the
1882 ** caller may modify the value text encoding.
1883 */
1884 assert( p->op==SQLITE_UPDATE );
1885 if( !p->aNew ){
1886 p->aNew = (Mem *)sqlite3DbMallocZero(db, sizeof(Mem) * p->pCsr->nField);
1887 if( !p->aNew ){
1888 rc = SQLITE_NOMEM;
1889 goto preupdate_new_out;
1890 }
1891 }
drh304637c2011-03-18 16:47:27 +00001892 assert( iIdx>=0 && iIdx<p->pCsr->nField );
dan37db03b2011-03-16 19:59:18 +00001893 pMem = &p->aNew[iIdx];
1894 if( pMem->flags==0 ){
dane43635a2016-10-21 21:21:45 +00001895 if( iIdx==p->pTab->iPKey ){
dan319eeb72011-03-19 08:38:50 +00001896 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1897 }else{
1898 rc = sqlite3VdbeMemCopy(pMem, &p->v->aMem[p->iNewReg+1+iIdx]);
1899 if( rc!=SQLITE_OK ) goto preupdate_new_out;
1900 }
dan37db03b2011-03-16 19:59:18 +00001901 }
1902 }
1903 *ppValue = pMem;
1904
1905 preupdate_new_out:
drhe1ed0b02014-08-26 02:15:07 +00001906 sqlite3Error(db, rc);
dan46c47d42011-03-01 18:42:07 +00001907 return sqlite3ApiExit(db, rc);
1908}
drh9b1c62d2011-03-30 21:04:43 +00001909#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
drh04e8a582014-11-18 21:20:57 +00001910
dan6f9702e2014-11-01 20:38:06 +00001911#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan04489b62014-10-31 20:11:32 +00001912/*
1913** Return status data for a single loop within query pStmt.
1914*/
1915int sqlite3_stmt_scanstatus(
drhd1a1c232014-11-03 16:35:55 +00001916 sqlite3_stmt *pStmt, /* Prepared statement being queried */
dan04489b62014-10-31 20:11:32 +00001917 int idx, /* Index of loop to report on */
drhd1a1c232014-11-03 16:35:55 +00001918 int iScanStatusOp, /* Which metric to return */
1919 void *pOut /* OUT: Write the answer here */
dan04489b62014-10-31 20:11:32 +00001920){
1921 Vdbe *p = (Vdbe*)pStmt;
dan037b5322014-11-03 11:25:32 +00001922 ScanStatus *pScan;
dan6f9702e2014-11-01 20:38:06 +00001923 if( idx<0 || idx>=p->nScan ) return 1;
1924 pScan = &p->aScan[idx];
drhd1a1c232014-11-03 16:35:55 +00001925 switch( iScanStatusOp ){
1926 case SQLITE_SCANSTAT_NLOOP: {
1927 *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
1928 break;
1929 }
1930 case SQLITE_SCANSTAT_NVISIT: {
1931 *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
1932 break;
1933 }
1934 case SQLITE_SCANSTAT_EST: {
drh518140e2014-11-06 03:55:10 +00001935 double r = 1.0;
1936 LogEst x = pScan->nEst;
1937 while( x<100 ){
1938 x += 10;
1939 r *= 0.5;
1940 }
1941 *(double*)pOut = r*sqlite3LogEstToInt(x);
drhd1a1c232014-11-03 16:35:55 +00001942 break;
1943 }
1944 case SQLITE_SCANSTAT_NAME: {
dand72219d2014-11-03 16:39:37 +00001945 *(const char**)pOut = pScan->zName;
drhd1a1c232014-11-03 16:35:55 +00001946 break;
1947 }
1948 case SQLITE_SCANSTAT_EXPLAIN: {
1949 if( pScan->addrExplain ){
1950 *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
1951 }else{
1952 *(const char**)pOut = 0;
1953 }
1954 break;
1955 }
drhc6652b12014-11-06 04:42:20 +00001956 case SQLITE_SCANSTAT_SELECTID: {
1957 if( pScan->addrExplain ){
1958 *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
1959 }else{
1960 *(int*)pOut = -1;
1961 }
1962 break;
1963 }
drhd1a1c232014-11-03 16:35:55 +00001964 default: {
1965 return 1;
dan6f9702e2014-11-01 20:38:06 +00001966 }
1967 }
dan04489b62014-10-31 20:11:32 +00001968 return 0;
1969}
1970
1971/*
1972** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
1973*/
1974void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
1975 Vdbe *p = (Vdbe*)pStmt;
dan6f9702e2014-11-01 20:38:06 +00001976 memset(p->anExec, 0, p->nOp * sizeof(i64));
dan04489b62014-10-31 20:11:32 +00001977}
dan6f9702e2014-11-01 20:38:06 +00001978#endif /* SQLITE_ENABLE_STMT_SCANSTATUS */