blob: 21c537d776310b3a5b1d37508db4c66c0efa52dc [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 ){
drhef15c6e2014-12-12 01:27:17 +0000403 int nEntry;
404 sqlite3BtreeEnter(pBt);
405 nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
406 sqlite3BtreeLeave(pBt);
drh5def0842010-05-05 20:00:25 +0000407 if( db->xWalCallback && nEntry>0 && rc==SQLITE_OK ){
408 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000409 }
410 }
411 }
dan5cf53532010-05-01 16:40:20 +0000412#endif
dan8d22a172010-04-19 18:03:51 +0000413 return rc;
414}
415
drh4f26d6c2004-05-26 23:25:30 +0000416/*
417** Execute the statement pStmt, either until a row of data is ready, the
418** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000419**
420** This routine implements the bulk of the logic behind the sqlite_step()
421** API. The only thing omitted is the automatic recompile if a
422** schema change has occurred. That detail is handled by the
423** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000424*/
drhb900aaf2006-11-09 00:24:53 +0000425static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000426 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000427 int rc;
428
danielk1977a185ddb2007-11-15 16:04:15 +0000429 assert(p);
430 if( p->magic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000431 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000432 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
433 ** with version 3.7.0, we changed this so that sqlite3_reset() would
434 ** be called automatically instead of throwing the SQLITE_MISUSE error.
435 ** This "automatic-reset" change is not technically an incompatibility,
436 ** since any application that receives an SQLITE_MISUSE is broken by
437 ** definition.
438 **
439 ** Nevertheless, some published applications that were originally written
440 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000441 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000442 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
443 ** legacy behavior of returning SQLITE_MISUSE for cases where the
444 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
445 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000446 */
drh602acb42011-01-17 17:42:37 +0000447#ifdef SQLITE_OMIT_AUTORESET
448 if( p->rc==SQLITE_BUSY || p->rc==SQLITE_LOCKED ){
449 sqlite3_reset((sqlite3_stmt*)p);
450 }else{
451 return SQLITE_MISUSE_BKPT;
452 }
453#else
drh3674bfd2010-04-17 12:53:19 +0000454 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000455#endif
drhf1bfe9a2007-10-17 01:44:20 +0000456 }
457
dan14d4cc42010-01-20 14:25:37 +0000458 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000459 db = p->db;
drhc456e572008-08-11 18:44:58 +0000460 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000461 p->rc = SQLITE_NOMEM;
drhc456e572008-08-11 18:44:58 +0000462 return SQLITE_NOMEM;
463 }
danielk1977261919c2005-12-06 12:52:59 +0000464
danielk1977a21c6b62005-01-24 10:25:59 +0000465 if( p->pc<=0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000466 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000467 rc = SQLITE_ERROR;
468 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000469 }
danielk19771d850a72004-05-31 08:26:49 +0000470 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000471 /* If there are no other statements currently running, then
472 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
473 ** from interrupting a statement that has not yet started.
474 */
drh4f7d3a52013-06-27 23:54:02 +0000475 if( db->nVdbeActive==0 ){
drh15ca1df2006-07-26 13:43:30 +0000476 db->u1.isInterrupted = 0;
477 }
478
drh648e2642013-07-11 15:03:32 +0000479 assert( db->nVdbeWrite>0 || db->autoCommit==0
480 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
481 );
dan1da40a32009-09-19 17:00:31 +0000482
drh19e2d372005-08-29 23:00:03 +0000483#ifndef SQLITE_OMIT_TRACE
drh19e2d372005-08-29 23:00:03 +0000484 if( db->xProfile && !db->init.busy ){
drhb7e8ea22010-05-03 14:32:30 +0000485 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh19e2d372005-08-29 23:00:03 +0000486 }
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);
586 sqlite3DbFree(db, v->zErrMsg);
587 if( !db->mallocFailed ){
588 v->zErrMsg = sqlite3DbStrDup(db, zErr);
drha6129fa2010-02-24 17:15:19 +0000589 v->rc = rc2;
drh413c3d32010-02-23 20:11:56 +0000590 } else {
591 v->zErrMsg = 0;
drha6129fa2010-02-24 17:15:19 +0000592 v->rc = rc = SQLITE_NOMEM;
drh413c3d32010-02-23 20:11:56 +0000593 }
594 }
595 rc = sqlite3ApiExit(db, rc);
596 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000597 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000598}
599
drh95a7b3e2013-09-16 12:57:19 +0000600
drh4f26d6c2004-05-26 23:25:30 +0000601/*
drheb2e1762004-05-27 01:53:56 +0000602** Extract the user data from a sqlite3_context structure and return a
603** pointer to it.
604*/
605void *sqlite3_user_data(sqlite3_context *p){
606 assert( p && p->pFunc );
607 return p->pFunc->pUserData;
608}
609
610/*
drhfa4a4b92008-03-19 21:45:51 +0000611** Extract the user data from a sqlite3_context structure and return a
612** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000613**
614** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
615** returns a copy of the pointer to the database connection (the 1st
616** parameter) of the sqlite3_create_function() and
617** sqlite3_create_function16() routines that originally registered the
618** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000619*/
620sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
621 assert( p && p->pFunc );
drh9bd038f2014-08-27 14:14:06 +0000622 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000623}
624
625/*
drh95a7b3e2013-09-16 12:57:19 +0000626** Return the current time for a statement
627*/
628sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
629 Vdbe *v = p->pVdbe;
630 int rc;
631 if( v->iCurrentTime==0 ){
drh9bd038f2014-08-27 14:14:06 +0000632 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, &v->iCurrentTime);
drh95a7b3e2013-09-16 12:57:19 +0000633 if( rc ) v->iCurrentTime = 0;
634 }
635 return v->iCurrentTime;
636}
637
638/*
drhb7481e72006-09-16 21:45:14 +0000639** The following is the implementation of an SQL function that always
640** fails with an error message stating that the function is used in the
641** wrong context. The sqlite3_overload_function() API might construct
642** SQL function that use this routine so that the functions will exist
643** for name resolution but are actually overloaded by the xFindFunction
644** method of virtual tables.
645*/
646void sqlite3InvalidFunction(
647 sqlite3_context *context, /* The function calling context */
danielk197762c14b32008-11-19 09:05:26 +0000648 int NotUsed, /* Number of arguments to the function */
649 sqlite3_value **NotUsed2 /* Value of each argument */
drhb7481e72006-09-16 21:45:14 +0000650){
651 const char *zName = context->pFunc->zName;
652 char *zErr;
danielk197762c14b32008-11-19 09:05:26 +0000653 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhbc6160b2009-04-08 15:45:31 +0000654 zErr = sqlite3_mprintf(
drhb7481e72006-09-16 21:45:14 +0000655 "unable to use function %s in the requested context", zName);
656 sqlite3_result_error(context, zErr, -1);
danielk19771e536952007-08-16 10:09:01 +0000657 sqlite3_free(zErr);
drhb7481e72006-09-16 21:45:14 +0000658}
659
660/*
drh9de4a172014-08-23 18:17:19 +0000661** Create a new aggregate context for p and return a pointer to
662** its pMem->z element.
663*/
664static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
665 Mem *pMem = p->pMem;
666 assert( (pMem->flags & MEM_Agg)==0 );
667 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000668 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000669 pMem->z = 0;
670 }else{
drh322f2852014-09-19 00:43:39 +0000671 sqlite3VdbeMemClearAndResize(pMem, nByte);
drh9de4a172014-08-23 18:17:19 +0000672 pMem->flags = MEM_Agg;
673 pMem->u.pDef = p->pFunc;
674 if( pMem->z ){
675 memset(pMem->z, 0, nByte);
676 }
677 }
678 return (void*)pMem->z;
679}
680
681/*
drheb2e1762004-05-27 01:53:56 +0000682** Allocate or return the aggregate context for a user function. A new
683** context is allocated on the first call. Subsequent calls return the
684** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000685*/
686void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh825c6622005-09-08 19:01:05 +0000687 assert( p && p->pFunc && p->pFunc->xStep );
drh9bd038f2014-08-27 14:14:06 +0000688 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000689 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000690 if( (p->pMem->flags & MEM_Agg)==0 ){
691 return createAggContext(p, nByte);
692 }else{
693 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000694 }
drheb2e1762004-05-27 01:53:56 +0000695}
696
697/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000698** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000699** the user-function defined by pCtx.
700*/
701void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000702 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000703
drh9bd038f2014-08-27 14:14:06 +0000704 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000705 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
706 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
danielk1977682f68b2004-06-05 10:22:17 +0000707 }
dan0c547792013-07-18 17:12:08 +0000708
709 return (pAuxData ? pAuxData->pAux : 0);
danielk1977682f68b2004-06-05 10:22:17 +0000710}
711
712/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000713** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000714** argument to the user-function defined by pCtx. Any previous value is
715** deleted by calling the delete function specified when it was set.
716*/
717void sqlite3_set_auxdata(
718 sqlite3_context *pCtx,
719 int iArg,
720 void *pAux,
721 void (*xDelete)(void*)
722){
dan0c547792013-07-18 17:12:08 +0000723 AuxData *pAuxData;
724 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000725
drh9bd038f2014-08-27 14:14:06 +0000726 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000727 if( iArg<0 ) goto failed;
danielk1977682f68b2004-06-05 10:22:17 +0000728
dan0c547792013-07-18 17:12:08 +0000729 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
730 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
731 }
732 if( pAuxData==0 ){
733 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
734 if( !pAuxData ) goto failed;
735 pAuxData->iOp = pCtx->iOp;
736 pAuxData->iArg = iArg;
737 pAuxData->pNext = pVdbe->pAuxData;
738 pVdbe->pAuxData = pAuxData;
drh9b47ee32013-08-20 03:13:51 +0000739 if( pCtx->fErrorOrAux==0 ){
740 pCtx->isError = 0;
741 pCtx->fErrorOrAux = 1;
742 }
dan0c547792013-07-18 17:12:08 +0000743 }else if( pAuxData->xDelete ){
danielk1977682f68b2004-06-05 10:22:17 +0000744 pAuxData->xDelete(pAuxData->pAux);
745 }
dan0c547792013-07-18 17:12:08 +0000746
danielk1977682f68b2004-06-05 10:22:17 +0000747 pAuxData->pAux = pAux;
748 pAuxData->xDelete = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000749 return;
750
751failed:
752 if( xDelete ){
753 xDelete(pAux);
754 }
danielk1977682f68b2004-06-05 10:22:17 +0000755}
756
shaneeec556d2008-10-12 00:27:53 +0000757#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000758/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000759** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000760** called.
761**
drhcf85a512006-02-09 18:35:29 +0000762** This function is deprecated. Do not use it for new code. It is
763** provide only to avoid breaking legacy code. New aggregate function
764** implementations should keep their own counts within their aggregate
765** context.
drheb2e1762004-05-27 01:53:56 +0000766*/
767int sqlite3_aggregate_count(sqlite3_context *p){
shanee34c6472009-03-05 04:23:47 +0000768 assert( p && p->pMem && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000769 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000770}
shaneeec556d2008-10-12 00:27:53 +0000771#endif
drheb2e1762004-05-27 01:53:56 +0000772
773/*
drh4f26d6c2004-05-26 23:25:30 +0000774** Return the number of columns in the result set for the statement pStmt.
775*/
776int sqlite3_column_count(sqlite3_stmt *pStmt){
777 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000778 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000779}
780
781/*
782** Return the number of values available from the current row of the
783** currently executing statement pStmt.
784*/
785int sqlite3_data_count(sqlite3_stmt *pStmt){
786 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000787 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000788 return pVm->nResColumn;
789}
790
drhb1a1c292014-03-05 12:47:55 +0000791/*
792** Return a pointer to static memory containing an SQL NULL value.
793*/
794static const Mem *columnNullValue(void){
795 /* Even though the Mem structure contains an element
796 ** of type i64, on certain architectures (x86) with certain compiler
797 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
798 ** instead of an 8-byte one. This all works fine, except that when
799 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
800 ** that a Mem structure is located on an 8-byte boundary. To prevent
801 ** these assert()s from failing, when building with SQLITE_DEBUG defined
802 ** using gcc, we force nullMem to be 8-byte aligned using the magical
803 ** __attribute__((aligned(8))) macro. */
804 static const Mem nullMem
805#if defined(SQLITE_DEBUG) && defined(__GNUC__)
806 __attribute__((aligned(8)))
807#endif
drh035e5632014-09-16 14:16:31 +0000808 = {
drh3329a632014-09-18 01:21:43 +0000809 /* .u = */ {0},
810 /* .flags = */ MEM_Null,
811 /* .enc = */ 0,
812 /* .n = */ 0,
drh3329a632014-09-18 01:21:43 +0000813 /* .z = */ 0,
814 /* .zMalloc = */ 0,
drh17bcb102014-09-18 21:25:33 +0000815 /* .szMalloc = */ 0,
816 /* .iPadding1 = */ 0,
drh3329a632014-09-18 01:21:43 +0000817 /* .db = */ 0,
818 /* .xDel = */ 0,
drhb1a1c292014-03-05 12:47:55 +0000819#ifdef SQLITE_DEBUG
drh3329a632014-09-18 01:21:43 +0000820 /* .pScopyFrom = */ 0,
821 /* .pFiller = */ 0,
drhb1a1c292014-03-05 12:47:55 +0000822#endif
drh035e5632014-09-16 14:16:31 +0000823 };
drhb1a1c292014-03-05 12:47:55 +0000824 return &nullMem;
825}
drh4f26d6c2004-05-26 23:25:30 +0000826
827/*
828** Check to see if column iCol of the given statement is valid. If
829** it is, return a pointer to the Mem for the value of that column.
830** If iCol is not valid, return a pointer to a Mem which has a value
831** of NULL.
832*/
833static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000834 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000835 Mem *pOut;
836
837 pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000838 if( pVm && pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drh32bc3f62007-08-21 20:25:39 +0000839 sqlite3_mutex_enter(pVm->db->mutex);
drhd4e70eb2008-01-02 00:34:36 +0000840 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +0000841 }else{
drh9b4ea4a2009-04-10 20:32:00 +0000842 if( pVm && ALWAYS(pVm->db) ){
drh27641702007-08-22 02:56:42 +0000843 sqlite3_mutex_enter(pVm->db->mutex);
drh13f40da2014-08-22 18:00:11 +0000844 sqlite3Error(pVm->db, SQLITE_RANGE);
drh27641702007-08-22 02:56:42 +0000845 }
drhb1a1c292014-03-05 12:47:55 +0000846 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +0000847 }
drh32bc3f62007-08-21 20:25:39 +0000848 return pOut;
drh4f26d6c2004-05-26 23:25:30 +0000849}
850
danielk19772e588c72005-12-09 14:25:08 +0000851/*
852** This function is called after invoking an sqlite3_value_XXX function on a
853** column value (i.e. a value returned by evaluating an SQL expression in the
854** select list of a SELECT statement) that may cause a malloc() failure. If
855** malloc() has failed, the threads mallocFailed flag is cleared and the result
856** code of statement pStmt set to SQLITE_NOMEM.
857**
drh32bc3f62007-08-21 20:25:39 +0000858** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +0000859**
860** sqlite3_column_int()
861** sqlite3_column_int64()
862** sqlite3_column_text()
863** sqlite3_column_text16()
864** sqlite3_column_real()
865** sqlite3_column_bytes()
866** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +0000867** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +0000868*/
869static void columnMallocFailure(sqlite3_stmt *pStmt)
870{
871 /* If malloc() failed during an encoding conversion within an
872 ** sqlite3_column_XXX API, then set the return code of the statement to
873 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
874 ** and _finalize() will return NOMEM.
875 */
danielk197754f01982006-01-18 15:25:17 +0000876 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000877 if( p ){
878 p->rc = sqlite3ApiExit(p->db, p->rc);
879 sqlite3_mutex_leave(p->db->mutex);
880 }
danielk19772e588c72005-12-09 14:25:08 +0000881}
882
drh4f26d6c2004-05-26 23:25:30 +0000883/**************************** sqlite3_column_ *******************************
884** The following routines are used to access elements of the current row
885** in the result set.
886*/
danielk1977c572ef72004-05-27 09:28:41 +0000887const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000888 const void *val;
danielk19772e588c72005-12-09 14:25:08 +0000889 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +0000890 /* Even though there is no encoding conversion, value_blob() might
891 ** need to call malloc() to expand the result of a zeroblob()
892 ** expression.
893 */
894 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +0000895 return val;
danielk1977c572ef72004-05-27 09:28:41 +0000896}
drh4f26d6c2004-05-26 23:25:30 +0000897int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000898 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
899 columnMallocFailure(pStmt);
900 return val;
drh4f26d6c2004-05-26 23:25:30 +0000901}
902int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000903 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
904 columnMallocFailure(pStmt);
905 return val;
drh4f26d6c2004-05-26 23:25:30 +0000906}
907double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000908 double val = sqlite3_value_double( columnMem(pStmt,i) );
909 columnMallocFailure(pStmt);
910 return val;
drh4f26d6c2004-05-26 23:25:30 +0000911}
912int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000913 int val = sqlite3_value_int( columnMem(pStmt,i) );
914 columnMallocFailure(pStmt);
915 return val;
drh4f26d6c2004-05-26 23:25:30 +0000916}
drhefad9992004-06-22 12:13:55 +0000917sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000918 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
919 columnMallocFailure(pStmt);
920 return val;
drh4f26d6c2004-05-26 23:25:30 +0000921}
922const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000923 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
924 columnMallocFailure(pStmt);
925 return val;
drh4f26d6c2004-05-26 23:25:30 +0000926}
drhd1e47332005-06-26 17:55:33 +0000927sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +0000928 Mem *pOut = columnMem(pStmt, i);
929 if( pOut->flags&MEM_Static ){
930 pOut->flags &= ~MEM_Static;
931 pOut->flags |= MEM_Ephem;
932 }
drh32bc3f62007-08-21 20:25:39 +0000933 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +0000934 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +0000935}
drh6c626082004-11-14 21:56:29 +0000936#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000937const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000938 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
939 columnMallocFailure(pStmt);
940 return val;
drh4f26d6c2004-05-26 23:25:30 +0000941}
drh6c626082004-11-14 21:56:29 +0000942#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000943int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000944 int iType = sqlite3_value_type( columnMem(pStmt,i) );
945 columnMallocFailure(pStmt);
946 return iType;
drh4f26d6c2004-05-26 23:25:30 +0000947}
948
drh5e2517e2004-09-24 23:59:12 +0000949/*
950** Convert the N-th element of pStmt->pColName[] into a string using
951** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000952**
953** There are up to 5 names for each column. useType determines which
954** name is returned. Here are the names:
955**
956** 0 The column name as it should be displayed for output
957** 1 The datatype name for the column
958** 2 The name of the database that the column derives from
959** 3 The name of the table that the column derives from
960** 4 The name of the table column that the result column derives from
961**
962** If the result is not a simple column reference (if it is an expression
963** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000964*/
965static const void *columnName(
966 sqlite3_stmt *pStmt,
967 int N,
968 const void *(*xFunc)(Mem*),
969 int useType
970){
drh9ca95732014-10-24 00:35:58 +0000971 const void *ret;
972 Vdbe *p;
drh32bc3f62007-08-21 20:25:39 +0000973 int n;
drh9ca95732014-10-24 00:35:58 +0000974 sqlite3 *db;
975#ifdef SQLITE_ENABLE_API_ARMOR
976 if( pStmt==0 ){
977 (void)SQLITE_MISUSE_BKPT;
978 return 0;
979 }
980#endif
981 ret = 0;
982 p = (Vdbe *)pStmt;
983 db = p->db;
drh9b4ea4a2009-04-10 20:32:00 +0000984 assert( db!=0 );
985 n = sqlite3_column_count(pStmt);
986 if( N<n && N>=0 ){
987 N += useType*n;
988 sqlite3_mutex_enter(db->mutex);
989 assert( db->mallocFailed==0 );
990 ret = xFunc(&p->aColName[N]);
991 /* A malloc may have failed inside of the xFunc() call. If this
992 ** is the case, clear the mallocFailed flag and return NULL.
993 */
994 if( db->mallocFailed ){
995 db->mallocFailed = 0;
996 ret = 0;
drh32bc3f62007-08-21 20:25:39 +0000997 }
drh9b4ea4a2009-04-10 20:32:00 +0000998 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +0000999 }
danielk197700fd9572005-12-07 06:27:43 +00001000 return ret;
drh5e2517e2004-09-24 23:59:12 +00001001}
1002
drh4f26d6c2004-05-26 23:25:30 +00001003/*
1004** Return the name of the Nth column of the result set returned by SQL
1005** statement pStmt.
1006*/
1007const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001008 return columnName(
1009 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +00001010}
drhe590fbd2005-05-20 19:36:01 +00001011#ifndef SQLITE_OMIT_UTF16
1012const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001013 return columnName(
1014 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001015}
1016#endif
drh4f26d6c2004-05-26 23:25:30 +00001017
1018/*
drh3f913572008-03-22 01:07:17 +00001019** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1020** not define OMIT_DECLTYPE.
1021*/
1022#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1023# error "Must not define both SQLITE_OMIT_DECLTYPE \
1024 and SQLITE_ENABLE_COLUMN_METADATA"
1025#endif
1026
1027#ifndef SQLITE_OMIT_DECLTYPE
1028/*
drh6c626082004-11-14 21:56:29 +00001029** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001030** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001031*/
1032const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001033 return columnName(
1034 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001035}
drh6c626082004-11-14 21:56:29 +00001036#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001037const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001038 return columnName(
1039 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001040}
drh6c626082004-11-14 21:56:29 +00001041#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001042#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001043
danielk19774b1ae992006-02-10 03:06:10 +00001044#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001045/*
1046** Return the name of the database from which a result column derives.
1047** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001048** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001049*/
1050const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001051 return columnName(
1052 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001053}
1054#ifndef SQLITE_OMIT_UTF16
1055const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001056 return columnName(
1057 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001058}
1059#endif /* SQLITE_OMIT_UTF16 */
1060
1061/*
1062** Return the name of the table from which a result column derives.
1063** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001064** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001065*/
1066const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001067 return columnName(
1068 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001069}
1070#ifndef SQLITE_OMIT_UTF16
1071const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001072 return columnName(
1073 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001074}
1075#endif /* SQLITE_OMIT_UTF16 */
1076
1077/*
1078** Return the name of the table column from which a result column derives.
1079** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001080** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001081*/
1082const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001083 return columnName(
1084 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001085}
1086#ifndef SQLITE_OMIT_UTF16
1087const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001088 return columnName(
1089 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001090}
1091#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001092#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001093
1094
drh4f26d6c2004-05-26 23:25:30 +00001095/******************************* sqlite3_bind_ ***************************
1096**
1097** Routines used to attach values to wildcards in a compiled SQL statement.
1098*/
1099/*
1100** Unbind the value bound to variable i in virtual machine p. This is the
1101** the same as binding a NULL value to the column. If the "i" parameter is
1102** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1103**
drh488e7b62008-10-06 12:46:43 +00001104** A successful evaluation of this routine acquires the mutex on p.
1105** the mutex is released if any kind of error occurs.
1106**
drh4f26d6c2004-05-26 23:25:30 +00001107** The error code stored in database p->db is overwritten with the return
1108** value in any case.
1109*/
1110static int vdbeUnbind(Vdbe *p, int i){
1111 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001112 if( vdbeSafetyNotNull(p) ){
1113 return SQLITE_MISUSE_BKPT;
1114 }
drh488e7b62008-10-06 12:46:43 +00001115 sqlite3_mutex_enter(p->db->mutex);
1116 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001117 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001118 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001119 sqlite3_log(SQLITE_MISUSE,
1120 "bind on a busy prepared statement: [%s]", p->zSql);
1121 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001122 }
1123 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001124 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001125 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001126 return SQLITE_RANGE;
1127 }
1128 i--;
drh290c1942004-08-21 17:54:45 +00001129 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001130 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001131 pVar->flags = MEM_Null;
drh13f40da2014-08-22 18:00:11 +00001132 sqlite3Error(p->db, SQLITE_OK);
dan937d0de2009-10-15 18:35:38 +00001133
dan1d2ce4f2009-10-19 18:11:09 +00001134 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1135 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001136 **
1137 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1138 ** parameter in the WHERE clause might influence the choice of query plan
1139 ** for a statement, then the statement will be automatically recompiled,
1140 ** as if there had been a schema change, on the first sqlite3_step() call
1141 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001142 */
drh823e09a2009-10-19 20:15:38 +00001143 if( p->isPrepareV2 &&
1144 ((i<32 && p->expmask & ((u32)1 << i)) || p->expmask==0xffffffff)
1145 ){
dan937d0de2009-10-15 18:35:38 +00001146 p->expired = 1;
1147 }
drh4f26d6c2004-05-26 23:25:30 +00001148 return SQLITE_OK;
1149}
1150
1151/*
drh5e2517e2004-09-24 23:59:12 +00001152** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001153*/
drh5e2517e2004-09-24 23:59:12 +00001154static int bindText(
drh605264d2007-08-21 15:13:19 +00001155 sqlite3_stmt *pStmt, /* The statement to bind against */
1156 int i, /* Index of the parameter to bind */
1157 const void *zData, /* Pointer to the data to be bound */
1158 int nData, /* Number of bytes of data to be bound */
1159 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001160 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001161){
1162 Vdbe *p = (Vdbe *)pStmt;
1163 Mem *pVar;
1164 int rc;
1165
1166 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001167 if( rc==SQLITE_OK ){
1168 if( zData!=0 ){
1169 pVar = &p->aVar[i-1];
1170 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1171 if( rc==SQLITE_OK && encoding!=0 ){
1172 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1173 }
drh13f40da2014-08-22 18:00:11 +00001174 sqlite3Error(p->db, rc);
drh488e7b62008-10-06 12:46:43 +00001175 rc = sqlite3ApiExit(p->db, rc);
drh27641702007-08-22 02:56:42 +00001176 }
drh488e7b62008-10-06 12:46:43 +00001177 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001178 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001179 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001180 }
drh605264d2007-08-21 15:13:19 +00001181 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001182}
drh5e2517e2004-09-24 23:59:12 +00001183
1184
1185/*
1186** Bind a blob value to an SQL statement variable.
1187*/
1188int sqlite3_bind_blob(
1189 sqlite3_stmt *pStmt,
1190 int i,
1191 const void *zData,
1192 int nData,
1193 void (*xDel)(void*)
1194){
1195 return bindText(pStmt, i, zData, nData, xDel, 0);
1196}
drhda4ca9d2014-09-09 17:27:35 +00001197int sqlite3_bind_blob64(
1198 sqlite3_stmt *pStmt,
1199 int i,
1200 const void *zData,
1201 sqlite3_uint64 nData,
1202 void (*xDel)(void*)
1203){
drhfc59a952014-09-11 23:34:55 +00001204 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001205 if( nData>0x7fffffff ){
1206 return invokeValueDestructor(zData, xDel, 0);
1207 }else{
drh3329a632014-09-18 01:21:43 +00001208 return bindText(pStmt, i, zData, (int)nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001209 }
1210}
drh4f26d6c2004-05-26 23:25:30 +00001211int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1212 int rc;
1213 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001214 rc = vdbeUnbind(p, i);
1215 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001216 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001217 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001218 }
danielk1977f4618892004-06-28 13:09:11 +00001219 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001220}
1221int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001222 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001223}
drhefad9992004-06-22 12:13:55 +00001224int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001225 int rc;
1226 Vdbe *p = (Vdbe *)pStmt;
1227 rc = vdbeUnbind(p, i);
1228 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001229 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001230 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001231 }
1232 return rc;
1233}
drh605264d2007-08-21 15:13:19 +00001234int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1235 int rc;
1236 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001237 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001238 if( rc==SQLITE_OK ){
1239 sqlite3_mutex_leave(p->db->mutex);
1240 }
drh605264d2007-08-21 15:13:19 +00001241 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001242}
1243int sqlite3_bind_text(
1244 sqlite3_stmt *pStmt,
1245 int i,
1246 const char *zData,
1247 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001248 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001249){
drh5e2517e2004-09-24 23:59:12 +00001250 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001251}
drhbbf483f2014-09-09 20:30:24 +00001252int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001253 sqlite3_stmt *pStmt,
1254 int i,
1255 const char *zData,
1256 sqlite3_uint64 nData,
1257 void (*xDel)(void*),
1258 unsigned char enc
1259){
drhfc59a952014-09-11 23:34:55 +00001260 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001261 if( nData>0x7fffffff ){
1262 return invokeValueDestructor(zData, xDel, 0);
1263 }else{
drhfc59a952014-09-11 23:34:55 +00001264 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drh3329a632014-09-18 01:21:43 +00001265 return bindText(pStmt, i, zData, (int)nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001266 }
1267}
drh6c626082004-11-14 21:56:29 +00001268#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001269int sqlite3_bind_text16(
1270 sqlite3_stmt *pStmt,
1271 int i,
1272 const void *zData,
1273 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001274 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001275){
drh5e2517e2004-09-24 23:59:12 +00001276 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001277}
drh6c626082004-11-14 21:56:29 +00001278#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001279int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1280 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001281 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001282 case SQLITE_INTEGER: {
1283 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1284 break;
1285 }
1286 case SQLITE_FLOAT: {
drh74eaba42014-09-18 17:52:15 +00001287 rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
drh29def562009-04-14 12:43:33 +00001288 break;
1289 }
1290 case SQLITE_BLOB: {
1291 if( pValue->flags & MEM_Zero ){
1292 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1293 }else{
1294 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1295 }
1296 break;
1297 }
1298 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001299 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1300 pValue->enc);
1301 break;
1302 }
1303 default: {
1304 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001305 break;
1306 }
danielk197726e41442006-06-14 15:16:35 +00001307 }
1308 return rc;
1309}
drhb026e052007-05-02 01:34:31 +00001310int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1311 int rc;
1312 Vdbe *p = (Vdbe *)pStmt;
1313 rc = vdbeUnbind(p, i);
1314 if( rc==SQLITE_OK ){
1315 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001316 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001317 }
1318 return rc;
1319}
drh75f6a032004-07-15 14:15:00 +00001320
1321/*
1322** Return the number of wildcards that can be potentially bound to.
1323** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001324*/
1325int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001326 Vdbe *p = (Vdbe*)pStmt;
1327 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001328}
drh895d7472004-08-20 16:02:39 +00001329
1330/*
drhfa6bc002004-09-07 16:19:52 +00001331** Return the name of a wildcard parameter. Return NULL if the index
1332** is out of range or if the wildcard is unnamed.
1333**
1334** The result is always UTF-8.
1335*/
1336const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1337 Vdbe *p = (Vdbe*)pStmt;
drh124c0b42011-06-01 18:15:55 +00001338 if( p==0 || i<1 || i>p->nzVar ){
drhfa6bc002004-09-07 16:19:52 +00001339 return 0;
1340 }
drh895d7472004-08-20 16:02:39 +00001341 return p->azVar[i-1];
1342}
drhfa6bc002004-09-07 16:19:52 +00001343
1344/*
1345** Given a wildcard parameter name, return the index of the variable
1346** with that name. If there is no variable with the given name,
1347** return 0.
1348*/
drh5f18a222009-11-26 14:01:53 +00001349int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drhfa6bc002004-09-07 16:19:52 +00001350 int i;
1351 if( p==0 ){
1352 return 0;
1353 }
drh6a8903c2004-12-10 18:00:04 +00001354 if( zName ){
drh124c0b42011-06-01 18:15:55 +00001355 for(i=0; i<p->nzVar; i++){
drh6a8903c2004-12-10 18:00:04 +00001356 const char *z = p->azVar[i];
drh503a6862013-03-01 01:07:17 +00001357 if( z && strncmp(z,zName,nName)==0 && z[nName]==0 ){
drh6a8903c2004-12-10 18:00:04 +00001358 return i+1;
1359 }
drhfa6bc002004-09-07 16:19:52 +00001360 }
1361 }
1362 return 0;
1363}
drh5f18a222009-11-26 14:01:53 +00001364int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1365 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1366}
drhf8db1bc2005-04-22 02:38:37 +00001367
drh51942bc2005-06-12 22:01:42 +00001368/*
drhf8db1bc2005-04-22 02:38:37 +00001369** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001370*/
shane145834a2008-09-04 12:03:42 +00001371int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001372 Vdbe *pFrom = (Vdbe*)pFromStmt;
1373 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001374 int i;
1375 assert( pTo->db==pFrom->db );
1376 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001377 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001378 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001379 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001380 }
drh27641702007-08-22 02:56:42 +00001381 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001382 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001383}
drh51942bc2005-06-12 22:01:42 +00001384
shaneeec556d2008-10-12 00:27:53 +00001385#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001386/*
shane145834a2008-09-04 12:03:42 +00001387** Deprecated external interface. Internal/core SQLite code
1388** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001389**
peter.d.reid60ec9142014-09-06 16:39:46 +00001390** It is misuse to call this routine with statements from different
drh0f5ea0b2009-04-09 14:02:44 +00001391** database connections. But as this is a deprecated interface, we
1392** will not bother to check for that condition.
1393**
1394** If the two statements contain a different number of bindings, then
1395** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1396** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001397*/
1398int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001399 Vdbe *pFrom = (Vdbe*)pFromStmt;
1400 Vdbe *pTo = (Vdbe*)pToStmt;
1401 if( pFrom->nVar!=pTo->nVar ){
1402 return SQLITE_ERROR;
1403 }
danc94b8592009-10-20 07:01:24 +00001404 if( pTo->isPrepareV2 && pTo->expmask ){
1405 pTo->expired = 1;
1406 }
1407 if( pFrom->isPrepareV2 && pFrom->expmask ){
1408 pFrom->expired = 1;
1409 }
shane145834a2008-09-04 12:03:42 +00001410 return sqlite3TransferBindings(pFromStmt, pToStmt);
1411}
shaneeec556d2008-10-12 00:27:53 +00001412#endif
shane145834a2008-09-04 12:03:42 +00001413
1414/*
drh51942bc2005-06-12 22:01:42 +00001415** Return the sqlite3* database handle to which the prepared statement given
1416** in the argument belongs. This is the same database handle that was
1417** the first argument to the sqlite3_prepare() that was used to create
1418** the statement in the first place.
1419*/
1420sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1421 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1422}
drhbb5a9c32008-06-19 02:52:25 +00001423
1424/*
drhf03d9cc2010-11-16 23:10:25 +00001425** Return true if the prepared statement is guaranteed to not modify the
1426** database.
1427*/
1428int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1429 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1430}
1431
1432/*
drh2fb66932011-11-25 17:21:47 +00001433** Return true if the prepared statement is in need of being reset.
1434*/
1435int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1436 Vdbe *v = (Vdbe*)pStmt;
dan857745c2014-07-19 17:57:10 +00001437 return v!=0 && v->pc>=0 && v->magic==VDBE_MAGIC_RUN;
drh2fb66932011-11-25 17:21:47 +00001438}
1439
1440/*
drhbb5a9c32008-06-19 02:52:25 +00001441** Return a pointer to the next prepared statement after pStmt associated
1442** with database connection pDb. If pStmt is NULL, return the first
1443** prepared statement for the database connection. Return NULL if there
1444** are no more.
1445*/
1446sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1447 sqlite3_stmt *pNext;
drh9ca95732014-10-24 00:35:58 +00001448#ifdef SQLITE_ENABLE_API_ARMOR
1449 if( !sqlite3SafetyCheckOk(pDb) ){
1450 (void)SQLITE_MISUSE_BKPT;
1451 return 0;
1452 }
1453#endif
drhbb5a9c32008-06-19 02:52:25 +00001454 sqlite3_mutex_enter(pDb->mutex);
1455 if( pStmt==0 ){
1456 pNext = (sqlite3_stmt*)pDb->pVdbe;
1457 }else{
1458 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1459 }
1460 sqlite3_mutex_leave(pDb->mutex);
1461 return pNext;
1462}
drhd1d38482008-10-07 23:46:38 +00001463
1464/*
1465** Return the value of a status counter for a prepared statement
1466*/
1467int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1468 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9ca95732014-10-24 00:35:58 +00001469 u32 v;
1470#ifdef SQLITE_ENABLE_API_ARMOR
1471 if( !pStmt ){
1472 (void)SQLITE_MISUSE_BKPT;
1473 return 0;
1474 }
1475#endif
1476 v = pVdbe->aCounter[op];
drh9b47ee32013-08-20 03:13:51 +00001477 if( resetFlag ) pVdbe->aCounter[op] = 0;
1478 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001479}
dan04489b62014-10-31 20:11:32 +00001480
dan6f9702e2014-11-01 20:38:06 +00001481#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan04489b62014-10-31 20:11:32 +00001482/*
1483** Return status data for a single loop within query pStmt.
1484*/
1485int sqlite3_stmt_scanstatus(
drhd1a1c232014-11-03 16:35:55 +00001486 sqlite3_stmt *pStmt, /* Prepared statement being queried */
dan04489b62014-10-31 20:11:32 +00001487 int idx, /* Index of loop to report on */
drhd1a1c232014-11-03 16:35:55 +00001488 int iScanStatusOp, /* Which metric to return */
1489 void *pOut /* OUT: Write the answer here */
dan04489b62014-10-31 20:11:32 +00001490){
1491 Vdbe *p = (Vdbe*)pStmt;
dan037b5322014-11-03 11:25:32 +00001492 ScanStatus *pScan;
dan6f9702e2014-11-01 20:38:06 +00001493 if( idx<0 || idx>=p->nScan ) return 1;
1494 pScan = &p->aScan[idx];
drhd1a1c232014-11-03 16:35:55 +00001495 switch( iScanStatusOp ){
1496 case SQLITE_SCANSTAT_NLOOP: {
1497 *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
1498 break;
1499 }
1500 case SQLITE_SCANSTAT_NVISIT: {
1501 *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
1502 break;
1503 }
1504 case SQLITE_SCANSTAT_EST: {
drh518140e2014-11-06 03:55:10 +00001505 double r = 1.0;
1506 LogEst x = pScan->nEst;
1507 while( x<100 ){
1508 x += 10;
1509 r *= 0.5;
1510 }
1511 *(double*)pOut = r*sqlite3LogEstToInt(x);
drhd1a1c232014-11-03 16:35:55 +00001512 break;
1513 }
1514 case SQLITE_SCANSTAT_NAME: {
dand72219d2014-11-03 16:39:37 +00001515 *(const char**)pOut = pScan->zName;
drhd1a1c232014-11-03 16:35:55 +00001516 break;
1517 }
1518 case SQLITE_SCANSTAT_EXPLAIN: {
1519 if( pScan->addrExplain ){
1520 *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
1521 }else{
1522 *(const char**)pOut = 0;
1523 }
1524 break;
1525 }
drhc6652b12014-11-06 04:42:20 +00001526 case SQLITE_SCANSTAT_SELECTID: {
1527 if( pScan->addrExplain ){
1528 *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
1529 }else{
1530 *(int*)pOut = -1;
1531 }
1532 break;
1533 }
drhd1a1c232014-11-03 16:35:55 +00001534 default: {
1535 return 1;
dan6f9702e2014-11-01 20:38:06 +00001536 }
1537 }
dan04489b62014-10-31 20:11:32 +00001538 return 0;
1539}
1540
1541/*
1542** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
1543*/
1544void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
1545 Vdbe *p = (Vdbe*)pStmt;
dan6f9702e2014-11-01 20:38:06 +00001546 memset(p->anExec, 0, p->nOp * sizeof(i64));
dan04489b62014-10-31 20:11:32 +00001547}
dan6f9702e2014-11-01 20:38:06 +00001548#endif /* SQLITE_ENABLE_STMT_SCANSTATUS */