blob: aad64aa64bc3bd045fcf70eef79e7009bc36a1f5 [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 );
drhda4ca9d2014-09-09 17:27:35 +0000321 if( n>0x7fffffff ){
322 (void)invokeValueDestructor(z, xDel, pCtx);
323 }else{
324 setResultStrOrError(pCtx, z, (int)n, enc, xDel);
325 }
326}
drh6c626082004-11-14 21:56:29 +0000327#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000328void sqlite3_result_text16(
329 sqlite3_context *pCtx,
330 const void *z,
331 int n,
danielk1977d8123362004-06-12 09:25:12 +0000332 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000333){
drh9bd038f2014-08-27 14:14:06 +0000334 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000335 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000336}
337void sqlite3_result_text16be(
338 sqlite3_context *pCtx,
339 const void *z,
340 int n,
341 void (*xDel)(void *)
342){
drh9bd038f2014-08-27 14:14:06 +0000343 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000344 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000345}
346void sqlite3_result_text16le(
347 sqlite3_context *pCtx,
348 const void *z,
349 int n,
350 void (*xDel)(void *)
351){
drh9bd038f2014-08-27 14:14:06 +0000352 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000353 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000354}
drh6c626082004-11-14 21:56:29 +0000355#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000356void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh9bd038f2014-08-27 14:14:06 +0000357 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
358 sqlite3VdbeMemCopy(pCtx->pOut, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000359}
drhb026e052007-05-02 01:34:31 +0000360void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh9bd038f2014-08-27 14:14:06 +0000361 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
362 sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
drhb026e052007-05-02 01:34:31 +0000363}
drh69544ec2008-02-06 14:11:34 +0000364void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
365 pCtx->isError = errCode;
drh9b47ee32013-08-20 03:13:51 +0000366 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000367 if( pCtx->pOut->flags & MEM_Null ){
368 sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
drh51c7d862009-04-27 18:46:06 +0000369 SQLITE_UTF8, SQLITE_STATIC);
370 }
drh69544ec2008-02-06 14:11:34 +0000371}
drh4f26d6c2004-05-26 23:25:30 +0000372
drha0206bc2007-05-08 15:15:02 +0000373/* Force an SQLITE_TOOBIG error. */
374void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000375 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000376 pCtx->isError = SQLITE_TOOBIG;
drh9b47ee32013-08-20 03:13:51 +0000377 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000378 sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
drhbb4957f2008-03-20 14:03:29 +0000379 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000380}
381
danielk1977a1644fd2007-08-29 12:31:25 +0000382/* An SQLITE_NOMEM error. */
383void sqlite3_result_error_nomem(sqlite3_context *pCtx){
drh9bd038f2014-08-27 14:14:06 +0000384 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
385 sqlite3VdbeMemSetNull(pCtx->pOut);
drh69544ec2008-02-06 14:11:34 +0000386 pCtx->isError = SQLITE_NOMEM;
drh9b47ee32013-08-20 03:13:51 +0000387 pCtx->fErrorOrAux = 1;
drh9bd038f2014-08-27 14:14:06 +0000388 pCtx->pOut->db->mallocFailed = 1;
danielk1977a1644fd2007-08-29 12:31:25 +0000389}
drh4f26d6c2004-05-26 23:25:30 +0000390
dan5cf53532010-05-01 16:40:20 +0000391/*
392** This function is called after a transaction has been committed. It
393** invokes callbacks registered with sqlite3_wal_hook() as required.
394*/
drh7ed91f22010-04-29 22:34:07 +0000395static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000396 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000397#ifndef SQLITE_OMIT_WAL
398 int i;
dan8d22a172010-04-19 18:03:51 +0000399 for(i=0; i<db->nDb; i++){
400 Btree *pBt = db->aDb[i].pBt;
401 if( pBt ){
drh7ed91f22010-04-29 22:34:07 +0000402 int nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
drh5def0842010-05-05 20:00:25 +0000403 if( db->xWalCallback && nEntry>0 && rc==SQLITE_OK ){
404 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000405 }
406 }
407 }
dan5cf53532010-05-01 16:40:20 +0000408#endif
dan8d22a172010-04-19 18:03:51 +0000409 return rc;
410}
411
drh4f26d6c2004-05-26 23:25:30 +0000412/*
413** Execute the statement pStmt, either until a row of data is ready, the
414** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000415**
416** This routine implements the bulk of the logic behind the sqlite_step()
417** API. The only thing omitted is the automatic recompile if a
418** schema change has occurred. That detail is handled by the
419** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000420*/
drhb900aaf2006-11-09 00:24:53 +0000421static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000422 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000423 int rc;
424
danielk1977a185ddb2007-11-15 16:04:15 +0000425 assert(p);
426 if( p->magic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000427 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000428 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
429 ** with version 3.7.0, we changed this so that sqlite3_reset() would
430 ** be called automatically instead of throwing the SQLITE_MISUSE error.
431 ** This "automatic-reset" change is not technically an incompatibility,
432 ** since any application that receives an SQLITE_MISUSE is broken by
433 ** definition.
434 **
435 ** Nevertheless, some published applications that were originally written
436 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000437 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000438 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
439 ** legacy behavior of returning SQLITE_MISUSE for cases where the
440 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
441 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000442 */
drh602acb42011-01-17 17:42:37 +0000443#ifdef SQLITE_OMIT_AUTORESET
444 if( p->rc==SQLITE_BUSY || p->rc==SQLITE_LOCKED ){
445 sqlite3_reset((sqlite3_stmt*)p);
446 }else{
447 return SQLITE_MISUSE_BKPT;
448 }
449#else
drh3674bfd2010-04-17 12:53:19 +0000450 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000451#endif
drhf1bfe9a2007-10-17 01:44:20 +0000452 }
453
dan14d4cc42010-01-20 14:25:37 +0000454 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000455 db = p->db;
drhc456e572008-08-11 18:44:58 +0000456 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000457 p->rc = SQLITE_NOMEM;
drhc456e572008-08-11 18:44:58 +0000458 return SQLITE_NOMEM;
459 }
danielk1977261919c2005-12-06 12:52:59 +0000460
danielk1977a21c6b62005-01-24 10:25:59 +0000461 if( p->pc<=0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000462 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000463 rc = SQLITE_ERROR;
464 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000465 }
danielk19771d850a72004-05-31 08:26:49 +0000466 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000467 /* If there are no other statements currently running, then
468 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
469 ** from interrupting a statement that has not yet started.
470 */
drh4f7d3a52013-06-27 23:54:02 +0000471 if( db->nVdbeActive==0 ){
drh15ca1df2006-07-26 13:43:30 +0000472 db->u1.isInterrupted = 0;
473 }
474
drh648e2642013-07-11 15:03:32 +0000475 assert( db->nVdbeWrite>0 || db->autoCommit==0
476 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
477 );
dan1da40a32009-09-19 17:00:31 +0000478
drh19e2d372005-08-29 23:00:03 +0000479#ifndef SQLITE_OMIT_TRACE
drh19e2d372005-08-29 23:00:03 +0000480 if( db->xProfile && !db->init.busy ){
drhb7e8ea22010-05-03 14:32:30 +0000481 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh19e2d372005-08-29 23:00:03 +0000482 }
483#endif
drhc16a03b2004-09-15 13:38:10 +0000484
drh4f7d3a52013-06-27 23:54:02 +0000485 db->nVdbeActive++;
486 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000487 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000488 p->pc = 0;
489 }
drhb7f91642004-10-31 02:22:47 +0000490#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000491 if( p->explain ){
492 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000493 }else
494#endif /* SQLITE_OMIT_EXPLAIN */
495 {
drh4f7d3a52013-06-27 23:54:02 +0000496 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000497 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000498 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000499 }
500
drh19e2d372005-08-29 23:00:03 +0000501#ifndef SQLITE_OMIT_TRACE
502 /* Invoke the profile callback if there is one
503 */
danielk19776ab3a2e2009-02-19 14:39:25 +0000504 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000505 sqlite3_int64 iNow;
506 sqlite3OsCurrentTimeInt64(db->pVfs, &iNow);
drhdf0db0f2010-07-29 10:07:21 +0000507 db->xProfile(db->pProfileArg, p->zSql, (iNow - p->startTime)*1000000);
drh19e2d372005-08-29 23:00:03 +0000508 }
509#endif
510
dan8d22a172010-04-19 18:03:51 +0000511 if( rc==SQLITE_DONE ){
512 assert( p->rc==SQLITE_OK );
drh7ed91f22010-04-29 22:34:07 +0000513 p->rc = doWalCallbacks(db);
dan8d22a172010-04-19 18:03:51 +0000514 if( p->rc!=SQLITE_OK ){
515 rc = SQLITE_ERROR;
516 }
517 }
518
drh80cc85b2008-07-23 21:07:25 +0000519 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000520 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
521 p->rc = SQLITE_NOMEM;
drhb900aaf2006-11-09 00:24:53 +0000522 }
danielk1977357864e2009-03-25 15:43:08 +0000523end_of_step:
524 /* At this point local variable rc holds the value that should be
525 ** returned if this statement was compiled using the legacy
526 ** sqlite3_prepare() interface. According to the docs, this can only
527 ** be one of the values in the first assert() below. Variable p->rc
528 ** contains the value that would be returned if sqlite3_finalize()
529 ** were called on statement p.
530 */
531 assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
532 || rc==SQLITE_BUSY || rc==SQLITE_MISUSE
533 );
534 assert( p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE );
535 if( p->isPrepareV2 && rc!=SQLITE_ROW && rc!=SQLITE_DONE ){
536 /* If this statement was prepared using sqlite3_prepare_v2(), and an
mistachkin48864df2013-03-21 21:20:32 +0000537 ** error has occurred, then return the error code in p->rc to the
danielk1977357864e2009-03-25 15:43:08 +0000538 ** caller. Set the error code in the database handle to the same value.
539 */
dan029ead62011-10-27 15:19:58 +0000540 rc = sqlite3VdbeTransferError(p);
danielk1977357864e2009-03-25 15:43:08 +0000541 }
542 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000543}
544
545/*
546** This is the top-level implementation of sqlite3_step(). Call
547** sqlite3Step() to do most of the work. If a schema error occurs,
548** call sqlite3Reprepare() and try again.
549*/
drhb900aaf2006-11-09 00:24:53 +0000550int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000551 int rc = SQLITE_OK; /* Result from sqlite3Step() */
552 int rc2 = SQLITE_OK; /* Result from sqlite3Reprepare() */
553 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
554 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
555 sqlite3 *db; /* The database connection */
556
drh413c3d32010-02-23 20:11:56 +0000557 if( vdbeSafetyNotNull(v) ){
558 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000559 }
drh413c3d32010-02-23 20:11:56 +0000560 db = v->db;
561 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000562 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000563 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh2c7946a2014-08-19 20:27:40 +0000564 && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
565 int savedPc = v->pc;
566 rc2 = rc = sqlite3Reprepare(v);
567 if( rc!=SQLITE_OK) break;
drh413c3d32010-02-23 20:11:56 +0000568 sqlite3_reset(pStmt);
drh5f58ae72014-08-19 20:41:36 +0000569 if( savedPc>=0 ) v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000570 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000571 }
drha3cc0072013-12-13 16:23:55 +0000572 if( rc2!=SQLITE_OK ){
drh413c3d32010-02-23 20:11:56 +0000573 /* This case occurs after failing to recompile an sql statement.
574 ** The error message from the SQL compiler has already been loaded
575 ** into the database handle. This block copies the error message
576 ** from the database handle into the statement and sets the statement
577 ** program counter to 0 to ensure that when the statement is
578 ** finalized or reset the parser error message is available via
579 ** sqlite3_errmsg() and sqlite3_errcode().
580 */
581 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
drha3cc0072013-12-13 16:23:55 +0000582 assert( zErr!=0 || db->mallocFailed );
drh413c3d32010-02-23 20:11:56 +0000583 sqlite3DbFree(db, v->zErrMsg);
584 if( !db->mallocFailed ){
585 v->zErrMsg = sqlite3DbStrDup(db, zErr);
drha6129fa2010-02-24 17:15:19 +0000586 v->rc = rc2;
drh413c3d32010-02-23 20:11:56 +0000587 } else {
588 v->zErrMsg = 0;
drha6129fa2010-02-24 17:15:19 +0000589 v->rc = rc = SQLITE_NOMEM;
drh413c3d32010-02-23 20:11:56 +0000590 }
591 }
592 rc = sqlite3ApiExit(db, rc);
593 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000594 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000595}
596
drh95a7b3e2013-09-16 12:57:19 +0000597
drh4f26d6c2004-05-26 23:25:30 +0000598/*
drheb2e1762004-05-27 01:53:56 +0000599** Extract the user data from a sqlite3_context structure and return a
600** pointer to it.
601*/
602void *sqlite3_user_data(sqlite3_context *p){
603 assert( p && p->pFunc );
604 return p->pFunc->pUserData;
605}
606
607/*
drhfa4a4b92008-03-19 21:45:51 +0000608** Extract the user data from a sqlite3_context structure and return a
609** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000610**
611** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
612** returns a copy of the pointer to the database connection (the 1st
613** parameter) of the sqlite3_create_function() and
614** sqlite3_create_function16() routines that originally registered the
615** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000616*/
617sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
618 assert( p && p->pFunc );
drh9bd038f2014-08-27 14:14:06 +0000619 return p->pOut->db;
drhfa4a4b92008-03-19 21:45:51 +0000620}
621
622/*
drh95a7b3e2013-09-16 12:57:19 +0000623** Return the current time for a statement
624*/
625sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
626 Vdbe *v = p->pVdbe;
627 int rc;
628 if( v->iCurrentTime==0 ){
drh9bd038f2014-08-27 14:14:06 +0000629 rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, &v->iCurrentTime);
drh95a7b3e2013-09-16 12:57:19 +0000630 if( rc ) v->iCurrentTime = 0;
631 }
632 return v->iCurrentTime;
633}
634
635/*
drhb7481e72006-09-16 21:45:14 +0000636** The following is the implementation of an SQL function that always
637** fails with an error message stating that the function is used in the
638** wrong context. The sqlite3_overload_function() API might construct
639** SQL function that use this routine so that the functions will exist
640** for name resolution but are actually overloaded by the xFindFunction
641** method of virtual tables.
642*/
643void sqlite3InvalidFunction(
644 sqlite3_context *context, /* The function calling context */
danielk197762c14b32008-11-19 09:05:26 +0000645 int NotUsed, /* Number of arguments to the function */
646 sqlite3_value **NotUsed2 /* Value of each argument */
drhb7481e72006-09-16 21:45:14 +0000647){
648 const char *zName = context->pFunc->zName;
649 char *zErr;
danielk197762c14b32008-11-19 09:05:26 +0000650 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhbc6160b2009-04-08 15:45:31 +0000651 zErr = sqlite3_mprintf(
drhb7481e72006-09-16 21:45:14 +0000652 "unable to use function %s in the requested context", zName);
653 sqlite3_result_error(context, zErr, -1);
danielk19771e536952007-08-16 10:09:01 +0000654 sqlite3_free(zErr);
drhb7481e72006-09-16 21:45:14 +0000655}
656
657/*
drh9de4a172014-08-23 18:17:19 +0000658** Create a new aggregate context for p and return a pointer to
659** its pMem->z element.
660*/
661static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
662 Mem *pMem = p->pMem;
663 assert( (pMem->flags & MEM_Agg)==0 );
664 if( nByte<=0 ){
drh0725cab2014-09-17 14:52:46 +0000665 sqlite3VdbeMemSetNull(pMem);
drh9de4a172014-08-23 18:17:19 +0000666 pMem->z = 0;
667 }else{
668 sqlite3VdbeMemGrow(pMem, nByte, 0);
669 pMem->flags = MEM_Agg;
670 pMem->u.pDef = p->pFunc;
671 if( pMem->z ){
672 memset(pMem->z, 0, nByte);
673 }
674 }
675 return (void*)pMem->z;
676}
677
678/*
drheb2e1762004-05-27 01:53:56 +0000679** Allocate or return the aggregate context for a user function. A new
680** context is allocated on the first call. Subsequent calls return the
681** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000682*/
683void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drh825c6622005-09-08 19:01:05 +0000684 assert( p && p->pFunc && p->pFunc->xStep );
drh9bd038f2014-08-27 14:14:06 +0000685 assert( sqlite3_mutex_held(p->pOut->db->mutex) );
drhd68eee02009-12-11 03:44:18 +0000686 testcase( nByte<0 );
drh9de4a172014-08-23 18:17:19 +0000687 if( (p->pMem->flags & MEM_Agg)==0 ){
688 return createAggContext(p, nByte);
689 }else{
690 return (void*)p->pMem->z;
drheb2e1762004-05-27 01:53:56 +0000691 }
drheb2e1762004-05-27 01:53:56 +0000692}
693
694/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000695** Return the auxiliary data pointer, if any, for the iArg'th argument to
danielk1977682f68b2004-06-05 10:22:17 +0000696** the user-function defined by pCtx.
697*/
698void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000699 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000700
drh9bd038f2014-08-27 14:14:06 +0000701 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000702 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
703 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
danielk1977682f68b2004-06-05 10:22:17 +0000704 }
dan0c547792013-07-18 17:12:08 +0000705
706 return (pAuxData ? pAuxData->pAux : 0);
danielk1977682f68b2004-06-05 10:22:17 +0000707}
708
709/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000710** Set the auxiliary data pointer and delete function, for the iArg'th
danielk1977682f68b2004-06-05 10:22:17 +0000711** argument to the user-function defined by pCtx. Any previous value is
712** deleted by calling the delete function specified when it was set.
713*/
714void sqlite3_set_auxdata(
715 sqlite3_context *pCtx,
716 int iArg,
717 void *pAux,
718 void (*xDelete)(void*)
719){
dan0c547792013-07-18 17:12:08 +0000720 AuxData *pAuxData;
721 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000722
drh9bd038f2014-08-27 14:14:06 +0000723 assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
dan0c547792013-07-18 17:12:08 +0000724 if( iArg<0 ) goto failed;
danielk1977682f68b2004-06-05 10:22:17 +0000725
dan0c547792013-07-18 17:12:08 +0000726 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
727 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
728 }
729 if( pAuxData==0 ){
730 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
731 if( !pAuxData ) goto failed;
732 pAuxData->iOp = pCtx->iOp;
733 pAuxData->iArg = iArg;
734 pAuxData->pNext = pVdbe->pAuxData;
735 pVdbe->pAuxData = pAuxData;
drh9b47ee32013-08-20 03:13:51 +0000736 if( pCtx->fErrorOrAux==0 ){
737 pCtx->isError = 0;
738 pCtx->fErrorOrAux = 1;
739 }
dan0c547792013-07-18 17:12:08 +0000740 }else if( pAuxData->xDelete ){
danielk1977682f68b2004-06-05 10:22:17 +0000741 pAuxData->xDelete(pAuxData->pAux);
742 }
dan0c547792013-07-18 17:12:08 +0000743
danielk1977682f68b2004-06-05 10:22:17 +0000744 pAuxData->pAux = pAux;
745 pAuxData->xDelete = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000746 return;
747
748failed:
749 if( xDelete ){
750 xDelete(pAux);
751 }
danielk1977682f68b2004-06-05 10:22:17 +0000752}
753
shaneeec556d2008-10-12 00:27:53 +0000754#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000755/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000756** Return the number of times the Step function of an aggregate has been
drheb2e1762004-05-27 01:53:56 +0000757** called.
758**
drhcf85a512006-02-09 18:35:29 +0000759** This function is deprecated. Do not use it for new code. It is
760** provide only to avoid breaking legacy code. New aggregate function
761** implementations should keep their own counts within their aggregate
762** context.
drheb2e1762004-05-27 01:53:56 +0000763*/
764int sqlite3_aggregate_count(sqlite3_context *p){
shanee34c6472009-03-05 04:23:47 +0000765 assert( p && p->pMem && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000766 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000767}
shaneeec556d2008-10-12 00:27:53 +0000768#endif
drheb2e1762004-05-27 01:53:56 +0000769
770/*
drh4f26d6c2004-05-26 23:25:30 +0000771** Return the number of columns in the result set for the statement pStmt.
772*/
773int sqlite3_column_count(sqlite3_stmt *pStmt){
774 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000775 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000776}
777
778/*
779** Return the number of values available from the current row of the
780** currently executing statement pStmt.
781*/
782int sqlite3_data_count(sqlite3_stmt *pStmt){
783 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000784 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000785 return pVm->nResColumn;
786}
787
drhb1a1c292014-03-05 12:47:55 +0000788/*
789** Return a pointer to static memory containing an SQL NULL value.
790*/
791static const Mem *columnNullValue(void){
792 /* Even though the Mem structure contains an element
793 ** of type i64, on certain architectures (x86) with certain compiler
794 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
795 ** instead of an 8-byte one. This all works fine, except that when
796 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
797 ** that a Mem structure is located on an 8-byte boundary. To prevent
798 ** these assert()s from failing, when building with SQLITE_DEBUG defined
799 ** using gcc, we force nullMem to be 8-byte aligned using the magical
800 ** __attribute__((aligned(8))) macro. */
801 static const Mem nullMem
802#if defined(SQLITE_DEBUG) && defined(__GNUC__)
803 __attribute__((aligned(8)))
804#endif
drh035e5632014-09-16 14:16:31 +0000805 = {
drh3329a632014-09-18 01:21:43 +0000806 /* .u = */ {0},
807 /* .flags = */ MEM_Null,
808 /* .enc = */ 0,
809 /* .n = */ 0,
drh3329a632014-09-18 01:21:43 +0000810 /* .z = */ 0,
811 /* .zMalloc = */ 0,
812 /* .db = */ 0,
813 /* .xDel = */ 0,
drhb1a1c292014-03-05 12:47:55 +0000814#ifdef SQLITE_DEBUG
drh3329a632014-09-18 01:21:43 +0000815 /* .pScopyFrom = */ 0,
816 /* .pFiller = */ 0,
drhb1a1c292014-03-05 12:47:55 +0000817#endif
drh035e5632014-09-16 14:16:31 +0000818 };
drhb1a1c292014-03-05 12:47:55 +0000819 return &nullMem;
820}
drh4f26d6c2004-05-26 23:25:30 +0000821
822/*
823** Check to see if column iCol of the given statement is valid. If
824** it is, return a pointer to the Mem for the value of that column.
825** If iCol is not valid, return a pointer to a Mem which has a value
826** of NULL.
827*/
828static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000829 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000830 Mem *pOut;
831
832 pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000833 if( pVm && pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drh32bc3f62007-08-21 20:25:39 +0000834 sqlite3_mutex_enter(pVm->db->mutex);
drhd4e70eb2008-01-02 00:34:36 +0000835 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +0000836 }else{
drh9b4ea4a2009-04-10 20:32:00 +0000837 if( pVm && ALWAYS(pVm->db) ){
drh27641702007-08-22 02:56:42 +0000838 sqlite3_mutex_enter(pVm->db->mutex);
drh13f40da2014-08-22 18:00:11 +0000839 sqlite3Error(pVm->db, SQLITE_RANGE);
drh27641702007-08-22 02:56:42 +0000840 }
drhb1a1c292014-03-05 12:47:55 +0000841 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +0000842 }
drh32bc3f62007-08-21 20:25:39 +0000843 return pOut;
drh4f26d6c2004-05-26 23:25:30 +0000844}
845
danielk19772e588c72005-12-09 14:25:08 +0000846/*
847** This function is called after invoking an sqlite3_value_XXX function on a
848** column value (i.e. a value returned by evaluating an SQL expression in the
849** select list of a SELECT statement) that may cause a malloc() failure. If
850** malloc() has failed, the threads mallocFailed flag is cleared and the result
851** code of statement pStmt set to SQLITE_NOMEM.
852**
drh32bc3f62007-08-21 20:25:39 +0000853** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +0000854**
855** sqlite3_column_int()
856** sqlite3_column_int64()
857** sqlite3_column_text()
858** sqlite3_column_text16()
859** sqlite3_column_real()
860** sqlite3_column_bytes()
861** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +0000862** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +0000863*/
864static void columnMallocFailure(sqlite3_stmt *pStmt)
865{
866 /* If malloc() failed during an encoding conversion within an
867 ** sqlite3_column_XXX API, then set the return code of the statement to
868 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
869 ** and _finalize() will return NOMEM.
870 */
danielk197754f01982006-01-18 15:25:17 +0000871 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000872 if( p ){
873 p->rc = sqlite3ApiExit(p->db, p->rc);
874 sqlite3_mutex_leave(p->db->mutex);
875 }
danielk19772e588c72005-12-09 14:25:08 +0000876}
877
drh4f26d6c2004-05-26 23:25:30 +0000878/**************************** sqlite3_column_ *******************************
879** The following routines are used to access elements of the current row
880** in the result set.
881*/
danielk1977c572ef72004-05-27 09:28:41 +0000882const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000883 const void *val;
danielk19772e588c72005-12-09 14:25:08 +0000884 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +0000885 /* Even though there is no encoding conversion, value_blob() might
886 ** need to call malloc() to expand the result of a zeroblob()
887 ** expression.
888 */
889 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +0000890 return val;
danielk1977c572ef72004-05-27 09:28:41 +0000891}
drh4f26d6c2004-05-26 23:25:30 +0000892int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000893 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
894 columnMallocFailure(pStmt);
895 return val;
drh4f26d6c2004-05-26 23:25:30 +0000896}
897int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000898 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
899 columnMallocFailure(pStmt);
900 return val;
drh4f26d6c2004-05-26 23:25:30 +0000901}
902double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000903 double val = sqlite3_value_double( columnMem(pStmt,i) );
904 columnMallocFailure(pStmt);
905 return val;
drh4f26d6c2004-05-26 23:25:30 +0000906}
907int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000908 int val = sqlite3_value_int( columnMem(pStmt,i) );
909 columnMallocFailure(pStmt);
910 return val;
drh4f26d6c2004-05-26 23:25:30 +0000911}
drhefad9992004-06-22 12:13:55 +0000912sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000913 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
914 columnMallocFailure(pStmt);
915 return val;
drh4f26d6c2004-05-26 23:25:30 +0000916}
917const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000918 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
919 columnMallocFailure(pStmt);
920 return val;
drh4f26d6c2004-05-26 23:25:30 +0000921}
drhd1e47332005-06-26 17:55:33 +0000922sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +0000923 Mem *pOut = columnMem(pStmt, i);
924 if( pOut->flags&MEM_Static ){
925 pOut->flags &= ~MEM_Static;
926 pOut->flags |= MEM_Ephem;
927 }
drh32bc3f62007-08-21 20:25:39 +0000928 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +0000929 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +0000930}
drh6c626082004-11-14 21:56:29 +0000931#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000932const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000933 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
934 columnMallocFailure(pStmt);
935 return val;
drh4f26d6c2004-05-26 23:25:30 +0000936}
drh6c626082004-11-14 21:56:29 +0000937#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000938int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000939 int iType = sqlite3_value_type( columnMem(pStmt,i) );
940 columnMallocFailure(pStmt);
941 return iType;
drh4f26d6c2004-05-26 23:25:30 +0000942}
943
drh5e2517e2004-09-24 23:59:12 +0000944/*
945** Convert the N-th element of pStmt->pColName[] into a string using
946** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000947**
948** There are up to 5 names for each column. useType determines which
949** name is returned. Here are the names:
950**
951** 0 The column name as it should be displayed for output
952** 1 The datatype name for the column
953** 2 The name of the database that the column derives from
954** 3 The name of the table that the column derives from
955** 4 The name of the table column that the result column derives from
956**
957** If the result is not a simple column reference (if it is an expression
958** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000959*/
960static const void *columnName(
961 sqlite3_stmt *pStmt,
962 int N,
963 const void *(*xFunc)(Mem*),
964 int useType
965){
drh32bc3f62007-08-21 20:25:39 +0000966 const void *ret = 0;
drh5e2517e2004-09-24 23:59:12 +0000967 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000968 int n;
drhc6c7fd52009-04-08 23:05:28 +0000969 sqlite3 *db = p->db;
drh32bc3f62007-08-21 20:25:39 +0000970
drh9b4ea4a2009-04-10 20:32:00 +0000971 assert( db!=0 );
972 n = sqlite3_column_count(pStmt);
973 if( N<n && N>=0 ){
974 N += useType*n;
975 sqlite3_mutex_enter(db->mutex);
976 assert( db->mallocFailed==0 );
977 ret = xFunc(&p->aColName[N]);
978 /* A malloc may have failed inside of the xFunc() call. If this
979 ** is the case, clear the mallocFailed flag and return NULL.
980 */
981 if( db->mallocFailed ){
982 db->mallocFailed = 0;
983 ret = 0;
drh32bc3f62007-08-21 20:25:39 +0000984 }
drh9b4ea4a2009-04-10 20:32:00 +0000985 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +0000986 }
danielk197700fd9572005-12-07 06:27:43 +0000987 return ret;
drh5e2517e2004-09-24 23:59:12 +0000988}
989
drh4f26d6c2004-05-26 23:25:30 +0000990/*
991** Return the name of the Nth column of the result set returned by SQL
992** statement pStmt.
993*/
994const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000995 return columnName(
996 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +0000997}
drhe590fbd2005-05-20 19:36:01 +0000998#ifndef SQLITE_OMIT_UTF16
999const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001000 return columnName(
1001 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +00001002}
1003#endif
drh4f26d6c2004-05-26 23:25:30 +00001004
1005/*
drh3f913572008-03-22 01:07:17 +00001006** Constraint: If you have ENABLE_COLUMN_METADATA then you must
1007** not define OMIT_DECLTYPE.
1008*/
1009#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
1010# error "Must not define both SQLITE_OMIT_DECLTYPE \
1011 and SQLITE_ENABLE_COLUMN_METADATA"
1012#endif
1013
1014#ifndef SQLITE_OMIT_DECLTYPE
1015/*
drh6c626082004-11-14 21:56:29 +00001016** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +00001017** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +00001018*/
1019const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001020 return columnName(
1021 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +00001022}
drh6c626082004-11-14 21:56:29 +00001023#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +00001024const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001025 return columnName(
1026 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +00001027}
drh6c626082004-11-14 21:56:29 +00001028#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +00001029#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +00001030
danielk19774b1ae992006-02-10 03:06:10 +00001031#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +00001032/*
1033** Return the name of the database from which a result column derives.
1034** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001035** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001036*/
1037const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001038 return columnName(
1039 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001040}
1041#ifndef SQLITE_OMIT_UTF16
1042const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001043 return columnName(
1044 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +00001045}
1046#endif /* SQLITE_OMIT_UTF16 */
1047
1048/*
1049** Return the name of the table from which a result column derives.
1050** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001051** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001052*/
1053const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001054 return columnName(
1055 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001056}
1057#ifndef SQLITE_OMIT_UTF16
1058const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001059 return columnName(
1060 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +00001061}
1062#endif /* SQLITE_OMIT_UTF16 */
1063
1064/*
1065** Return the name of the table column from which a result column derives.
1066** NULL is returned if the result column is an expression or constant or
peter.d.reid60ec9142014-09-06 16:39:46 +00001067** anything else which is not an unambiguous reference to a database column.
drhe590fbd2005-05-20 19:36:01 +00001068*/
1069const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001070 return columnName(
1071 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001072}
1073#ifndef SQLITE_OMIT_UTF16
1074const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001075 return columnName(
1076 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001077}
1078#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001079#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001080
1081
drh4f26d6c2004-05-26 23:25:30 +00001082/******************************* sqlite3_bind_ ***************************
1083**
1084** Routines used to attach values to wildcards in a compiled SQL statement.
1085*/
1086/*
1087** Unbind the value bound to variable i in virtual machine p. This is the
1088** the same as binding a NULL value to the column. If the "i" parameter is
1089** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1090**
drh488e7b62008-10-06 12:46:43 +00001091** A successful evaluation of this routine acquires the mutex on p.
1092** the mutex is released if any kind of error occurs.
1093**
drh4f26d6c2004-05-26 23:25:30 +00001094** The error code stored in database p->db is overwritten with the return
1095** value in any case.
1096*/
1097static int vdbeUnbind(Vdbe *p, int i){
1098 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001099 if( vdbeSafetyNotNull(p) ){
1100 return SQLITE_MISUSE_BKPT;
1101 }
drh488e7b62008-10-06 12:46:43 +00001102 sqlite3_mutex_enter(p->db->mutex);
1103 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh13f40da2014-08-22 18:00:11 +00001104 sqlite3Error(p->db, SQLITE_MISUSE);
drh488e7b62008-10-06 12:46:43 +00001105 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001106 sqlite3_log(SQLITE_MISUSE,
1107 "bind on a busy prepared statement: [%s]", p->zSql);
1108 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001109 }
1110 if( i<1 || i>p->nVar ){
drh13f40da2014-08-22 18:00:11 +00001111 sqlite3Error(p->db, SQLITE_RANGE);
drh488e7b62008-10-06 12:46:43 +00001112 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001113 return SQLITE_RANGE;
1114 }
1115 i--;
drh290c1942004-08-21 17:54:45 +00001116 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001117 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001118 pVar->flags = MEM_Null;
drh13f40da2014-08-22 18:00:11 +00001119 sqlite3Error(p->db, SQLITE_OK);
dan937d0de2009-10-15 18:35:38 +00001120
dan1d2ce4f2009-10-19 18:11:09 +00001121 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1122 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001123 **
1124 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1125 ** parameter in the WHERE clause might influence the choice of query plan
1126 ** for a statement, then the statement will be automatically recompiled,
1127 ** as if there had been a schema change, on the first sqlite3_step() call
1128 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001129 */
drh823e09a2009-10-19 20:15:38 +00001130 if( p->isPrepareV2 &&
1131 ((i<32 && p->expmask & ((u32)1 << i)) || p->expmask==0xffffffff)
1132 ){
dan937d0de2009-10-15 18:35:38 +00001133 p->expired = 1;
1134 }
drh4f26d6c2004-05-26 23:25:30 +00001135 return SQLITE_OK;
1136}
1137
1138/*
drh5e2517e2004-09-24 23:59:12 +00001139** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001140*/
drh5e2517e2004-09-24 23:59:12 +00001141static int bindText(
drh605264d2007-08-21 15:13:19 +00001142 sqlite3_stmt *pStmt, /* The statement to bind against */
1143 int i, /* Index of the parameter to bind */
1144 const void *zData, /* Pointer to the data to be bound */
1145 int nData, /* Number of bytes of data to be bound */
1146 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001147 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001148){
1149 Vdbe *p = (Vdbe *)pStmt;
1150 Mem *pVar;
1151 int rc;
1152
1153 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001154 if( rc==SQLITE_OK ){
1155 if( zData!=0 ){
1156 pVar = &p->aVar[i-1];
1157 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1158 if( rc==SQLITE_OK && encoding!=0 ){
1159 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1160 }
drh13f40da2014-08-22 18:00:11 +00001161 sqlite3Error(p->db, rc);
drh488e7b62008-10-06 12:46:43 +00001162 rc = sqlite3ApiExit(p->db, rc);
drh27641702007-08-22 02:56:42 +00001163 }
drh488e7b62008-10-06 12:46:43 +00001164 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001165 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001166 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001167 }
drh605264d2007-08-21 15:13:19 +00001168 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001169}
drh5e2517e2004-09-24 23:59:12 +00001170
1171
1172/*
1173** Bind a blob value to an SQL statement variable.
1174*/
1175int sqlite3_bind_blob(
1176 sqlite3_stmt *pStmt,
1177 int i,
1178 const void *zData,
1179 int nData,
1180 void (*xDel)(void*)
1181){
1182 return bindText(pStmt, i, zData, nData, xDel, 0);
1183}
drhda4ca9d2014-09-09 17:27:35 +00001184int sqlite3_bind_blob64(
1185 sqlite3_stmt *pStmt,
1186 int i,
1187 const void *zData,
1188 sqlite3_uint64 nData,
1189 void (*xDel)(void*)
1190){
drhfc59a952014-09-11 23:34:55 +00001191 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001192 if( nData>0x7fffffff ){
1193 return invokeValueDestructor(zData, xDel, 0);
1194 }else{
drh3329a632014-09-18 01:21:43 +00001195 return bindText(pStmt, i, zData, (int)nData, xDel, 0);
drhda4ca9d2014-09-09 17:27:35 +00001196 }
1197}
drh4f26d6c2004-05-26 23:25:30 +00001198int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1199 int rc;
1200 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001201 rc = vdbeUnbind(p, i);
1202 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001203 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001204 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001205 }
danielk1977f4618892004-06-28 13:09:11 +00001206 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001207}
1208int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001209 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001210}
drhefad9992004-06-22 12:13:55 +00001211int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001212 int rc;
1213 Vdbe *p = (Vdbe *)pStmt;
1214 rc = vdbeUnbind(p, i);
1215 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001216 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001217 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001218 }
1219 return rc;
1220}
drh605264d2007-08-21 15:13:19 +00001221int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1222 int rc;
1223 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001224 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001225 if( rc==SQLITE_OK ){
1226 sqlite3_mutex_leave(p->db->mutex);
1227 }
drh605264d2007-08-21 15:13:19 +00001228 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001229}
1230int sqlite3_bind_text(
1231 sqlite3_stmt *pStmt,
1232 int i,
1233 const char *zData,
1234 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001235 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001236){
drh5e2517e2004-09-24 23:59:12 +00001237 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001238}
drhbbf483f2014-09-09 20:30:24 +00001239int sqlite3_bind_text64(
drhda4ca9d2014-09-09 17:27:35 +00001240 sqlite3_stmt *pStmt,
1241 int i,
1242 const char *zData,
1243 sqlite3_uint64 nData,
1244 void (*xDel)(void*),
1245 unsigned char enc
1246){
drhfc59a952014-09-11 23:34:55 +00001247 assert( xDel!=SQLITE_DYNAMIC );
drhda4ca9d2014-09-09 17:27:35 +00001248 if( nData>0x7fffffff ){
1249 return invokeValueDestructor(zData, xDel, 0);
1250 }else{
drhfc59a952014-09-11 23:34:55 +00001251 if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
drh3329a632014-09-18 01:21:43 +00001252 return bindText(pStmt, i, zData, (int)nData, xDel, enc);
drhda4ca9d2014-09-09 17:27:35 +00001253 }
1254}
drh6c626082004-11-14 21:56:29 +00001255#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001256int sqlite3_bind_text16(
1257 sqlite3_stmt *pStmt,
1258 int i,
1259 const void *zData,
1260 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001261 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001262){
drh5e2517e2004-09-24 23:59:12 +00001263 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001264}
drh6c626082004-11-14 21:56:29 +00001265#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001266int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1267 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001268 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001269 case SQLITE_INTEGER: {
1270 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1271 break;
1272 }
1273 case SQLITE_FLOAT: {
drh74eaba42014-09-18 17:52:15 +00001274 rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
drh29def562009-04-14 12:43:33 +00001275 break;
1276 }
1277 case SQLITE_BLOB: {
1278 if( pValue->flags & MEM_Zero ){
1279 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1280 }else{
1281 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1282 }
1283 break;
1284 }
1285 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001286 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1287 pValue->enc);
1288 break;
1289 }
1290 default: {
1291 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001292 break;
1293 }
danielk197726e41442006-06-14 15:16:35 +00001294 }
1295 return rc;
1296}
drhb026e052007-05-02 01:34:31 +00001297int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1298 int rc;
1299 Vdbe *p = (Vdbe *)pStmt;
1300 rc = vdbeUnbind(p, i);
1301 if( rc==SQLITE_OK ){
1302 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001303 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001304 }
1305 return rc;
1306}
drh75f6a032004-07-15 14:15:00 +00001307
1308/*
1309** Return the number of wildcards that can be potentially bound to.
1310** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001311*/
1312int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001313 Vdbe *p = (Vdbe*)pStmt;
1314 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001315}
drh895d7472004-08-20 16:02:39 +00001316
1317/*
drhfa6bc002004-09-07 16:19:52 +00001318** Return the name of a wildcard parameter. Return NULL if the index
1319** is out of range or if the wildcard is unnamed.
1320**
1321** The result is always UTF-8.
1322*/
1323const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1324 Vdbe *p = (Vdbe*)pStmt;
drh124c0b42011-06-01 18:15:55 +00001325 if( p==0 || i<1 || i>p->nzVar ){
drhfa6bc002004-09-07 16:19:52 +00001326 return 0;
1327 }
drh895d7472004-08-20 16:02:39 +00001328 return p->azVar[i-1];
1329}
drhfa6bc002004-09-07 16:19:52 +00001330
1331/*
1332** Given a wildcard parameter name, return the index of the variable
1333** with that name. If there is no variable with the given name,
1334** return 0.
1335*/
drh5f18a222009-11-26 14:01:53 +00001336int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drhfa6bc002004-09-07 16:19:52 +00001337 int i;
1338 if( p==0 ){
1339 return 0;
1340 }
drh6a8903c2004-12-10 18:00:04 +00001341 if( zName ){
drh124c0b42011-06-01 18:15:55 +00001342 for(i=0; i<p->nzVar; i++){
drh6a8903c2004-12-10 18:00:04 +00001343 const char *z = p->azVar[i];
drh503a6862013-03-01 01:07:17 +00001344 if( z && strncmp(z,zName,nName)==0 && z[nName]==0 ){
drh6a8903c2004-12-10 18:00:04 +00001345 return i+1;
1346 }
drhfa6bc002004-09-07 16:19:52 +00001347 }
1348 }
1349 return 0;
1350}
drh5f18a222009-11-26 14:01:53 +00001351int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1352 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1353}
drhf8db1bc2005-04-22 02:38:37 +00001354
drh51942bc2005-06-12 22:01:42 +00001355/*
drhf8db1bc2005-04-22 02:38:37 +00001356** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001357*/
shane145834a2008-09-04 12:03:42 +00001358int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001359 Vdbe *pFrom = (Vdbe*)pFromStmt;
1360 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001361 int i;
1362 assert( pTo->db==pFrom->db );
1363 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001364 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001365 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001366 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001367 }
drh27641702007-08-22 02:56:42 +00001368 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001369 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001370}
drh51942bc2005-06-12 22:01:42 +00001371
shaneeec556d2008-10-12 00:27:53 +00001372#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001373/*
shane145834a2008-09-04 12:03:42 +00001374** Deprecated external interface. Internal/core SQLite code
1375** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001376**
peter.d.reid60ec9142014-09-06 16:39:46 +00001377** It is misuse to call this routine with statements from different
drh0f5ea0b2009-04-09 14:02:44 +00001378** database connections. But as this is a deprecated interface, we
1379** will not bother to check for that condition.
1380**
1381** If the two statements contain a different number of bindings, then
1382** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1383** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001384*/
1385int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001386 Vdbe *pFrom = (Vdbe*)pFromStmt;
1387 Vdbe *pTo = (Vdbe*)pToStmt;
1388 if( pFrom->nVar!=pTo->nVar ){
1389 return SQLITE_ERROR;
1390 }
danc94b8592009-10-20 07:01:24 +00001391 if( pTo->isPrepareV2 && pTo->expmask ){
1392 pTo->expired = 1;
1393 }
1394 if( pFrom->isPrepareV2 && pFrom->expmask ){
1395 pFrom->expired = 1;
1396 }
shane145834a2008-09-04 12:03:42 +00001397 return sqlite3TransferBindings(pFromStmt, pToStmt);
1398}
shaneeec556d2008-10-12 00:27:53 +00001399#endif
shane145834a2008-09-04 12:03:42 +00001400
1401/*
drh51942bc2005-06-12 22:01:42 +00001402** Return the sqlite3* database handle to which the prepared statement given
1403** in the argument belongs. This is the same database handle that was
1404** the first argument to the sqlite3_prepare() that was used to create
1405** the statement in the first place.
1406*/
1407sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1408 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1409}
drhbb5a9c32008-06-19 02:52:25 +00001410
1411/*
drhf03d9cc2010-11-16 23:10:25 +00001412** Return true if the prepared statement is guaranteed to not modify the
1413** database.
1414*/
1415int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1416 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1417}
1418
1419/*
drh2fb66932011-11-25 17:21:47 +00001420** Return true if the prepared statement is in need of being reset.
1421*/
1422int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1423 Vdbe *v = (Vdbe*)pStmt;
dan857745c2014-07-19 17:57:10 +00001424 return v!=0 && v->pc>=0 && v->magic==VDBE_MAGIC_RUN;
drh2fb66932011-11-25 17:21:47 +00001425}
1426
1427/*
drhbb5a9c32008-06-19 02:52:25 +00001428** Return a pointer to the next prepared statement after pStmt associated
1429** with database connection pDb. If pStmt is NULL, return the first
1430** prepared statement for the database connection. Return NULL if there
1431** are no more.
1432*/
1433sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1434 sqlite3_stmt *pNext;
1435 sqlite3_mutex_enter(pDb->mutex);
1436 if( pStmt==0 ){
1437 pNext = (sqlite3_stmt*)pDb->pVdbe;
1438 }else{
1439 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1440 }
1441 sqlite3_mutex_leave(pDb->mutex);
1442 return pNext;
1443}
drhd1d38482008-10-07 23:46:38 +00001444
1445/*
1446** Return the value of a status counter for a prepared statement
1447*/
1448int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1449 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9b47ee32013-08-20 03:13:51 +00001450 u32 v = pVdbe->aCounter[op];
1451 if( resetFlag ) pVdbe->aCounter[op] = 0;
1452 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001453}