blob: 0a15633ddff14122a97c4004ef6d18bfd5448b0a [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){
dan5b6c8e42016-01-30 15:46:03 +0000191 Mem *pMem = (Mem*)pVal;
192 return ((pMem->flags & MEM_Subtype) ? pMem->eSubtype : 0);
drhbcdf78a2015-09-10 20:34:56 +0000193}
drh4f26d6c2004-05-26 23:25:30 +0000194const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000195 return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000196}
drh6c626082004-11-14 21:56:29 +0000197#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000198const void *sqlite3_value_text16(sqlite3_value* pVal){
drhb21c8cd2007-08-21 19:33:56 +0000199 return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000200}
danielk1977d8123362004-06-12 09:25:12 +0000201const void *sqlite3_value_text16be(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000202 return sqlite3ValueText(pVal, SQLITE_UTF16BE);
danielk1977d8123362004-06-12 09:25:12 +0000203}
204const void *sqlite3_value_text16le(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000205 return sqlite3ValueText(pVal, SQLITE_UTF16LE);
danielk1977d8123362004-06-12 09:25:12 +0000206}
drh6c626082004-11-14 21:56:29 +0000207#endif /* SQLITE_OMIT_UTF16 */
drh22ec1342015-02-27 00:33:15 +0000208/* EVIDENCE-OF: R-12793-43283 Every value in SQLite has one of five
209** fundamental datatypes: 64-bit signed integer 64-bit IEEE floating
210** point number string BLOB NULL
211*/
drh4f26d6c2004-05-26 23:25:30 +0000212int sqlite3_value_type(sqlite3_value* pVal){
drh1b27b8c2014-02-10 03:21:57 +0000213 static const u8 aType[] = {
214 SQLITE_BLOB, /* 0x00 */
215 SQLITE_NULL, /* 0x01 */
216 SQLITE_TEXT, /* 0x02 */
217 SQLITE_NULL, /* 0x03 */
218 SQLITE_INTEGER, /* 0x04 */
219 SQLITE_NULL, /* 0x05 */
220 SQLITE_INTEGER, /* 0x06 */
221 SQLITE_NULL, /* 0x07 */
222 SQLITE_FLOAT, /* 0x08 */
223 SQLITE_NULL, /* 0x09 */
224 SQLITE_FLOAT, /* 0x0a */
225 SQLITE_NULL, /* 0x0b */
226 SQLITE_INTEGER, /* 0x0c */
227 SQLITE_NULL, /* 0x0d */
228 SQLITE_INTEGER, /* 0x0e */
229 SQLITE_NULL, /* 0x0f */
230 SQLITE_BLOB, /* 0x10 */
231 SQLITE_NULL, /* 0x11 */
232 SQLITE_TEXT, /* 0x12 */
233 SQLITE_NULL, /* 0x13 */
234 SQLITE_INTEGER, /* 0x14 */
235 SQLITE_NULL, /* 0x15 */
236 SQLITE_INTEGER, /* 0x16 */
237 SQLITE_NULL, /* 0x17 */
238 SQLITE_FLOAT, /* 0x18 */
239 SQLITE_NULL, /* 0x19 */
240 SQLITE_FLOAT, /* 0x1a */
241 SQLITE_NULL, /* 0x1b */
242 SQLITE_INTEGER, /* 0x1c */
243 SQLITE_NULL, /* 0x1d */
244 SQLITE_INTEGER, /* 0x1e */
245 SQLITE_NULL, /* 0x1f */
246 };
mistachkinafc14f72014-03-05 01:29:18 +0000247 return aType[pVal->flags&MEM_AffMask];
drh4f26d6c2004-05-26 23:25:30 +0000248}
249
drh4f03f412015-05-20 21:28:32 +0000250/* Make a copy of an sqlite3_value object
251*/
252sqlite3_value *sqlite3_value_dup(const sqlite3_value *pOrig){
253 sqlite3_value *pNew;
254 if( pOrig==0 ) return 0;
255 pNew = sqlite3_malloc( sizeof(*pNew) );
256 if( pNew==0 ) return 0;
257 memset(pNew, 0, sizeof(*pNew));
258 memcpy(pNew, pOrig, MEMCELLSIZE);
259 pNew->flags &= ~MEM_Dyn;
260 pNew->db = 0;
261 if( pNew->flags&(MEM_Str|MEM_Blob) ){
drh10ca5b42015-05-22 21:04:54 +0000262 pNew->flags &= ~(MEM_Static|MEM_Dyn);
263 pNew->flags |= MEM_Ephem;
264 if( sqlite3VdbeMemMakeWriteable(pNew)!=SQLITE_OK ){
265 sqlite3ValueFree(pNew);
266 pNew = 0;
drh4f03f412015-05-20 21:28:32 +0000267 }
268 }
269 return pNew;
270}
271
272/* Destroy an sqlite3_value object previously obtained from
273** sqlite3_value_dup().
274*/
275void sqlite3_value_free(sqlite3_value *pOld){
276 sqlite3ValueFree(pOld);
277}
278
279
drh4f26d6c2004-05-26 23:25:30 +0000280/**************************** sqlite3_result_ *******************************
281** The following routines are used by user-defined functions to specify
282** the function result.
drh4c8555f2009-06-25 01:47:11 +0000283**
peter.d.reid60ec9142014-09-06 16:39:46 +0000284** The setStrOrError() function calls sqlite3VdbeMemSetStr() to store the
drh4c8555f2009-06-25 01:47:11 +0000285** result as a string or blob but if the string or blob is too large, it
286** then sets the error code to SQLITE_TOOBIG
drhda4ca9d2014-09-09 17:27:35 +0000287**
288** The invokeValueDestructor(P,X) routine invokes destructor function X()
289** on value P is not going to be used and need to be destroyed.
drh4f26d6c2004-05-26 23:25:30 +0000290*/
drh4c8555f2009-06-25 01:47:11 +0000291static void setResultStrOrError(
292 sqlite3_context *pCtx, /* Function context */
293 const char *z, /* String pointer */
294 int n, /* Bytes in string, or negative */
295 u8 enc, /* Encoding of z. 0 for BLOBs */
296 void (*xDel)(void*) /* Destructor function */
297){
drh9bd038f2014-08-27 14:14:06 +0000298 if( sqlite3VdbeMemSetStr(pCtx->pOut, z, n, enc, xDel)==SQLITE_TOOBIG ){
drh4c8555f2009-06-25 01:47:11 +0000299 sqlite3_result_error_toobig(pCtx);
300 }
301}
drhda4ca9d2014-09-09 17:27:35 +0000302static int invokeValueDestructor(
303 const void *p, /* Value to destroy */
304 void (*xDel)(void*), /* The destructor */
305 sqlite3_context *pCtx /* Set a SQLITE_TOOBIG error if no NULL */
306){
drhfc59a952014-09-11 23:34:55 +0000307 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000308 if( xDel==0 ){
309 /* noop */
310 }else if( xDel==SQLITE_TRANSIENT ){
311 /* noop */
drhda4ca9d2014-09-09 17:27:35 +0000312 }else{
313 xDel((void*)p);
314 }
315 if( pCtx ) sqlite3_result_error_toobig(pCtx);
316 return SQLITE_TOOBIG;
317}
drh4f26d6c2004-05-26 23:25:30 +0000318void sqlite3_result_blob(
319 sqlite3_context *pCtx,
320 const void *z,
321 int n,
danielk1977d8123362004-06-12 09:25:12 +0000322 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000323){
drh5708d2d2005-06-22 10:53:59 +0000324 assert( n>=0 );
drh9bd038f2014-08-27 14:14:06 +0000325 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000326 setResultStrOrError(pCtx, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000327}
drhda4ca9d2014-09-09 17:27:35 +0000328void sqlite3_result_blob64(
329 sqlite3_context *pCtx,
330 const void *z,
331 sqlite3_uint64 n,
332 void (*xDel)(void *)
333){
334 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000335 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000336 if( n>0x7fffffff ){
337 (void)invokeValueDestructor(z, xDel, pCtx);
338 }else{
339 setResultStrOrError(pCtx, z, (int)n, 0, xDel);
340 }
341}
drh4f26d6c2004-05-26 23:25:30 +0000342void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
drh9bd038f2014-08-27 14:14:06 +0000343 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
344 sqlite3VdbeMemSetDouble(pCtx->pOut, rVal);
drh4f26d6c2004-05-26 23:25:30 +0000345}
346void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000347 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000348 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000349 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000350 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000351}
danielk1977a1686c92006-01-23 07:52:37 +0000352#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000353void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000354 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000355 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000356 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000357 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000358}
danielk1977a1686c92006-01-23 07:52:37 +0000359#endif
drhf4479502004-05-27 03:12:53 +0000360void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh9bd038f2014-08-27 14:14:06 +0000361 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
362 sqlite3VdbeMemSetInt64(pCtx->pOut, (i64)iVal);
drh4f26d6c2004-05-26 23:25:30 +0000363}
364void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
drh9bd038f2014-08-27 14:14:06 +0000365 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
366 sqlite3VdbeMemSetInt64(pCtx->pOut, iVal);
drh4f26d6c2004-05-26 23:25:30 +0000367}
368void sqlite3_result_null(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000369 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
370 sqlite3VdbeMemSetNull(pCtx->pOut);
drh4f26d6c2004-05-26 23:25:30 +0000371}
drhbcdf78a2015-09-10 20:34:56 +0000372void sqlite3_result_subtype(sqlite3_context *pCtx, unsigned int eSubtype){
dan5b6c8e42016-01-30 15:46:03 +0000373 Mem *pOut = pCtx->pOut;
374 assert( sqlite3_mutex_held(pOut->db->mutex) );
375 pOut->eSubtype = eSubtype & 0xff;
376 pOut->flags |= MEM_Subtype;
drhbcdf78a2015-09-10 20:34:56 +0000377}
drh4f26d6c2004-05-26 23:25:30 +0000378void sqlite3_result_text(
379 sqlite3_context *pCtx,
380 const char *z,
381 int n,
danielk1977d8123362004-06-12 09:25:12 +0000382 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000383){
drh9bd038f2014-08-27 14:14:06 +0000384 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000385 setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000386}
drhbbf483f2014-09-09 20:30:24 +0000387void sqlite3_result_text64(
drhda4ca9d2014-09-09 17:27:35 +0000388 sqlite3_context *pCtx,
389 const char *z,
390 sqlite3_uint64 n,
391 void (*xDel)(void *),
392 unsigned char enc
393){
394 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000395 assert( xDel!=SQLITE_DYNAMIC );
drh79f7af92014-10-03 16:00:51 +0000396 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drhda4ca9d2014-09-09 17:27:35 +0000397 if( n>0x7fffffff ){
398 (void)invokeValueDestructor(z, xDel, pCtx);
399 }else{
400 setResultStrOrError(pCtx, z, (int)n, enc, xDel);
401 }
402}
drh6c626082004-11-14 21:56:29 +0000403#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000404void sqlite3_result_text16(
405 sqlite3_context *pCtx,
406 const void *z,
407 int n,
danielk1977d8123362004-06-12 09:25:12 +0000408 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000409){
drh9bd038f2014-08-27 14:14:06 +0000410 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000411 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000412}
413void sqlite3_result_text16be(
414 sqlite3_context *pCtx,
415 const void *z,
416 int n,
417 void (*xDel)(void *)
418){
drh9bd038f2014-08-27 14:14:06 +0000419 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000420 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000421}
422void sqlite3_result_text16le(
423 sqlite3_context *pCtx,
424 const void *z,
425 int n,
426 void (*xDel)(void *)
427){
drh9bd038f2014-08-27 14:14:06 +0000428 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000429 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000430}
drh6c626082004-11-14 21:56:29 +0000431#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000432void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh9bd038f2014-08-27 14:14:06 +0000433 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
434 sqlite3VdbeMemCopy(pCtx->pOut, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000435}
drhb026e052007-05-02 01:34:31 +0000436void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh9bd038f2014-08-27 14:14:06 +0000437 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
438 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
drhb026e052007-05-02 01:34:31 +0000439}
dana4d5ae82015-07-24 16:24:37 +0000440int sqlite3_result_zeroblob64(sqlite3_context *pCtx, u64 n){
441 Mem *pOut = pCtx->pOut;
442 assert( sqlite3_mutex_held(pOut->db->mutex) );
drh6bacdc22015-07-24 17:14:03 +0000443 if( n>(u64)pOut->db->aLimit[SQLITE_LIMIT_LENGTH] ){
dana4d5ae82015-07-24 16:24:37 +0000444 return SQLITE_TOOBIG;
445 }
446 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, (int)n);
447 return SQLITE_OK;
448}
drh69544ec2008-02-06 14:11:34 +0000449void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
450 pCtx->isError = errCode;
drh9b47ee32013-08-20 03:13:51 +0000451 pCtx->fErrorOrAux = 1;
drh983b5ee2015-02-13 12:05:56 +0000452#ifdef SQLITE_DEBUG
drh96f4ad22015-03-12 21:02:36 +0000453 if( pCtx->pVdbe ) pCtx->pVdbe->rcApp = errCode;
drh983b5ee2015-02-13 12:05:56 +0000454#endif
drh9bd038f2014-08-27 14:14:06 +0000455 if( pCtx->pOut->flags & MEM_Null ){
456 sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
drh51c7d862009-04-27 18:46:06 +0000457 SQLITE_UTF8, SQLITE_STATIC);
458 }
drh69544ec2008-02-06 14:11:34 +0000459}
drh4f26d6c2004-05-26 23:25:30 +0000460
drha0206bc2007-05-08 15:15:02 +0000461/* Force an SQLITE_TOOBIG error. */
462void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000463 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000464 pCtx->isError = SQLITE_TOOBIG;
drh9b47ee32013-08-20 03:13:51 +0000465 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000466 sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
drhbb4957f2008-03-20 14:03:29 +0000467 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000468}
469
danielk1977a1644fd2007-08-29 12:31:25 +0000470/* An SQLITE_NOMEM error. */
471void sqlite3_result_error_nomem(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000472 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
473 sqlite3VdbeMemSetNull(pCtx->pOut);
drh69544ec2008-02-06 14:11:34 +0000474 pCtx->isError = SQLITE_NOMEM;
drh9b47ee32013-08-20 03:13:51 +0000475 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000476 pCtx->pOut->db->mallocFailed = 1;
danielk1977a1644fd2007-08-29 12:31:25 +0000477}
drh4f26d6c2004-05-26 23:25:30 +0000478
dan5cf53532010-05-01 16:40:20 +0000479/*
480** This function is called after a transaction has been committed. It
481** invokes callbacks registered with sqlite3_wal_hook() as required.
482*/
drh7ed91f22010-04-29 22:34:07 +0000483static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000484 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000485#ifndef SQLITE_OMIT_WAL
486 int i;
dan8d22a172010-04-19 18:03:51 +0000487 for(i=0; i<db->nDb; i++){
488 Btree *pBt = db->aDb[i].pBt;
489 if( pBt ){
drhef15c6e2014-12-12 01:27:17 +0000490 int nEntry;
491 sqlite3BtreeEnter(pBt);
492 nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
493 sqlite3BtreeLeave(pBt);
drh5def0842010-05-05 20:00:25 +0000494 if( db->xWalCallback && nEntry>0 && rc==SQLITE_OK ){
495 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000496 }
497 }
498 }
dan5cf53532010-05-01 16:40:20 +0000499#endif
dan8d22a172010-04-19 18:03:51 +0000500 return rc;
501}
502
drh201e0c62015-07-14 14:48:50 +0000503
drh4f26d6c2004-05-26 23:25:30 +0000504/*
505** Execute the statement pStmt, either until a row of data is ready, the
506** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000507**
508** This routine implements the bulk of the logic behind the sqlite_step()
509** API. The only thing omitted is the automatic recompile if a
510** schema change has occurred. That detail is handled by the
511** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000512*/
drhb900aaf2006-11-09 00:24:53 +0000513static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000514 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000515 int rc;
516
danielk1977a185ddb2007-11-15 16:04:15 +0000517 assert(p);
518 if( p->magic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000519 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000520 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
521 ** with version 3.7.0, we changed this so that sqlite3_reset() would
522 ** be called automatically instead of throwing the SQLITE_MISUSE error.
523 ** This "automatic-reset" change is not technically an incompatibility,
524 ** since any application that receives an SQLITE_MISUSE is broken by
525 ** definition.
526 **
527 ** Nevertheless, some published applications that were originally written
528 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000529 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000530 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
531 ** legacy behavior of returning SQLITE_MISUSE for cases where the
532 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
533 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000534 */
drh602acb42011-01-17 17:42:37 +0000535#ifdef SQLITE_OMIT_AUTORESET
drh983b5ee2015-02-13 12:05:56 +0000536 if( (rc = p->rc&0xff)==SQLITE_BUSY || rc==SQLITE_LOCKED ){
drh602acb42011-01-17 17:42:37 +0000537 sqlite3_reset((sqlite3_stmt*)p);
538 }else{
539 return SQLITE_MISUSE_BKPT;
540 }
541#else
drh3674bfd2010-04-17 12:53:19 +0000542 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000543#endif
drhf1bfe9a2007-10-17 01:44:20 +0000544 }
545
dan14d4cc42010-01-20 14:25:37 +0000546 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000547 db = p->db;
drhc456e572008-08-11 18:44:58 +0000548 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000549 p->rc = SQLITE_NOMEM;
drhc456e572008-08-11 18:44:58 +0000550 return SQLITE_NOMEM;
551 }
danielk1977261919c2005-12-06 12:52:59 +0000552
danielk1977a21c6b62005-01-24 10:25:59 +0000553 if( p->pc<=0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000554 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000555 rc = SQLITE_ERROR;
556 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000557 }
danielk19771d850a72004-05-31 08:26:49 +0000558 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000559 /* If there are no other statements currently running, then
560 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
561 ** from interrupting a statement that has not yet started.
562 */
drh4f7d3a52013-06-27 23:54:02 +0000563 if( db->nVdbeActive==0 ){
drh15ca1df2006-07-26 13:43:30 +0000564 db->u1.isInterrupted = 0;
565 }
566
drh648e2642013-07-11 15:03:32 +0000567 assert( db->nVdbeWrite>0 || db->autoCommit==0
568 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
569 );
dan1da40a32009-09-19 17:00:31 +0000570
drh19e2d372005-08-29 23:00:03 +0000571#ifndef SQLITE_OMIT_TRACE
drh201e0c62015-07-14 14:48:50 +0000572 if( db->xProfile && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000573 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh201e0c62015-07-14 14:48:50 +0000574 }else{
575 assert( p->startTime==0 );
drh19e2d372005-08-29 23:00:03 +0000576 }
577#endif
drhc16a03b2004-09-15 13:38:10 +0000578
drh4f7d3a52013-06-27 23:54:02 +0000579 db->nVdbeActive++;
580 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000581 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000582 p->pc = 0;
583 }
drh983b5ee2015-02-13 12:05:56 +0000584#ifdef SQLITE_DEBUG
585 p->rcApp = SQLITE_OK;
586#endif
drhb7f91642004-10-31 02:22:47 +0000587#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000588 if( p->explain ){
589 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000590 }else
591#endif /* SQLITE_OMIT_EXPLAIN */
592 {
drh4f7d3a52013-06-27 23:54:02 +0000593 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000594 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000595 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000596 }
597
drh19e2d372005-08-29 23:00:03 +0000598#ifndef SQLITE_OMIT_TRACE
drh201e0c62015-07-14 14:48:50 +0000599 /* If the statement completed successfully, invoke the profile callback */
600 if( rc!=SQLITE_ROW ) checkProfileCallback(db, p);
drh19e2d372005-08-29 23:00:03 +0000601#endif
602
dan8d22a172010-04-19 18:03:51 +0000603 if( rc==SQLITE_DONE ){
604 assert( p->rc==SQLITE_OK );
drh7ed91f22010-04-29 22:34:07 +0000605 p->rc = doWalCallbacks(db);
dan8d22a172010-04-19 18:03:51 +0000606 if( p->rc!=SQLITE_OK ){
607 rc = SQLITE_ERROR;
608 }
609 }
610
drh80cc85b2008-07-23 21:07:25 +0000611 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000612 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
613 p->rc = SQLITE_NOMEM;
drhb900aaf2006-11-09 00:24:53 +0000614 }
danielk1977357864e2009-03-25 15:43:08 +0000615end_of_step:
616 /* At this point local variable rc holds the value that should be
617 ** returned if this statement was compiled using the legacy
618 ** sqlite3_prepare() interface. According to the docs, this can only
619 ** be one of the values in the first assert() below. Variable p->rc
620 ** contains the value that would be returned if sqlite3_finalize()
621 ** were called on statement p.
622 */
623 assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
drhcbd8db32015-08-20 17:18:32 +0000624 || (rc&0xff)==SQLITE_BUSY || rc==SQLITE_MISUSE
danielk1977357864e2009-03-25 15:43:08 +0000625 );
drh983b5ee2015-02-13 12:05:56 +0000626 assert( (p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE) || p->rc==p->rcApp );
danielk1977357864e2009-03-25 15:43:08 +0000627 if( p->isPrepareV2 && rc!=SQLITE_ROW && rc!=SQLITE_DONE ){
628 /* If this statement was prepared using sqlite3_prepare_v2(), and an
mistachkin48864df2013-03-21 21:20:32 +0000629 ** error has occurred, then return the error code in p->rc to the
danielk1977357864e2009-03-25 15:43:08 +0000630 ** caller. Set the error code in the database handle to the same value.
631 */
dan029ead62011-10-27 15:19:58 +0000632 rc = sqlite3VdbeTransferError(p);
danielk1977357864e2009-03-25 15:43:08 +0000633 }
634 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000635}
636
637/*
638** This is the top-level implementation of sqlite3_step(). Call
639** sqlite3Step() to do most of the work. If a schema error occurs,
640** call sqlite3Reprepare() and try again.
641*/
drhb900aaf2006-11-09 00:24:53 +0000642int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000643 int rc = SQLITE_OK; /* Result from sqlite3Step() */
644 int rc2 = SQLITE_OK; /* Result from sqlite3Reprepare() */
645 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
646 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
647 sqlite3 *db; /* The database connection */
648
drh413c3d32010-02-23 20:11:56 +0000649 if( vdbeSafetyNotNull(v) ){
650 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000651 }
drh413c3d32010-02-23 20:11:56 +0000652 db = v->db;
653 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000654 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000655 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh2c7946a2014-08-19 20:27:40 +0000656 && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
657 int savedPc = v->pc;
658 rc2 = rc = sqlite3Reprepare(v);
659 if( rc!=SQLITE_OK) break;
drh413c3d32010-02-23 20:11:56 +0000660 sqlite3_reset(pStmt);
drh5f58ae72014-08-19 20:41:36 +0000661 if( savedPc>=0 ) v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000662 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000663 }
drha3cc0072013-12-13 16:23:55 +0000664 if( rc2!=SQLITE_OK ){
drh413c3d32010-02-23 20:11:56 +0000665 /* This case occurs after failing to recompile an sql statement.
666 ** The error message from the SQL compiler has already been loaded
667 ** into the database handle. This block copies the error message
668 ** from the database handle into the statement and sets the statement
669 ** program counter to 0 to ensure that when the statement is
670 ** finalized or reset the parser error message is available via
671 ** sqlite3_errmsg() and sqlite3_errcode().
672 */
673 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
674 sqlite3DbFree(db, v->zErrMsg);
675 if( !db->mallocFailed ){
676 v->zErrMsg = sqlite3DbStrDup(db, zErr);
drha6129fa2010-02-24 17:15:19 +0000677 v->rc = rc2;
drh413c3d32010-02-23 20:11:56 +0000678 } else {
679 v->zErrMsg = 0;
drha6129fa2010-02-24 17:15:19 +0000680 v->rc = rc = SQLITE_NOMEM;
drh413c3d32010-02-23 20:11:56 +0000681 }
682 }
683 rc = sqlite3ApiExit(db, rc);
684 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000685 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000686}
687
drh95a7b3e2013-09-16 12:57:19 +0000688
drh4f26d6c2004-05-26 23:25:30 +0000689/*
drheb2e1762004-05-27 01:53:56 +0000690** Extract the user data from a sqlite3_context structure and return a
691** pointer to it.
692*/
693void *sqlite3_user_data(sqlite3_context *p){
694 assert( p && p->pFunc );
695 return p->pFunc->pUserData;
696}
697
698/*
drhfa4a4b92008-03-19 21:45:51 +0000699** Extract the user data from a sqlite3_context structure and return a
700** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000701**
702** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
703** returns a copy of the pointer to the database connection (the 1st
704** parameter) of the sqlite3_create_function() and
705** sqlite3_create_function16() routines that originally registered the
706** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000707*/
708sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
drha46a4a62015-09-08 21:12:53 +0000709 assert( p && p->pOut );
drh9bd038f2014-08-27 14:14:06 +0000710 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000711}
712
713/*
drha9e03b12015-03-12 06:46:52 +0000714** Return the current time for a statement. If the current time
715** is requested more than once within the same run of a single prepared
716** statement, the exact same time is returned for each invocation regardless
717** of the amount of time that elapses between invocations. In other words,
718** the time returned is always the time of the first call.
drh95a7b3e2013-09-16 12:57:19 +0000719*/
720sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
drh95a7b3e2013-09-16 12:57:19 +0000721 int rc;
drha9e03b12015-03-12 06:46:52 +0000722#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
drh3df79a92015-03-12 23:48:27 +0000723 sqlite3_int64 *piTime = &p->pVdbe->iCurrentTime;
drha9e03b12015-03-12 06:46:52 +0000724 assert( p->pVdbe!=0 );
725#else
drh3df79a92015-03-12 23:48:27 +0000726 sqlite3_int64 iTime = 0;
drha9e03b12015-03-12 06:46:52 +0000727 sqlite3_int64 *piTime = p->pVdbe!=0 ? &p->pVdbe->iCurrentTime : &iTime;
drha9e03b12015-03-12 06:46:52 +0000728#endif
drh3df79a92015-03-12 23:48:27 +0000729 if( *piTime==0 ){
drha9e03b12015-03-12 06:46:52 +0000730 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, piTime);
731 if( rc ) *piTime = 0;
732 }
733 return *piTime;
drh95a7b3e2013-09-16 12:57:19 +0000734}
735
736/*
drhb7481e72006-09-16 21:45:14 +0000737** The following is the implementation of an SQL function that always
738** fails with an error message stating that the function is used in the
739** wrong context. The sqlite3_overload_function() API might construct
740** SQL function that use this routine so that the functions will exist
741** for name resolution but are actually overloaded by the xFindFunction
742** method of virtual tables.
743*/
744void sqlite3InvalidFunction(
745 sqlite3_context *context, /* The function calling context */
danielk197762c14b32008-11-19 09:05:26 +0000746 int NotUsed, /* Number of arguments to the function */
747 sqlite3_value **NotUsed2 /* Value of each argument */
drhb7481e72006-09-16 21:45:14 +0000748){
749 const char *zName = context->pFunc->zName;
750 char *zErr;
danielk197762c14b32008-11-19 09:05:26 +0000751 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhbc6160b2009-04-08 15:45:31 +0000752 zErr = sqlite3_mprintf(
drhb7481e72006-09-16 21:45:14 +0000753 "unable to use function %s in the requested context", zName);
754 sqlite3_result_error(context, zErr, -1);
danielk19771e536952007-08-16 10:09:01 +0000755 sqlite3_free(zErr);
drhb7481e72006-09-16 21:45:14 +0000756}
757
758/*
drh9de4a172014-08-23 18:17:19 +0000759** Create a new aggregate context for p and return a pointer to
760** its pMem->z element.
761*/
762static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
763 Mem *pMem = p->pMem;
764 assert( (pMem->flags & MEM_Agg)==0 );
765 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000766 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000767 pMem->z = 0;
768 }else{
drh322f2852014-09-19 00:43:39 +0000769 sqlite3VdbeMemClearAndResize(pMem, nByte);
drh9de4a172014-08-23 18:17:19 +0000770 pMem->flags = MEM_Agg;
771 pMem->u.pDef = p->pFunc;
772 if( pMem->z ){
773 memset(pMem->z, 0, nByte);
774 }
775 }
776 return (void*)pMem->z;
777}
778
779/*
drheb2e1762004-05-27 01:53:56 +0000780** Allocate or return the aggregate context for a user function. A new
781** context is allocated on the first call. Subsequent calls return the
782** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000783*/
784void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh2d801512016-01-14 22:19:58 +0000785 assert( p && p->pFunc && p->pFunc->xFinalize );
drh9bd038f2014-08-27 14:14:06 +0000786 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000787 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000788 if( (p->pMem->flags & MEM_Agg)==0 ){
789 return createAggContext(p, nByte);
790 }else{
791 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000792 }
drheb2e1762004-05-27 01:53:56 +0000793}
794
795/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000796** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000797** the user-function defined by pCtx.
798*/
799void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000800 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000801
drh9bd038f2014-08-27 14:14:06 +0000802 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drha9e03b12015-03-12 06:46:52 +0000803#if SQLITE_ENABLE_STAT3_OR_STAT4
dan18bf8072015-03-11 20:06:40 +0000804 if( pCtx->pVdbe==0 ) return 0;
drha9e03b12015-03-12 06:46:52 +0000805#else
806 assert( pCtx->pVdbe!=0 );
807#endif
dan0c547792013-07-18 17:12:08 +0000808 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
809 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
danielk1977682f68b2004-06-05 10:22:17 +0000810 }
dan0c547792013-07-18 17:12:08 +0000811
812 return (pAuxData ? pAuxData->pAux : 0);
danielk1977682f68b2004-06-05 10:22:17 +0000813}
814
815/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000816** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000817** argument to the user-function defined by pCtx. Any previous value is
818** deleted by calling the delete function specified when it was set.
819*/
820void sqlite3_set_auxdata(
821 sqlite3_context *pCtx,
822 int iArg,
823 void *pAux,
824 void (*xDelete)(void*)
825){
dan0c547792013-07-18 17:12:08 +0000826 AuxData *pAuxData;
827 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000828
drh9bd038f2014-08-27 14:14:06 +0000829 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000830 if( iArg<0 ) goto failed;
drha9e03b12015-03-12 06:46:52 +0000831#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan18bf8072015-03-11 20:06:40 +0000832 if( pVdbe==0 ) goto failed;
drha9e03b12015-03-12 06:46:52 +0000833#else
834 assert( pVdbe!=0 );
835#endif
danielk1977682f68b2004-06-05 10:22:17 +0000836
dan0c547792013-07-18 17:12:08 +0000837 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
838 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
839 }
840 if( pAuxData==0 ){
841 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
842 if( !pAuxData ) goto failed;
843 pAuxData->iOp = pCtx->iOp;
844 pAuxData->iArg = iArg;
845 pAuxData->pNext = pVdbe->pAuxData;
846 pVdbe->pAuxData = pAuxData;
drh9b47ee32013-08-20 03:13:51 +0000847 if( pCtx->fErrorOrAux==0 ){
848 pCtx->isError = 0;
849 pCtx->fErrorOrAux = 1;
850 }
dan0c547792013-07-18 17:12:08 +0000851 }else if( pAuxData->xDelete ){
danielk1977682f68b2004-06-05 10:22:17 +0000852 pAuxData->xDelete(pAuxData->pAux);
853 }
dan0c547792013-07-18 17:12:08 +0000854
danielk1977682f68b2004-06-05 10:22:17 +0000855 pAuxData->pAux = pAux;
856 pAuxData->xDelete = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000857 return;
858
859failed:
860 if( xDelete ){
861 xDelete(pAux);
862 }
danielk1977682f68b2004-06-05 10:22:17 +0000863}
864
shaneeec556d2008-10-12 00:27:53 +0000865#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000866/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000867** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000868** called.
869**
drhcf85a512006-02-09 18:35:29 +0000870** This function is deprecated. Do not use it for new code. It is
871** provide only to avoid breaking legacy code. New aggregate function
872** implementations should keep their own counts within their aggregate
873** context.
drheb2e1762004-05-27 01:53:56 +0000874*/
875int sqlite3_aggregate_count(sqlite3_context *p){
drh2d801512016-01-14 22:19:58 +0000876 assert( p && p->pMem && p->pFunc && p->pFunc->xFinalize );
drhabfcea22005-09-06 20:36:48 +0000877 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000878}
shaneeec556d2008-10-12 00:27:53 +0000879#endif
drheb2e1762004-05-27 01:53:56 +0000880
881/*
drh4f26d6c2004-05-26 23:25:30 +0000882** Return the number of columns in the result set for the statement pStmt.
883*/
884int sqlite3_column_count(sqlite3_stmt *pStmt){
885 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000886 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000887}
888
889/*
890** Return the number of values available from the current row of the
891** currently executing statement pStmt.
892*/
893int sqlite3_data_count(sqlite3_stmt *pStmt){
894 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000895 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000896 return pVm->nResColumn;
897}
898
drhb1a1c292014-03-05 12:47:55 +0000899/*
900** Return a pointer to static memory containing an SQL NULL value.
901*/
902static const Mem *columnNullValue(void){
903 /* Even though the Mem structure contains an element
904 ** of type i64, on certain architectures (x86) with certain compiler
905 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
906 ** instead of an 8-byte one. This all works fine, except that when
907 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
908 ** that a Mem structure is located on an 8-byte boundary. To prevent
909 ** these assert()s from failing, when building with SQLITE_DEBUG defined
910 ** using gcc, we force nullMem to be 8-byte aligned using the magical
911 ** __attribute__((aligned(8))) macro. */
912 static const Mem nullMem
913#if defined(SQLITE_DEBUG) && defined(__GNUC__)
914 __attribute__((aligned(8)))
915#endif
drh035e5632014-09-16 14:16:31 +0000916 = {
drh3329a632014-09-18 01:21:43 +0000917 /* .u = */ {0},
drh8faee872015-09-19 18:08:13 +0000918 /* .flags = */ (u16)MEM_Null,
919 /* .enc = */ (u8)0,
920 /* .eSubtype = */ (u8)0,
921 /* .n = */ (int)0,
922 /* .z = */ (char*)0,
923 /* .zMalloc = */ (char*)0,
924 /* .szMalloc = */ (int)0,
925 /* .uTemp = */ (u32)0,
926 /* .db = */ (sqlite3*)0,
927 /* .xDel = */ (void(*)(void*))0,
drhb1a1c292014-03-05 12:47:55 +0000928#ifdef SQLITE_DEBUG
drh8faee872015-09-19 18:08:13 +0000929 /* .pScopyFrom = */ (Mem*)0,
930 /* .pFiller = */ (void*)0,
drhb1a1c292014-03-05 12:47:55 +0000931#endif
drh035e5632014-09-16 14:16:31 +0000932 };
drhb1a1c292014-03-05 12:47:55 +0000933 return &nullMem;
934}
drh4f26d6c2004-05-26 23:25:30 +0000935
936/*
937** Check to see if column iCol of the given statement is valid. If
938** it is, return a pointer to the Mem for the value of that column.
939** If iCol is not valid, return a pointer to a Mem which has a value
940** of NULL.
941*/
942static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000943 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000944 Mem *pOut;
945
946 pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000947 if( pVm && pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drh32bc3f62007-08-21 20:25:39 +0000948 sqlite3_mutex_enter(pVm->db->mutex);
drhd4e70eb2008-01-02 00:34:36 +0000949 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +0000950 }else{
drh9b4ea4a2009-04-10 20:32:00 +0000951 if( pVm && ALWAYS(pVm->db) ){
drh27641702007-08-22 02:56:42 +0000952 sqlite3_mutex_enter(pVm->db->mutex);
drh13f40da2014-08-22 18:00:11 +0000953 sqlite3Error(pVm->db, SQLITE_RANGE);
drh27641702007-08-22 02:56:42 +0000954 }
drhb1a1c292014-03-05 12:47:55 +0000955 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +0000956 }
drh32bc3f62007-08-21 20:25:39 +0000957 return pOut;
drh4f26d6c2004-05-26 23:25:30 +0000958}
959
danielk19772e588c72005-12-09 14:25:08 +0000960/*
961** This function is called after invoking an sqlite3_value_XXX function on a
962** column value (i.e. a value returned by evaluating an SQL expression in the
963** select list of a SELECT statement) that may cause a malloc() failure. If
964** malloc() has failed, the threads mallocFailed flag is cleared and the result
965** code of statement pStmt set to SQLITE_NOMEM.
966**
drh32bc3f62007-08-21 20:25:39 +0000967** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +0000968**
969** sqlite3_column_int()
970** sqlite3_column_int64()
971** sqlite3_column_text()
972** sqlite3_column_text16()
973** sqlite3_column_real()
974** sqlite3_column_bytes()
975** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +0000976** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +0000977*/
978static void columnMallocFailure(sqlite3_stmt *pStmt)
979{
980 /* If malloc() failed during an encoding conversion within an
981 ** sqlite3_column_XXX API, then set the return code of the statement to
982 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
983 ** and _finalize() will return NOMEM.
984 */
danielk197754f01982006-01-18 15:25:17 +0000985 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000986 if( p ){
987 p->rc = sqlite3ApiExit(p->db, p->rc);
988 sqlite3_mutex_leave(p->db->mutex);
989 }
danielk19772e588c72005-12-09 14:25:08 +0000990}
991
drh4f26d6c2004-05-26 23:25:30 +0000992/**************************** sqlite3_column_ *******************************
993** The following routines are used to access elements of the current row
994** in the result set.
995*/
danielk1977c572ef72004-05-27 09:28:41 +0000996const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000997 const void *val;
danielk19772e588c72005-12-09 14:25:08 +0000998 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +0000999 /* Even though there is no encoding conversion, value_blob() might
1000 ** need to call malloc() to expand the result of a zeroblob()
1001 ** expression.
1002 */
1003 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +00001004 return val;
danielk1977c572ef72004-05-27 09:28:41 +00001005}
drh4f26d6c2004-05-26 23:25:30 +00001006int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001007 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
1008 columnMallocFailure(pStmt);
1009 return val;
drh4f26d6c2004-05-26 23:25:30 +00001010}
1011int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001012 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
1013 columnMallocFailure(pStmt);
1014 return val;
drh4f26d6c2004-05-26 23:25:30 +00001015}
1016double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001017 double val = sqlite3_value_double( columnMem(pStmt,i) );
1018 columnMallocFailure(pStmt);
1019 return val;
drh4f26d6c2004-05-26 23:25:30 +00001020}
1021int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001022 int val = sqlite3_value_int( columnMem(pStmt,i) );
1023 columnMallocFailure(pStmt);
1024 return val;
drh4f26d6c2004-05-26 23:25:30 +00001025}
drhefad9992004-06-22 12:13:55 +00001026sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001027 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
1028 columnMallocFailure(pStmt);
1029 return val;
drh4f26d6c2004-05-26 23:25:30 +00001030}
1031const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001032 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
1033 columnMallocFailure(pStmt);
1034 return val;
drh4f26d6c2004-05-26 23:25:30 +00001035}
drhd1e47332005-06-26 17:55:33 +00001036sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +00001037 Mem *pOut = columnMem(pStmt, i);
1038 if( pOut->flags&MEM_Static ){
1039 pOut->flags &= ~MEM_Static;
1040 pOut->flags |= MEM_Ephem;
1041 }
drh32bc3f62007-08-21 20:25:39 +00001042 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +00001043 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +00001044}
drh6c626082004-11-14 21:56:29 +00001045#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001046const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +00001047 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
1048 columnMallocFailure(pStmt);
1049 return val;
drh4f26d6c2004-05-26 23:25:30 +00001050}
drh6c626082004-11-14 21:56:29 +00001051#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +00001052int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +00001053 int iType = sqlite3_value_type( columnMem(pStmt,i) );
1054 columnMallocFailure(pStmt);
1055 return iType;
drh4f26d6c2004-05-26 23:25:30 +00001056}
1057
drh5e2517e2004-09-24 23:59:12 +00001058/*
1059** Convert the N-th element of pStmt->pColName[] into a string using
1060** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +00001061**
1062** There are up to 5 names for each column. useType determines which
1063** name is returned. Here are the names:
1064**
1065** 0 The column name as it should be displayed for output
1066** 1 The datatype name for the column
1067** 2 The name of the database that the column derives from
1068** 3 The name of the table that the column derives from
1069** 4 The name of the table column that the result column derives from
1070**
1071** If the result is not a simple column reference (if it is an expression
1072** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +00001073*/
1074static const void *columnName(
1075 sqlite3_stmt *pStmt,
1076 int N,
1077 const void *(*xFunc)(Mem*),
1078 int useType
1079){
drh9ca95732014-10-24 00:35:58 +00001080 const void *ret;
1081 Vdbe *p;
drh32bc3f62007-08-21 20:25:39 +00001082 int n;
drh9ca95732014-10-24 00:35:58 +00001083 sqlite3 *db;
1084#ifdef SQLITE_ENABLE_API_ARMOR
1085 if( pStmt==0 ){
1086 (void)SQLITE_MISUSE_BKPT;
1087 return 0;
1088 }
1089#endif
1090 ret = 0;
1091 p = (Vdbe *)pStmt;
1092 db = p->db;
drh9b4ea4a2009-04-10 20:32:00 +00001093 assert( db!=0 );
1094 n = sqlite3_column_count(pStmt);
1095 if( N<n && N>=0 ){
1096 N += useType*n;
1097 sqlite3_mutex_enter(db->mutex);
1098 assert( db->mallocFailed==0 );
1099 ret = xFunc(&p->aColName[N]);
1100 /* A malloc may have failed inside of the xFunc() call. If this
1101 ** is the case, clear the mallocFailed flag and return NULL.
1102 */
1103 if( db->mallocFailed ){
1104 db->mallocFailed = 0;
1105 ret = 0;
drh32bc3f62007-08-21 20:25:39 +00001106 }
drh9b4ea4a2009-04-10 20:32:00 +00001107 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +00001108 }
danielk197700fd9572005-12-07 06:27:43 +00001109 return ret;
drh5e2517e2004-09-24 23:59:12 +00001110}
1111
drh4f26d6c2004-05-26 23:25:30 +00001112/*
1113** Return the name of the Nth column of the result set returned by SQL
1114** statement pStmt.
1115*/
1116const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001117 return columnName(
1118 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +00001119}
drhe590fbd2005-05-20 19:36:01 +00001120#ifndef SQLITE_OMIT_UTF16
1121const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001122 return columnName(
1123 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001124}
1125#endif
drh4f26d6c2004-05-26 23:25:30 +00001126
1127/*
drh3f913572008-03-22 01:07:17 +00001128** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1129** not define OMIT_DECLTYPE.
1130*/
1131#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1132# error "Must not define both SQLITE_OMIT_DECLTYPE \
1133 and SQLITE_ENABLE_COLUMN_METADATA"
1134#endif
1135
1136#ifndef SQLITE_OMIT_DECLTYPE
1137/*
drh6c626082004-11-14 21:56:29 +00001138** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001139** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001140*/
1141const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001142 return columnName(
1143 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001144}
drh6c626082004-11-14 21:56:29 +00001145#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001146const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001147 return columnName(
1148 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001149}
drh6c626082004-11-14 21:56:29 +00001150#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001151#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001152
danielk19774b1ae992006-02-10 03:06:10 +00001153#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001154/*
1155** Return the name of the database from which a result column derives.
1156** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001157** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001158*/
1159const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001160 return columnName(
1161 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001162}
1163#ifndef SQLITE_OMIT_UTF16
1164const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001165 return columnName(
1166 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001167}
1168#endif /* SQLITE_OMIT_UTF16 */
1169
1170/*
1171** Return the name of the table from which a result column derives.
1172** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001173** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001174*/
1175const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001176 return columnName(
1177 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001178}
1179#ifndef SQLITE_OMIT_UTF16
1180const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001181 return columnName(
1182 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001183}
1184#endif /* SQLITE_OMIT_UTF16 */
1185
1186/*
1187** Return the name of the table column from which a result column derives.
1188** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001189** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001190*/
1191const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001192 return columnName(
1193 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001194}
1195#ifndef SQLITE_OMIT_UTF16
1196const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001197 return columnName(
1198 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001199}
1200#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001201#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001202
1203
drh4f26d6c2004-05-26 23:25:30 +00001204/******************************* sqlite3_bind_ ***************************
1205**
1206** Routines used to attach values to wildcards in a compiled SQL statement.
1207*/
1208/*
1209** Unbind the value bound to variable i in virtual machine p. This is the
1210** the same as binding a NULL value to the column. If the "i" parameter is
1211** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1212**
drh488e7b62008-10-06 12:46:43 +00001213** A successful evaluation of this routine acquires the mutex on p.
1214** the mutex is released if any kind of error occurs.
1215**
drh4f26d6c2004-05-26 23:25:30 +00001216** The error code stored in database p->db is overwritten with the return
1217** value in any case.
1218*/
1219static int vdbeUnbind(Vdbe *p, int i){
1220 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001221 if( vdbeSafetyNotNull(p) ){
1222 return SQLITE_MISUSE_BKPT;
1223 }
drh488e7b62008-10-06 12:46:43 +00001224 sqlite3_mutex_enter(p->db->mutex);
1225 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001226 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001227 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001228 sqlite3_log(SQLITE_MISUSE,
1229 "bind on a busy prepared statement: [%s]", p->zSql);
1230 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001231 }
1232 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001233 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001234 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001235 return SQLITE_RANGE;
1236 }
1237 i--;
drh290c1942004-08-21 17:54:45 +00001238 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001239 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001240 pVar->flags = MEM_Null;
drh13f40da2014-08-22 18:00:11 +00001241 sqlite3Error(p->db, SQLITE_OK);
dan937d0de2009-10-15 18:35:38 +00001242
dan1d2ce4f2009-10-19 18:11:09 +00001243 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1244 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001245 **
1246 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1247 ** parameter in the WHERE clause might influence the choice of query plan
1248 ** for a statement, then the statement will be automatically recompiled,
1249 ** as if there had been a schema change, on the first sqlite3_step() call
1250 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001251 */
drh823e09a2009-10-19 20:15:38 +00001252 if( p->isPrepareV2 &&
1253 ((i<32 && p->expmask & ((u32)1 << i)) || p->expmask==0xffffffff)
1254 ){
dan937d0de2009-10-15 18:35:38 +00001255 p->expired = 1;
1256 }
drh4f26d6c2004-05-26 23:25:30 +00001257 return SQLITE_OK;
1258}
1259
1260/*
drh5e2517e2004-09-24 23:59:12 +00001261** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001262*/
drh5e2517e2004-09-24 23:59:12 +00001263static int bindText(
drh605264d2007-08-21 15:13:19 +00001264 sqlite3_stmt *pStmt, /* The statement to bind against */
1265 int i, /* Index of the parameter to bind */
1266 const void *zData, /* Pointer to the data to be bound */
1267 int nData, /* Number of bytes of data to be bound */
1268 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001269 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001270){
1271 Vdbe *p = (Vdbe *)pStmt;
1272 Mem *pVar;
1273 int rc;
1274
1275 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001276 if( rc==SQLITE_OK ){
1277 if( zData!=0 ){
1278 pVar = &p->aVar[i-1];
1279 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1280 if( rc==SQLITE_OK && encoding!=0 ){
1281 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1282 }
drh13f40da2014-08-22 18:00:11 +00001283 sqlite3Error(p->db, rc);
drh488e7b62008-10-06 12:46:43 +00001284 rc = sqlite3ApiExit(p->db, rc);
drh27641702007-08-22 02:56:42 +00001285 }
drh488e7b62008-10-06 12:46:43 +00001286 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001287 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001288 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001289 }
drh605264d2007-08-21 15:13:19 +00001290 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001291}
drh5e2517e2004-09-24 23:59:12 +00001292
1293
1294/*
1295** Bind a blob value to an SQL statement variable.
1296*/
1297int sqlite3_bind_blob(
1298 sqlite3_stmt *pStmt,
1299 int i,
1300 const void *zData,
1301 int nData,
1302 void (*xDel)(void*)
1303){
1304 return bindText(pStmt, i, zData, nData, xDel, 0);
1305}
drhda4ca9d2014-09-09 17:27:35 +00001306int sqlite3_bind_blob64(
1307 sqlite3_stmt *pStmt,
1308 int i,
1309 const void *zData,
1310 sqlite3_uint64 nData,
1311 void (*xDel)(void*)
1312){
drhfc59a952014-09-11 23:34:55 +00001313 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001314 if( nData>0x7fffffff ){
1315 return invokeValueDestructor(zData, xDel, 0);
1316 }else{
drh3329a632014-09-18 01:21:43 +00001317 return bindText(pStmt, i, zData, (int)nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001318 }
1319}
drh4f26d6c2004-05-26 23:25:30 +00001320int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1321 int rc;
1322 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001323 rc = vdbeUnbind(p, i);
1324 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001325 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001326 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001327 }
danielk1977f4618892004-06-28 13:09:11 +00001328 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001329}
1330int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001331 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001332}
drhefad9992004-06-22 12:13:55 +00001333int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001334 int rc;
1335 Vdbe *p = (Vdbe *)pStmt;
1336 rc = vdbeUnbind(p, i);
1337 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001338 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001339 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001340 }
1341 return rc;
1342}
drh605264d2007-08-21 15:13:19 +00001343int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1344 int rc;
1345 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001346 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001347 if( rc==SQLITE_OK ){
1348 sqlite3_mutex_leave(p->db->mutex);
1349 }
drh605264d2007-08-21 15:13:19 +00001350 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001351}
1352int sqlite3_bind_text(
1353 sqlite3_stmt *pStmt,
1354 int i,
1355 const char *zData,
1356 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001357 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001358){
drh5e2517e2004-09-24 23:59:12 +00001359 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001360}
drhbbf483f2014-09-09 20:30:24 +00001361int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001362 sqlite3_stmt *pStmt,
1363 int i,
1364 const char *zData,
1365 sqlite3_uint64 nData,
1366 void (*xDel)(void*),
1367 unsigned char enc
1368){
drhfc59a952014-09-11 23:34:55 +00001369 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001370 if( nData>0x7fffffff ){
1371 return invokeValueDestructor(zData, xDel, 0);
1372 }else{
drhfc59a952014-09-11 23:34:55 +00001373 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drh3329a632014-09-18 01:21:43 +00001374 return bindText(pStmt, i, zData, (int)nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001375 }
1376}
drh6c626082004-11-14 21:56:29 +00001377#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001378int sqlite3_bind_text16(
1379 sqlite3_stmt *pStmt,
1380 int i,
1381 const void *zData,
1382 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001383 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001384){
drh5e2517e2004-09-24 23:59:12 +00001385 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001386}
drh6c626082004-11-14 21:56:29 +00001387#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001388int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1389 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001390 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001391 case SQLITE_INTEGER: {
1392 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1393 break;
1394 }
1395 case SQLITE_FLOAT: {
drh74eaba42014-09-18 17:52:15 +00001396 rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
drh29def562009-04-14 12:43:33 +00001397 break;
1398 }
1399 case SQLITE_BLOB: {
1400 if( pValue->flags & MEM_Zero ){
1401 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1402 }else{
1403 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1404 }
1405 break;
1406 }
1407 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001408 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1409 pValue->enc);
1410 break;
1411 }
1412 default: {
1413 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001414 break;
1415 }
danielk197726e41442006-06-14 15:16:35 +00001416 }
1417 return rc;
1418}
drhb026e052007-05-02 01:34:31 +00001419int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1420 int rc;
1421 Vdbe *p = (Vdbe *)pStmt;
1422 rc = vdbeUnbind(p, i);
1423 if( rc==SQLITE_OK ){
1424 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001425 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001426 }
1427 return rc;
1428}
dan80c03022015-07-24 17:36:34 +00001429int sqlite3_bind_zeroblob64(sqlite3_stmt *pStmt, int i, sqlite3_uint64 n){
1430 int rc;
1431 Vdbe *p = (Vdbe *)pStmt;
1432 sqlite3_mutex_enter(p->db->mutex);
1433 if( n>(u64)p->db->aLimit[SQLITE_LIMIT_LENGTH] ){
1434 rc = SQLITE_TOOBIG;
1435 }else{
1436 assert( (n & 0x7FFFFFFF)==n );
1437 rc = sqlite3_bind_zeroblob(pStmt, i, n);
1438 }
1439 rc = sqlite3ApiExit(p->db, rc);
1440 sqlite3_mutex_leave(p->db->mutex);
1441 return rc;
1442}
drh75f6a032004-07-15 14:15:00 +00001443
1444/*
1445** Return the number of wildcards that can be potentially bound to.
1446** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001447*/
1448int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001449 Vdbe *p = (Vdbe*)pStmt;
1450 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001451}
drh895d7472004-08-20 16:02:39 +00001452
1453/*
drhfa6bc002004-09-07 16:19:52 +00001454** Return the name of a wildcard parameter. Return NULL if the index
1455** is out of range or if the wildcard is unnamed.
1456**
1457** The result is always UTF-8.
1458*/
1459const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1460 Vdbe *p = (Vdbe*)pStmt;
drh124c0b42011-06-01 18:15:55 +00001461 if( p==0 || i<1 || i>p->nzVar ){
drhfa6bc002004-09-07 16:19:52 +00001462 return 0;
1463 }
drh895d7472004-08-20 16:02:39 +00001464 return p->azVar[i-1];
1465}
drhfa6bc002004-09-07 16:19:52 +00001466
1467/*
1468** Given a wildcard parameter name, return the index of the variable
1469** with that name. If there is no variable with the given name,
1470** return 0.
1471*/
drh5f18a222009-11-26 14:01:53 +00001472int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drhfa6bc002004-09-07 16:19:52 +00001473 int i;
1474 if( p==0 ){
1475 return 0;
1476 }
drh6a8903c2004-12-10 18:00:04 +00001477 if( zName ){
drh124c0b42011-06-01 18:15:55 +00001478 for(i=0; i<p->nzVar; i++){
drh6a8903c2004-12-10 18:00:04 +00001479 const char *z = p->azVar[i];
drh503a6862013-03-01 01:07:17 +00001480 if( z && strncmp(z,zName,nName)==0 && z[nName]==0 ){
drh6a8903c2004-12-10 18:00:04 +00001481 return i+1;
1482 }
drhfa6bc002004-09-07 16:19:52 +00001483 }
1484 }
1485 return 0;
1486}
drh5f18a222009-11-26 14:01:53 +00001487int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1488 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1489}
drhf8db1bc2005-04-22 02:38:37 +00001490
drh51942bc2005-06-12 22:01:42 +00001491/*
drhf8db1bc2005-04-22 02:38:37 +00001492** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001493*/
shane145834a2008-09-04 12:03:42 +00001494int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001495 Vdbe *pFrom = (Vdbe*)pFromStmt;
1496 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001497 int i;
1498 assert( pTo->db==pFrom->db );
1499 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001500 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001501 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001502 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001503 }
drh27641702007-08-22 02:56:42 +00001504 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001505 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001506}
drh51942bc2005-06-12 22:01:42 +00001507
shaneeec556d2008-10-12 00:27:53 +00001508#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001509/*
shane145834a2008-09-04 12:03:42 +00001510** Deprecated external interface. Internal/core SQLite code
1511** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001512**
peter.d.reid60ec9142014-09-06 16:39:46 +00001513** It is misuse to call this routine with statements from different
drh0f5ea0b2009-04-09 14:02:44 +00001514** database connections. But as this is a deprecated interface, we
1515** will not bother to check for that condition.
1516**
1517** If the two statements contain a different number of bindings, then
1518** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1519** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001520*/
1521int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001522 Vdbe *pFrom = (Vdbe*)pFromStmt;
1523 Vdbe *pTo = (Vdbe*)pToStmt;
1524 if( pFrom->nVar!=pTo->nVar ){
1525 return SQLITE_ERROR;
1526 }
danc94b8592009-10-20 07:01:24 +00001527 if( pTo->isPrepareV2 && pTo->expmask ){
1528 pTo->expired = 1;
1529 }
1530 if( pFrom->isPrepareV2 && pFrom->expmask ){
1531 pFrom->expired = 1;
1532 }
shane145834a2008-09-04 12:03:42 +00001533 return sqlite3TransferBindings(pFromStmt, pToStmt);
1534}
shaneeec556d2008-10-12 00:27:53 +00001535#endif
shane145834a2008-09-04 12:03:42 +00001536
1537/*
drh51942bc2005-06-12 22:01:42 +00001538** Return the sqlite3* database handle to which the prepared statement given
1539** in the argument belongs. This is the same database handle that was
1540** the first argument to the sqlite3_prepare() that was used to create
1541** the statement in the first place.
1542*/
1543sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1544 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1545}
drhbb5a9c32008-06-19 02:52:25 +00001546
1547/*
drhf03d9cc2010-11-16 23:10:25 +00001548** Return true if the prepared statement is guaranteed to not modify the
1549** database.
1550*/
1551int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1552 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1553}
1554
1555/*
drh2fb66932011-11-25 17:21:47 +00001556** Return true if the prepared statement is in need of being reset.
1557*/
1558int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1559 Vdbe *v = (Vdbe*)pStmt;
dan857745c2014-07-19 17:57:10 +00001560 return v!=0 && v->pc>=0 && v->magic==VDBE_MAGIC_RUN;
drh2fb66932011-11-25 17:21:47 +00001561}
1562
1563/*
drhbb5a9c32008-06-19 02:52:25 +00001564** Return a pointer to the next prepared statement after pStmt associated
1565** with database connection pDb. If pStmt is NULL, return the first
1566** prepared statement for the database connection. Return NULL if there
1567** are no more.
1568*/
1569sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1570 sqlite3_stmt *pNext;
drh9ca95732014-10-24 00:35:58 +00001571#ifdef SQLITE_ENABLE_API_ARMOR
1572 if( !sqlite3SafetyCheckOk(pDb) ){
1573 (void)SQLITE_MISUSE_BKPT;
1574 return 0;
1575 }
1576#endif
drhbb5a9c32008-06-19 02:52:25 +00001577 sqlite3_mutex_enter(pDb->mutex);
1578 if( pStmt==0 ){
1579 pNext = (sqlite3_stmt*)pDb->pVdbe;
1580 }else{
1581 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1582 }
1583 sqlite3_mutex_leave(pDb->mutex);
1584 return pNext;
1585}
drhd1d38482008-10-07 23:46:38 +00001586
1587/*
1588** Return the value of a status counter for a prepared statement
1589*/
1590int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1591 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9ca95732014-10-24 00:35:58 +00001592 u32 v;
1593#ifdef SQLITE_ENABLE_API_ARMOR
1594 if( !pStmt ){
1595 (void)SQLITE_MISUSE_BKPT;
1596 return 0;
1597 }
1598#endif
1599 v = pVdbe->aCounter[op];
drh9b47ee32013-08-20 03:13:51 +00001600 if( resetFlag ) pVdbe->aCounter[op] = 0;
1601 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001602}
dan04489b62014-10-31 20:11:32 +00001603
dan6f9702e2014-11-01 20:38:06 +00001604#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan04489b62014-10-31 20:11:32 +00001605/*
1606** Return status data for a single loop within query pStmt.
1607*/
1608int sqlite3_stmt_scanstatus(
drhd1a1c232014-11-03 16:35:55 +00001609 sqlite3_stmt *pStmt, /* Prepared statement being queried */
dan04489b62014-10-31 20:11:32 +00001610 int idx, /* Index of loop to report on */
drhd1a1c232014-11-03 16:35:55 +00001611 int iScanStatusOp, /* Which metric to return */
1612 void *pOut /* OUT: Write the answer here */
dan04489b62014-10-31 20:11:32 +00001613){
1614 Vdbe *p = (Vdbe*)pStmt;
dan037b5322014-11-03 11:25:32 +00001615 ScanStatus *pScan;
dan6f9702e2014-11-01 20:38:06 +00001616 if( idx<0 || idx>=p->nScan ) return 1;
1617 pScan = &p->aScan[idx];
drhd1a1c232014-11-03 16:35:55 +00001618 switch( iScanStatusOp ){
1619 case SQLITE_SCANSTAT_NLOOP: {
1620 *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
1621 break;
1622 }
1623 case SQLITE_SCANSTAT_NVISIT: {
1624 *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
1625 break;
1626 }
1627 case SQLITE_SCANSTAT_EST: {
drh518140e2014-11-06 03:55:10 +00001628 double r = 1.0;
1629 LogEst x = pScan->nEst;
1630 while( x<100 ){
1631 x += 10;
1632 r *= 0.5;
1633 }
1634 *(double*)pOut = r*sqlite3LogEstToInt(x);
drhd1a1c232014-11-03 16:35:55 +00001635 break;
1636 }
1637 case SQLITE_SCANSTAT_NAME: {
dand72219d2014-11-03 16:39:37 +00001638 *(const char**)pOut = pScan->zName;
drhd1a1c232014-11-03 16:35:55 +00001639 break;
1640 }
1641 case SQLITE_SCANSTAT_EXPLAIN: {
1642 if( pScan->addrExplain ){
1643 *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
1644 }else{
1645 *(const char**)pOut = 0;
1646 }
1647 break;
1648 }
drhc6652b12014-11-06 04:42:20 +00001649 case SQLITE_SCANSTAT_SELECTID: {
1650 if( pScan->addrExplain ){
1651 *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
1652 }else{
1653 *(int*)pOut = -1;
1654 }
1655 break;
1656 }
drhd1a1c232014-11-03 16:35:55 +00001657 default: {
1658 return 1;
dan6f9702e2014-11-01 20:38:06 +00001659 }
1660 }
dan04489b62014-10-31 20:11:32 +00001661 return 0;
1662}
1663
1664/*
1665** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
1666*/
1667void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
1668 Vdbe *p = (Vdbe*)pStmt;
dan6f9702e2014-11-01 20:38:06 +00001669 memset(p->anExec, 0, p->nOp * sizeof(i64));
dan04489b62014-10-31 20:11:32 +00001670}
dan6f9702e2014-11-01 20:38:06 +00001671#endif /* SQLITE_ENABLE_STMT_SCANSTATUS */