blob: c7c14d9c31d9facdd5e8c74a15b5a8a9bbc7ffd6 [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
56/*
drhe30f4422007-08-21 16:15:55 +000057** The following routine destroys a virtual machine that is created by
58** the sqlite3_compile() routine. The integer returned is an SQLITE_
59** success/failure code that describes the result of executing the virtual
60** machine.
61**
62** This routine sets the error code and string returned by
63** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
64*/
65int sqlite3_finalize(sqlite3_stmt *pStmt){
66 int rc;
67 if( pStmt==0 ){
drh65bafa62010-09-29 01:54:00 +000068 /* IMPLEMENTATION-OF: R-57228-12904 Invoking sqlite3_finalize() on a NULL
69 ** pointer is a harmless no-op. */
drhe30f4422007-08-21 16:15:55 +000070 rc = SQLITE_OK;
71 }else{
72 Vdbe *v = (Vdbe*)pStmt;
danielk1977238746a2009-03-19 18:51:06 +000073 sqlite3 *db = v->db;
drh413c3d32010-02-23 20:11:56 +000074 if( vdbeSafety(v) ) return SQLITE_MISUSE_BKPT;
drh4245c402012-06-02 14:32:21 +000075 sqlite3_mutex_enter(db->mutex);
drhe30f4422007-08-21 16:15:55 +000076 rc = sqlite3VdbeFinalize(v);
danielk1977238746a2009-03-19 18:51:06 +000077 rc = sqlite3ApiExit(db, rc);
drh4245c402012-06-02 14:32:21 +000078 sqlite3LeaveMutexAndCloseZombie(db);
drhe30f4422007-08-21 16:15:55 +000079 }
80 return rc;
81}
82
83/*
84** Terminate the current execution of an SQL statement and reset it
85** back to its starting state so that it can be reused. A success code from
86** the prior execution is returned.
87**
88** This routine sets the error code and string returned by
89** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
90*/
91int sqlite3_reset(sqlite3_stmt *pStmt){
92 int rc;
93 if( pStmt==0 ){
94 rc = SQLITE_OK;
95 }else{
96 Vdbe *v = (Vdbe*)pStmt;
97 sqlite3_mutex_enter(v->db->mutex);
drhc890fec2008-08-01 20:10:08 +000098 rc = sqlite3VdbeReset(v);
drh124c0b42011-06-01 18:15:55 +000099 sqlite3VdbeRewind(v);
drhe30f4422007-08-21 16:15:55 +0000100 assert( (rc & (v->db->errMask))==rc );
danielk1977238746a2009-03-19 18:51:06 +0000101 rc = sqlite3ApiExit(v->db, rc);
drhe30f4422007-08-21 16:15:55 +0000102 sqlite3_mutex_leave(v->db->mutex);
103 }
104 return rc;
105}
106
107/*
108** Set all the parameters in the compiled SQL statement to NULL.
109*/
110int sqlite3_clear_bindings(sqlite3_stmt *pStmt){
111 int i;
112 int rc = SQLITE_OK;
drh7297d1f2008-05-09 14:39:44 +0000113 Vdbe *p = (Vdbe*)pStmt;
drh18472fa2008-10-07 15:25:48 +0000114#if SQLITE_THREADSAFE
drh7e8b8482008-01-23 03:03:05 +0000115 sqlite3_mutex *mutex = ((Vdbe*)pStmt)->db->mutex;
116#endif
117 sqlite3_mutex_enter(mutex);
drh7297d1f2008-05-09 14:39:44 +0000118 for(i=0; i<p->nVar; i++){
119 sqlite3VdbeMemRelease(&p->aVar[i]);
120 p->aVar[i].flags = MEM_Null;
drhe30f4422007-08-21 16:15:55 +0000121 }
danc94b8592009-10-20 07:01:24 +0000122 if( p->isPrepareV2 && p->expmask ){
123 p->expired = 1;
124 }
drh7e8b8482008-01-23 03:03:05 +0000125 sqlite3_mutex_leave(mutex);
drhe30f4422007-08-21 16:15:55 +0000126 return rc;
127}
128
129
drh4f26d6c2004-05-26 23:25:30 +0000130/**************************** sqlite3_value_ *******************************
131** The following routines extract information from a Mem or sqlite3_value
132** structure.
133*/
134const void *sqlite3_value_blob(sqlite3_value *pVal){
135 Mem *p = (Mem*)pVal;
136 if( p->flags & (MEM_Blob|MEM_Str) ){
drhb21c8cd2007-08-21 19:33:56 +0000137 sqlite3VdbeMemExpandBlob(p);
drh1f0feef2007-05-15 13:27:07 +0000138 p->flags |= MEM_Blob;
drh42262532010-09-08 16:30:36 +0000139 return p->n ? p->z : 0;
drh4f26d6c2004-05-26 23:25:30 +0000140 }else{
141 return sqlite3_value_text(pVal);
142 }
143}
144int sqlite3_value_bytes(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000145 return sqlite3ValueBytes(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000146}
147int sqlite3_value_bytes16(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000148 return sqlite3ValueBytes(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000149}
150double sqlite3_value_double(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000151 return sqlite3VdbeRealValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000152}
153int sqlite3_value_int(sqlite3_value *pVal){
drhb27b7f52008-12-10 18:03:45 +0000154 return (int)sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000155}
drhefad9992004-06-22 12:13:55 +0000156sqlite_int64 sqlite3_value_int64(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000157 return sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000158}
159const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000160 return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000161}
drh6c626082004-11-14 21:56:29 +0000162#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000163const void *sqlite3_value_text16(sqlite3_value* pVal){
drhb21c8cd2007-08-21 19:33:56 +0000164 return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000165}
danielk1977d8123362004-06-12 09:25:12 +0000166const void *sqlite3_value_text16be(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000167 return sqlite3ValueText(pVal, SQLITE_UTF16BE);
danielk1977d8123362004-06-12 09:25:12 +0000168}
169const void *sqlite3_value_text16le(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000170 return sqlite3ValueText(pVal, SQLITE_UTF16LE);
danielk1977d8123362004-06-12 09:25:12 +0000171}
drh6c626082004-11-14 21:56:29 +0000172#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000173int sqlite3_value_type(sqlite3_value* pVal){
drh1b27b8c2014-02-10 03:21:57 +0000174 static const u8 aType[] = {
175 SQLITE_BLOB, /* 0x00 */
176 SQLITE_NULL, /* 0x01 */
177 SQLITE_TEXT, /* 0x02 */
178 SQLITE_NULL, /* 0x03 */
179 SQLITE_INTEGER, /* 0x04 */
180 SQLITE_NULL, /* 0x05 */
181 SQLITE_INTEGER, /* 0x06 */
182 SQLITE_NULL, /* 0x07 */
183 SQLITE_FLOAT, /* 0x08 */
184 SQLITE_NULL, /* 0x09 */
185 SQLITE_FLOAT, /* 0x0a */
186 SQLITE_NULL, /* 0x0b */
187 SQLITE_INTEGER, /* 0x0c */
188 SQLITE_NULL, /* 0x0d */
189 SQLITE_INTEGER, /* 0x0e */
190 SQLITE_NULL, /* 0x0f */
191 SQLITE_BLOB, /* 0x10 */
192 SQLITE_NULL, /* 0x11 */
193 SQLITE_TEXT, /* 0x12 */
194 SQLITE_NULL, /* 0x13 */
195 SQLITE_INTEGER, /* 0x14 */
196 SQLITE_NULL, /* 0x15 */
197 SQLITE_INTEGER, /* 0x16 */
198 SQLITE_NULL, /* 0x17 */
199 SQLITE_FLOAT, /* 0x18 */
200 SQLITE_NULL, /* 0x19 */
201 SQLITE_FLOAT, /* 0x1a */
202 SQLITE_NULL, /* 0x1b */
203 SQLITE_INTEGER, /* 0x1c */
204 SQLITE_NULL, /* 0x1d */
205 SQLITE_INTEGER, /* 0x1e */
206 SQLITE_NULL, /* 0x1f */
207 };
mistachkinafc14f72014-03-05 01:29:18 +0000208 return aType[pVal->flags&MEM_AffMask];
drh4f26d6c2004-05-26 23:25:30 +0000209}
210
211/**************************** sqlite3_result_ *******************************
212** The following routines are used by user-defined functions to specify
213** the function result.
drh4c8555f2009-06-25 01:47:11 +0000214**
peter.d.reid60ec9142014-09-06 16:39:46 +0000215** The setStrOrError() function calls sqlite3VdbeMemSetStr() to store the
drh4c8555f2009-06-25 01:47:11 +0000216** result as a string or blob but if the string or blob is too large, it
217** then sets the error code to SQLITE_TOOBIG
drhda4ca9d2014-09-09 17:27:35 +0000218**
219** The invokeValueDestructor(P,X) routine invokes destructor function X()
220** on value P is not going to be used and need to be destroyed.
drh4f26d6c2004-05-26 23:25:30 +0000221*/
drh4c8555f2009-06-25 01:47:11 +0000222static void setResultStrOrError(
223 sqlite3_context *pCtx, /* Function context */
224 const char *z, /* String pointer */
225 int n, /* Bytes in string, or negative */
226 u8 enc, /* Encoding of z. 0 for BLOBs */
227 void (*xDel)(void*) /* Destructor function */
228){
drh9bd038f2014-08-27 14:14:06 +0000229 if( sqlite3VdbeMemSetStr(pCtx->pOut, z, n, enc, xDel)==SQLITE_TOOBIG ){
drh4c8555f2009-06-25 01:47:11 +0000230 sqlite3_result_error_toobig(pCtx);
231 }
232}
drhda4ca9d2014-09-09 17:27:35 +0000233static int invokeValueDestructor(
234 const void *p, /* Value to destroy */
235 void (*xDel)(void*), /* The destructor */
236 sqlite3_context *pCtx /* Set a SQLITE_TOOBIG error if no NULL */
237){
drhfc59a952014-09-11 23:34:55 +0000238 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000239 if( xDel==0 ){
240 /* noop */
241 }else if( xDel==SQLITE_TRANSIENT ){
242 /* noop */
drhda4ca9d2014-09-09 17:27:35 +0000243 }else{
244 xDel((void*)p);
245 }
246 if( pCtx ) sqlite3_result_error_toobig(pCtx);
247 return SQLITE_TOOBIG;
248}
drh4f26d6c2004-05-26 23:25:30 +0000249void sqlite3_result_blob(
250 sqlite3_context *pCtx,
251 const void *z,
252 int n,
danielk1977d8123362004-06-12 09:25:12 +0000253 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000254){
drh5708d2d2005-06-22 10:53:59 +0000255 assert( n>=0 );
drh9bd038f2014-08-27 14:14:06 +0000256 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000257 setResultStrOrError(pCtx, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000258}
drhda4ca9d2014-09-09 17:27:35 +0000259void sqlite3_result_blob64(
260 sqlite3_context *pCtx,
261 const void *z,
262 sqlite3_uint64 n,
263 void (*xDel)(void *)
264){
265 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000266 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +0000267 if( n>0x7fffffff ){
268 (void)invokeValueDestructor(z, xDel, pCtx);
269 }else{
270 setResultStrOrError(pCtx, z, (int)n, 0, xDel);
271 }
272}
drh4f26d6c2004-05-26 23:25:30 +0000273void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
drh9bd038f2014-08-27 14:14:06 +0000274 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
275 sqlite3VdbeMemSetDouble(pCtx->pOut, rVal);
drh4f26d6c2004-05-26 23:25:30 +0000276}
277void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000278 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000279 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000280 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000281 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000282}
danielk1977a1686c92006-01-23 07:52:37 +0000283#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000284void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
drh9bd038f2014-08-27 14:14:06 +0000285 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000286 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000287 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000288 sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000289}
danielk1977a1686c92006-01-23 07:52:37 +0000290#endif
drhf4479502004-05-27 03:12:53 +0000291void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh9bd038f2014-08-27 14:14:06 +0000292 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
293 sqlite3VdbeMemSetInt64(pCtx->pOut, (i64)iVal);
drh4f26d6c2004-05-26 23:25:30 +0000294}
295void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
drh9bd038f2014-08-27 14:14:06 +0000296 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
297 sqlite3VdbeMemSetInt64(pCtx->pOut, iVal);
drh4f26d6c2004-05-26 23:25:30 +0000298}
299void sqlite3_result_null(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000300 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
301 sqlite3VdbeMemSetNull(pCtx->pOut);
drh4f26d6c2004-05-26 23:25:30 +0000302}
303void sqlite3_result_text(
304 sqlite3_context *pCtx,
305 const char *z,
306 int n,
danielk1977d8123362004-06-12 09:25:12 +0000307 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000308){
drh9bd038f2014-08-27 14:14:06 +0000309 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000310 setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000311}
drhbbf483f2014-09-09 20:30:24 +0000312void sqlite3_result_text64(
drhda4ca9d2014-09-09 17:27:35 +0000313 sqlite3_context *pCtx,
314 const char *z,
315 sqlite3_uint64 n,
316 void (*xDel)(void *),
317 unsigned char enc
318){
319 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhfc59a952014-09-11 23:34:55 +0000320 assert( xDel!=SQLITE_DYNAMIC );
drh79f7af92014-10-03 16:00:51 +0000321 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drhda4ca9d2014-09-09 17:27:35 +0000322 if( n>0x7fffffff ){
323 (void)invokeValueDestructor(z, xDel, pCtx);
324 }else{
325 setResultStrOrError(pCtx, z, (int)n, enc, xDel);
326 }
327}
drh6c626082004-11-14 21:56:29 +0000328#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000329void sqlite3_result_text16(
330 sqlite3_context *pCtx,
331 const void *z,
332 int n,
danielk1977d8123362004-06-12 09:25:12 +0000333 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000334){
drh9bd038f2014-08-27 14:14:06 +0000335 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000336 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000337}
338void sqlite3_result_text16be(
339 sqlite3_context *pCtx,
340 const void *z,
341 int n,
342 void (*xDel)(void *)
343){
drh9bd038f2014-08-27 14:14:06 +0000344 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000345 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000346}
347void sqlite3_result_text16le(
348 sqlite3_context *pCtx,
349 const void *z,
350 int n,
351 void (*xDel)(void *)
352){
drh9bd038f2014-08-27 14:14:06 +0000353 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000354 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000355}
drh6c626082004-11-14 21:56:29 +0000356#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000357void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh9bd038f2014-08-27 14:14:06 +0000358 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
359 sqlite3VdbeMemCopy(pCtx->pOut, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000360}
drhb026e052007-05-02 01:34:31 +0000361void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh9bd038f2014-08-27 14:14:06 +0000362 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
363 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
drhb026e052007-05-02 01:34:31 +0000364}
drh69544ec2008-02-06 14:11:34 +0000365void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
366 pCtx->isError = errCode;
drh9b47ee32013-08-20 03:13:51 +0000367 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000368 if( pCtx->pOut->flags & MEM_Null ){
369 sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
drh51c7d862009-04-27 18:46:06 +0000370 SQLITE_UTF8, SQLITE_STATIC);
371 }
drh69544ec2008-02-06 14:11:34 +0000372}
drh4f26d6c2004-05-26 23:25:30 +0000373
drha0206bc2007-05-08 15:15:02 +0000374/* Force an SQLITE_TOOBIG error. */
375void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000376 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000377 pCtx->isError = SQLITE_TOOBIG;
drh9b47ee32013-08-20 03:13:51 +0000378 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000379 sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
drhbb4957f2008-03-20 14:03:29 +0000380 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000381}
382
danielk1977a1644fd2007-08-29 12:31:25 +0000383/* An SQLITE_NOMEM error. */
384void sqlite3_result_error_nomem(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000385 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
386 sqlite3VdbeMemSetNull(pCtx->pOut);
drh69544ec2008-02-06 14:11:34 +0000387 pCtx->isError = SQLITE_NOMEM;
drh9b47ee32013-08-20 03:13:51 +0000388 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000389 pCtx->pOut->db->mallocFailed = 1;
danielk1977a1644fd2007-08-29 12:31:25 +0000390}
drh4f26d6c2004-05-26 23:25:30 +0000391
dan5cf53532010-05-01 16:40:20 +0000392/*
393** This function is called after a transaction has been committed. It
394** invokes callbacks registered with sqlite3_wal_hook() as required.
395*/
drh7ed91f22010-04-29 22:34:07 +0000396static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000397 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000398#ifndef SQLITE_OMIT_WAL
399 int i;
dan8d22a172010-04-19 18:03:51 +0000400 for(i=0; i<db->nDb; i++){
401 Btree *pBt = db->aDb[i].pBt;
402 if( pBt ){
drh7ed91f22010-04-29 22:34:07 +0000403 int nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
drh5def0842010-05-05 20:00:25 +0000404 if( db->xWalCallback && nEntry>0 && rc==SQLITE_OK ){
405 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000406 }
407 }
408 }
dan5cf53532010-05-01 16:40:20 +0000409#endif
dan8d22a172010-04-19 18:03:51 +0000410 return rc;
411}
412
drh4f26d6c2004-05-26 23:25:30 +0000413/*
414** Execute the statement pStmt, either until a row of data is ready, the
415** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000416**
417** This routine implements the bulk of the logic behind the sqlite_step()
418** API. The only thing omitted is the automatic recompile if a
419** schema change has occurred. That detail is handled by the
420** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000421*/
drhb900aaf2006-11-09 00:24:53 +0000422static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000423 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000424 int rc;
425
danielk1977a185ddb2007-11-15 16:04:15 +0000426 assert(p);
427 if( p->magic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000428 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000429 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
430 ** with version 3.7.0, we changed this so that sqlite3_reset() would
431 ** be called automatically instead of throwing the SQLITE_MISUSE error.
432 ** This "automatic-reset" change is not technically an incompatibility,
433 ** since any application that receives an SQLITE_MISUSE is broken by
434 ** definition.
435 **
436 ** Nevertheless, some published applications that were originally written
437 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000438 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000439 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
440 ** legacy behavior of returning SQLITE_MISUSE for cases where the
441 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
442 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000443 */
drh602acb42011-01-17 17:42:37 +0000444#ifdef SQLITE_OMIT_AUTORESET
445 if( p->rc==SQLITE_BUSY || p->rc==SQLITE_LOCKED ){
446 sqlite3_reset((sqlite3_stmt*)p);
447 }else{
448 return SQLITE_MISUSE_BKPT;
449 }
450#else
drh3674bfd2010-04-17 12:53:19 +0000451 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000452#endif
drhf1bfe9a2007-10-17 01:44:20 +0000453 }
454
dan14d4cc42010-01-20 14:25:37 +0000455 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000456 db = p->db;
drhc456e572008-08-11 18:44:58 +0000457 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000458 p->rc = SQLITE_NOMEM;
drhc456e572008-08-11 18:44:58 +0000459 return SQLITE_NOMEM;
460 }
danielk1977261919c2005-12-06 12:52:59 +0000461
danielk1977a21c6b62005-01-24 10:25:59 +0000462 if( p->pc<=0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000463 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000464 rc = SQLITE_ERROR;
465 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000466 }
danielk19771d850a72004-05-31 08:26:49 +0000467 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000468 /* If there are no other statements currently running, then
469 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
470 ** from interrupting a statement that has not yet started.
471 */
drh4f7d3a52013-06-27 23:54:02 +0000472 if( db->nVdbeActive==0 ){
drh15ca1df2006-07-26 13:43:30 +0000473 db->u1.isInterrupted = 0;
474 }
475
drh888e16e2013-07-09 13:05:49 +0000476 assert( db->nVdbeWrite>0 || db->autoCommit==0
dancb3e4b72013-07-03 19:53:05 +0000477 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
478 );
dan1da40a32009-09-19 17:00:31 +0000479
drh19e2d372005-08-29 23:00:03 +0000480#ifndef SQLITE_OMIT_TRACE
drh19e2d372005-08-29 23:00:03 +0000481 if( db->xProfile && !db->init.busy ){
drhb7e8ea22010-05-03 14:32:30 +0000482 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh19e2d372005-08-29 23:00:03 +0000483 }
484#endif
drhc16a03b2004-09-15 13:38:10 +0000485
drh4f7d3a52013-06-27 23:54:02 +0000486 db->nVdbeActive++;
487 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000488 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000489 p->pc = 0;
490 }
drhb7f91642004-10-31 02:22:47 +0000491#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000492 if( p->explain ){
493 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000494 }else
495#endif /* SQLITE_OMIT_EXPLAIN */
496 {
drh4f7d3a52013-06-27 23:54:02 +0000497 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000498 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000499 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000500 }
501
drh19e2d372005-08-29 23:00:03 +0000502#ifndef SQLITE_OMIT_TRACE
503 /* Invoke the profile callback if there is one
504 */
danielk19776ab3a2e2009-02-19 14:39:25 +0000505 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000506 sqlite3_int64 iNow;
507 sqlite3OsCurrentTimeInt64(db->pVfs, &iNow);
drhdf0db0f2010-07-29 10:07:21 +0000508 db->xProfile(db->pProfileArg, p->zSql, (iNow - p->startTime)*1000000);
drh19e2d372005-08-29 23:00:03 +0000509 }
510#endif
511
dan8d22a172010-04-19 18:03:51 +0000512 if( rc==SQLITE_DONE ){
513 assert( p->rc==SQLITE_OK );
drh7ed91f22010-04-29 22:34:07 +0000514 p->rc = doWalCallbacks(db);
dan8d22a172010-04-19 18:03:51 +0000515 if( p->rc!=SQLITE_OK ){
516 rc = SQLITE_ERROR;
517 }
518 }
519
drh80cc85b2008-07-23 21:07:25 +0000520 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000521 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
522 p->rc = SQLITE_NOMEM;
drhb900aaf2006-11-09 00:24:53 +0000523 }
danielk1977357864e2009-03-25 15:43:08 +0000524end_of_step:
525 /* At this point local variable rc holds the value that should be
526 ** returned if this statement was compiled using the legacy
527 ** sqlite3_prepare() interface. According to the docs, this can only
528 ** be one of the values in the first assert() below. Variable p->rc
529 ** contains the value that would be returned if sqlite3_finalize()
530 ** were called on statement p.
531 */
532 assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
533 || rc==SQLITE_BUSY || rc==SQLITE_MISUSE
534 );
535 assert( p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE );
536 if( p->isPrepareV2 && rc!=SQLITE_ROW && rc!=SQLITE_DONE ){
537 /* If this statement was prepared using sqlite3_prepare_v2(), and an
mistachkin48864df2013-03-21 21:20:32 +0000538 ** error has occurred, then return the error code in p->rc to the
danielk1977357864e2009-03-25 15:43:08 +0000539 ** caller. Set the error code in the database handle to the same value.
540 */
dan029ead62011-10-27 15:19:58 +0000541 rc = sqlite3VdbeTransferError(p);
danielk1977357864e2009-03-25 15:43:08 +0000542 }
543 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000544}
545
546/*
547** This is the top-level implementation of sqlite3_step(). Call
548** sqlite3Step() to do most of the work. If a schema error occurs,
549** call sqlite3Reprepare() and try again.
550*/
drhb900aaf2006-11-09 00:24:53 +0000551int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000552 int rc = SQLITE_OK; /* Result from sqlite3Step() */
553 int rc2 = SQLITE_OK; /* Result from sqlite3Reprepare() */
554 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
555 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
556 sqlite3 *db; /* The database connection */
557
drh413c3d32010-02-23 20:11:56 +0000558 if( vdbeSafetyNotNull(v) ){
559 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000560 }
drh413c3d32010-02-23 20:11:56 +0000561 db = v->db;
562 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000563 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000564 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh2c7946a2014-08-19 20:27:40 +0000565 && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
566 int savedPc = v->pc;
567 rc2 = rc = sqlite3Reprepare(v);
568 if( rc!=SQLITE_OK) break;
drh413c3d32010-02-23 20:11:56 +0000569 sqlite3_reset(pStmt);
drh5f58ae72014-08-19 20:41:36 +0000570 if( savedPc>=0 ) v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000571 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000572 }
drha3cc0072013-12-13 16:23:55 +0000573 if( rc2!=SQLITE_OK ){
drh413c3d32010-02-23 20:11:56 +0000574 /* This case occurs after failing to recompile an sql statement.
575 ** The error message from the SQL compiler has already been loaded
576 ** into the database handle. This block copies the error message
577 ** from the database handle into the statement and sets the statement
578 ** program counter to 0 to ensure that when the statement is
579 ** finalized or reset the parser error message is available via
580 ** sqlite3_errmsg() and sqlite3_errcode().
581 */
582 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
drha3cc0072013-12-13 16:23:55 +0000583 assert( zErr!=0 || db->mallocFailed );
drh413c3d32010-02-23 20:11:56 +0000584 sqlite3DbFree(db, v->zErrMsg);
585 if( !db->mallocFailed ){
586 v->zErrMsg = sqlite3DbStrDup(db, zErr);
drha6129fa2010-02-24 17:15:19 +0000587 v->rc = rc2;
drh413c3d32010-02-23 20:11:56 +0000588 } else {
589 v->zErrMsg = 0;
drha6129fa2010-02-24 17:15:19 +0000590 v->rc = rc = SQLITE_NOMEM;
drh413c3d32010-02-23 20:11:56 +0000591 }
592 }
593 rc = sqlite3ApiExit(db, rc);
594 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000595 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000596}
597
drh95a7b3e2013-09-16 12:57:19 +0000598
drh4f26d6c2004-05-26 23:25:30 +0000599/*
drheb2e1762004-05-27 01:53:56 +0000600** Extract the user data from a sqlite3_context structure and return a
601** pointer to it.
602*/
603void *sqlite3_user_data(sqlite3_context *p){
604 assert( p && p->pFunc );
605 return p->pFunc->pUserData;
606}
607
608/*
drhfa4a4b92008-03-19 21:45:51 +0000609** Extract the user data from a sqlite3_context structure and return a
610** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000611**
612** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
613** returns a copy of the pointer to the database connection (the 1st
614** parameter) of the sqlite3_create_function() and
615** sqlite3_create_function16() routines that originally registered the
616** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000617*/
618sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
619 assert( p && p->pFunc );
drh9bd038f2014-08-27 14:14:06 +0000620 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000621}
622
623/*
drh95a7b3e2013-09-16 12:57:19 +0000624** Return the current time for a statement
625*/
626sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
627 Vdbe *v = p->pVdbe;
628 int rc;
629 if( v->iCurrentTime==0 ){
drh9bd038f2014-08-27 14:14:06 +0000630 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, &v->iCurrentTime);
drh95a7b3e2013-09-16 12:57:19 +0000631 if( rc ) v->iCurrentTime = 0;
632 }
633 return v->iCurrentTime;
634}
635
636/*
drhb7481e72006-09-16 21:45:14 +0000637** The following is the implementation of an SQL function that always
638** fails with an error message stating that the function is used in the
639** wrong context. The sqlite3_overload_function() API might construct
640** SQL function that use this routine so that the functions will exist
641** for name resolution but are actually overloaded by the xFindFunction
642** method of virtual tables.
643*/
644void sqlite3InvalidFunction(
645 sqlite3_context *context, /* The function calling context */
danielk197762c14b32008-11-19 09:05:26 +0000646 int NotUsed, /* Number of arguments to the function */
647 sqlite3_value **NotUsed2 /* Value of each argument */
drhb7481e72006-09-16 21:45:14 +0000648){
649 const char *zName = context->pFunc->zName;
650 char *zErr;
danielk197762c14b32008-11-19 09:05:26 +0000651 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhbc6160b2009-04-08 15:45:31 +0000652 zErr = sqlite3_mprintf(
drhb7481e72006-09-16 21:45:14 +0000653 "unable to use function %s in the requested context", zName);
654 sqlite3_result_error(context, zErr, -1);
danielk19771e536952007-08-16 10:09:01 +0000655 sqlite3_free(zErr);
drhb7481e72006-09-16 21:45:14 +0000656}
657
658/*
drh9de4a172014-08-23 18:17:19 +0000659** Create a new aggregate context for p and return a pointer to
660** its pMem->z element.
661*/
662static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
663 Mem *pMem = p->pMem;
664 assert( (pMem->flags & MEM_Agg)==0 );
665 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000666 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000667 pMem->z = 0;
668 }else{
drh322f2852014-09-19 00:43:39 +0000669 sqlite3VdbeMemClearAndResize(pMem, nByte);
drh9de4a172014-08-23 18:17:19 +0000670 pMem->flags = MEM_Agg;
671 pMem->u.pDef = p->pFunc;
672 if( pMem->z ){
673 memset(pMem->z, 0, nByte);
674 }
675 }
676 return (void*)pMem->z;
677}
678
679/*
drheb2e1762004-05-27 01:53:56 +0000680** Allocate or return the aggregate context for a user function. A new
681** context is allocated on the first call. Subsequent calls return the
682** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000683*/
684void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh825c6622005-09-08 19:01:05 +0000685 assert( p && p->pFunc && p->pFunc->xStep );
drh9bd038f2014-08-27 14:14:06 +0000686 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000687 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000688 if( (p->pMem->flags & MEM_Agg)==0 ){
689 return createAggContext(p, nByte);
690 }else{
691 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000692 }
drheb2e1762004-05-27 01:53:56 +0000693}
694
695/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000696** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000697** the user-function defined by pCtx.
698*/
699void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000700 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000701
drh9bd038f2014-08-27 14:14:06 +0000702 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000703 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
704 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
danielk1977682f68b2004-06-05 10:22:17 +0000705 }
dan0c547792013-07-18 17:12:08 +0000706
707 return (pAuxData ? pAuxData->pAux : 0);
danielk1977682f68b2004-06-05 10:22:17 +0000708}
709
710/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000711** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000712** argument to the user-function defined by pCtx. Any previous value is
713** deleted by calling the delete function specified when it was set.
714*/
715void sqlite3_set_auxdata(
716 sqlite3_context *pCtx,
717 int iArg,
718 void *pAux,
719 void (*xDelete)(void*)
720){
dan0c547792013-07-18 17:12:08 +0000721 AuxData *pAuxData;
722 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000723
drh9bd038f2014-08-27 14:14:06 +0000724 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000725 if( iArg<0 ) goto failed;
danielk1977682f68b2004-06-05 10:22:17 +0000726
dan0c547792013-07-18 17:12:08 +0000727 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
728 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
729 }
730 if( pAuxData==0 ){
731 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
732 if( !pAuxData ) goto failed;
733 pAuxData->iOp = pCtx->iOp;
734 pAuxData->iArg = iArg;
735 pAuxData->pNext = pVdbe->pAuxData;
736 pVdbe->pAuxData = pAuxData;
drh9b47ee32013-08-20 03:13:51 +0000737 if( pCtx->fErrorOrAux==0 ){
738 pCtx->isError = 0;
739 pCtx->fErrorOrAux = 1;
740 }
dan0c547792013-07-18 17:12:08 +0000741 }else if( pAuxData->xDelete ){
danielk1977682f68b2004-06-05 10:22:17 +0000742 pAuxData->xDelete(pAuxData->pAux);
743 }
dan0c547792013-07-18 17:12:08 +0000744
danielk1977682f68b2004-06-05 10:22:17 +0000745 pAuxData->pAux = pAux;
746 pAuxData->xDelete = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000747 return;
748
749failed:
750 if( xDelete ){
751 xDelete(pAux);
752 }
danielk1977682f68b2004-06-05 10:22:17 +0000753}
754
shaneeec556d2008-10-12 00:27:53 +0000755#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000756/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000757** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000758** called.
759**
drhcf85a512006-02-09 18:35:29 +0000760** This function is deprecated. Do not use it for new code. It is
761** provide only to avoid breaking legacy code. New aggregate function
762** implementations should keep their own counts within their aggregate
763** context.
drheb2e1762004-05-27 01:53:56 +0000764*/
765int sqlite3_aggregate_count(sqlite3_context *p){
shanee34c6472009-03-05 04:23:47 +0000766 assert( p && p->pMem && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000767 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000768}
shaneeec556d2008-10-12 00:27:53 +0000769#endif
drheb2e1762004-05-27 01:53:56 +0000770
771/*
drh4f26d6c2004-05-26 23:25:30 +0000772** Return the number of columns in the result set for the statement pStmt.
773*/
774int sqlite3_column_count(sqlite3_stmt *pStmt){
775 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000776 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000777}
778
779/*
780** Return the number of values available from the current row of the
781** currently executing statement pStmt.
782*/
783int sqlite3_data_count(sqlite3_stmt *pStmt){
784 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000785 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000786 return pVm->nResColumn;
787}
788
dan46c47d42011-03-01 18:42:07 +0000789/*
790** Return a pointer to static memory containing an SQL NULL value.
791*/
792static const Mem *columnNullValue(void){
793 /* Even though the Mem structure contains an element
drhb1a1c292014-03-05 12:47:55 +0000794 ** of type i64, on certain architectures (x86) with certain compiler
dan46c47d42011-03-01 18:42:07 +0000795 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
796 ** instead of an 8-byte one. This all works fine, except that when
797 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
798 ** that a Mem structure is located on an 8-byte boundary. To prevent
drhb1a1c292014-03-05 12:47:55 +0000799 ** these assert()s from failing, when building with SQLITE_DEBUG defined
800 ** using gcc, we force nullMem to be 8-byte aligned using the magical
dan46c47d42011-03-01 18:42:07 +0000801 ** __attribute__((aligned(8))) macro. */
802 static const Mem nullMem
803#if defined(SQLITE_DEBUG) && defined(__GNUC__)
drhb1a1c292014-03-05 12:47:55 +0000804 __attribute__((aligned(8)))
dan46c47d42011-03-01 18:42:07 +0000805#endif
drh035e5632014-09-16 14:16:31 +0000806 = {
drh3329a632014-09-18 01:21:43 +0000807 /* .u = */ {0},
808 /* .flags = */ MEM_Null,
809 /* .enc = */ 0,
810 /* .n = */ 0,
drh3329a632014-09-18 01:21:43 +0000811 /* .z = */ 0,
812 /* .zMalloc = */ 0,
drh17bcb102014-09-18 21:25:33 +0000813 /* .szMalloc = */ 0,
814 /* .iPadding1 = */ 0,
drh3329a632014-09-18 01:21:43 +0000815 /* .db = */ 0,
816 /* .xDel = */ 0,
drhb1a1c292014-03-05 12:47:55 +0000817#ifdef SQLITE_DEBUG
drh3329a632014-09-18 01:21:43 +0000818 /* .pScopyFrom = */ 0,
819 /* .pFiller = */ 0,
drhb1a1c292014-03-05 12:47:55 +0000820#endif
drh035e5632014-09-16 14:16:31 +0000821 };
dan46c47d42011-03-01 18:42:07 +0000822 return &nullMem;
823}
drh4f26d6c2004-05-26 23:25:30 +0000824
825/*
826** Check to see if column iCol of the given statement is valid. If
827** it is, return a pointer to the Mem for the value of that column.
828** If iCol is not valid, return a pointer to a Mem which has a value
829** of NULL.
830*/
831static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000832 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000833 Mem *pOut;
834
835 pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000836 if( pVm && pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drh32bc3f62007-08-21 20:25:39 +0000837 sqlite3_mutex_enter(pVm->db->mutex);
drhd4e70eb2008-01-02 00:34:36 +0000838 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +0000839 }else{
drh9b4ea4a2009-04-10 20:32:00 +0000840 if( pVm && ALWAYS(pVm->db) ){
drh27641702007-08-22 02:56:42 +0000841 sqlite3_mutex_enter(pVm->db->mutex);
drh13f40da2014-08-22 18:00:11 +0000842 sqlite3Error(pVm->db, SQLITE_RANGE);
drh27641702007-08-22 02:56:42 +0000843 }
dan46c47d42011-03-01 18:42:07 +0000844 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +0000845 }
drh32bc3f62007-08-21 20:25:39 +0000846 return pOut;
drh4f26d6c2004-05-26 23:25:30 +0000847}
848
danielk19772e588c72005-12-09 14:25:08 +0000849/*
850** This function is called after invoking an sqlite3_value_XXX function on a
851** column value (i.e. a value returned by evaluating an SQL expression in the
852** select list of a SELECT statement) that may cause a malloc() failure. If
853** malloc() has failed, the threads mallocFailed flag is cleared and the result
854** code of statement pStmt set to SQLITE_NOMEM.
855**
drh32bc3f62007-08-21 20:25:39 +0000856** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +0000857**
858** sqlite3_column_int()
859** sqlite3_column_int64()
860** sqlite3_column_text()
861** sqlite3_column_text16()
862** sqlite3_column_real()
863** sqlite3_column_bytes()
864** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +0000865** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +0000866*/
867static void columnMallocFailure(sqlite3_stmt *pStmt)
868{
869 /* If malloc() failed during an encoding conversion within an
870 ** sqlite3_column_XXX API, then set the return code of the statement to
871 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
872 ** and _finalize() will return NOMEM.
873 */
danielk197754f01982006-01-18 15:25:17 +0000874 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000875 if( p ){
876 p->rc = sqlite3ApiExit(p->db, p->rc);
877 sqlite3_mutex_leave(p->db->mutex);
878 }
danielk19772e588c72005-12-09 14:25:08 +0000879}
880
drh4f26d6c2004-05-26 23:25:30 +0000881/**************************** sqlite3_column_ *******************************
882** The following routines are used to access elements of the current row
883** in the result set.
884*/
danielk1977c572ef72004-05-27 09:28:41 +0000885const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000886 const void *val;
danielk19772e588c72005-12-09 14:25:08 +0000887 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +0000888 /* Even though there is no encoding conversion, value_blob() might
889 ** need to call malloc() to expand the result of a zeroblob()
890 ** expression.
891 */
892 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +0000893 return val;
danielk1977c572ef72004-05-27 09:28:41 +0000894}
drh4f26d6c2004-05-26 23:25:30 +0000895int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000896 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
897 columnMallocFailure(pStmt);
898 return val;
drh4f26d6c2004-05-26 23:25:30 +0000899}
900int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000901 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
902 columnMallocFailure(pStmt);
903 return val;
drh4f26d6c2004-05-26 23:25:30 +0000904}
905double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000906 double val = sqlite3_value_double( columnMem(pStmt,i) );
907 columnMallocFailure(pStmt);
908 return val;
drh4f26d6c2004-05-26 23:25:30 +0000909}
910int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000911 int val = sqlite3_value_int( columnMem(pStmt,i) );
912 columnMallocFailure(pStmt);
913 return val;
drh4f26d6c2004-05-26 23:25:30 +0000914}
drhefad9992004-06-22 12:13:55 +0000915sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000916 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
917 columnMallocFailure(pStmt);
918 return val;
drh4f26d6c2004-05-26 23:25:30 +0000919}
920const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000921 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
922 columnMallocFailure(pStmt);
923 return val;
drh4f26d6c2004-05-26 23:25:30 +0000924}
drhd1e47332005-06-26 17:55:33 +0000925sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +0000926 Mem *pOut = columnMem(pStmt, i);
927 if( pOut->flags&MEM_Static ){
928 pOut->flags &= ~MEM_Static;
929 pOut->flags |= MEM_Ephem;
930 }
drh32bc3f62007-08-21 20:25:39 +0000931 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +0000932 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +0000933}
drh6c626082004-11-14 21:56:29 +0000934#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000935const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000936 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
937 columnMallocFailure(pStmt);
938 return val;
drh4f26d6c2004-05-26 23:25:30 +0000939}
drh6c626082004-11-14 21:56:29 +0000940#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000941int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000942 int iType = sqlite3_value_type( columnMem(pStmt,i) );
943 columnMallocFailure(pStmt);
944 return iType;
drh4f26d6c2004-05-26 23:25:30 +0000945}
946
drh5e2517e2004-09-24 23:59:12 +0000947/*
948** Convert the N-th element of pStmt->pColName[] into a string using
949** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000950**
951** There are up to 5 names for each column. useType determines which
952** name is returned. Here are the names:
953**
954** 0 The column name as it should be displayed for output
955** 1 The datatype name for the column
956** 2 The name of the database that the column derives from
957** 3 The name of the table that the column derives from
958** 4 The name of the table column that the result column derives from
959**
960** If the result is not a simple column reference (if it is an expression
961** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000962*/
963static const void *columnName(
964 sqlite3_stmt *pStmt,
965 int N,
966 const void *(*xFunc)(Mem*),
967 int useType
968){
drh9ca95732014-10-24 00:35:58 +0000969 const void *ret;
970 Vdbe *p;
drh32bc3f62007-08-21 20:25:39 +0000971 int n;
drh9ca95732014-10-24 00:35:58 +0000972 sqlite3 *db;
973#ifdef SQLITE_ENABLE_API_ARMOR
974 if( pStmt==0 ){
975 (void)SQLITE_MISUSE_BKPT;
976 return 0;
977 }
978#endif
979 ret = 0;
980 p = (Vdbe *)pStmt;
981 db = p->db;
drh9b4ea4a2009-04-10 20:32:00 +0000982 assert( db!=0 );
983 n = sqlite3_column_count(pStmt);
984 if( N<n && N>=0 ){
985 N += useType*n;
986 sqlite3_mutex_enter(db->mutex);
987 assert( db->mallocFailed==0 );
988 ret = xFunc(&p->aColName[N]);
989 /* A malloc may have failed inside of the xFunc() call. If this
990 ** is the case, clear the mallocFailed flag and return NULL.
991 */
992 if( db->mallocFailed ){
993 db->mallocFailed = 0;
994 ret = 0;
drh32bc3f62007-08-21 20:25:39 +0000995 }
drh9b4ea4a2009-04-10 20:32:00 +0000996 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +0000997 }
danielk197700fd9572005-12-07 06:27:43 +0000998 return ret;
drh5e2517e2004-09-24 23:59:12 +0000999}
1000
drh4f26d6c2004-05-26 23:25:30 +00001001/*
1002** Return the name of the Nth column of the result set returned by SQL
1003** statement pStmt.
1004*/
1005const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001006 return columnName(
1007 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +00001008}
drhe590fbd2005-05-20 19:36:01 +00001009#ifndef SQLITE_OMIT_UTF16
1010const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001011 return columnName(
1012 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001013}
1014#endif
drh4f26d6c2004-05-26 23:25:30 +00001015
1016/*
drh3f913572008-03-22 01:07:17 +00001017** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1018** not define OMIT_DECLTYPE.
1019*/
1020#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1021# error "Must not define both SQLITE_OMIT_DECLTYPE \
1022 and SQLITE_ENABLE_COLUMN_METADATA"
1023#endif
1024
1025#ifndef SQLITE_OMIT_DECLTYPE
1026/*
drh6c626082004-11-14 21:56:29 +00001027** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001028** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001029*/
1030const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001031 return columnName(
1032 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001033}
drh6c626082004-11-14 21:56:29 +00001034#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001035const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001036 return columnName(
1037 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001038}
drh6c626082004-11-14 21:56:29 +00001039#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001040#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001041
danielk19774b1ae992006-02-10 03:06:10 +00001042#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001043/*
1044** Return the name of the database from which a result column derives.
1045** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001046** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001047*/
1048const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001049 return columnName(
1050 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001051}
1052#ifndef SQLITE_OMIT_UTF16
1053const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001054 return columnName(
1055 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001056}
1057#endif /* SQLITE_OMIT_UTF16 */
1058
1059/*
1060** Return the name of the table from which a result column derives.
1061** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001062** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001063*/
1064const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001065 return columnName(
1066 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001067}
1068#ifndef SQLITE_OMIT_UTF16
1069const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001070 return columnName(
1071 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001072}
1073#endif /* SQLITE_OMIT_UTF16 */
1074
1075/*
1076** Return the name of the table column from which a result column derives.
1077** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001078** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001079*/
1080const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001081 return columnName(
1082 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001083}
1084#ifndef SQLITE_OMIT_UTF16
1085const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001086 return columnName(
1087 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001088}
1089#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001090#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001091
1092
drh4f26d6c2004-05-26 23:25:30 +00001093/******************************* sqlite3_bind_ ***************************
1094**
1095** Routines used to attach values to wildcards in a compiled SQL statement.
1096*/
1097/*
1098** Unbind the value bound to variable i in virtual machine p. This is the
1099** the same as binding a NULL value to the column. If the "i" parameter is
1100** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1101**
drh488e7b62008-10-06 12:46:43 +00001102** A successful evaluation of this routine acquires the mutex on p.
1103** the mutex is released if any kind of error occurs.
1104**
drh4f26d6c2004-05-26 23:25:30 +00001105** The error code stored in database p->db is overwritten with the return
1106** value in any case.
1107*/
1108static int vdbeUnbind(Vdbe *p, int i){
1109 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001110 if( vdbeSafetyNotNull(p) ){
1111 return SQLITE_MISUSE_BKPT;
1112 }
drh488e7b62008-10-06 12:46:43 +00001113 sqlite3_mutex_enter(p->db->mutex);
1114 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001115 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001116 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001117 sqlite3_log(SQLITE_MISUSE,
1118 "bind on a busy prepared statement: [%s]", p->zSql);
1119 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001120 }
1121 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001122 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001123 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001124 return SQLITE_RANGE;
1125 }
1126 i--;
drh290c1942004-08-21 17:54:45 +00001127 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001128 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001129 pVar->flags = MEM_Null;
drh13f40da2014-08-22 18:00:11 +00001130 sqlite3Error(p->db, SQLITE_OK);
dan937d0de2009-10-15 18:35:38 +00001131
dan1d2ce4f2009-10-19 18:11:09 +00001132 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1133 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001134 **
1135 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1136 ** parameter in the WHERE clause might influence the choice of query plan
1137 ** for a statement, then the statement will be automatically recompiled,
1138 ** as if there had been a schema change, on the first sqlite3_step() call
1139 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001140 */
drh823e09a2009-10-19 20:15:38 +00001141 if( p->isPrepareV2 &&
1142 ((i<32 && p->expmask & ((u32)1 << i)) || p->expmask==0xffffffff)
1143 ){
dan937d0de2009-10-15 18:35:38 +00001144 p->expired = 1;
1145 }
drh4f26d6c2004-05-26 23:25:30 +00001146 return SQLITE_OK;
1147}
1148
1149/*
drh5e2517e2004-09-24 23:59:12 +00001150** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001151*/
drh5e2517e2004-09-24 23:59:12 +00001152static int bindText(
drh605264d2007-08-21 15:13:19 +00001153 sqlite3_stmt *pStmt, /* The statement to bind against */
1154 int i, /* Index of the parameter to bind */
1155 const void *zData, /* Pointer to the data to be bound */
1156 int nData, /* Number of bytes of data to be bound */
1157 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001158 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001159){
1160 Vdbe *p = (Vdbe *)pStmt;
1161 Mem *pVar;
1162 int rc;
1163
1164 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001165 if( rc==SQLITE_OK ){
1166 if( zData!=0 ){
1167 pVar = &p->aVar[i-1];
1168 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1169 if( rc==SQLITE_OK && encoding!=0 ){
1170 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1171 }
drh13f40da2014-08-22 18:00:11 +00001172 sqlite3Error(p->db, rc);
drh488e7b62008-10-06 12:46:43 +00001173 rc = sqlite3ApiExit(p->db, rc);
drh27641702007-08-22 02:56:42 +00001174 }
drh488e7b62008-10-06 12:46:43 +00001175 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001176 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001177 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001178 }
drh605264d2007-08-21 15:13:19 +00001179 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001180}
drh5e2517e2004-09-24 23:59:12 +00001181
1182
1183/*
1184** Bind a blob value to an SQL statement variable.
1185*/
1186int sqlite3_bind_blob(
1187 sqlite3_stmt *pStmt,
1188 int i,
1189 const void *zData,
1190 int nData,
1191 void (*xDel)(void*)
1192){
1193 return bindText(pStmt, i, zData, nData, xDel, 0);
1194}
drhda4ca9d2014-09-09 17:27:35 +00001195int sqlite3_bind_blob64(
1196 sqlite3_stmt *pStmt,
1197 int i,
1198 const void *zData,
1199 sqlite3_uint64 nData,
1200 void (*xDel)(void*)
1201){
drhfc59a952014-09-11 23:34:55 +00001202 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001203 if( nData>0x7fffffff ){
1204 return invokeValueDestructor(zData, xDel, 0);
1205 }else{
drh3329a632014-09-18 01:21:43 +00001206 return bindText(pStmt, i, zData, (int)nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001207 }
1208}
drh4f26d6c2004-05-26 23:25:30 +00001209int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1210 int rc;
1211 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001212 rc = vdbeUnbind(p, i);
1213 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001214 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001215 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001216 }
danielk1977f4618892004-06-28 13:09:11 +00001217 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001218}
1219int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001220 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001221}
drhefad9992004-06-22 12:13:55 +00001222int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001223 int rc;
1224 Vdbe *p = (Vdbe *)pStmt;
1225 rc = vdbeUnbind(p, i);
1226 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001227 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001228 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001229 }
1230 return rc;
1231}
drh605264d2007-08-21 15:13:19 +00001232int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1233 int rc;
1234 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001235 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001236 if( rc==SQLITE_OK ){
1237 sqlite3_mutex_leave(p->db->mutex);
1238 }
drh605264d2007-08-21 15:13:19 +00001239 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001240}
1241int sqlite3_bind_text(
1242 sqlite3_stmt *pStmt,
1243 int i,
1244 const char *zData,
1245 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001246 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001247){
drh5e2517e2004-09-24 23:59:12 +00001248 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001249}
drhbbf483f2014-09-09 20:30:24 +00001250int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001251 sqlite3_stmt *pStmt,
1252 int i,
1253 const char *zData,
1254 sqlite3_uint64 nData,
1255 void (*xDel)(void*),
1256 unsigned char enc
1257){
drhfc59a952014-09-11 23:34:55 +00001258 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001259 if( nData>0x7fffffff ){
1260 return invokeValueDestructor(zData, xDel, 0);
1261 }else{
drhfc59a952014-09-11 23:34:55 +00001262 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drh3329a632014-09-18 01:21:43 +00001263 return bindText(pStmt, i, zData, (int)nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001264 }
1265}
drh6c626082004-11-14 21:56:29 +00001266#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001267int sqlite3_bind_text16(
1268 sqlite3_stmt *pStmt,
1269 int i,
1270 const void *zData,
1271 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001272 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001273){
drh5e2517e2004-09-24 23:59:12 +00001274 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001275}
drh6c626082004-11-14 21:56:29 +00001276#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001277int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1278 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001279 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001280 case SQLITE_INTEGER: {
1281 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1282 break;
1283 }
1284 case SQLITE_FLOAT: {
drh74eaba42014-09-18 17:52:15 +00001285 rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
drh29def562009-04-14 12:43:33 +00001286 break;
1287 }
1288 case SQLITE_BLOB: {
1289 if( pValue->flags & MEM_Zero ){
1290 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1291 }else{
1292 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1293 }
1294 break;
1295 }
1296 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001297 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1298 pValue->enc);
1299 break;
1300 }
1301 default: {
1302 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001303 break;
1304 }
danielk197726e41442006-06-14 15:16:35 +00001305 }
1306 return rc;
1307}
drhb026e052007-05-02 01:34:31 +00001308int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1309 int rc;
1310 Vdbe *p = (Vdbe *)pStmt;
1311 rc = vdbeUnbind(p, i);
1312 if( rc==SQLITE_OK ){
1313 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001314 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001315 }
1316 return rc;
1317}
drh75f6a032004-07-15 14:15:00 +00001318
1319/*
1320** Return the number of wildcards that can be potentially bound to.
1321** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001322*/
1323int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001324 Vdbe *p = (Vdbe*)pStmt;
1325 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001326}
drh895d7472004-08-20 16:02:39 +00001327
1328/*
drhfa6bc002004-09-07 16:19:52 +00001329** Return the name of a wildcard parameter. Return NULL if the index
1330** is out of range or if the wildcard is unnamed.
1331**
1332** The result is always UTF-8.
1333*/
1334const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1335 Vdbe *p = (Vdbe*)pStmt;
drh124c0b42011-06-01 18:15:55 +00001336 if( p==0 || i<1 || i>p->nzVar ){
drhfa6bc002004-09-07 16:19:52 +00001337 return 0;
1338 }
drh895d7472004-08-20 16:02:39 +00001339 return p->azVar[i-1];
1340}
drhfa6bc002004-09-07 16:19:52 +00001341
1342/*
1343** Given a wildcard parameter name, return the index of the variable
1344** with that name. If there is no variable with the given name,
1345** return 0.
1346*/
drh5f18a222009-11-26 14:01:53 +00001347int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drhfa6bc002004-09-07 16:19:52 +00001348 int i;
1349 if( p==0 ){
1350 return 0;
1351 }
drh6a8903c2004-12-10 18:00:04 +00001352 if( zName ){
drh124c0b42011-06-01 18:15:55 +00001353 for(i=0; i<p->nzVar; i++){
drh6a8903c2004-12-10 18:00:04 +00001354 const char *z = p->azVar[i];
drh503a6862013-03-01 01:07:17 +00001355 if( z && strncmp(z,zName,nName)==0 && z[nName]==0 ){
drh6a8903c2004-12-10 18:00:04 +00001356 return i+1;
1357 }
drhfa6bc002004-09-07 16:19:52 +00001358 }
1359 }
1360 return 0;
1361}
drh5f18a222009-11-26 14:01:53 +00001362int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1363 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1364}
drhf8db1bc2005-04-22 02:38:37 +00001365
drh51942bc2005-06-12 22:01:42 +00001366/*
drhf8db1bc2005-04-22 02:38:37 +00001367** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001368*/
shane145834a2008-09-04 12:03:42 +00001369int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001370 Vdbe *pFrom = (Vdbe*)pFromStmt;
1371 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001372 int i;
1373 assert( pTo->db==pFrom->db );
1374 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001375 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001376 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001377 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001378 }
drh27641702007-08-22 02:56:42 +00001379 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001380 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001381}
drh51942bc2005-06-12 22:01:42 +00001382
shaneeec556d2008-10-12 00:27:53 +00001383#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001384/*
shane145834a2008-09-04 12:03:42 +00001385** Deprecated external interface. Internal/core SQLite code
1386** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001387**
peter.d.reid60ec9142014-09-06 16:39:46 +00001388** It is misuse to call this routine with statements from different
drh0f5ea0b2009-04-09 14:02:44 +00001389** database connections. But as this is a deprecated interface, we
1390** will not bother to check for that condition.
1391**
1392** If the two statements contain a different number of bindings, then
1393** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1394** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001395*/
1396int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001397 Vdbe *pFrom = (Vdbe*)pFromStmt;
1398 Vdbe *pTo = (Vdbe*)pToStmt;
1399 if( pFrom->nVar!=pTo->nVar ){
1400 return SQLITE_ERROR;
1401 }
danc94b8592009-10-20 07:01:24 +00001402 if( pTo->isPrepareV2 && pTo->expmask ){
1403 pTo->expired = 1;
1404 }
1405 if( pFrom->isPrepareV2 && pFrom->expmask ){
1406 pFrom->expired = 1;
1407 }
shane145834a2008-09-04 12:03:42 +00001408 return sqlite3TransferBindings(pFromStmt, pToStmt);
1409}
shaneeec556d2008-10-12 00:27:53 +00001410#endif
shane145834a2008-09-04 12:03:42 +00001411
1412/*
drh51942bc2005-06-12 22:01:42 +00001413** Return the sqlite3* database handle to which the prepared statement given
1414** in the argument belongs. This is the same database handle that was
1415** the first argument to the sqlite3_prepare() that was used to create
1416** the statement in the first place.
1417*/
1418sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1419 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1420}
drhbb5a9c32008-06-19 02:52:25 +00001421
1422/*
drhf03d9cc2010-11-16 23:10:25 +00001423** Return true if the prepared statement is guaranteed to not modify the
1424** database.
1425*/
1426int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1427 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1428}
1429
1430/*
drh2fb66932011-11-25 17:21:47 +00001431** Return true if the prepared statement is in need of being reset.
1432*/
1433int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1434 Vdbe *v = (Vdbe*)pStmt;
dan857745c2014-07-19 17:57:10 +00001435 return v!=0 && v->pc>=0 && v->magic==VDBE_MAGIC_RUN;
drh2fb66932011-11-25 17:21:47 +00001436}
1437
1438/*
drhbb5a9c32008-06-19 02:52:25 +00001439** Return a pointer to the next prepared statement after pStmt associated
1440** with database connection pDb. If pStmt is NULL, return the first
1441** prepared statement for the database connection. Return NULL if there
1442** are no more.
1443*/
1444sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1445 sqlite3_stmt *pNext;
drh9ca95732014-10-24 00:35:58 +00001446#ifdef SQLITE_ENABLE_API_ARMOR
1447 if( !sqlite3SafetyCheckOk(pDb) ){
1448 (void)SQLITE_MISUSE_BKPT;
1449 return 0;
1450 }
1451#endif
drhbb5a9c32008-06-19 02:52:25 +00001452 sqlite3_mutex_enter(pDb->mutex);
1453 if( pStmt==0 ){
1454 pNext = (sqlite3_stmt*)pDb->pVdbe;
1455 }else{
1456 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1457 }
1458 sqlite3_mutex_leave(pDb->mutex);
1459 return pNext;
1460}
drhd1d38482008-10-07 23:46:38 +00001461
1462/*
1463** Return the value of a status counter for a prepared statement
1464*/
1465int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1466 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9ca95732014-10-24 00:35:58 +00001467 u32 v;
1468#ifdef SQLITE_ENABLE_API_ARMOR
1469 if( !pStmt ){
1470 (void)SQLITE_MISUSE_BKPT;
1471 return 0;
1472 }
1473#endif
1474 v = pVdbe->aCounter[op];
drh9b47ee32013-08-20 03:13:51 +00001475 if( resetFlag ) pVdbe->aCounter[op] = 0;
1476 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001477}
dan46c47d42011-03-01 18:42:07 +00001478
drh9b1c62d2011-03-30 21:04:43 +00001479#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001480/*
dan93bca692011-09-14 19:41:44 +00001481** Allocate and populate an UnpackedRecord structure based on the serialized
1482** record in nKey/pKey. Return a pointer to the new UnpackedRecord structure
1483** if successful, or a NULL pointer if an OOM error is encountered.
1484*/
1485static UnpackedRecord *vdbeUnpackRecord(
1486 KeyInfo *pKeyInfo,
1487 int nKey,
1488 const void *pKey
1489){
1490 char *dummy; /* Dummy argument for AllocUnpackedRecord() */
1491 UnpackedRecord *pRet; /* Return value */
1492
1493 pRet = sqlite3VdbeAllocUnpackedRecord(pKeyInfo, 0, 0, &dummy);
1494 if( pRet ){
drhc8d985e2013-12-14 18:24:46 +00001495 memset(pRet->aMem, 0, sizeof(Mem)*(pKeyInfo->nField+1));
dan93bca692011-09-14 19:41:44 +00001496 sqlite3VdbeRecordUnpack(pKeyInfo, nKey, pKey, pRet);
1497 }
1498 return pRet;
1499}
1500
1501/*
dan37db03b2011-03-16 19:59:18 +00001502** This function is called from within a pre-update callback to retrieve
1503** a field of the row currently being updated or deleted.
1504*/
dan46c47d42011-03-01 18:42:07 +00001505int sqlite3_preupdate_old(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
1506 PreUpdate *p = db->pPreUpdate;
1507 int rc = SQLITE_OK;
1508
dan37db03b2011-03-16 19:59:18 +00001509 /* Test that this call is being made from within an SQLITE_DELETE or
1510 ** SQLITE_UPDATE pre-update callback, and that iIdx is within range. */
dan46c47d42011-03-01 18:42:07 +00001511 if( !p || p->op==SQLITE_INSERT ){
1512 rc = SQLITE_MISUSE_BKPT;
1513 goto preupdate_old_out;
1514 }
1515 if( iIdx>=p->pCsr->nField || iIdx<0 ){
1516 rc = SQLITE_RANGE;
1517 goto preupdate_old_out;
1518 }
1519
dan37db03b2011-03-16 19:59:18 +00001520 /* If the old.* record has not yet been loaded into memory, do so now. */
dan46c47d42011-03-01 18:42:07 +00001521 if( p->pUnpacked==0 ){
dan12ca0b52011-03-21 16:17:42 +00001522 u32 nRec;
1523 u8 *aRec;
dan46c47d42011-03-01 18:42:07 +00001524
dan12ca0b52011-03-21 16:17:42 +00001525 rc = sqlite3BtreeDataSize(p->pCsr->pCursor, &nRec);
dan46c47d42011-03-01 18:42:07 +00001526 if( rc!=SQLITE_OK ) goto preupdate_old_out;
dan12ca0b52011-03-21 16:17:42 +00001527 aRec = sqlite3DbMallocRaw(db, nRec);
1528 if( !aRec ) goto preupdate_old_out;
1529 rc = sqlite3BtreeData(p->pCsr->pCursor, 0, nRec, aRec);
1530 if( rc==SQLITE_OK ){
dan93bca692011-09-14 19:41:44 +00001531 p->pUnpacked = vdbeUnpackRecord(&p->keyinfo, nRec, aRec);
dan12ca0b52011-03-21 16:17:42 +00001532 if( !p->pUnpacked ) rc = SQLITE_NOMEM;
1533 }
dan46c47d42011-03-01 18:42:07 +00001534 if( rc!=SQLITE_OK ){
dan12ca0b52011-03-21 16:17:42 +00001535 sqlite3DbFree(db, aRec);
dan46c47d42011-03-01 18:42:07 +00001536 goto preupdate_old_out;
1537 }
dan12ca0b52011-03-21 16:17:42 +00001538 p->aRecord = aRec;
dan46c47d42011-03-01 18:42:07 +00001539 }
1540
1541 if( iIdx>=p->pUnpacked->nField ){
1542 *ppValue = (sqlite3_value *)columnNullValue();
1543 }else{
1544 *ppValue = &p->pUnpacked->aMem[iIdx];
dan319eeb72011-03-19 08:38:50 +00001545 if( iIdx==p->iPKey ){
1546 sqlite3VdbeMemSetInt64(*ppValue, p->iKey1);
1547 }
dan46c47d42011-03-01 18:42:07 +00001548 }
1549
1550 preupdate_old_out:
drhe1ed0b02014-08-26 02:15:07 +00001551 sqlite3Error(db, rc);
dan46c47d42011-03-01 18:42:07 +00001552 return sqlite3ApiExit(db, rc);
1553}
drh9b1c62d2011-03-30 21:04:43 +00001554#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00001555
drh9b1c62d2011-03-30 21:04:43 +00001556#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001557/*
1558** This function is called from within a pre-update callback to retrieve
1559** the number of columns in the row being updated, deleted or inserted.
1560*/
dan46c47d42011-03-01 18:42:07 +00001561int sqlite3_preupdate_count(sqlite3 *db){
1562 PreUpdate *p = db->pPreUpdate;
dane437ca52011-07-11 19:45:38 +00001563 return (p ? p->keyinfo.nField : 0);
dan46c47d42011-03-01 18:42:07 +00001564}
drh9b1c62d2011-03-30 21:04:43 +00001565#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00001566
drh9b1c62d2011-03-30 21:04:43 +00001567#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan37db03b2011-03-16 19:59:18 +00001568/*
dan1e7a2d42011-03-22 18:45:29 +00001569** This function is designed to be called from within a pre-update callback
1570** only. It returns zero if the change that caused the callback was made
1571** immediately by a user SQL statement. Or, if the change was made by a
1572** trigger program, it returns the number of trigger programs currently
1573** on the stack (1 for a top-level trigger, 2 for a trigger fired by a
1574** top-level trigger etc.).
1575**
1576** For the purposes of the previous paragraph, a foreign key CASCADE, SET NULL
1577** or SET DEFAULT action is considered a trigger.
1578*/
1579int sqlite3_preupdate_depth(sqlite3 *db){
1580 PreUpdate *p = db->pPreUpdate;
1581 return (p ? p->v->nFrame : 0);
1582}
drh9b1c62d2011-03-30 21:04:43 +00001583#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan1e7a2d42011-03-22 18:45:29 +00001584
drh9b1c62d2011-03-30 21:04:43 +00001585#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan1e7a2d42011-03-22 18:45:29 +00001586/*
dan37db03b2011-03-16 19:59:18 +00001587** This function is called from within a pre-update callback to retrieve
1588** a field of the row currently being updated or inserted.
1589*/
1590int sqlite3_preupdate_new(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
dan46c47d42011-03-01 18:42:07 +00001591 PreUpdate *p = db->pPreUpdate;
1592 int rc = SQLITE_OK;
dan37db03b2011-03-16 19:59:18 +00001593 Mem *pMem;
dan46c47d42011-03-01 18:42:07 +00001594
dan37db03b2011-03-16 19:59:18 +00001595 if( !p || p->op==SQLITE_DELETE ){
dan46c47d42011-03-01 18:42:07 +00001596 rc = SQLITE_MISUSE_BKPT;
dan37db03b2011-03-16 19:59:18 +00001597 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001598 }
1599 if( iIdx>=p->pCsr->nField || iIdx<0 ){
1600 rc = SQLITE_RANGE;
dan37db03b2011-03-16 19:59:18 +00001601 goto preupdate_new_out;
dan46c47d42011-03-01 18:42:07 +00001602 }
dan46c47d42011-03-01 18:42:07 +00001603
dan37db03b2011-03-16 19:59:18 +00001604 if( p->op==SQLITE_INSERT ){
1605 /* For an INSERT, memory cell p->iNewReg contains the serialized record
1606 ** that is being inserted. Deserialize it. */
1607 UnpackedRecord *pUnpack = p->pNewUnpacked;
1608 if( !pUnpack ){
1609 Mem *pData = &p->v->aMem[p->iNewReg];
1610 rc = sqlite3VdbeMemExpandBlob(pData);
1611 if( rc!=SQLITE_OK ) goto preupdate_new_out;
dan93bca692011-09-14 19:41:44 +00001612 pUnpack = vdbeUnpackRecord(&p->keyinfo, pData->n, pData->z);
dan37db03b2011-03-16 19:59:18 +00001613 if( !pUnpack ){
1614 rc = SQLITE_NOMEM;
1615 goto preupdate_new_out;
1616 }
1617 p->pNewUnpacked = pUnpack;
1618 }
1619 if( iIdx>=pUnpack->nField ){
1620 pMem = (sqlite3_value *)columnNullValue();
1621 }else{
1622 pMem = &pUnpack->aMem[iIdx];
dan319eeb72011-03-19 08:38:50 +00001623 if( iIdx==p->iPKey ){
1624 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1625 }
dan37db03b2011-03-16 19:59:18 +00001626 }
1627 }else{
1628 /* For an UPDATE, memory cell (p->iNewReg+1+iIdx) contains the required
1629 ** value. Make a copy of the cell contents and return a pointer to it.
1630 ** It is not safe to return a pointer to the memory cell itself as the
1631 ** caller may modify the value text encoding.
1632 */
1633 assert( p->op==SQLITE_UPDATE );
1634 if( !p->aNew ){
1635 p->aNew = (Mem *)sqlite3DbMallocZero(db, sizeof(Mem) * p->pCsr->nField);
1636 if( !p->aNew ){
1637 rc = SQLITE_NOMEM;
1638 goto preupdate_new_out;
1639 }
1640 }
drh304637c2011-03-18 16:47:27 +00001641 assert( iIdx>=0 && iIdx<p->pCsr->nField );
dan37db03b2011-03-16 19:59:18 +00001642 pMem = &p->aNew[iIdx];
1643 if( pMem->flags==0 ){
dan319eeb72011-03-19 08:38:50 +00001644 if( iIdx==p->iPKey ){
1645 sqlite3VdbeMemSetInt64(pMem, p->iKey2);
1646 }else{
1647 rc = sqlite3VdbeMemCopy(pMem, &p->v->aMem[p->iNewReg+1+iIdx]);
1648 if( rc!=SQLITE_OK ) goto preupdate_new_out;
1649 }
dan37db03b2011-03-16 19:59:18 +00001650 }
1651 }
1652 *ppValue = pMem;
1653
1654 preupdate_new_out:
drhe1ed0b02014-08-26 02:15:07 +00001655 sqlite3Error(db, rc);
dan46c47d42011-03-01 18:42:07 +00001656 return sqlite3ApiExit(db, rc);
1657}
drh9b1c62d2011-03-30 21:04:43 +00001658#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
drh04e8a582014-11-18 21:20:57 +00001659
dan6f9702e2014-11-01 20:38:06 +00001660#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan04489b62014-10-31 20:11:32 +00001661/*
1662** Return status data for a single loop within query pStmt.
1663*/
1664int sqlite3_stmt_scanstatus(
drhd1a1c232014-11-03 16:35:55 +00001665 sqlite3_stmt *pStmt, /* Prepared statement being queried */
dan04489b62014-10-31 20:11:32 +00001666 int idx, /* Index of loop to report on */
drhd1a1c232014-11-03 16:35:55 +00001667 int iScanStatusOp, /* Which metric to return */
1668 void *pOut /* OUT: Write the answer here */
dan04489b62014-10-31 20:11:32 +00001669){
1670 Vdbe *p = (Vdbe*)pStmt;
dan037b5322014-11-03 11:25:32 +00001671 ScanStatus *pScan;
dan6f9702e2014-11-01 20:38:06 +00001672 if( idx<0 || idx>=p->nScan ) return 1;
1673 pScan = &p->aScan[idx];
drhd1a1c232014-11-03 16:35:55 +00001674 switch( iScanStatusOp ){
1675 case SQLITE_SCANSTAT_NLOOP: {
1676 *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
1677 break;
1678 }
1679 case SQLITE_SCANSTAT_NVISIT: {
1680 *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
1681 break;
1682 }
1683 case SQLITE_SCANSTAT_EST: {
drh518140e2014-11-06 03:55:10 +00001684 double r = 1.0;
1685 LogEst x = pScan->nEst;
1686 while( x<100 ){
1687 x += 10;
1688 r *= 0.5;
1689 }
1690 *(double*)pOut = r*sqlite3LogEstToInt(x);
drhd1a1c232014-11-03 16:35:55 +00001691 break;
1692 }
1693 case SQLITE_SCANSTAT_NAME: {
dand72219d2014-11-03 16:39:37 +00001694 *(const char**)pOut = pScan->zName;
drhd1a1c232014-11-03 16:35:55 +00001695 break;
1696 }
1697 case SQLITE_SCANSTAT_EXPLAIN: {
1698 if( pScan->addrExplain ){
1699 *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
1700 }else{
1701 *(const char**)pOut = 0;
1702 }
1703 break;
1704 }
drhc6652b12014-11-06 04:42:20 +00001705 case SQLITE_SCANSTAT_SELECTID: {
1706 if( pScan->addrExplain ){
1707 *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
1708 }else{
1709 *(int*)pOut = -1;
1710 }
1711 break;
1712 }
drhd1a1c232014-11-03 16:35:55 +00001713 default: {
1714 return 1;
dan6f9702e2014-11-01 20:38:06 +00001715 }
1716 }
dan04489b62014-10-31 20:11:32 +00001717 return 0;
1718}
1719
1720/*
1721** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
1722*/
1723void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
1724 Vdbe *p = (Vdbe*)pStmt;
dan6f9702e2014-11-01 20:38:06 +00001725 memset(p->anExec, 0, p->nOp * sizeof(i64));
dan04489b62014-10-31 20:11:32 +00001726}
dan6f9702e2014-11-01 20:38:06 +00001727#endif /* SQLITE_ENABLE_STMT_SCANSTATUS */