blob: 33c6ba3b287e9a45eb9beaf6d89cda513a029cfd [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;
63 assert( p->startTime>0 );
64 assert( db->xProfile!=0 );
65 assert( db->init.busy==0 );
66 assert( p->zSql!=0 );
67 sqlite3OsCurrentTimeInt64(db->pVfs, &iNow);
68 db->xProfile(db->pProfileArg, p->zSql, (iNow - p->startTime)*1000000);
69 p->startTime = 0;
70}
71/*
72** The checkProfileCallback(DB,P) macro checks to see if a profile callback
73** is needed, and it invokes the callback if it is needed.
74*/
75# define checkProfileCallback(DB,P) \
76 if( ((P)->startTime)>0 ){ invokeProfileCallback(DB,P); }
77#else
78# define checkProfileCallback(DB,P) /*no-op*/
79#endif
80
drh413c3d32010-02-23 20:11:56 +000081/*
drhe30f4422007-08-21 16:15:55 +000082** The following routine destroys a virtual machine that is created by
83** the sqlite3_compile() routine. The integer returned is an SQLITE_
84** success/failure code that describes the result of executing the virtual
85** machine.
86**
87** This routine sets the error code and string returned by
88** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
89*/
90int sqlite3_finalize(sqlite3_stmt *pStmt){
91 int rc;
92 if( pStmt==0 ){
drh65bafa62010-09-29 01:54:00 +000093 /* IMPLEMENTATION-OF: R-57228-12904 Invoking sqlite3_finalize() on a NULL
94 ** pointer is a harmless no-op. */
drhe30f4422007-08-21 16:15:55 +000095 rc = SQLITE_OK;
96 }else{
97 Vdbe *v = (Vdbe*)pStmt;
danielk1977238746a2009-03-19 18:51:06 +000098 sqlite3 *db = v->db;
drh413c3d32010-02-23 20:11:56 +000099 if( vdbeSafety(v) ) return SQLITE_MISUSE_BKPT;
drh4245c402012-06-02 14:32:21 +0000100 sqlite3_mutex_enter(db->mutex);
drh201e0c62015-07-14 14:48:50 +0000101 checkProfileCallback(db, v);
drhe30f4422007-08-21 16:15:55 +0000102 rc = sqlite3VdbeFinalize(v);
danielk1977238746a2009-03-19 18:51:06 +0000103 rc = sqlite3ApiExit(db, rc);
drh4245c402012-06-02 14:32:21 +0000104 sqlite3LeaveMutexAndCloseZombie(db);
drhe30f4422007-08-21 16:15:55 +0000105 }
106 return rc;
107}
108
109/*
110** Terminate the current execution of an SQL statement and reset it
111** back to its starting state so that it can be reused. A success code from
112** the prior execution is returned.
113**
114** This routine sets the error code and string returned by
115** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
116*/
117int sqlite3_reset(sqlite3_stmt *pStmt){
118 int rc;
119 if( pStmt==0 ){
120 rc = SQLITE_OK;
121 }else{
122 Vdbe *v = (Vdbe*)pStmt;
drh201e0c62015-07-14 14:48:50 +0000123 sqlite3 *db = v->db;
124 sqlite3_mutex_enter(db->mutex);
125 checkProfileCallback(db, v);
drhc890fec2008-08-01 20:10:08 +0000126 rc = sqlite3VdbeReset(v);
drh124c0b42011-06-01 18:15:55 +0000127 sqlite3VdbeRewind(v);
drh201e0c62015-07-14 14:48:50 +0000128 assert( (rc & (db->errMask))==rc );
129 rc = sqlite3ApiExit(db, rc);
130 sqlite3_mutex_leave(db->mutex);
drhe30f4422007-08-21 16:15:55 +0000131 }
132 return rc;
133}
134
135/*
136** Set all the parameters in the compiled SQL statement to NULL.
137*/
138int sqlite3_clear_bindings(sqlite3_stmt *pStmt){
139 int i;
140 int rc = SQLITE_OK;
drh7297d1f2008-05-09 14:39:44 +0000141 Vdbe *p = (Vdbe*)pStmt;
drh18472fa2008-10-07 15:25:48 +0000142#if SQLITE_THREADSAFE
drh7e8b8482008-01-23 03:03:05 +0000143 sqlite3_mutex *mutex = ((Vdbe*)pStmt)->db->mutex;
144#endif
145 sqlite3_mutex_enter(mutex);
drh7297d1f2008-05-09 14:39:44 +0000146 for(i=0; i<p->nVar; i++){
147 sqlite3VdbeMemRelease(&p->aVar[i]);
148 p->aVar[i].flags = MEM_Null;
drhe30f4422007-08-21 16:15:55 +0000149 }
danc94b8592009-10-20 07:01:24 +0000150 if( p->isPrepareV2 && p->expmask ){
151 p->expired = 1;
152 }
drh7e8b8482008-01-23 03:03:05 +0000153 sqlite3_mutex_leave(mutex);
drhe30f4422007-08-21 16:15:55 +0000154 return rc;
155}
156
157
drh4f26d6c2004-05-26 23:25:30 +0000158/**************************** sqlite3_value_ *******************************
159** The following routines extract information from a Mem or sqlite3_value
160** structure.
161*/
162const void *sqlite3_value_blob(sqlite3_value *pVal){
163 Mem *p = (Mem*)pVal;
164 if( p->flags & (MEM_Blob|MEM_Str) ){
dana4d5ae82015-07-24 16:24:37 +0000165 if( sqlite3VdbeMemExpandBlob(p)!=SQLITE_OK ){
166 assert( p->flags==MEM_Null && p->z==0 );
167 return 0;
168 }
drh1f0feef2007-05-15 13:27:07 +0000169 p->flags |= MEM_Blob;
drh42262532010-09-08 16:30:36 +0000170 return p->n ? p->z : 0;
drh4f26d6c2004-05-26 23:25:30 +0000171 }else{
172 return sqlite3_value_text(pVal);
173 }
174}
175int sqlite3_value_bytes(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000176 return sqlite3ValueBytes(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000177}
178int sqlite3_value_bytes16(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000179 return sqlite3ValueBytes(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000180}
181double sqlite3_value_double(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000182 return sqlite3VdbeRealValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000183}
184int sqlite3_value_int(sqlite3_value *pVal){
drhb27b7f52008-12-10 18:03:45 +0000185 return (int)sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000186}
drhefad9992004-06-22 12:13:55 +0000187sqlite_int64 sqlite3_value_int64(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000188 return sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000189}
drhbcdf78a2015-09-10 20:34:56 +0000190unsigned int sqlite3_value_subtype(sqlite3_value *pVal){
191 return ((Mem*)pVal)->eSubtype;
192}
drh4f26d6c2004-05-26 23:25:30 +0000193const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000194 return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000195}
drh6c626082004-11-14 21:56:29 +0000196#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000197const void *sqlite3_value_text16(sqlite3_value* pVal){
drhb21c8cd2007-08-21 19:33:56 +0000198 return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000199}
danielk1977d8123362004-06-12 09:25:12 +0000200const void *sqlite3_value_text16be(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000201 return sqlite3ValueText(pVal, SQLITE_UTF16BE);
danielk1977d8123362004-06-12 09:25:12 +0000202}
203const void *sqlite3_value_text16le(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000204 return sqlite3ValueText(pVal, SQLITE_UTF16LE);
danielk1977d8123362004-06-12 09:25:12 +0000205}
drh6c626082004-11-14 21:56:29 +0000206#endif /* SQLITE_OMIT_UTF16 */
drh22ec1342015-02-27 00:33:15 +0000207/* EVIDENCE-OF: R-12793-43283 Every value in SQLite has one of five
208** fundamental datatypes: 64-bit signed integer 64-bit IEEE floating
209** point number string BLOB NULL
210*/
drh4f26d6c2004-05-26 23:25:30 +0000211int sqlite3_value_type(sqlite3_value* pVal){
drh1b27b8c2014-02-10 03:21:57 +0000212 static const u8 aType[] = {
213 SQLITE_BLOB, /* 0x00 */
214 SQLITE_NULL, /* 0x01 */
215 SQLITE_TEXT, /* 0x02 */
216 SQLITE_NULL, /* 0x03 */
217 SQLITE_INTEGER, /* 0x04 */
218 SQLITE_NULL, /* 0x05 */
219 SQLITE_INTEGER, /* 0x06 */
220 SQLITE_NULL, /* 0x07 */
221 SQLITE_FLOAT, /* 0x08 */
222 SQLITE_NULL, /* 0x09 */
223 SQLITE_FLOAT, /* 0x0a */
224 SQLITE_NULL, /* 0x0b */
225 SQLITE_INTEGER, /* 0x0c */
226 SQLITE_NULL, /* 0x0d */
227 SQLITE_INTEGER, /* 0x0e */
228 SQLITE_NULL, /* 0x0f */
229 SQLITE_BLOB, /* 0x10 */
230 SQLITE_NULL, /* 0x11 */
231 SQLITE_TEXT, /* 0x12 */
232 SQLITE_NULL, /* 0x13 */
233 SQLITE_INTEGER, /* 0x14 */
234 SQLITE_NULL, /* 0x15 */
235 SQLITE_INTEGER, /* 0x16 */
236 SQLITE_NULL, /* 0x17 */
237 SQLITE_FLOAT, /* 0x18 */
238 SQLITE_NULL, /* 0x19 */
239 SQLITE_FLOAT, /* 0x1a */
240 SQLITE_NULL, /* 0x1b */
241 SQLITE_INTEGER, /* 0x1c */
242 SQLITE_NULL, /* 0x1d */
243 SQLITE_INTEGER, /* 0x1e */
244 SQLITE_NULL, /* 0x1f */
245 };
mistachkinafc14f72014-03-05 01:29:18 +0000246 return aType[pVal->flags&MEM_AffMask];
drh4f26d6c2004-05-26 23:25:30 +0000247}
248
drh4f03f412015-05-20 21:28:32 +0000249/* Make a copy of an sqlite3_value object
250*/
251sqlite3_value *sqlite3_value_dup(const sqlite3_value *pOrig){
252 sqlite3_value *pNew;
253 if( pOrig==0 ) return 0;
254 pNew = sqlite3_malloc( sizeof(*pNew) );
255 if( pNew==0 ) return 0;
256 memset(pNew, 0, sizeof(*pNew));
257 memcpy(pNew, pOrig, MEMCELLSIZE);
258 pNew->flags &= ~MEM_Dyn;
259 pNew->db = 0;
260 if( pNew->flags&(MEM_Str|MEM_Blob) ){
drh10ca5b42015-05-22 21:04:54 +0000261 pNew->flags &= ~(MEM_Static|MEM_Dyn);
262 pNew->flags |= MEM_Ephem;
263 if( sqlite3VdbeMemMakeWriteable(pNew)!=SQLITE_OK ){
264 sqlite3ValueFree(pNew);
265 pNew = 0;
drh4f03f412015-05-20 21:28:32 +0000266 }
267 }
268 return pNew;
269}
270
271/* Destroy an sqlite3_value object previously obtained from
272** sqlite3_value_dup().
273*/
274void sqlite3_value_free(sqlite3_value *pOld){
275 sqlite3ValueFree(pOld);
276}
277
278
drh4f26d6c2004-05-26 23:25:30 +0000279/**************************** sqlite3_result_ *******************************
280** The following routines are used by user-defined functions to specify
281** the function result.
drh4c8555f2009-06-25 01:47:11 +0000282**
peter.d.reid60ec9142014-09-06 16:39:46 +0000283** The setStrOrError() function calls sqlite3VdbeMemSetStr() to store the
drh4c8555f2009-06-25 01:47:11 +0000284** result as a string or blob but if the string or blob is too large, it
285** then sets the error code to SQLITE_TOOBIG
drhda4ca9d2014-09-09 17:27:35 +0000286**
287** The invokeValueDestructor(P,X) routine invokes destructor function X()
288** on value P is not going to be used and need to be destroyed.
drh4f26d6c2004-05-26 23:25:30 +0000289*/
drh4c8555f2009-06-25 01:47:11 +0000290static void setResultStrOrError(
291 sqlite3_context *pCtx, /* Function context */
292 const char *z, /* String pointer */
293 int n, /* Bytes in string, or negative */
294 u8 enc, /* Encoding of z. 0 for BLOBs */
295 void (*xDel)(void*) /* Destructor function */
296){
drh9bd038f2014-08-27 14:14:06 +0000297 if( sqlite3VdbeMemSetStr(pCtx->pOut, z, n, enc, xDel)==SQLITE_TOOBIG ){
drh4c8555f2009-06-25 01:47:11 +0000298 sqlite3_result_error_toobig(pCtx);
299 }
300}
drhda4ca9d2014-09-09 17:27:35 +0000301static int invokeValueDestructor(
302 const void *p, /* Value to destroy */
303 void (*xDel)(void*), /* The destructor */
304 sqlite3_context *pCtx /* Set a SQLITE_TOOBIG error if no NULL */
305){
drhfc59a952014-09-11 23:34:55 +0000306 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000307 if( xDel==0 ){
308 /* noop */
309 }else if( xDel==SQLITE_TRANSIENT ){
310 /* noop */
drhda4ca9d2014-09-09 17:27:35 +0000311 }else{
312 xDel((void*)p);
313 }
314 if( pCtx ) sqlite3_result_error_toobig(pCtx);
315 return SQLITE_TOOBIG;
316}
drh4f26d6c2004-05-26 23:25:30 +0000317void sqlite3_result_blob(
318 sqlite3_context *pCtx,
319 const void *z,
320 int n,
danielk1977d8123362004-06-12 09:25:12 +0000321 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000322){
drh5708d2d2005-06-22 10:53:59 +0000323 assert( n>=0 );
drh9bd038f2014-08-27 14:14:06 +0000324 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000325 setResultStrOrError(pCtx, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000326}
drhda4ca9d2014-09-09 17:27:35 +0000327void sqlite3_result_blob64(
328 sqlite3_context *pCtx,
329 const void *z,
330 sqlite3_uint64 n,
331 void (*xDel)(void *)
332){
333 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000334 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000335 if( n>0x7fffffff ){
336 (void)invokeValueDestructor(z, xDel, pCtx);
337 }else{
338 setResultStrOrError(pCtx, z, (int)n, 0, xDel);
339 }
340}
drh4f26d6c2004-05-26 23:25:30 +0000341void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
drh9bd038f2014-08-27 14:14:06 +0000342 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
343 sqlite3VdbeMemSetDouble(pCtx->pOut, rVal);
drh4f26d6c2004-05-26 23:25:30 +0000344}
345void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000346 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000347 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000348 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000349 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000350}
danielk1977a1686c92006-01-23 07:52:37 +0000351#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000352void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000353 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000354 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000355 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000356 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000357}
danielk1977a1686c92006-01-23 07:52:37 +0000358#endif
drhf4479502004-05-27 03:12:53 +0000359void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh9bd038f2014-08-27 14:14:06 +0000360 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
361 sqlite3VdbeMemSetInt64(pCtx->pOut, (i64)iVal);
drh4f26d6c2004-05-26 23:25:30 +0000362}
363void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
drh9bd038f2014-08-27 14:14:06 +0000364 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
365 sqlite3VdbeMemSetInt64(pCtx->pOut, iVal);
drh4f26d6c2004-05-26 23:25:30 +0000366}
367void sqlite3_result_null(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000368 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
369 sqlite3VdbeMemSetNull(pCtx->pOut);
drh4f26d6c2004-05-26 23:25:30 +0000370}
drhbcdf78a2015-09-10 20:34:56 +0000371void sqlite3_result_subtype(sqlite3_context *pCtx, unsigned int eSubtype){
372 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
373 pCtx->pOut->eSubtype = eSubtype & 0xff;
374}
drh4f26d6c2004-05-26 23:25:30 +0000375void sqlite3_result_text(
376 sqlite3_context *pCtx,
377 const char *z,
378 int n,
danielk1977d8123362004-06-12 09:25:12 +0000379 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000380){
drh9bd038f2014-08-27 14:14:06 +0000381 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000382 setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000383}
drhbbf483f2014-09-09 20:30:24 +0000384void sqlite3_result_text64(
drhda4ca9d2014-09-09 17:27:35 +0000385 sqlite3_context *pCtx,
386 const char *z,
387 sqlite3_uint64 n,
388 void (*xDel)(void *),
389 unsigned char enc
390){
391 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000392 assert( xDel!=SQLITE_DYNAMIC );
drh79f7af92014-10-03 16:00:51 +0000393 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drhda4ca9d2014-09-09 17:27:35 +0000394 if( n>0x7fffffff ){
395 (void)invokeValueDestructor(z, xDel, pCtx);
396 }else{
397 setResultStrOrError(pCtx, z, (int)n, enc, xDel);
398 }
399}
drh6c626082004-11-14 21:56:29 +0000400#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000401void sqlite3_result_text16(
402 sqlite3_context *pCtx,
403 const void *z,
404 int n,
danielk1977d8123362004-06-12 09:25:12 +0000405 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000406){
drh9bd038f2014-08-27 14:14:06 +0000407 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000408 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000409}
410void sqlite3_result_text16be(
411 sqlite3_context *pCtx,
412 const void *z,
413 int n,
414 void (*xDel)(void *)
415){
drh9bd038f2014-08-27 14:14:06 +0000416 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000417 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000418}
419void sqlite3_result_text16le(
420 sqlite3_context *pCtx,
421 const void *z,
422 int n,
423 void (*xDel)(void *)
424){
drh9bd038f2014-08-27 14:14:06 +0000425 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000426 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000427}
drh6c626082004-11-14 21:56:29 +0000428#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000429void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh9bd038f2014-08-27 14:14:06 +0000430 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
431 sqlite3VdbeMemCopy(pCtx->pOut, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000432}
drhb026e052007-05-02 01:34:31 +0000433void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh9bd038f2014-08-27 14:14:06 +0000434 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
435 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
drhb026e052007-05-02 01:34:31 +0000436}
dana4d5ae82015-07-24 16:24:37 +0000437int sqlite3_result_zeroblob64(sqlite3_context *pCtx, u64 n){
438 Mem *pOut = pCtx->pOut;
439 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh6bacdc22015-07-24 17:14:03 +0000440 if( n>(u64)pOut->db->aLimit[SQLITE_LIMIT_LENGTH] ){
dana4d5ae82015-07-24 16:24:37 +0000441 return SQLITE_TOOBIG;
442 }
443 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, (int)n);
444 return SQLITE_OK;
445}
drh69544ec2008-02-06 14:11:34 +0000446void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
447 pCtx->isError = errCode;
drh9b47ee32013-08-20 03:13:51 +0000448 pCtx->fErrorOrAux = 1;
drh983b5ee2015-02-13 12:05:56 +0000449#ifdef SQLITE_DEBUG
drh96f4ad22015-03-12 21:02:36 +0000450 if( pCtx->pVdbe ) pCtx->pVdbe->rcApp = errCode;
drh983b5ee2015-02-13 12:05:56 +0000451#endif
drh9bd038f2014-08-27 14:14:06 +0000452 if( pCtx->pOut->flags & MEM_Null ){
453 sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
drh51c7d862009-04-27 18:46:06 +0000454 SQLITE_UTF8, SQLITE_STATIC);
455 }
drh69544ec2008-02-06 14:11:34 +0000456}
drh4f26d6c2004-05-26 23:25:30 +0000457
drha0206bc2007-05-08 15:15:02 +0000458/* Force an SQLITE_TOOBIG error. */
459void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000460 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000461 pCtx->isError = SQLITE_TOOBIG;
drh9b47ee32013-08-20 03:13:51 +0000462 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000463 sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
drhbb4957f2008-03-20 14:03:29 +0000464 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000465}
466
danielk1977a1644fd2007-08-29 12:31:25 +0000467/* An SQLITE_NOMEM error. */
468void sqlite3_result_error_nomem(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000469 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
470 sqlite3VdbeMemSetNull(pCtx->pOut);
drh69544ec2008-02-06 14:11:34 +0000471 pCtx->isError = SQLITE_NOMEM;
drh9b47ee32013-08-20 03:13:51 +0000472 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000473 pCtx->pOut->db->mallocFailed = 1;
danielk1977a1644fd2007-08-29 12:31:25 +0000474}
drh4f26d6c2004-05-26 23:25:30 +0000475
dan5cf53532010-05-01 16:40:20 +0000476/*
477** This function is called after a transaction has been committed. It
478** invokes callbacks registered with sqlite3_wal_hook() as required.
479*/
drh7ed91f22010-04-29 22:34:07 +0000480static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000481 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000482#ifndef SQLITE_OMIT_WAL
483 int i;
dan8d22a172010-04-19 18:03:51 +0000484 for(i=0; i<db->nDb; i++){
485 Btree *pBt = db->aDb[i].pBt;
486 if( pBt ){
drhef15c6e2014-12-12 01:27:17 +0000487 int nEntry;
488 sqlite3BtreeEnter(pBt);
489 nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
490 sqlite3BtreeLeave(pBt);
drh5def0842010-05-05 20:00:25 +0000491 if( db->xWalCallback && nEntry>0 && rc==SQLITE_OK ){
492 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000493 }
494 }
495 }
dan5cf53532010-05-01 16:40:20 +0000496#endif
dan8d22a172010-04-19 18:03:51 +0000497 return rc;
498}
499
drh201e0c62015-07-14 14:48:50 +0000500
drh4f26d6c2004-05-26 23:25:30 +0000501/*
502** Execute the statement pStmt, either until a row of data is ready, the
503** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000504**
505** This routine implements the bulk of the logic behind the sqlite_step()
506** API. The only thing omitted is the automatic recompile if a
507** schema change has occurred. That detail is handled by the
508** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000509*/
drhb900aaf2006-11-09 00:24:53 +0000510static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000511 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000512 int rc;
513
danielk1977a185ddb2007-11-15 16:04:15 +0000514 assert(p);
515 if( p->magic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000516 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000517 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
518 ** with version 3.7.0, we changed this so that sqlite3_reset() would
519 ** be called automatically instead of throwing the SQLITE_MISUSE error.
520 ** This "automatic-reset" change is not technically an incompatibility,
521 ** since any application that receives an SQLITE_MISUSE is broken by
522 ** definition.
523 **
524 ** Nevertheless, some published applications that were originally written
525 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000526 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000527 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
528 ** legacy behavior of returning SQLITE_MISUSE for cases where the
529 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
530 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000531 */
drh602acb42011-01-17 17:42:37 +0000532#ifdef SQLITE_OMIT_AUTORESET
drh983b5ee2015-02-13 12:05:56 +0000533 if( (rc = p->rc&0xff)==SQLITE_BUSY || rc==SQLITE_LOCKED ){
drh602acb42011-01-17 17:42:37 +0000534 sqlite3_reset((sqlite3_stmt*)p);
535 }else{
536 return SQLITE_MISUSE_BKPT;
537 }
538#else
drh3674bfd2010-04-17 12:53:19 +0000539 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000540#endif
drhf1bfe9a2007-10-17 01:44:20 +0000541 }
542
dan14d4cc42010-01-20 14:25:37 +0000543 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000544 db = p->db;
drhc456e572008-08-11 18:44:58 +0000545 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000546 p->rc = SQLITE_NOMEM;
drhc456e572008-08-11 18:44:58 +0000547 return SQLITE_NOMEM;
548 }
danielk1977261919c2005-12-06 12:52:59 +0000549
danielk1977a21c6b62005-01-24 10:25:59 +0000550 if( p->pc<=0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000551 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000552 rc = SQLITE_ERROR;
553 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000554 }
danielk19771d850a72004-05-31 08:26:49 +0000555 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000556 /* If there are no other statements currently running, then
557 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
558 ** from interrupting a statement that has not yet started.
559 */
drh4f7d3a52013-06-27 23:54:02 +0000560 if( db->nVdbeActive==0 ){
drh15ca1df2006-07-26 13:43:30 +0000561 db->u1.isInterrupted = 0;
562 }
563
drh648e2642013-07-11 15:03:32 +0000564 assert( db->nVdbeWrite>0 || db->autoCommit==0
565 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
566 );
dan1da40a32009-09-19 17:00:31 +0000567
drh19e2d372005-08-29 23:00:03 +0000568#ifndef SQLITE_OMIT_TRACE
drh201e0c62015-07-14 14:48:50 +0000569 if( db->xProfile && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000570 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh201e0c62015-07-14 14:48:50 +0000571 }else{
572 assert( p->startTime==0 );
drh19e2d372005-08-29 23:00:03 +0000573 }
574#endif
drhc16a03b2004-09-15 13:38:10 +0000575
drh4f7d3a52013-06-27 23:54:02 +0000576 db->nVdbeActive++;
577 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000578 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000579 p->pc = 0;
580 }
drh983b5ee2015-02-13 12:05:56 +0000581#ifdef SQLITE_DEBUG
582 p->rcApp = SQLITE_OK;
583#endif
drhb7f91642004-10-31 02:22:47 +0000584#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000585 if( p->explain ){
586 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000587 }else
588#endif /* SQLITE_OMIT_EXPLAIN */
589 {
drh4f7d3a52013-06-27 23:54:02 +0000590 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000591 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000592 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000593 }
594
drh19e2d372005-08-29 23:00:03 +0000595#ifndef SQLITE_OMIT_TRACE
drh201e0c62015-07-14 14:48:50 +0000596 /* If the statement completed successfully, invoke the profile callback */
597 if( rc!=SQLITE_ROW ) checkProfileCallback(db, p);
drh19e2d372005-08-29 23:00:03 +0000598#endif
599
dan8d22a172010-04-19 18:03:51 +0000600 if( rc==SQLITE_DONE ){
601 assert( p->rc==SQLITE_OK );
drh7ed91f22010-04-29 22:34:07 +0000602 p->rc = doWalCallbacks(db);
dan8d22a172010-04-19 18:03:51 +0000603 if( p->rc!=SQLITE_OK ){
604 rc = SQLITE_ERROR;
605 }
606 }
607
drh80cc85b2008-07-23 21:07:25 +0000608 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000609 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
610 p->rc = SQLITE_NOMEM;
drhb900aaf2006-11-09 00:24:53 +0000611 }
danielk1977357864e2009-03-25 15:43:08 +0000612end_of_step:
613 /* At this point local variable rc holds the value that should be
614 ** returned if this statement was compiled using the legacy
615 ** sqlite3_prepare() interface. According to the docs, this can only
616 ** be one of the values in the first assert() below. Variable p->rc
617 ** contains the value that would be returned if sqlite3_finalize()
618 ** were called on statement p.
619 */
620 assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
drhcbd8db32015-08-20 17:18:32 +0000621 || (rc&0xff)==SQLITE_BUSY || rc==SQLITE_MISUSE
danielk1977357864e2009-03-25 15:43:08 +0000622 );
drh983b5ee2015-02-13 12:05:56 +0000623 assert( (p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE) || p->rc==p->rcApp );
danielk1977357864e2009-03-25 15:43:08 +0000624 if( p->isPrepareV2 && rc!=SQLITE_ROW && rc!=SQLITE_DONE ){
625 /* If this statement was prepared using sqlite3_prepare_v2(), and an
mistachkin48864df2013-03-21 21:20:32 +0000626 ** error has occurred, then return the error code in p->rc to the
danielk1977357864e2009-03-25 15:43:08 +0000627 ** caller. Set the error code in the database handle to the same value.
628 */
dan029ead62011-10-27 15:19:58 +0000629 rc = sqlite3VdbeTransferError(p);
danielk1977357864e2009-03-25 15:43:08 +0000630 }
631 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000632}
633
634/*
635** This is the top-level implementation of sqlite3_step(). Call
636** sqlite3Step() to do most of the work. If a schema error occurs,
637** call sqlite3Reprepare() and try again.
638*/
drhb900aaf2006-11-09 00:24:53 +0000639int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000640 int rc = SQLITE_OK; /* Result from sqlite3Step() */
641 int rc2 = SQLITE_OK; /* Result from sqlite3Reprepare() */
642 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
643 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
644 sqlite3 *db; /* The database connection */
645
drh413c3d32010-02-23 20:11:56 +0000646 if( vdbeSafetyNotNull(v) ){
647 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000648 }
drh413c3d32010-02-23 20:11:56 +0000649 db = v->db;
650 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000651 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000652 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh2c7946a2014-08-19 20:27:40 +0000653 && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
654 int savedPc = v->pc;
655 rc2 = rc = sqlite3Reprepare(v);
656 if( rc!=SQLITE_OK) break;
drh413c3d32010-02-23 20:11:56 +0000657 sqlite3_reset(pStmt);
drh5f58ae72014-08-19 20:41:36 +0000658 if( savedPc>=0 ) v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000659 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000660 }
drha3cc0072013-12-13 16:23:55 +0000661 if( rc2!=SQLITE_OK ){
drh413c3d32010-02-23 20:11:56 +0000662 /* This case occurs after failing to recompile an sql statement.
663 ** The error message from the SQL compiler has already been loaded
664 ** into the database handle. This block copies the error message
665 ** from the database handle into the statement and sets the statement
666 ** program counter to 0 to ensure that when the statement is
667 ** finalized or reset the parser error message is available via
668 ** sqlite3_errmsg() and sqlite3_errcode().
669 */
670 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
671 sqlite3DbFree(db, v->zErrMsg);
672 if( !db->mallocFailed ){
673 v->zErrMsg = sqlite3DbStrDup(db, zErr);
drha6129fa2010-02-24 17:15:19 +0000674 v->rc = rc2;
drh413c3d32010-02-23 20:11:56 +0000675 } else {
676 v->zErrMsg = 0;
drha6129fa2010-02-24 17:15:19 +0000677 v->rc = rc = SQLITE_NOMEM;
drh413c3d32010-02-23 20:11:56 +0000678 }
679 }
680 rc = sqlite3ApiExit(db, rc);
681 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000682 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000683}
684
drh95a7b3e2013-09-16 12:57:19 +0000685
drh4f26d6c2004-05-26 23:25:30 +0000686/*
drheb2e1762004-05-27 01:53:56 +0000687** Extract the user data from a sqlite3_context structure and return a
688** pointer to it.
689*/
690void *sqlite3_user_data(sqlite3_context *p){
691 assert( p && p->pFunc );
692 return p->pFunc->pUserData;
693}
694
695/*
drhfa4a4b92008-03-19 21:45:51 +0000696** Extract the user data from a sqlite3_context structure and return a
697** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000698**
699** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
700** returns a copy of the pointer to the database connection (the 1st
701** parameter) of the sqlite3_create_function() and
702** sqlite3_create_function16() routines that originally registered the
703** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000704*/
705sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
drha46a4a62015-09-08 21:12:53 +0000706 assert( p && p->pOut );
drh9bd038f2014-08-27 14:14:06 +0000707 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000708}
709
710/*
drha9e03b12015-03-12 06:46:52 +0000711** Return the current time for a statement. If the current time
712** is requested more than once within the same run of a single prepared
713** statement, the exact same time is returned for each invocation regardless
714** of the amount of time that elapses between invocations. In other words,
715** the time returned is always the time of the first call.
drh95a7b3e2013-09-16 12:57:19 +0000716*/
717sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
drh95a7b3e2013-09-16 12:57:19 +0000718 int rc;
drha9e03b12015-03-12 06:46:52 +0000719#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
drh3df79a92015-03-12 23:48:27 +0000720 sqlite3_int64 *piTime = &p->pVdbe->iCurrentTime;
drha9e03b12015-03-12 06:46:52 +0000721 assert( p->pVdbe!=0 );
722#else
drh3df79a92015-03-12 23:48:27 +0000723 sqlite3_int64 iTime = 0;
drha9e03b12015-03-12 06:46:52 +0000724 sqlite3_int64 *piTime = p->pVdbe!=0 ? &p->pVdbe->iCurrentTime : &iTime;
drha9e03b12015-03-12 06:46:52 +0000725#endif
drh3df79a92015-03-12 23:48:27 +0000726 if( *piTime==0 ){
drha9e03b12015-03-12 06:46:52 +0000727 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, piTime);
728 if( rc ) *piTime = 0;
729 }
730 return *piTime;
drh95a7b3e2013-09-16 12:57:19 +0000731}
732
733/*
drhb7481e72006-09-16 21:45:14 +0000734** The following is the implementation of an SQL function that always
735** fails with an error message stating that the function is used in the
736** wrong context. The sqlite3_overload_function() API might construct
737** SQL function that use this routine so that the functions will exist
738** for name resolution but are actually overloaded by the xFindFunction
739** method of virtual tables.
740*/
741void sqlite3InvalidFunction(
742 sqlite3_context *context, /* The function calling context */
danielk197762c14b32008-11-19 09:05:26 +0000743 int NotUsed, /* Number of arguments to the function */
744 sqlite3_value **NotUsed2 /* Value of each argument */
drhb7481e72006-09-16 21:45:14 +0000745){
746 const char *zName = context->pFunc->zName;
747 char *zErr;
danielk197762c14b32008-11-19 09:05:26 +0000748 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhbc6160b2009-04-08 15:45:31 +0000749 zErr = sqlite3_mprintf(
drhb7481e72006-09-16 21:45:14 +0000750 "unable to use function %s in the requested context", zName);
751 sqlite3_result_error(context, zErr, -1);
danielk19771e536952007-08-16 10:09:01 +0000752 sqlite3_free(zErr);
drhb7481e72006-09-16 21:45:14 +0000753}
754
755/*
drh9de4a172014-08-23 18:17:19 +0000756** Create a new aggregate context for p and return a pointer to
757** its pMem->z element.
758*/
759static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
760 Mem *pMem = p->pMem;
761 assert( (pMem->flags & MEM_Agg)==0 );
762 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000763 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000764 pMem->z = 0;
765 }else{
drh322f2852014-09-19 00:43:39 +0000766 sqlite3VdbeMemClearAndResize(pMem, nByte);
drh9de4a172014-08-23 18:17:19 +0000767 pMem->flags = MEM_Agg;
768 pMem->u.pDef = p->pFunc;
769 if( pMem->z ){
770 memset(pMem->z, 0, nByte);
771 }
772 }
773 return (void*)pMem->z;
774}
775
776/*
drheb2e1762004-05-27 01:53:56 +0000777** Allocate or return the aggregate context for a user function. A new
778** context is allocated on the first call. Subsequent calls return the
779** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000780*/
781void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh825c6622005-09-08 19:01:05 +0000782 assert( p && p->pFunc && p->pFunc->xStep );
drh9bd038f2014-08-27 14:14:06 +0000783 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000784 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000785 if( (p->pMem->flags & MEM_Agg)==0 ){
786 return createAggContext(p, nByte);
787 }else{
788 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000789 }
drheb2e1762004-05-27 01:53:56 +0000790}
791
792/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000793** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000794** the user-function defined by pCtx.
795*/
796void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000797 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000798
drh9bd038f2014-08-27 14:14:06 +0000799 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drha9e03b12015-03-12 06:46:52 +0000800#if SQLITE_ENABLE_STAT3_OR_STAT4
dan18bf8072015-03-11 20:06:40 +0000801 if( pCtx->pVdbe==0 ) return 0;
drha9e03b12015-03-12 06:46:52 +0000802#else
803 assert( pCtx->pVdbe!=0 );
804#endif
dan0c547792013-07-18 17:12:08 +0000805 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
806 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
danielk1977682f68b2004-06-05 10:22:17 +0000807 }
dan0c547792013-07-18 17:12:08 +0000808
809 return (pAuxData ? pAuxData->pAux : 0);
danielk1977682f68b2004-06-05 10:22:17 +0000810}
811
812/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000813** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000814** argument to the user-function defined by pCtx. Any previous value is
815** deleted by calling the delete function specified when it was set.
816*/
817void sqlite3_set_auxdata(
818 sqlite3_context *pCtx,
819 int iArg,
820 void *pAux,
821 void (*xDelete)(void*)
822){
dan0c547792013-07-18 17:12:08 +0000823 AuxData *pAuxData;
824 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000825
drh9bd038f2014-08-27 14:14:06 +0000826 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000827 if( iArg<0 ) goto failed;
drha9e03b12015-03-12 06:46:52 +0000828#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan18bf8072015-03-11 20:06:40 +0000829 if( pVdbe==0 ) goto failed;
drha9e03b12015-03-12 06:46:52 +0000830#else
831 assert( pVdbe!=0 );
832#endif
danielk1977682f68b2004-06-05 10:22:17 +0000833
dan0c547792013-07-18 17:12:08 +0000834 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
835 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
836 }
837 if( pAuxData==0 ){
838 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
839 if( !pAuxData ) goto failed;
840 pAuxData->iOp = pCtx->iOp;
841 pAuxData->iArg = iArg;
842 pAuxData->pNext = pVdbe->pAuxData;
843 pVdbe->pAuxData = pAuxData;
drh9b47ee32013-08-20 03:13:51 +0000844 if( pCtx->fErrorOrAux==0 ){
845 pCtx->isError = 0;
846 pCtx->fErrorOrAux = 1;
847 }
dan0c547792013-07-18 17:12:08 +0000848 }else if( pAuxData->xDelete ){
danielk1977682f68b2004-06-05 10:22:17 +0000849 pAuxData->xDelete(pAuxData->pAux);
850 }
dan0c547792013-07-18 17:12:08 +0000851
danielk1977682f68b2004-06-05 10:22:17 +0000852 pAuxData->pAux = pAux;
853 pAuxData->xDelete = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000854 return;
855
856failed:
857 if( xDelete ){
858 xDelete(pAux);
859 }
danielk1977682f68b2004-06-05 10:22:17 +0000860}
861
shaneeec556d2008-10-12 00:27:53 +0000862#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000863/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000864** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000865** called.
866**
drhcf85a512006-02-09 18:35:29 +0000867** This function is deprecated. Do not use it for new code. It is
868** provide only to avoid breaking legacy code. New aggregate function
869** implementations should keep their own counts within their aggregate
870** context.
drheb2e1762004-05-27 01:53:56 +0000871*/
872int sqlite3_aggregate_count(sqlite3_context *p){
shanee34c6472009-03-05 04:23:47 +0000873 assert( p && p->pMem && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000874 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000875}
shaneeec556d2008-10-12 00:27:53 +0000876#endif
drheb2e1762004-05-27 01:53:56 +0000877
878/*
drh4f26d6c2004-05-26 23:25:30 +0000879** Return the number of columns in the result set for the statement pStmt.
880*/
881int sqlite3_column_count(sqlite3_stmt *pStmt){
882 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000883 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000884}
885
886/*
887** Return the number of values available from the current row of the
888** currently executing statement pStmt.
889*/
890int sqlite3_data_count(sqlite3_stmt *pStmt){
891 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000892 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000893 return pVm->nResColumn;
894}
895
drhb1a1c292014-03-05 12:47:55 +0000896/*
897** Return a pointer to static memory containing an SQL NULL value.
898*/
899static const Mem *columnNullValue(void){
900 /* Even though the Mem structure contains an element
901 ** of type i64, on certain architectures (x86) with certain compiler
902 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
903 ** instead of an 8-byte one. This all works fine, except that when
904 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
905 ** that a Mem structure is located on an 8-byte boundary. To prevent
906 ** these assert()s from failing, when building with SQLITE_DEBUG defined
907 ** using gcc, we force nullMem to be 8-byte aligned using the magical
908 ** __attribute__((aligned(8))) macro. */
909 static const Mem nullMem
910#if defined(SQLITE_DEBUG) && defined(__GNUC__)
911 __attribute__((aligned(8)))
912#endif
drh035e5632014-09-16 14:16:31 +0000913 = {
drh3329a632014-09-18 01:21:43 +0000914 /* .u = */ {0},
drh8faee872015-09-19 18:08:13 +0000915 /* .flags = */ (u16)MEM_Null,
916 /* .enc = */ (u8)0,
917 /* .eSubtype = */ (u8)0,
918 /* .n = */ (int)0,
919 /* .z = */ (char*)0,
920 /* .zMalloc = */ (char*)0,
921 /* .szMalloc = */ (int)0,
922 /* .uTemp = */ (u32)0,
923 /* .db = */ (sqlite3*)0,
924 /* .xDel = */ (void(*)(void*))0,
drhb1a1c292014-03-05 12:47:55 +0000925#ifdef SQLITE_DEBUG
drh8faee872015-09-19 18:08:13 +0000926 /* .pScopyFrom = */ (Mem*)0,
927 /* .pFiller = */ (void*)0,
drhb1a1c292014-03-05 12:47:55 +0000928#endif
drh035e5632014-09-16 14:16:31 +0000929 };
drhb1a1c292014-03-05 12:47:55 +0000930 return &nullMem;
931}
drh4f26d6c2004-05-26 23:25:30 +0000932
933/*
934** Check to see if column iCol of the given statement is valid. If
935** it is, return a pointer to the Mem for the value of that column.
936** If iCol is not valid, return a pointer to a Mem which has a value
937** of NULL.
938*/
939static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000940 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000941 Mem *pOut;
942
943 pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000944 if( pVm && pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drh32bc3f62007-08-21 20:25:39 +0000945 sqlite3_mutex_enter(pVm->db->mutex);
drhd4e70eb2008-01-02 00:34:36 +0000946 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +0000947 }else{
drh9b4ea4a2009-04-10 20:32:00 +0000948 if( pVm && ALWAYS(pVm->db) ){
drh27641702007-08-22 02:56:42 +0000949 sqlite3_mutex_enter(pVm->db->mutex);
drh13f40da2014-08-22 18:00:11 +0000950 sqlite3Error(pVm->db, SQLITE_RANGE);
drh27641702007-08-22 02:56:42 +0000951 }
drhb1a1c292014-03-05 12:47:55 +0000952 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +0000953 }
drh32bc3f62007-08-21 20:25:39 +0000954 return pOut;
drh4f26d6c2004-05-26 23:25:30 +0000955}
956
danielk19772e588c72005-12-09 14:25:08 +0000957/*
958** This function is called after invoking an sqlite3_value_XXX function on a
959** column value (i.e. a value returned by evaluating an SQL expression in the
960** select list of a SELECT statement) that may cause a malloc() failure. If
961** malloc() has failed, the threads mallocFailed flag is cleared and the result
962** code of statement pStmt set to SQLITE_NOMEM.
963**
drh32bc3f62007-08-21 20:25:39 +0000964** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +0000965**
966** sqlite3_column_int()
967** sqlite3_column_int64()
968** sqlite3_column_text()
969** sqlite3_column_text16()
970** sqlite3_column_real()
971** sqlite3_column_bytes()
972** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +0000973** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +0000974*/
975static void columnMallocFailure(sqlite3_stmt *pStmt)
976{
977 /* If malloc() failed during an encoding conversion within an
978 ** sqlite3_column_XXX API, then set the return code of the statement to
979 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
980 ** and _finalize() will return NOMEM.
981 */
danielk197754f01982006-01-18 15:25:17 +0000982 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000983 if( p ){
984 p->rc = sqlite3ApiExit(p->db, p->rc);
985 sqlite3_mutex_leave(p->db->mutex);
986 }
danielk19772e588c72005-12-09 14:25:08 +0000987}
988
drh4f26d6c2004-05-26 23:25:30 +0000989/**************************** sqlite3_column_ *******************************
990** The following routines are used to access elements of the current row
991** in the result set.
992*/
danielk1977c572ef72004-05-27 09:28:41 +0000993const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000994 const void *val;
danielk19772e588c72005-12-09 14:25:08 +0000995 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +0000996 /* Even though there is no encoding conversion, value_blob() might
997 ** need to call malloc() to expand the result of a zeroblob()
998 ** expression.
999 */
1000 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +00001001 return val;
danielk1977c572ef72004-05-27 09:28:41 +00001002}
drh4f26d6c2004-05-26 23:25:30 +00001003int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001004 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
1005 columnMallocFailure(pStmt);
1006 return val;
drh4f26d6c2004-05-26 23:25:30 +00001007}
1008int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001009 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
1010 columnMallocFailure(pStmt);
1011 return val;
drh4f26d6c2004-05-26 23:25:30 +00001012}
1013double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001014 double val = sqlite3_value_double( columnMem(pStmt,i) );
1015 columnMallocFailure(pStmt);
1016 return val;
drh4f26d6c2004-05-26 23:25:30 +00001017}
1018int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001019 int val = sqlite3_value_int( columnMem(pStmt,i) );
1020 columnMallocFailure(pStmt);
1021 return val;
drh4f26d6c2004-05-26 23:25:30 +00001022}
drhefad9992004-06-22 12:13:55 +00001023sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001024 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
1025 columnMallocFailure(pStmt);
1026 return val;
drh4f26d6c2004-05-26 23:25:30 +00001027}
1028const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001029 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
1030 columnMallocFailure(pStmt);
1031 return val;
drh4f26d6c2004-05-26 23:25:30 +00001032}
drhd1e47332005-06-26 17:55:33 +00001033sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +00001034 Mem *pOut = columnMem(pStmt, i);
1035 if( pOut->flags&MEM_Static ){
1036 pOut->flags &= ~MEM_Static;
1037 pOut->flags |= MEM_Ephem;
1038 }
drh32bc3f62007-08-21 20:25:39 +00001039 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +00001040 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +00001041}
drh6c626082004-11-14 21:56:29 +00001042#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001043const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001044 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
1045 columnMallocFailure(pStmt);
1046 return val;
drh4f26d6c2004-05-26 23:25:30 +00001047}
drh6c626082004-11-14 21:56:29 +00001048#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +00001049int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +00001050 int iType = sqlite3_value_type( columnMem(pStmt,i) );
1051 columnMallocFailure(pStmt);
1052 return iType;
drh4f26d6c2004-05-26 23:25:30 +00001053}
1054
drh5e2517e2004-09-24 23:59:12 +00001055/*
1056** Convert the N-th element of pStmt->pColName[] into a string using
1057** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +00001058**
1059** There are up to 5 names for each column. useType determines which
1060** name is returned. Here are the names:
1061**
1062** 0 The column name as it should be displayed for output
1063** 1 The datatype name for the column
1064** 2 The name of the database that the column derives from
1065** 3 The name of the table that the column derives from
1066** 4 The name of the table column that the result column derives from
1067**
1068** If the result is not a simple column reference (if it is an expression
1069** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +00001070*/
1071static const void *columnName(
1072 sqlite3_stmt *pStmt,
1073 int N,
1074 const void *(*xFunc)(Mem*),
1075 int useType
1076){
drh9ca95732014-10-24 00:35:58 +00001077 const void *ret;
1078 Vdbe *p;
drh32bc3f62007-08-21 20:25:39 +00001079 int n;
drh9ca95732014-10-24 00:35:58 +00001080 sqlite3 *db;
1081#ifdef SQLITE_ENABLE_API_ARMOR
1082 if( pStmt==0 ){
1083 (void)SQLITE_MISUSE_BKPT;
1084 return 0;
1085 }
1086#endif
1087 ret = 0;
1088 p = (Vdbe *)pStmt;
1089 db = p->db;
drh9b4ea4a2009-04-10 20:32:00 +00001090 assert( db!=0 );
1091 n = sqlite3_column_count(pStmt);
1092 if( N<n && N>=0 ){
1093 N += useType*n;
1094 sqlite3_mutex_enter(db->mutex);
1095 assert( db->mallocFailed==0 );
1096 ret = xFunc(&p->aColName[N]);
1097 /* A malloc may have failed inside of the xFunc() call. If this
1098 ** is the case, clear the mallocFailed flag and return NULL.
1099 */
1100 if( db->mallocFailed ){
1101 db->mallocFailed = 0;
1102 ret = 0;
drh32bc3f62007-08-21 20:25:39 +00001103 }
drh9b4ea4a2009-04-10 20:32:00 +00001104 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +00001105 }
danielk197700fd9572005-12-07 06:27:43 +00001106 return ret;
drh5e2517e2004-09-24 23:59:12 +00001107}
1108
drh4f26d6c2004-05-26 23:25:30 +00001109/*
1110** Return the name of the Nth column of the result set returned by SQL
1111** statement pStmt.
1112*/
1113const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001114 return columnName(
1115 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +00001116}
drhe590fbd2005-05-20 19:36:01 +00001117#ifndef SQLITE_OMIT_UTF16
1118const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001119 return columnName(
1120 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001121}
1122#endif
drh4f26d6c2004-05-26 23:25:30 +00001123
1124/*
drh3f913572008-03-22 01:07:17 +00001125** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1126** not define OMIT_DECLTYPE.
1127*/
1128#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1129# error "Must not define both SQLITE_OMIT_DECLTYPE \
1130 and SQLITE_ENABLE_COLUMN_METADATA"
1131#endif
1132
1133#ifndef SQLITE_OMIT_DECLTYPE
1134/*
drh6c626082004-11-14 21:56:29 +00001135** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001136** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001137*/
1138const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001139 return columnName(
1140 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001141}
drh6c626082004-11-14 21:56:29 +00001142#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001143const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001144 return columnName(
1145 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001146}
drh6c626082004-11-14 21:56:29 +00001147#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001148#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001149
danielk19774b1ae992006-02-10 03:06:10 +00001150#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001151/*
1152** Return the name of the database from which a result column derives.
1153** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001154** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001155*/
1156const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001157 return columnName(
1158 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001159}
1160#ifndef SQLITE_OMIT_UTF16
1161const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001162 return columnName(
1163 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001164}
1165#endif /* SQLITE_OMIT_UTF16 */
1166
1167/*
1168** Return the name of the table from which a result column derives.
1169** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001170** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001171*/
1172const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001173 return columnName(
1174 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001175}
1176#ifndef SQLITE_OMIT_UTF16
1177const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001178 return columnName(
1179 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001180}
1181#endif /* SQLITE_OMIT_UTF16 */
1182
1183/*
1184** Return the name of the table column from which a result column derives.
1185** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001186** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001187*/
1188const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001189 return columnName(
1190 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001191}
1192#ifndef SQLITE_OMIT_UTF16
1193const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001194 return columnName(
1195 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001196}
1197#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001198#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001199
1200
drh4f26d6c2004-05-26 23:25:30 +00001201/******************************* sqlite3_bind_ ***************************
1202**
1203** Routines used to attach values to wildcards in a compiled SQL statement.
1204*/
1205/*
1206** Unbind the value bound to variable i in virtual machine p. This is the
1207** the same as binding a NULL value to the column. If the "i" parameter is
1208** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1209**
drh488e7b62008-10-06 12:46:43 +00001210** A successful evaluation of this routine acquires the mutex on p.
1211** the mutex is released if any kind of error occurs.
1212**
drh4f26d6c2004-05-26 23:25:30 +00001213** The error code stored in database p->db is overwritten with the return
1214** value in any case.
1215*/
1216static int vdbeUnbind(Vdbe *p, int i){
1217 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001218 if( vdbeSafetyNotNull(p) ){
1219 return SQLITE_MISUSE_BKPT;
1220 }
drh488e7b62008-10-06 12:46:43 +00001221 sqlite3_mutex_enter(p->db->mutex);
1222 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001223 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001224 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001225 sqlite3_log(SQLITE_MISUSE,
1226 "bind on a busy prepared statement: [%s]", p->zSql);
1227 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001228 }
1229 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001230 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001231 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001232 return SQLITE_RANGE;
1233 }
1234 i--;
drh290c1942004-08-21 17:54:45 +00001235 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001236 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001237 pVar->flags = MEM_Null;
drh13f40da2014-08-22 18:00:11 +00001238 sqlite3Error(p->db, SQLITE_OK);
dan937d0de2009-10-15 18:35:38 +00001239
dan1d2ce4f2009-10-19 18:11:09 +00001240 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1241 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001242 **
1243 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1244 ** parameter in the WHERE clause might influence the choice of query plan
1245 ** for a statement, then the statement will be automatically recompiled,
1246 ** as if there had been a schema change, on the first sqlite3_step() call
1247 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001248 */
drh823e09a2009-10-19 20:15:38 +00001249 if( p->isPrepareV2 &&
1250 ((i<32 && p->expmask & ((u32)1 << i)) || p->expmask==0xffffffff)
1251 ){
dan937d0de2009-10-15 18:35:38 +00001252 p->expired = 1;
1253 }
drh4f26d6c2004-05-26 23:25:30 +00001254 return SQLITE_OK;
1255}
1256
1257/*
drh5e2517e2004-09-24 23:59:12 +00001258** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001259*/
drh5e2517e2004-09-24 23:59:12 +00001260static int bindText(
drh605264d2007-08-21 15:13:19 +00001261 sqlite3_stmt *pStmt, /* The statement to bind against */
1262 int i, /* Index of the parameter to bind */
1263 const void *zData, /* Pointer to the data to be bound */
1264 int nData, /* Number of bytes of data to be bound */
1265 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001266 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001267){
1268 Vdbe *p = (Vdbe *)pStmt;
1269 Mem *pVar;
1270 int rc;
1271
1272 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001273 if( rc==SQLITE_OK ){
1274 if( zData!=0 ){
1275 pVar = &p->aVar[i-1];
1276 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1277 if( rc==SQLITE_OK && encoding!=0 ){
1278 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1279 }
drh13f40da2014-08-22 18:00:11 +00001280 sqlite3Error(p->db, rc);
drh488e7b62008-10-06 12:46:43 +00001281 rc = sqlite3ApiExit(p->db, rc);
drh27641702007-08-22 02:56:42 +00001282 }
drh488e7b62008-10-06 12:46:43 +00001283 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001284 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001285 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001286 }
drh605264d2007-08-21 15:13:19 +00001287 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001288}
drh5e2517e2004-09-24 23:59:12 +00001289
1290
1291/*
1292** Bind a blob value to an SQL statement variable.
1293*/
1294int sqlite3_bind_blob(
1295 sqlite3_stmt *pStmt,
1296 int i,
1297 const void *zData,
1298 int nData,
1299 void (*xDel)(void*)
1300){
1301 return bindText(pStmt, i, zData, nData, xDel, 0);
1302}
drhda4ca9d2014-09-09 17:27:35 +00001303int sqlite3_bind_blob64(
1304 sqlite3_stmt *pStmt,
1305 int i,
1306 const void *zData,
1307 sqlite3_uint64 nData,
1308 void (*xDel)(void*)
1309){
drhfc59a952014-09-11 23:34:55 +00001310 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001311 if( nData>0x7fffffff ){
1312 return invokeValueDestructor(zData, xDel, 0);
1313 }else{
drh3329a632014-09-18 01:21:43 +00001314 return bindText(pStmt, i, zData, (int)nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001315 }
1316}
drh4f26d6c2004-05-26 23:25:30 +00001317int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1318 int rc;
1319 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001320 rc = vdbeUnbind(p, i);
1321 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001322 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001323 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001324 }
danielk1977f4618892004-06-28 13:09:11 +00001325 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001326}
1327int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001328 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001329}
drhefad9992004-06-22 12:13:55 +00001330int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001331 int rc;
1332 Vdbe *p = (Vdbe *)pStmt;
1333 rc = vdbeUnbind(p, i);
1334 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001335 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001336 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001337 }
1338 return rc;
1339}
drh605264d2007-08-21 15:13:19 +00001340int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1341 int rc;
1342 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001343 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001344 if( rc==SQLITE_OK ){
1345 sqlite3_mutex_leave(p->db->mutex);
1346 }
drh605264d2007-08-21 15:13:19 +00001347 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001348}
1349int sqlite3_bind_text(
1350 sqlite3_stmt *pStmt,
1351 int i,
1352 const char *zData,
1353 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001354 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001355){
drh5e2517e2004-09-24 23:59:12 +00001356 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001357}
drhbbf483f2014-09-09 20:30:24 +00001358int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001359 sqlite3_stmt *pStmt,
1360 int i,
1361 const char *zData,
1362 sqlite3_uint64 nData,
1363 void (*xDel)(void*),
1364 unsigned char enc
1365){
drhfc59a952014-09-11 23:34:55 +00001366 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001367 if( nData>0x7fffffff ){
1368 return invokeValueDestructor(zData, xDel, 0);
1369 }else{
drhfc59a952014-09-11 23:34:55 +00001370 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drh3329a632014-09-18 01:21:43 +00001371 return bindText(pStmt, i, zData, (int)nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001372 }
1373}
drh6c626082004-11-14 21:56:29 +00001374#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001375int sqlite3_bind_text16(
1376 sqlite3_stmt *pStmt,
1377 int i,
1378 const void *zData,
1379 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001380 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001381){
drh5e2517e2004-09-24 23:59:12 +00001382 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001383}
drh6c626082004-11-14 21:56:29 +00001384#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001385int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1386 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001387 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001388 case SQLITE_INTEGER: {
1389 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1390 break;
1391 }
1392 case SQLITE_FLOAT: {
drh74eaba42014-09-18 17:52:15 +00001393 rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
drh29def562009-04-14 12:43:33 +00001394 break;
1395 }
1396 case SQLITE_BLOB: {
1397 if( pValue->flags & MEM_Zero ){
1398 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1399 }else{
1400 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1401 }
1402 break;
1403 }
1404 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001405 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1406 pValue->enc);
1407 break;
1408 }
1409 default: {
1410 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001411 break;
1412 }
danielk197726e41442006-06-14 15:16:35 +00001413 }
1414 return rc;
1415}
drhb026e052007-05-02 01:34:31 +00001416int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1417 int rc;
1418 Vdbe *p = (Vdbe *)pStmt;
1419 rc = vdbeUnbind(p, i);
1420 if( rc==SQLITE_OK ){
1421 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001422 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001423 }
1424 return rc;
1425}
dan80c03022015-07-24 17:36:34 +00001426int sqlite3_bind_zeroblob64(sqlite3_stmt *pStmt, int i, sqlite3_uint64 n){
1427 int rc;
1428 Vdbe *p = (Vdbe *)pStmt;
1429 sqlite3_mutex_enter(p->db->mutex);
1430 if( n>(u64)p->db->aLimit[SQLITE_LIMIT_LENGTH] ){
1431 rc = SQLITE_TOOBIG;
1432 }else{
1433 assert( (n & 0x7FFFFFFF)==n );
1434 rc = sqlite3_bind_zeroblob(pStmt, i, n);
1435 }
1436 rc = sqlite3ApiExit(p->db, rc);
1437 sqlite3_mutex_leave(p->db->mutex);
1438 return rc;
1439}
drh75f6a032004-07-15 14:15:00 +00001440
1441/*
1442** Return the number of wildcards that can be potentially bound to.
1443** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001444*/
1445int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001446 Vdbe *p = (Vdbe*)pStmt;
1447 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001448}
drh895d7472004-08-20 16:02:39 +00001449
1450/*
drhfa6bc002004-09-07 16:19:52 +00001451** Return the name of a wildcard parameter. Return NULL if the index
1452** is out of range or if the wildcard is unnamed.
1453**
1454** The result is always UTF-8.
1455*/
1456const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1457 Vdbe *p = (Vdbe*)pStmt;
drh124c0b42011-06-01 18:15:55 +00001458 if( p==0 || i<1 || i>p->nzVar ){
drhfa6bc002004-09-07 16:19:52 +00001459 return 0;
1460 }
drh895d7472004-08-20 16:02:39 +00001461 return p->azVar[i-1];
1462}
drhfa6bc002004-09-07 16:19:52 +00001463
1464/*
1465** Given a wildcard parameter name, return the index of the variable
1466** with that name. If there is no variable with the given name,
1467** return 0.
1468*/
drh5f18a222009-11-26 14:01:53 +00001469int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drhfa6bc002004-09-07 16:19:52 +00001470 int i;
1471 if( p==0 ){
1472 return 0;
1473 }
drh6a8903c2004-12-10 18:00:04 +00001474 if( zName ){
drh124c0b42011-06-01 18:15:55 +00001475 for(i=0; i<p->nzVar; i++){
drh6a8903c2004-12-10 18:00:04 +00001476 const char *z = p->azVar[i];
drh503a6862013-03-01 01:07:17 +00001477 if( z && strncmp(z,zName,nName)==0 && z[nName]==0 ){
drh6a8903c2004-12-10 18:00:04 +00001478 return i+1;
1479 }
drhfa6bc002004-09-07 16:19:52 +00001480 }
1481 }
1482 return 0;
1483}
drh5f18a222009-11-26 14:01:53 +00001484int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1485 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1486}
drhf8db1bc2005-04-22 02:38:37 +00001487
drh51942bc2005-06-12 22:01:42 +00001488/*
drhf8db1bc2005-04-22 02:38:37 +00001489** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001490*/
shane145834a2008-09-04 12:03:42 +00001491int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001492 Vdbe *pFrom = (Vdbe*)pFromStmt;
1493 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001494 int i;
1495 assert( pTo->db==pFrom->db );
1496 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001497 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001498 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001499 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001500 }
drh27641702007-08-22 02:56:42 +00001501 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001502 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001503}
drh51942bc2005-06-12 22:01:42 +00001504
shaneeec556d2008-10-12 00:27:53 +00001505#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001506/*
shane145834a2008-09-04 12:03:42 +00001507** Deprecated external interface. Internal/core SQLite code
1508** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001509**
peter.d.reid60ec9142014-09-06 16:39:46 +00001510** It is misuse to call this routine with statements from different
drh0f5ea0b2009-04-09 14:02:44 +00001511** database connections. But as this is a deprecated interface, we
1512** will not bother to check for that condition.
1513**
1514** If the two statements contain a different number of bindings, then
1515** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1516** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001517*/
1518int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001519 Vdbe *pFrom = (Vdbe*)pFromStmt;
1520 Vdbe *pTo = (Vdbe*)pToStmt;
1521 if( pFrom->nVar!=pTo->nVar ){
1522 return SQLITE_ERROR;
1523 }
danc94b8592009-10-20 07:01:24 +00001524 if( pTo->isPrepareV2 && pTo->expmask ){
1525 pTo->expired = 1;
1526 }
1527 if( pFrom->isPrepareV2 && pFrom->expmask ){
1528 pFrom->expired = 1;
1529 }
shane145834a2008-09-04 12:03:42 +00001530 return sqlite3TransferBindings(pFromStmt, pToStmt);
1531}
shaneeec556d2008-10-12 00:27:53 +00001532#endif
shane145834a2008-09-04 12:03:42 +00001533
1534/*
drh51942bc2005-06-12 22:01:42 +00001535** Return the sqlite3* database handle to which the prepared statement given
1536** in the argument belongs. This is the same database handle that was
1537** the first argument to the sqlite3_prepare() that was used to create
1538** the statement in the first place.
1539*/
1540sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1541 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1542}
drhbb5a9c32008-06-19 02:52:25 +00001543
1544/*
drhf03d9cc2010-11-16 23:10:25 +00001545** Return true if the prepared statement is guaranteed to not modify the
1546** database.
1547*/
1548int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1549 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1550}
1551
1552/*
drh2fb66932011-11-25 17:21:47 +00001553** Return true if the prepared statement is in need of being reset.
1554*/
1555int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1556 Vdbe *v = (Vdbe*)pStmt;
dan857745c2014-07-19 17:57:10 +00001557 return v!=0 && v->pc>=0 && v->magic==VDBE_MAGIC_RUN;
drh2fb66932011-11-25 17:21:47 +00001558}
1559
1560/*
drhbb5a9c32008-06-19 02:52:25 +00001561** Return a pointer to the next prepared statement after pStmt associated
1562** with database connection pDb. If pStmt is NULL, return the first
1563** prepared statement for the database connection. Return NULL if there
1564** are no more.
1565*/
1566sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1567 sqlite3_stmt *pNext;
drh9ca95732014-10-24 00:35:58 +00001568#ifdef SQLITE_ENABLE_API_ARMOR
1569 if( !sqlite3SafetyCheckOk(pDb) ){
1570 (void)SQLITE_MISUSE_BKPT;
1571 return 0;
1572 }
1573#endif
drhbb5a9c32008-06-19 02:52:25 +00001574 sqlite3_mutex_enter(pDb->mutex);
1575 if( pStmt==0 ){
1576 pNext = (sqlite3_stmt*)pDb->pVdbe;
1577 }else{
1578 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1579 }
1580 sqlite3_mutex_leave(pDb->mutex);
1581 return pNext;
1582}
drhd1d38482008-10-07 23:46:38 +00001583
1584/*
1585** Return the value of a status counter for a prepared statement
1586*/
1587int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1588 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9ca95732014-10-24 00:35:58 +00001589 u32 v;
1590#ifdef SQLITE_ENABLE_API_ARMOR
1591 if( !pStmt ){
1592 (void)SQLITE_MISUSE_BKPT;
1593 return 0;
1594 }
1595#endif
1596 v = pVdbe->aCounter[op];
drh9b47ee32013-08-20 03:13:51 +00001597 if( resetFlag ) pVdbe->aCounter[op] = 0;
1598 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001599}
dan04489b62014-10-31 20:11:32 +00001600
dan6f9702e2014-11-01 20:38:06 +00001601#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan04489b62014-10-31 20:11:32 +00001602/*
1603** Return status data for a single loop within query pStmt.
1604*/
1605int sqlite3_stmt_scanstatus(
drhd1a1c232014-11-03 16:35:55 +00001606 sqlite3_stmt *pStmt, /* Prepared statement being queried */
dan04489b62014-10-31 20:11:32 +00001607 int idx, /* Index of loop to report on */
drhd1a1c232014-11-03 16:35:55 +00001608 int iScanStatusOp, /* Which metric to return */
1609 void *pOut /* OUT: Write the answer here */
dan04489b62014-10-31 20:11:32 +00001610){
1611 Vdbe *p = (Vdbe*)pStmt;
dan037b5322014-11-03 11:25:32 +00001612 ScanStatus *pScan;
dan6f9702e2014-11-01 20:38:06 +00001613 if( idx<0 || idx>=p->nScan ) return 1;
1614 pScan = &p->aScan[idx];
drhd1a1c232014-11-03 16:35:55 +00001615 switch( iScanStatusOp ){
1616 case SQLITE_SCANSTAT_NLOOP: {
1617 *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
1618 break;
1619 }
1620 case SQLITE_SCANSTAT_NVISIT: {
1621 *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
1622 break;
1623 }
1624 case SQLITE_SCANSTAT_EST: {
drh518140e2014-11-06 03:55:10 +00001625 double r = 1.0;
1626 LogEst x = pScan->nEst;
1627 while( x<100 ){
1628 x += 10;
1629 r *= 0.5;
1630 }
1631 *(double*)pOut = r*sqlite3LogEstToInt(x);
drhd1a1c232014-11-03 16:35:55 +00001632 break;
1633 }
1634 case SQLITE_SCANSTAT_NAME: {
dand72219d2014-11-03 16:39:37 +00001635 *(const char**)pOut = pScan->zName;
drhd1a1c232014-11-03 16:35:55 +00001636 break;
1637 }
1638 case SQLITE_SCANSTAT_EXPLAIN: {
1639 if( pScan->addrExplain ){
1640 *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
1641 }else{
1642 *(const char**)pOut = 0;
1643 }
1644 break;
1645 }
drhc6652b12014-11-06 04:42:20 +00001646 case SQLITE_SCANSTAT_SELECTID: {
1647 if( pScan->addrExplain ){
1648 *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
1649 }else{
1650 *(int*)pOut = -1;
1651 }
1652 break;
1653 }
drhd1a1c232014-11-03 16:35:55 +00001654 default: {
1655 return 1;
dan6f9702e2014-11-01 20:38:06 +00001656 }
1657 }
dan04489b62014-10-31 20:11:32 +00001658 return 0;
1659}
1660
1661/*
1662** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
1663*/
1664void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
1665 Vdbe *p = (Vdbe*)pStmt;
dan6f9702e2014-11-01 20:38:06 +00001666 memset(p->anExec, 0, p->nOp * sizeof(i64));
dan04489b62014-10-31 20:11:32 +00001667}
dan6f9702e2014-11-01 20:38:06 +00001668#endif /* SQLITE_ENABLE_STMT_SCANSTATUS */