blob: e49c663064ab79bd1e9b882574b50dcb4c14ce3a [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
drh648e2642013-07-11 15:03:32 +0000476 assert( db->nVdbeWrite>0 || db->autoCommit==0
477 || (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
danf533dbe2014-10-23 17:26:22 +0000485#if defined(SQLITE_DEBUG) && defined(SQLITE_ENABLE_LOOPCOUNTERS)
486 memset(p->anExec, 0, sizeof(int) * p->nOp);
487#endif
drhc16a03b2004-09-15 13:38:10 +0000488
drh4f7d3a52013-06-27 23:54:02 +0000489 db->nVdbeActive++;
490 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000491 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000492 p->pc = 0;
493 }
drhb7f91642004-10-31 02:22:47 +0000494#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000495 if( p->explain ){
496 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000497 }else
498#endif /* SQLITE_OMIT_EXPLAIN */
499 {
drh4f7d3a52013-06-27 23:54:02 +0000500 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000501 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000502 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000503 }
504
drh19e2d372005-08-29 23:00:03 +0000505#ifndef SQLITE_OMIT_TRACE
506 /* Invoke the profile callback if there is one
507 */
danielk19776ab3a2e2009-02-19 14:39:25 +0000508 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000509 sqlite3_int64 iNow;
510 sqlite3OsCurrentTimeInt64(db->pVfs, &iNow);
drhdf0db0f2010-07-29 10:07:21 +0000511 db->xProfile(db->pProfileArg, p->zSql, (iNow - p->startTime)*1000000);
drh19e2d372005-08-29 23:00:03 +0000512 }
513#endif
514
dan8d22a172010-04-19 18:03:51 +0000515 if( rc==SQLITE_DONE ){
516 assert( p->rc==SQLITE_OK );
drh7ed91f22010-04-29 22:34:07 +0000517 p->rc = doWalCallbacks(db);
dan8d22a172010-04-19 18:03:51 +0000518 if( p->rc!=SQLITE_OK ){
519 rc = SQLITE_ERROR;
520 }
521 }
522
drh80cc85b2008-07-23 21:07:25 +0000523 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000524 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
525 p->rc = SQLITE_NOMEM;
drhb900aaf2006-11-09 00:24:53 +0000526 }
danielk1977357864e2009-03-25 15:43:08 +0000527end_of_step:
528 /* At this point local variable rc holds the value that should be
529 ** returned if this statement was compiled using the legacy
530 ** sqlite3_prepare() interface. According to the docs, this can only
531 ** be one of the values in the first assert() below. Variable p->rc
532 ** contains the value that would be returned if sqlite3_finalize()
533 ** were called on statement p.
534 */
535 assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
536 || rc==SQLITE_BUSY || rc==SQLITE_MISUSE
537 );
538 assert( p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE );
539 if( p->isPrepareV2 && rc!=SQLITE_ROW && rc!=SQLITE_DONE ){
540 /* If this statement was prepared using sqlite3_prepare_v2(), and an
mistachkin48864df2013-03-21 21:20:32 +0000541 ** error has occurred, then return the error code in p->rc to the
danielk1977357864e2009-03-25 15:43:08 +0000542 ** caller. Set the error code in the database handle to the same value.
543 */
dan029ead62011-10-27 15:19:58 +0000544 rc = sqlite3VdbeTransferError(p);
danielk1977357864e2009-03-25 15:43:08 +0000545 }
546 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000547}
548
549/*
550** This is the top-level implementation of sqlite3_step(). Call
551** sqlite3Step() to do most of the work. If a schema error occurs,
552** call sqlite3Reprepare() and try again.
553*/
drhb900aaf2006-11-09 00:24:53 +0000554int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000555 int rc = SQLITE_OK; /* Result from sqlite3Step() */
556 int rc2 = SQLITE_OK; /* Result from sqlite3Reprepare() */
557 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
558 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
559 sqlite3 *db; /* The database connection */
560
drh413c3d32010-02-23 20:11:56 +0000561 if( vdbeSafetyNotNull(v) ){
562 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000563 }
drh413c3d32010-02-23 20:11:56 +0000564 db = v->db;
565 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000566 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000567 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh2c7946a2014-08-19 20:27:40 +0000568 && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
569 int savedPc = v->pc;
570 rc2 = rc = sqlite3Reprepare(v);
571 if( rc!=SQLITE_OK) break;
drh413c3d32010-02-23 20:11:56 +0000572 sqlite3_reset(pStmt);
drh5f58ae72014-08-19 20:41:36 +0000573 if( savedPc>=0 ) v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000574 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000575 }
drha3cc0072013-12-13 16:23:55 +0000576 if( rc2!=SQLITE_OK ){
drh413c3d32010-02-23 20:11:56 +0000577 /* This case occurs after failing to recompile an sql statement.
578 ** The error message from the SQL compiler has already been loaded
579 ** into the database handle. This block copies the error message
580 ** from the database handle into the statement and sets the statement
581 ** program counter to 0 to ensure that when the statement is
582 ** finalized or reset the parser error message is available via
583 ** sqlite3_errmsg() and sqlite3_errcode().
584 */
585 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
drha3cc0072013-12-13 16:23:55 +0000586 assert( zErr!=0 || db->mallocFailed );
drh413c3d32010-02-23 20:11:56 +0000587 sqlite3DbFree(db, v->zErrMsg);
588 if( !db->mallocFailed ){
589 v->zErrMsg = sqlite3DbStrDup(db, zErr);
drha6129fa2010-02-24 17:15:19 +0000590 v->rc = rc2;
drh413c3d32010-02-23 20:11:56 +0000591 } else {
592 v->zErrMsg = 0;
drha6129fa2010-02-24 17:15:19 +0000593 v->rc = rc = SQLITE_NOMEM;
drh413c3d32010-02-23 20:11:56 +0000594 }
595 }
596 rc = sqlite3ApiExit(db, rc);
597 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000598 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000599}
600
drh95a7b3e2013-09-16 12:57:19 +0000601
drh4f26d6c2004-05-26 23:25:30 +0000602/*
drheb2e1762004-05-27 01:53:56 +0000603** Extract the user data from a sqlite3_context structure and return a
604** pointer to it.
605*/
606void *sqlite3_user_data(sqlite3_context *p){
607 assert( p && p->pFunc );
608 return p->pFunc->pUserData;
609}
610
611/*
drhfa4a4b92008-03-19 21:45:51 +0000612** Extract the user data from a sqlite3_context structure and return a
613** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000614**
615** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
616** returns a copy of the pointer to the database connection (the 1st
617** parameter) of the sqlite3_create_function() and
618** sqlite3_create_function16() routines that originally registered the
619** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000620*/
621sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
622 assert( p && p->pFunc );
drh9bd038f2014-08-27 14:14:06 +0000623 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000624}
625
626/*
drh95a7b3e2013-09-16 12:57:19 +0000627** Return the current time for a statement
628*/
629sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
630 Vdbe *v = p->pVdbe;
631 int rc;
632 if( v->iCurrentTime==0 ){
drh9bd038f2014-08-27 14:14:06 +0000633 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, &v->iCurrentTime);
drh95a7b3e2013-09-16 12:57:19 +0000634 if( rc ) v->iCurrentTime = 0;
635 }
636 return v->iCurrentTime;
637}
638
639/*
drhb7481e72006-09-16 21:45:14 +0000640** The following is the implementation of an SQL function that always
641** fails with an error message stating that the function is used in the
642** wrong context. The sqlite3_overload_function() API might construct
643** SQL function that use this routine so that the functions will exist
644** for name resolution but are actually overloaded by the xFindFunction
645** method of virtual tables.
646*/
647void sqlite3InvalidFunction(
648 sqlite3_context *context, /* The function calling context */
danielk197762c14b32008-11-19 09:05:26 +0000649 int NotUsed, /* Number of arguments to the function */
650 sqlite3_value **NotUsed2 /* Value of each argument */
drhb7481e72006-09-16 21:45:14 +0000651){
652 const char *zName = context->pFunc->zName;
653 char *zErr;
danielk197762c14b32008-11-19 09:05:26 +0000654 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhbc6160b2009-04-08 15:45:31 +0000655 zErr = sqlite3_mprintf(
drhb7481e72006-09-16 21:45:14 +0000656 "unable to use function %s in the requested context", zName);
657 sqlite3_result_error(context, zErr, -1);
danielk19771e536952007-08-16 10:09:01 +0000658 sqlite3_free(zErr);
drhb7481e72006-09-16 21:45:14 +0000659}
660
661/*
drh9de4a172014-08-23 18:17:19 +0000662** Create a new aggregate context for p and return a pointer to
663** its pMem->z element.
664*/
665static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
666 Mem *pMem = p->pMem;
667 assert( (pMem->flags & MEM_Agg)==0 );
668 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000669 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000670 pMem->z = 0;
671 }else{
drh322f2852014-09-19 00:43:39 +0000672 sqlite3VdbeMemClearAndResize(pMem, nByte);
drh9de4a172014-08-23 18:17:19 +0000673 pMem->flags = MEM_Agg;
674 pMem->u.pDef = p->pFunc;
675 if( pMem->z ){
676 memset(pMem->z, 0, nByte);
677 }
678 }
679 return (void*)pMem->z;
680}
681
682/*
drheb2e1762004-05-27 01:53:56 +0000683** Allocate or return the aggregate context for a user function. A new
684** context is allocated on the first call. Subsequent calls return the
685** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000686*/
687void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh825c6622005-09-08 19:01:05 +0000688 assert( p && p->pFunc && p->pFunc->xStep );
drh9bd038f2014-08-27 14:14:06 +0000689 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000690 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000691 if( (p->pMem->flags & MEM_Agg)==0 ){
692 return createAggContext(p, nByte);
693 }else{
694 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000695 }
drheb2e1762004-05-27 01:53:56 +0000696}
697
698/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000699** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000700** the user-function defined by pCtx.
701*/
702void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000703 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000704
drh9bd038f2014-08-27 14:14:06 +0000705 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000706 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
707 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
danielk1977682f68b2004-06-05 10:22:17 +0000708 }
dan0c547792013-07-18 17:12:08 +0000709
710 return (pAuxData ? pAuxData->pAux : 0);
danielk1977682f68b2004-06-05 10:22:17 +0000711}
712
713/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000714** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000715** argument to the user-function defined by pCtx. Any previous value is
716** deleted by calling the delete function specified when it was set.
717*/
718void sqlite3_set_auxdata(
719 sqlite3_context *pCtx,
720 int iArg,
721 void *pAux,
722 void (*xDelete)(void*)
723){
dan0c547792013-07-18 17:12:08 +0000724 AuxData *pAuxData;
725 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000726
drh9bd038f2014-08-27 14:14:06 +0000727 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000728 if( iArg<0 ) goto failed;
danielk1977682f68b2004-06-05 10:22:17 +0000729
dan0c547792013-07-18 17:12:08 +0000730 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
731 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
732 }
733 if( pAuxData==0 ){
734 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
735 if( !pAuxData ) goto failed;
736 pAuxData->iOp = pCtx->iOp;
737 pAuxData->iArg = iArg;
738 pAuxData->pNext = pVdbe->pAuxData;
739 pVdbe->pAuxData = pAuxData;
drh9b47ee32013-08-20 03:13:51 +0000740 if( pCtx->fErrorOrAux==0 ){
741 pCtx->isError = 0;
742 pCtx->fErrorOrAux = 1;
743 }
dan0c547792013-07-18 17:12:08 +0000744 }else if( pAuxData->xDelete ){
danielk1977682f68b2004-06-05 10:22:17 +0000745 pAuxData->xDelete(pAuxData->pAux);
746 }
dan0c547792013-07-18 17:12:08 +0000747
danielk1977682f68b2004-06-05 10:22:17 +0000748 pAuxData->pAux = pAux;
749 pAuxData->xDelete = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000750 return;
751
752failed:
753 if( xDelete ){
754 xDelete(pAux);
755 }
danielk1977682f68b2004-06-05 10:22:17 +0000756}
757
shaneeec556d2008-10-12 00:27:53 +0000758#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000759/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000760** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000761** called.
762**
drhcf85a512006-02-09 18:35:29 +0000763** This function is deprecated. Do not use it for new code. It is
764** provide only to avoid breaking legacy code. New aggregate function
765** implementations should keep their own counts within their aggregate
766** context.
drheb2e1762004-05-27 01:53:56 +0000767*/
768int sqlite3_aggregate_count(sqlite3_context *p){
shanee34c6472009-03-05 04:23:47 +0000769 assert( p && p->pMem && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000770 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000771}
shaneeec556d2008-10-12 00:27:53 +0000772#endif
drheb2e1762004-05-27 01:53:56 +0000773
774/*
drh4f26d6c2004-05-26 23:25:30 +0000775** Return the number of columns in the result set for the statement pStmt.
776*/
777int sqlite3_column_count(sqlite3_stmt *pStmt){
778 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000779 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000780}
781
782/*
783** Return the number of values available from the current row of the
784** currently executing statement pStmt.
785*/
786int sqlite3_data_count(sqlite3_stmt *pStmt){
787 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000788 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000789 return pVm->nResColumn;
790}
791
drhb1a1c292014-03-05 12:47:55 +0000792/*
793** Return a pointer to static memory containing an SQL NULL value.
794*/
795static const Mem *columnNullValue(void){
796 /* Even though the Mem structure contains an element
797 ** of type i64, on certain architectures (x86) with certain compiler
798 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
799 ** instead of an 8-byte one. This all works fine, except that when
800 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
801 ** that a Mem structure is located on an 8-byte boundary. To prevent
802 ** these assert()s from failing, when building with SQLITE_DEBUG defined
803 ** using gcc, we force nullMem to be 8-byte aligned using the magical
804 ** __attribute__((aligned(8))) macro. */
805 static const Mem nullMem
806#if defined(SQLITE_DEBUG) && defined(__GNUC__)
807 __attribute__((aligned(8)))
808#endif
drh035e5632014-09-16 14:16:31 +0000809 = {
drh3329a632014-09-18 01:21:43 +0000810 /* .u = */ {0},
811 /* .flags = */ MEM_Null,
812 /* .enc = */ 0,
813 /* .n = */ 0,
drh3329a632014-09-18 01:21:43 +0000814 /* .z = */ 0,
815 /* .zMalloc = */ 0,
drh17bcb102014-09-18 21:25:33 +0000816 /* .szMalloc = */ 0,
817 /* .iPadding1 = */ 0,
drh3329a632014-09-18 01:21:43 +0000818 /* .db = */ 0,
819 /* .xDel = */ 0,
drhb1a1c292014-03-05 12:47:55 +0000820#ifdef SQLITE_DEBUG
drh3329a632014-09-18 01:21:43 +0000821 /* .pScopyFrom = */ 0,
822 /* .pFiller = */ 0,
drhb1a1c292014-03-05 12:47:55 +0000823#endif
drh035e5632014-09-16 14:16:31 +0000824 };
drhb1a1c292014-03-05 12:47:55 +0000825 return &nullMem;
826}
drh4f26d6c2004-05-26 23:25:30 +0000827
828/*
829** Check to see if column iCol of the given statement is valid. If
830** it is, return a pointer to the Mem for the value of that column.
831** If iCol is not valid, return a pointer to a Mem which has a value
832** of NULL.
833*/
834static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000835 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000836 Mem *pOut;
837
838 pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000839 if( pVm && pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drh32bc3f62007-08-21 20:25:39 +0000840 sqlite3_mutex_enter(pVm->db->mutex);
drhd4e70eb2008-01-02 00:34:36 +0000841 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +0000842 }else{
drh9b4ea4a2009-04-10 20:32:00 +0000843 if( pVm && ALWAYS(pVm->db) ){
drh27641702007-08-22 02:56:42 +0000844 sqlite3_mutex_enter(pVm->db->mutex);
drh13f40da2014-08-22 18:00:11 +0000845 sqlite3Error(pVm->db, SQLITE_RANGE);
drh27641702007-08-22 02:56:42 +0000846 }
drhb1a1c292014-03-05 12:47:55 +0000847 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +0000848 }
drh32bc3f62007-08-21 20:25:39 +0000849 return pOut;
drh4f26d6c2004-05-26 23:25:30 +0000850}
851
danielk19772e588c72005-12-09 14:25:08 +0000852/*
853** This function is called after invoking an sqlite3_value_XXX function on a
854** column value (i.e. a value returned by evaluating an SQL expression in the
855** select list of a SELECT statement) that may cause a malloc() failure. If
856** malloc() has failed, the threads mallocFailed flag is cleared and the result
857** code of statement pStmt set to SQLITE_NOMEM.
858**
drh32bc3f62007-08-21 20:25:39 +0000859** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +0000860**
861** sqlite3_column_int()
862** sqlite3_column_int64()
863** sqlite3_column_text()
864** sqlite3_column_text16()
865** sqlite3_column_real()
866** sqlite3_column_bytes()
867** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +0000868** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +0000869*/
870static void columnMallocFailure(sqlite3_stmt *pStmt)
871{
872 /* If malloc() failed during an encoding conversion within an
873 ** sqlite3_column_XXX API, then set the return code of the statement to
874 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
875 ** and _finalize() will return NOMEM.
876 */
danielk197754f01982006-01-18 15:25:17 +0000877 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000878 if( p ){
879 p->rc = sqlite3ApiExit(p->db, p->rc);
880 sqlite3_mutex_leave(p->db->mutex);
881 }
danielk19772e588c72005-12-09 14:25:08 +0000882}
883
drh4f26d6c2004-05-26 23:25:30 +0000884/**************************** sqlite3_column_ *******************************
885** The following routines are used to access elements of the current row
886** in the result set.
887*/
danielk1977c572ef72004-05-27 09:28:41 +0000888const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000889 const void *val;
danielk19772e588c72005-12-09 14:25:08 +0000890 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +0000891 /* Even though there is no encoding conversion, value_blob() might
892 ** need to call malloc() to expand the result of a zeroblob()
893 ** expression.
894 */
895 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +0000896 return val;
danielk1977c572ef72004-05-27 09:28:41 +0000897}
drh4f26d6c2004-05-26 23:25:30 +0000898int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000899 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
900 columnMallocFailure(pStmt);
901 return val;
drh4f26d6c2004-05-26 23:25:30 +0000902}
903int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000904 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
905 columnMallocFailure(pStmt);
906 return val;
drh4f26d6c2004-05-26 23:25:30 +0000907}
908double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000909 double val = sqlite3_value_double( columnMem(pStmt,i) );
910 columnMallocFailure(pStmt);
911 return val;
drh4f26d6c2004-05-26 23:25:30 +0000912}
913int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000914 int val = sqlite3_value_int( columnMem(pStmt,i) );
915 columnMallocFailure(pStmt);
916 return val;
drh4f26d6c2004-05-26 23:25:30 +0000917}
drhefad9992004-06-22 12:13:55 +0000918sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000919 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
920 columnMallocFailure(pStmt);
921 return val;
drh4f26d6c2004-05-26 23:25:30 +0000922}
923const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000924 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
925 columnMallocFailure(pStmt);
926 return val;
drh4f26d6c2004-05-26 23:25:30 +0000927}
drhd1e47332005-06-26 17:55:33 +0000928sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +0000929 Mem *pOut = columnMem(pStmt, i);
930 if( pOut->flags&MEM_Static ){
931 pOut->flags &= ~MEM_Static;
932 pOut->flags |= MEM_Ephem;
933 }
drh32bc3f62007-08-21 20:25:39 +0000934 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +0000935 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +0000936}
drh6c626082004-11-14 21:56:29 +0000937#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000938const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000939 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
940 columnMallocFailure(pStmt);
941 return val;
drh4f26d6c2004-05-26 23:25:30 +0000942}
drh6c626082004-11-14 21:56:29 +0000943#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000944int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000945 int iType = sqlite3_value_type( columnMem(pStmt,i) );
946 columnMallocFailure(pStmt);
947 return iType;
drh4f26d6c2004-05-26 23:25:30 +0000948}
949
drh5e2517e2004-09-24 23:59:12 +0000950/*
951** Convert the N-th element of pStmt->pColName[] into a string using
952** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000953**
954** There are up to 5 names for each column. useType determines which
955** name is returned. Here are the names:
956**
957** 0 The column name as it should be displayed for output
958** 1 The datatype name for the column
959** 2 The name of the database that the column derives from
960** 3 The name of the table that the column derives from
961** 4 The name of the table column that the result column derives from
962**
963** If the result is not a simple column reference (if it is an expression
964** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000965*/
966static const void *columnName(
967 sqlite3_stmt *pStmt,
968 int N,
969 const void *(*xFunc)(Mem*),
970 int useType
971){
drh32bc3f62007-08-21 20:25:39 +0000972 const void *ret = 0;
drh5e2517e2004-09-24 23:59:12 +0000973 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000974 int n;
drhc6c7fd52009-04-08 23:05:28 +0000975 sqlite3 *db = p->db;
drh32bc3f62007-08-21 20:25:39 +0000976
drh9b4ea4a2009-04-10 20:32:00 +0000977 assert( db!=0 );
978 n = sqlite3_column_count(pStmt);
979 if( N<n && N>=0 ){
980 N += useType*n;
981 sqlite3_mutex_enter(db->mutex);
982 assert( db->mallocFailed==0 );
983 ret = xFunc(&p->aColName[N]);
984 /* A malloc may have failed inside of the xFunc() call. If this
985 ** is the case, clear the mallocFailed flag and return NULL.
986 */
987 if( db->mallocFailed ){
988 db->mallocFailed = 0;
989 ret = 0;
drh32bc3f62007-08-21 20:25:39 +0000990 }
drh9b4ea4a2009-04-10 20:32:00 +0000991 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +0000992 }
danielk197700fd9572005-12-07 06:27:43 +0000993 return ret;
drh5e2517e2004-09-24 23:59:12 +0000994}
995
drh4f26d6c2004-05-26 23:25:30 +0000996/*
997** Return the name of the Nth column of the result set returned by SQL
998** statement pStmt.
999*/
1000const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001001 return columnName(
1002 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +00001003}
drhe590fbd2005-05-20 19:36:01 +00001004#ifndef SQLITE_OMIT_UTF16
1005const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001006 return columnName(
1007 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001008}
1009#endif
drh4f26d6c2004-05-26 23:25:30 +00001010
1011/*
drh3f913572008-03-22 01:07:17 +00001012** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1013** not define OMIT_DECLTYPE.
1014*/
1015#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1016# error "Must not define both SQLITE_OMIT_DECLTYPE \
1017 and SQLITE_ENABLE_COLUMN_METADATA"
1018#endif
1019
1020#ifndef SQLITE_OMIT_DECLTYPE
1021/*
drh6c626082004-11-14 21:56:29 +00001022** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001023** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001024*/
1025const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001026 return columnName(
1027 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001028}
drh6c626082004-11-14 21:56:29 +00001029#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001030const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001031 return columnName(
1032 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001033}
drh6c626082004-11-14 21:56:29 +00001034#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001035#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001036
danielk19774b1ae992006-02-10 03:06:10 +00001037#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001038/*
1039** Return the name of the database from which a result column derives.
1040** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001041** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001042*/
1043const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001044 return columnName(
1045 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001046}
1047#ifndef SQLITE_OMIT_UTF16
1048const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001049 return columnName(
1050 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001051}
1052#endif /* SQLITE_OMIT_UTF16 */
1053
1054/*
1055** Return the name of the table from which a result column derives.
1056** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001057** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001058*/
1059const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001060 return columnName(
1061 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001062}
1063#ifndef SQLITE_OMIT_UTF16
1064const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001065 return columnName(
1066 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001067}
1068#endif /* SQLITE_OMIT_UTF16 */
1069
1070/*
1071** Return the name of the table column from which a result column derives.
1072** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001073** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001074*/
1075const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001076 return columnName(
1077 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001078}
1079#ifndef SQLITE_OMIT_UTF16
1080const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001081 return columnName(
1082 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001083}
1084#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001085#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001086
1087
drh4f26d6c2004-05-26 23:25:30 +00001088/******************************* sqlite3_bind_ ***************************
1089**
1090** Routines used to attach values to wildcards in a compiled SQL statement.
1091*/
1092/*
1093** Unbind the value bound to variable i in virtual machine p. This is the
1094** the same as binding a NULL value to the column. If the "i" parameter is
1095** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1096**
drh488e7b62008-10-06 12:46:43 +00001097** A successful evaluation of this routine acquires the mutex on p.
1098** the mutex is released if any kind of error occurs.
1099**
drh4f26d6c2004-05-26 23:25:30 +00001100** The error code stored in database p->db is overwritten with the return
1101** value in any case.
1102*/
1103static int vdbeUnbind(Vdbe *p, int i){
1104 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001105 if( vdbeSafetyNotNull(p) ){
1106 return SQLITE_MISUSE_BKPT;
1107 }
drh488e7b62008-10-06 12:46:43 +00001108 sqlite3_mutex_enter(p->db->mutex);
1109 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001110 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001111 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001112 sqlite3_log(SQLITE_MISUSE,
1113 "bind on a busy prepared statement: [%s]", p->zSql);
1114 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001115 }
1116 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001117 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001118 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001119 return SQLITE_RANGE;
1120 }
1121 i--;
drh290c1942004-08-21 17:54:45 +00001122 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001123 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001124 pVar->flags = MEM_Null;
drh13f40da2014-08-22 18:00:11 +00001125 sqlite3Error(p->db, SQLITE_OK);
dan937d0de2009-10-15 18:35:38 +00001126
dan1d2ce4f2009-10-19 18:11:09 +00001127 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1128 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001129 **
1130 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1131 ** parameter in the WHERE clause might influence the choice of query plan
1132 ** for a statement, then the statement will be automatically recompiled,
1133 ** as if there had been a schema change, on the first sqlite3_step() call
1134 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001135 */
drh823e09a2009-10-19 20:15:38 +00001136 if( p->isPrepareV2 &&
1137 ((i<32 && p->expmask & ((u32)1 << i)) || p->expmask==0xffffffff)
1138 ){
dan937d0de2009-10-15 18:35:38 +00001139 p->expired = 1;
1140 }
drh4f26d6c2004-05-26 23:25:30 +00001141 return SQLITE_OK;
1142}
1143
1144/*
drh5e2517e2004-09-24 23:59:12 +00001145** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001146*/
drh5e2517e2004-09-24 23:59:12 +00001147static int bindText(
drh605264d2007-08-21 15:13:19 +00001148 sqlite3_stmt *pStmt, /* The statement to bind against */
1149 int i, /* Index of the parameter to bind */
1150 const void *zData, /* Pointer to the data to be bound */
1151 int nData, /* Number of bytes of data to be bound */
1152 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001153 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001154){
1155 Vdbe *p = (Vdbe *)pStmt;
1156 Mem *pVar;
1157 int rc;
1158
1159 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001160 if( rc==SQLITE_OK ){
1161 if( zData!=0 ){
1162 pVar = &p->aVar[i-1];
1163 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1164 if( rc==SQLITE_OK && encoding!=0 ){
1165 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1166 }
drh13f40da2014-08-22 18:00:11 +00001167 sqlite3Error(p->db, rc);
drh488e7b62008-10-06 12:46:43 +00001168 rc = sqlite3ApiExit(p->db, rc);
drh27641702007-08-22 02:56:42 +00001169 }
drh488e7b62008-10-06 12:46:43 +00001170 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001171 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001172 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001173 }
drh605264d2007-08-21 15:13:19 +00001174 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001175}
drh5e2517e2004-09-24 23:59:12 +00001176
1177
1178/*
1179** Bind a blob value to an SQL statement variable.
1180*/
1181int sqlite3_bind_blob(
1182 sqlite3_stmt *pStmt,
1183 int i,
1184 const void *zData,
1185 int nData,
1186 void (*xDel)(void*)
1187){
1188 return bindText(pStmt, i, zData, nData, xDel, 0);
1189}
drhda4ca9d2014-09-09 17:27:35 +00001190int sqlite3_bind_blob64(
1191 sqlite3_stmt *pStmt,
1192 int i,
1193 const void *zData,
1194 sqlite3_uint64 nData,
1195 void (*xDel)(void*)
1196){
drhfc59a952014-09-11 23:34:55 +00001197 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001198 if( nData>0x7fffffff ){
1199 return invokeValueDestructor(zData, xDel, 0);
1200 }else{
drh3329a632014-09-18 01:21:43 +00001201 return bindText(pStmt, i, zData, (int)nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001202 }
1203}
drh4f26d6c2004-05-26 23:25:30 +00001204int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1205 int rc;
1206 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001207 rc = vdbeUnbind(p, i);
1208 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001209 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001210 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001211 }
danielk1977f4618892004-06-28 13:09:11 +00001212 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001213}
1214int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001215 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001216}
drhefad9992004-06-22 12:13:55 +00001217int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001218 int rc;
1219 Vdbe *p = (Vdbe *)pStmt;
1220 rc = vdbeUnbind(p, i);
1221 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001222 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001223 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001224 }
1225 return rc;
1226}
drh605264d2007-08-21 15:13:19 +00001227int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1228 int rc;
1229 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001230 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001231 if( rc==SQLITE_OK ){
1232 sqlite3_mutex_leave(p->db->mutex);
1233 }
drh605264d2007-08-21 15:13:19 +00001234 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001235}
1236int sqlite3_bind_text(
1237 sqlite3_stmt *pStmt,
1238 int i,
1239 const char *zData,
1240 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001241 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001242){
drh5e2517e2004-09-24 23:59:12 +00001243 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001244}
drhbbf483f2014-09-09 20:30:24 +00001245int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001246 sqlite3_stmt *pStmt,
1247 int i,
1248 const char *zData,
1249 sqlite3_uint64 nData,
1250 void (*xDel)(void*),
1251 unsigned char enc
1252){
drhfc59a952014-09-11 23:34:55 +00001253 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001254 if( nData>0x7fffffff ){
1255 return invokeValueDestructor(zData, xDel, 0);
1256 }else{
drhfc59a952014-09-11 23:34:55 +00001257 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drh3329a632014-09-18 01:21:43 +00001258 return bindText(pStmt, i, zData, (int)nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001259 }
1260}
drh6c626082004-11-14 21:56:29 +00001261#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001262int sqlite3_bind_text16(
1263 sqlite3_stmt *pStmt,
1264 int i,
1265 const void *zData,
1266 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001267 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001268){
drh5e2517e2004-09-24 23:59:12 +00001269 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001270}
drh6c626082004-11-14 21:56:29 +00001271#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001272int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1273 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001274 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001275 case SQLITE_INTEGER: {
1276 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1277 break;
1278 }
1279 case SQLITE_FLOAT: {
drh74eaba42014-09-18 17:52:15 +00001280 rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
drh29def562009-04-14 12:43:33 +00001281 break;
1282 }
1283 case SQLITE_BLOB: {
1284 if( pValue->flags & MEM_Zero ){
1285 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1286 }else{
1287 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1288 }
1289 break;
1290 }
1291 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001292 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1293 pValue->enc);
1294 break;
1295 }
1296 default: {
1297 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001298 break;
1299 }
danielk197726e41442006-06-14 15:16:35 +00001300 }
1301 return rc;
1302}
drhb026e052007-05-02 01:34:31 +00001303int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1304 int rc;
1305 Vdbe *p = (Vdbe *)pStmt;
1306 rc = vdbeUnbind(p, i);
1307 if( rc==SQLITE_OK ){
1308 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001309 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001310 }
1311 return rc;
1312}
drh75f6a032004-07-15 14:15:00 +00001313
1314/*
1315** Return the number of wildcards that can be potentially bound to.
1316** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001317*/
1318int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001319 Vdbe *p = (Vdbe*)pStmt;
1320 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001321}
drh895d7472004-08-20 16:02:39 +00001322
1323/*
drhfa6bc002004-09-07 16:19:52 +00001324** Return the name of a wildcard parameter. Return NULL if the index
1325** is out of range or if the wildcard is unnamed.
1326**
1327** The result is always UTF-8.
1328*/
1329const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1330 Vdbe *p = (Vdbe*)pStmt;
drh124c0b42011-06-01 18:15:55 +00001331 if( p==0 || i<1 || i>p->nzVar ){
drhfa6bc002004-09-07 16:19:52 +00001332 return 0;
1333 }
drh895d7472004-08-20 16:02:39 +00001334 return p->azVar[i-1];
1335}
drhfa6bc002004-09-07 16:19:52 +00001336
1337/*
1338** Given a wildcard parameter name, return the index of the variable
1339** with that name. If there is no variable with the given name,
1340** return 0.
1341*/
drh5f18a222009-11-26 14:01:53 +00001342int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drhfa6bc002004-09-07 16:19:52 +00001343 int i;
1344 if( p==0 ){
1345 return 0;
1346 }
drh6a8903c2004-12-10 18:00:04 +00001347 if( zName ){
drh124c0b42011-06-01 18:15:55 +00001348 for(i=0; i<p->nzVar; i++){
drh6a8903c2004-12-10 18:00:04 +00001349 const char *z = p->azVar[i];
drh503a6862013-03-01 01:07:17 +00001350 if( z && strncmp(z,zName,nName)==0 && z[nName]==0 ){
drh6a8903c2004-12-10 18:00:04 +00001351 return i+1;
1352 }
drhfa6bc002004-09-07 16:19:52 +00001353 }
1354 }
1355 return 0;
1356}
drh5f18a222009-11-26 14:01:53 +00001357int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1358 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1359}
drhf8db1bc2005-04-22 02:38:37 +00001360
drh51942bc2005-06-12 22:01:42 +00001361/*
drhf8db1bc2005-04-22 02:38:37 +00001362** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001363*/
shane145834a2008-09-04 12:03:42 +00001364int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001365 Vdbe *pFrom = (Vdbe*)pFromStmt;
1366 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001367 int i;
1368 assert( pTo->db==pFrom->db );
1369 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001370 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001371 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001372 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001373 }
drh27641702007-08-22 02:56:42 +00001374 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001375 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001376}
drh51942bc2005-06-12 22:01:42 +00001377
shaneeec556d2008-10-12 00:27:53 +00001378#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001379/*
shane145834a2008-09-04 12:03:42 +00001380** Deprecated external interface. Internal/core SQLite code
1381** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001382**
peter.d.reid60ec9142014-09-06 16:39:46 +00001383** It is misuse to call this routine with statements from different
drh0f5ea0b2009-04-09 14:02:44 +00001384** database connections. But as this is a deprecated interface, we
1385** will not bother to check for that condition.
1386**
1387** If the two statements contain a different number of bindings, then
1388** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1389** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001390*/
1391int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001392 Vdbe *pFrom = (Vdbe*)pFromStmt;
1393 Vdbe *pTo = (Vdbe*)pToStmt;
1394 if( pFrom->nVar!=pTo->nVar ){
1395 return SQLITE_ERROR;
1396 }
danc94b8592009-10-20 07:01:24 +00001397 if( pTo->isPrepareV2 && pTo->expmask ){
1398 pTo->expired = 1;
1399 }
1400 if( pFrom->isPrepareV2 && pFrom->expmask ){
1401 pFrom->expired = 1;
1402 }
shane145834a2008-09-04 12:03:42 +00001403 return sqlite3TransferBindings(pFromStmt, pToStmt);
1404}
shaneeec556d2008-10-12 00:27:53 +00001405#endif
shane145834a2008-09-04 12:03:42 +00001406
1407/*
drh51942bc2005-06-12 22:01:42 +00001408** Return the sqlite3* database handle to which the prepared statement given
1409** in the argument belongs. This is the same database handle that was
1410** the first argument to the sqlite3_prepare() that was used to create
1411** the statement in the first place.
1412*/
1413sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1414 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1415}
drhbb5a9c32008-06-19 02:52:25 +00001416
1417/*
drhf03d9cc2010-11-16 23:10:25 +00001418** Return true if the prepared statement is guaranteed to not modify the
1419** database.
1420*/
1421int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1422 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1423}
1424
1425/*
drh2fb66932011-11-25 17:21:47 +00001426** Return true if the prepared statement is in need of being reset.
1427*/
1428int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1429 Vdbe *v = (Vdbe*)pStmt;
dan857745c2014-07-19 17:57:10 +00001430 return v!=0 && v->pc>=0 && v->magic==VDBE_MAGIC_RUN;
drh2fb66932011-11-25 17:21:47 +00001431}
1432
1433/*
drhbb5a9c32008-06-19 02:52:25 +00001434** Return a pointer to the next prepared statement after pStmt associated
1435** with database connection pDb. If pStmt is NULL, return the first
1436** prepared statement for the database connection. Return NULL if there
1437** are no more.
1438*/
1439sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1440 sqlite3_stmt *pNext;
1441 sqlite3_mutex_enter(pDb->mutex);
1442 if( pStmt==0 ){
1443 pNext = (sqlite3_stmt*)pDb->pVdbe;
1444 }else{
1445 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1446 }
1447 sqlite3_mutex_leave(pDb->mutex);
1448 return pNext;
1449}
drhd1d38482008-10-07 23:46:38 +00001450
1451/*
1452** Return the value of a status counter for a prepared statement
1453*/
1454int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1455 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9b47ee32013-08-20 03:13:51 +00001456 u32 v = pVdbe->aCounter[op];
1457 if( resetFlag ) pVdbe->aCounter[op] = 0;
1458 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001459}
danf533dbe2014-10-23 17:26:22 +00001460
1461#if defined(SQLITE_DEBUG) && defined(SQLITE_ENABLE_LOOPCOUNTERS)
1462const char *sqlite3_stmt_loopcounter(
1463 sqlite3_stmt *pStmt, int idx, int *piSub, int *piLoop, int *pnTest, int *pnVisit
1464){
1465 Vdbe *p = (Vdbe*)pStmt;
1466 if( idx>=p->nLoop || idx<0 ) return 0;
1467 *piSub = p->aOp[p->aLoop[idx].addrExplain].p1;
1468 *piLoop = p->aOp[p->aLoop[idx].addrExplain].p2;
1469 *pnTest = p->anExec[ p->aLoop[idx].addrTest ];
1470 *pnVisit = p->anExec[ p->aLoop[idx].addrBody ];
1471 return p->aOp[p->aLoop[idx].addrExplain].p4.z;
1472}
1473#endif
1474
1475