blob: 5e5bb813663ab776b6452651718de1eea025423a [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**
215** The setStrOrError() funtion calls sqlite3VdbeMemSetStr() to store the
216** 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
drh4f26d6c2004-05-26 23:25:30 +0000218*/
drh4c8555f2009-06-25 01:47:11 +0000219static void setResultStrOrError(
220 sqlite3_context *pCtx, /* Function context */
221 const char *z, /* String pointer */
222 int n, /* Bytes in string, or negative */
223 u8 enc, /* Encoding of z. 0 for BLOBs */
224 void (*xDel)(void*) /* Destructor function */
225){
226 if( sqlite3VdbeMemSetStr(&pCtx->s, z, n, enc, xDel)==SQLITE_TOOBIG ){
227 sqlite3_result_error_toobig(pCtx);
228 }
229}
drh4f26d6c2004-05-26 23:25:30 +0000230void sqlite3_result_blob(
231 sqlite3_context *pCtx,
232 const void *z,
233 int n,
danielk1977d8123362004-06-12 09:25:12 +0000234 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000235){
drh5708d2d2005-06-22 10:53:59 +0000236 assert( n>=0 );
drh32bc3f62007-08-21 20:25:39 +0000237 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000238 setResultStrOrError(pCtx, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000239}
240void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
drh32bc3f62007-08-21 20:25:39 +0000241 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4f26d6c2004-05-26 23:25:30 +0000242 sqlite3VdbeMemSetDouble(&pCtx->s, rVal);
243}
244void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
drh32bc3f62007-08-21 20:25:39 +0000245 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000246 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000247 pCtx->fErrorOrAux = 1;
drhb21c8cd2007-08-21 19:33:56 +0000248 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000249}
danielk1977a1686c92006-01-23 07:52:37 +0000250#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000251void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
drh32bc3f62007-08-21 20:25:39 +0000252 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000253 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000254 pCtx->fErrorOrAux = 1;
drhb21c8cd2007-08-21 19:33:56 +0000255 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000256}
danielk1977a1686c92006-01-23 07:52:37 +0000257#endif
drhf4479502004-05-27 03:12:53 +0000258void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh32bc3f62007-08-21 20:25:39 +0000259 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4f26d6c2004-05-26 23:25:30 +0000260 sqlite3VdbeMemSetInt64(&pCtx->s, (i64)iVal);
261}
262void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
drh32bc3f62007-08-21 20:25:39 +0000263 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4f26d6c2004-05-26 23:25:30 +0000264 sqlite3VdbeMemSetInt64(&pCtx->s, iVal);
265}
266void sqlite3_result_null(sqlite3_context *pCtx){
drh32bc3f62007-08-21 20:25:39 +0000267 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drhf4479502004-05-27 03:12:53 +0000268 sqlite3VdbeMemSetNull(&pCtx->s);
drh4f26d6c2004-05-26 23:25:30 +0000269}
270void sqlite3_result_text(
271 sqlite3_context *pCtx,
272 const char *z,
273 int n,
danielk1977d8123362004-06-12 09:25:12 +0000274 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000275){
drh32bc3f62007-08-21 20:25:39 +0000276 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000277 setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000278}
drh6c626082004-11-14 21:56:29 +0000279#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000280void sqlite3_result_text16(
281 sqlite3_context *pCtx,
282 const void *z,
283 int n,
danielk1977d8123362004-06-12 09:25:12 +0000284 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000285){
drh32bc3f62007-08-21 20:25:39 +0000286 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000287 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000288}
289void sqlite3_result_text16be(
290 sqlite3_context *pCtx,
291 const void *z,
292 int n,
293 void (*xDel)(void *)
294){
drh32bc3f62007-08-21 20:25:39 +0000295 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000296 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000297}
298void sqlite3_result_text16le(
299 sqlite3_context *pCtx,
300 const void *z,
301 int n,
302 void (*xDel)(void *)
303){
drh32bc3f62007-08-21 20:25:39 +0000304 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000305 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000306}
drh6c626082004-11-14 21:56:29 +0000307#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000308void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh32bc3f62007-08-21 20:25:39 +0000309 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drhb21c8cd2007-08-21 19:33:56 +0000310 sqlite3VdbeMemCopy(&pCtx->s, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000311}
drhb026e052007-05-02 01:34:31 +0000312void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh32bc3f62007-08-21 20:25:39 +0000313 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drhb026e052007-05-02 01:34:31 +0000314 sqlite3VdbeMemSetZeroBlob(&pCtx->s, n);
315}
drh69544ec2008-02-06 14:11:34 +0000316void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
317 pCtx->isError = errCode;
drh9b47ee32013-08-20 03:13:51 +0000318 pCtx->fErrorOrAux = 1;
drh51c7d862009-04-27 18:46:06 +0000319 if( pCtx->s.flags & MEM_Null ){
320 sqlite3VdbeMemSetStr(&pCtx->s, sqlite3ErrStr(errCode), -1,
321 SQLITE_UTF8, SQLITE_STATIC);
322 }
drh69544ec2008-02-06 14:11:34 +0000323}
drh4f26d6c2004-05-26 23:25:30 +0000324
drha0206bc2007-05-08 15:15:02 +0000325/* Force an SQLITE_TOOBIG error. */
326void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh32bc3f62007-08-21 20:25:39 +0000327 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000328 pCtx->isError = SQLITE_TOOBIG;
drh9b47ee32013-08-20 03:13:51 +0000329 pCtx->fErrorOrAux = 1;
drhbb4957f2008-03-20 14:03:29 +0000330 sqlite3VdbeMemSetStr(&pCtx->s, "string or blob too big", -1,
331 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000332}
333
danielk1977a1644fd2007-08-29 12:31:25 +0000334/* An SQLITE_NOMEM error. */
335void sqlite3_result_error_nomem(sqlite3_context *pCtx){
336 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
337 sqlite3VdbeMemSetNull(&pCtx->s);
drh69544ec2008-02-06 14:11:34 +0000338 pCtx->isError = SQLITE_NOMEM;
drh9b47ee32013-08-20 03:13:51 +0000339 pCtx->fErrorOrAux = 1;
danielk1977a1644fd2007-08-29 12:31:25 +0000340 pCtx->s.db->mallocFailed = 1;
341}
drh4f26d6c2004-05-26 23:25:30 +0000342
dan5cf53532010-05-01 16:40:20 +0000343/*
344** This function is called after a transaction has been committed. It
345** invokes callbacks registered with sqlite3_wal_hook() as required.
346*/
drh7ed91f22010-04-29 22:34:07 +0000347static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000348 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000349#ifndef SQLITE_OMIT_WAL
350 int i;
dan8d22a172010-04-19 18:03:51 +0000351 for(i=0; i<db->nDb; i++){
352 Btree *pBt = db->aDb[i].pBt;
353 if( pBt ){
drh7ed91f22010-04-29 22:34:07 +0000354 int nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
drh5def0842010-05-05 20:00:25 +0000355 if( db->xWalCallback && nEntry>0 && rc==SQLITE_OK ){
356 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000357 }
358 }
359 }
dan5cf53532010-05-01 16:40:20 +0000360#endif
dan8d22a172010-04-19 18:03:51 +0000361 return rc;
362}
363
drh4f26d6c2004-05-26 23:25:30 +0000364/*
365** Execute the statement pStmt, either until a row of data is ready, the
366** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000367**
368** This routine implements the bulk of the logic behind the sqlite_step()
369** API. The only thing omitted is the automatic recompile if a
370** schema change has occurred. That detail is handled by the
371** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000372*/
drhb900aaf2006-11-09 00:24:53 +0000373static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000374 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000375 int rc;
376
danielk1977a185ddb2007-11-15 16:04:15 +0000377 assert(p);
378 if( p->magic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000379 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000380 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
381 ** with version 3.7.0, we changed this so that sqlite3_reset() would
382 ** be called automatically instead of throwing the SQLITE_MISUSE error.
383 ** This "automatic-reset" change is not technically an incompatibility,
384 ** since any application that receives an SQLITE_MISUSE is broken by
385 ** definition.
386 **
387 ** Nevertheless, some published applications that were originally written
388 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000389 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000390 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
391 ** legacy behavior of returning SQLITE_MISUSE for cases where the
392 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
393 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000394 */
drh602acb42011-01-17 17:42:37 +0000395#ifdef SQLITE_OMIT_AUTORESET
396 if( p->rc==SQLITE_BUSY || p->rc==SQLITE_LOCKED ){
397 sqlite3_reset((sqlite3_stmt*)p);
398 }else{
399 return SQLITE_MISUSE_BKPT;
400 }
401#else
drh3674bfd2010-04-17 12:53:19 +0000402 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000403#endif
drhf1bfe9a2007-10-17 01:44:20 +0000404 }
405
dan14d4cc42010-01-20 14:25:37 +0000406 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000407 db = p->db;
drhc456e572008-08-11 18:44:58 +0000408 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000409 p->rc = SQLITE_NOMEM;
drhc456e572008-08-11 18:44:58 +0000410 return SQLITE_NOMEM;
411 }
danielk1977261919c2005-12-06 12:52:59 +0000412
danielk1977a21c6b62005-01-24 10:25:59 +0000413 if( p->pc<=0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000414 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000415 rc = SQLITE_ERROR;
416 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000417 }
danielk19771d850a72004-05-31 08:26:49 +0000418 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000419 /* If there are no other statements currently running, then
420 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
421 ** from interrupting a statement that has not yet started.
422 */
drh4f7d3a52013-06-27 23:54:02 +0000423 if( db->nVdbeActive==0 ){
drh15ca1df2006-07-26 13:43:30 +0000424 db->u1.isInterrupted = 0;
425 }
426
drh648e2642013-07-11 15:03:32 +0000427 assert( db->nVdbeWrite>0 || db->autoCommit==0
428 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
429 );
dan1da40a32009-09-19 17:00:31 +0000430
drh19e2d372005-08-29 23:00:03 +0000431#ifndef SQLITE_OMIT_TRACE
drh19e2d372005-08-29 23:00:03 +0000432 if( db->xProfile && !db->init.busy ){
drhb7e8ea22010-05-03 14:32:30 +0000433 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh19e2d372005-08-29 23:00:03 +0000434 }
435#endif
drhc16a03b2004-09-15 13:38:10 +0000436
drh4f7d3a52013-06-27 23:54:02 +0000437 db->nVdbeActive++;
438 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000439 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000440 p->pc = 0;
441 }
drhb7f91642004-10-31 02:22:47 +0000442#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000443 if( p->explain ){
444 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000445 }else
446#endif /* SQLITE_OMIT_EXPLAIN */
447 {
drh4f7d3a52013-06-27 23:54:02 +0000448 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000449 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000450 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000451 }
452
drh19e2d372005-08-29 23:00:03 +0000453#ifndef SQLITE_OMIT_TRACE
454 /* Invoke the profile callback if there is one
455 */
danielk19776ab3a2e2009-02-19 14:39:25 +0000456 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000457 sqlite3_int64 iNow;
458 sqlite3OsCurrentTimeInt64(db->pVfs, &iNow);
drhdf0db0f2010-07-29 10:07:21 +0000459 db->xProfile(db->pProfileArg, p->zSql, (iNow - p->startTime)*1000000);
drh19e2d372005-08-29 23:00:03 +0000460 }
461#endif
462
dan8d22a172010-04-19 18:03:51 +0000463 if( rc==SQLITE_DONE ){
464 assert( p->rc==SQLITE_OK );
drh7ed91f22010-04-29 22:34:07 +0000465 p->rc = doWalCallbacks(db);
dan8d22a172010-04-19 18:03:51 +0000466 if( p->rc!=SQLITE_OK ){
467 rc = SQLITE_ERROR;
468 }
469 }
470
drh80cc85b2008-07-23 21:07:25 +0000471 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000472 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
473 p->rc = SQLITE_NOMEM;
drhb900aaf2006-11-09 00:24:53 +0000474 }
danielk1977357864e2009-03-25 15:43:08 +0000475end_of_step:
476 /* At this point local variable rc holds the value that should be
477 ** returned if this statement was compiled using the legacy
478 ** sqlite3_prepare() interface. According to the docs, this can only
479 ** be one of the values in the first assert() below. Variable p->rc
480 ** contains the value that would be returned if sqlite3_finalize()
481 ** were called on statement p.
482 */
483 assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
484 || rc==SQLITE_BUSY || rc==SQLITE_MISUSE
485 );
486 assert( p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE );
487 if( p->isPrepareV2 && rc!=SQLITE_ROW && rc!=SQLITE_DONE ){
488 /* If this statement was prepared using sqlite3_prepare_v2(), and an
mistachkin48864df2013-03-21 21:20:32 +0000489 ** error has occurred, then return the error code in p->rc to the
danielk1977357864e2009-03-25 15:43:08 +0000490 ** caller. Set the error code in the database handle to the same value.
491 */
dan029ead62011-10-27 15:19:58 +0000492 rc = sqlite3VdbeTransferError(p);
danielk1977357864e2009-03-25 15:43:08 +0000493 }
494 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000495}
496
497/*
498** This is the top-level implementation of sqlite3_step(). Call
499** sqlite3Step() to do most of the work. If a schema error occurs,
500** call sqlite3Reprepare() and try again.
501*/
drhb900aaf2006-11-09 00:24:53 +0000502int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000503 int rc = SQLITE_OK; /* Result from sqlite3Step() */
504 int rc2 = SQLITE_OK; /* Result from sqlite3Reprepare() */
505 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
506 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
507 sqlite3 *db; /* The database connection */
508
drh413c3d32010-02-23 20:11:56 +0000509 if( vdbeSafetyNotNull(v) ){
510 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000511 }
drh413c3d32010-02-23 20:11:56 +0000512 db = v->db;
513 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000514 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000515 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh24e713d2011-06-23 01:42:53 +0000516 && cnt++ < SQLITE_MAX_SCHEMA_RETRY
drha6129fa2010-02-24 17:15:19 +0000517 && (rc2 = rc = sqlite3Reprepare(v))==SQLITE_OK ){
drh413c3d32010-02-23 20:11:56 +0000518 sqlite3_reset(pStmt);
drh37f58e92012-09-04 21:34:26 +0000519 v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000520 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000521 }
drha3cc0072013-12-13 16:23:55 +0000522 if( rc2!=SQLITE_OK ){
drh413c3d32010-02-23 20:11:56 +0000523 /* This case occurs after failing to recompile an sql statement.
524 ** The error message from the SQL compiler has already been loaded
525 ** into the database handle. This block copies the error message
526 ** from the database handle into the statement and sets the statement
527 ** program counter to 0 to ensure that when the statement is
528 ** finalized or reset the parser error message is available via
529 ** sqlite3_errmsg() and sqlite3_errcode().
530 */
531 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
drha3cc0072013-12-13 16:23:55 +0000532 assert( zErr!=0 || db->mallocFailed );
drh413c3d32010-02-23 20:11:56 +0000533 sqlite3DbFree(db, v->zErrMsg);
534 if( !db->mallocFailed ){
535 v->zErrMsg = sqlite3DbStrDup(db, zErr);
drha6129fa2010-02-24 17:15:19 +0000536 v->rc = rc2;
drh413c3d32010-02-23 20:11:56 +0000537 } else {
538 v->zErrMsg = 0;
drha6129fa2010-02-24 17:15:19 +0000539 v->rc = rc = SQLITE_NOMEM;
drh413c3d32010-02-23 20:11:56 +0000540 }
541 }
542 rc = sqlite3ApiExit(db, rc);
543 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000544 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000545}
546
drh95a7b3e2013-09-16 12:57:19 +0000547
drh4f26d6c2004-05-26 23:25:30 +0000548/*
drheb2e1762004-05-27 01:53:56 +0000549** Extract the user data from a sqlite3_context structure and return a
550** pointer to it.
551*/
552void *sqlite3_user_data(sqlite3_context *p){
553 assert( p && p->pFunc );
554 return p->pFunc->pUserData;
555}
556
557/*
drhfa4a4b92008-03-19 21:45:51 +0000558** Extract the user data from a sqlite3_context structure and return a
559** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000560**
561** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
562** returns a copy of the pointer to the database connection (the 1st
563** parameter) of the sqlite3_create_function() and
564** sqlite3_create_function16() routines that originally registered the
565** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000566*/
567sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
568 assert( p && p->pFunc );
569 return p->s.db;
570}
571
572/*
drh95a7b3e2013-09-16 12:57:19 +0000573** Return the current time for a statement
574*/
575sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
576 Vdbe *v = p->pVdbe;
577 int rc;
578 if( v->iCurrentTime==0 ){
579 rc = sqlite3OsCurrentTimeInt64(p->s.db->pVfs, &v->iCurrentTime);
580 if( rc ) v->iCurrentTime = 0;
581 }
582 return v->iCurrentTime;
583}
584
585/*
drhb7481e72006-09-16 21:45:14 +0000586** The following is the implementation of an SQL function that always
587** fails with an error message stating that the function is used in the
588** wrong context. The sqlite3_overload_function() API might construct
589** SQL function that use this routine so that the functions will exist
590** for name resolution but are actually overloaded by the xFindFunction
591** method of virtual tables.
592*/
593void sqlite3InvalidFunction(
594 sqlite3_context *context, /* The function calling context */
danielk197762c14b32008-11-19 09:05:26 +0000595 int NotUsed, /* Number of arguments to the function */
596 sqlite3_value **NotUsed2 /* Value of each argument */
drhb7481e72006-09-16 21:45:14 +0000597){
598 const char *zName = context->pFunc->zName;
599 char *zErr;
danielk197762c14b32008-11-19 09:05:26 +0000600 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhbc6160b2009-04-08 15:45:31 +0000601 zErr = sqlite3_mprintf(
drhb7481e72006-09-16 21:45:14 +0000602 "unable to use function %s in the requested context", zName);
603 sqlite3_result_error(context, zErr, -1);
danielk19771e536952007-08-16 10:09:01 +0000604 sqlite3_free(zErr);
drhb7481e72006-09-16 21:45:14 +0000605}
606
607/*
drheb2e1762004-05-27 01:53:56 +0000608** Allocate or return the aggregate context for a user function. A new
609** context is allocated on the first call. Subsequent calls return the
610** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000611*/
612void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drhb21c8cd2007-08-21 19:33:56 +0000613 Mem *pMem;
drh825c6622005-09-08 19:01:05 +0000614 assert( p && p->pFunc && p->pFunc->xStep );
drhb21c8cd2007-08-21 19:33:56 +0000615 assert( sqlite3_mutex_held(p->s.db->mutex) );
616 pMem = p->pMem;
drhd68eee02009-12-11 03:44:18 +0000617 testcase( nByte<0 );
drha10a34b2005-09-07 22:09:48 +0000618 if( (pMem->flags & MEM_Agg)==0 ){
drhd68eee02009-12-11 03:44:18 +0000619 if( nByte<=0 ){
danielk19775f096132008-03-28 15:44:09 +0000620 sqlite3VdbeMemReleaseExternal(pMem);
621 pMem->flags = MEM_Null;
drha10a34b2005-09-07 22:09:48 +0000622 pMem->z = 0;
drheb2e1762004-05-27 01:53:56 +0000623 }else{
danielk19775f096132008-03-28 15:44:09 +0000624 sqlite3VdbeMemGrow(pMem, nByte, 0);
drha10a34b2005-09-07 22:09:48 +0000625 pMem->flags = MEM_Agg;
drh3c024d62007-03-30 11:23:45 +0000626 pMem->u.pDef = p->pFunc;
danielk19775f096132008-03-28 15:44:09 +0000627 if( pMem->z ){
628 memset(pMem->z, 0, nByte);
629 }
drheb2e1762004-05-27 01:53:56 +0000630 }
631 }
drhabfcea22005-09-06 20:36:48 +0000632 return (void*)pMem->z;
drheb2e1762004-05-27 01:53:56 +0000633}
634
635/*
danielk1977682f68b2004-06-05 10:22:17 +0000636** Return the auxilary data pointer, if any, for the iArg'th argument to
637** the user-function defined by pCtx.
638*/
639void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000640 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000641
642 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
dan0c547792013-07-18 17:12:08 +0000643 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
644 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
danielk1977682f68b2004-06-05 10:22:17 +0000645 }
dan0c547792013-07-18 17:12:08 +0000646
647 return (pAuxData ? pAuxData->pAux : 0);
danielk1977682f68b2004-06-05 10:22:17 +0000648}
649
650/*
651** Set the auxilary data pointer and delete function, for the iArg'th
652** argument to the user-function defined by pCtx. Any previous value is
653** deleted by calling the delete function specified when it was set.
654*/
655void sqlite3_set_auxdata(
656 sqlite3_context *pCtx,
657 int iArg,
658 void *pAux,
659 void (*xDelete)(void*)
660){
dan0c547792013-07-18 17:12:08 +0000661 AuxData *pAuxData;
662 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000663
drhb21c8cd2007-08-21 19:33:56 +0000664 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
dan0c547792013-07-18 17:12:08 +0000665 if( iArg<0 ) goto failed;
danielk1977682f68b2004-06-05 10:22:17 +0000666
dan0c547792013-07-18 17:12:08 +0000667 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
668 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
669 }
670 if( pAuxData==0 ){
671 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
672 if( !pAuxData ) goto failed;
673 pAuxData->iOp = pCtx->iOp;
674 pAuxData->iArg = iArg;
675 pAuxData->pNext = pVdbe->pAuxData;
676 pVdbe->pAuxData = pAuxData;
drh9b47ee32013-08-20 03:13:51 +0000677 if( pCtx->fErrorOrAux==0 ){
678 pCtx->isError = 0;
679 pCtx->fErrorOrAux = 1;
680 }
dan0c547792013-07-18 17:12:08 +0000681 }else if( pAuxData->xDelete ){
danielk1977682f68b2004-06-05 10:22:17 +0000682 pAuxData->xDelete(pAuxData->pAux);
683 }
dan0c547792013-07-18 17:12:08 +0000684
danielk1977682f68b2004-06-05 10:22:17 +0000685 pAuxData->pAux = pAux;
686 pAuxData->xDelete = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000687 return;
688
689failed:
690 if( xDelete ){
691 xDelete(pAux);
692 }
danielk1977682f68b2004-06-05 10:22:17 +0000693}
694
shaneeec556d2008-10-12 00:27:53 +0000695#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000696/*
drheb2e1762004-05-27 01:53:56 +0000697** Return the number of times the Step function of a aggregate has been
698** called.
699**
drhcf85a512006-02-09 18:35:29 +0000700** This function is deprecated. Do not use it for new code. It is
701** provide only to avoid breaking legacy code. New aggregate function
702** implementations should keep their own counts within their aggregate
703** context.
drheb2e1762004-05-27 01:53:56 +0000704*/
705int sqlite3_aggregate_count(sqlite3_context *p){
shanee34c6472009-03-05 04:23:47 +0000706 assert( p && p->pMem && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000707 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000708}
shaneeec556d2008-10-12 00:27:53 +0000709#endif
drheb2e1762004-05-27 01:53:56 +0000710
711/*
drh4f26d6c2004-05-26 23:25:30 +0000712** Return the number of columns in the result set for the statement pStmt.
713*/
714int sqlite3_column_count(sqlite3_stmt *pStmt){
715 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000716 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000717}
718
719/*
720** Return the number of values available from the current row of the
721** currently executing statement pStmt.
722*/
723int sqlite3_data_count(sqlite3_stmt *pStmt){
724 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000725 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000726 return pVm->nResColumn;
727}
728
drhb1a1c292014-03-05 12:47:55 +0000729/*
730** Return a pointer to static memory containing an SQL NULL value.
731*/
732static const Mem *columnNullValue(void){
733 /* Even though the Mem structure contains an element
734 ** of type i64, on certain architectures (x86) with certain compiler
735 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
736 ** instead of an 8-byte one. This all works fine, except that when
737 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
738 ** that a Mem structure is located on an 8-byte boundary. To prevent
739 ** these assert()s from failing, when building with SQLITE_DEBUG defined
740 ** using gcc, we force nullMem to be 8-byte aligned using the magical
741 ** __attribute__((aligned(8))) macro. */
742 static const Mem nullMem
743#if defined(SQLITE_DEBUG) && defined(__GNUC__)
744 __attribute__((aligned(8)))
745#endif
746 = {0, "", (double)0, {0}, 0, MEM_Null, 0,
747#ifdef SQLITE_DEBUG
748 0, 0, /* pScopyFrom, pFiller */
749#endif
750 0, 0 };
751 return &nullMem;
752}
drh4f26d6c2004-05-26 23:25:30 +0000753
754/*
755** Check to see if column iCol of the given statement is valid. If
756** it is, return a pointer to the Mem for the value of that column.
757** If iCol is not valid, return a pointer to a Mem which has a value
758** of NULL.
759*/
760static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000761 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000762 Mem *pOut;
763
764 pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000765 if( pVm && pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drh32bc3f62007-08-21 20:25:39 +0000766 sqlite3_mutex_enter(pVm->db->mutex);
drhd4e70eb2008-01-02 00:34:36 +0000767 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +0000768 }else{
drh9b4ea4a2009-04-10 20:32:00 +0000769 if( pVm && ALWAYS(pVm->db) ){
drh27641702007-08-22 02:56:42 +0000770 sqlite3_mutex_enter(pVm->db->mutex);
771 sqlite3Error(pVm->db, SQLITE_RANGE, 0);
772 }
drhb1a1c292014-03-05 12:47:55 +0000773 pOut = (Mem*)columnNullValue();
drh4f26d6c2004-05-26 23:25:30 +0000774 }
drh32bc3f62007-08-21 20:25:39 +0000775 return pOut;
drh4f26d6c2004-05-26 23:25:30 +0000776}
777
danielk19772e588c72005-12-09 14:25:08 +0000778/*
779** This function is called after invoking an sqlite3_value_XXX function on a
780** column value (i.e. a value returned by evaluating an SQL expression in the
781** select list of a SELECT statement) that may cause a malloc() failure. If
782** malloc() has failed, the threads mallocFailed flag is cleared and the result
783** code of statement pStmt set to SQLITE_NOMEM.
784**
drh32bc3f62007-08-21 20:25:39 +0000785** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +0000786**
787** sqlite3_column_int()
788** sqlite3_column_int64()
789** sqlite3_column_text()
790** sqlite3_column_text16()
791** sqlite3_column_real()
792** sqlite3_column_bytes()
793** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +0000794** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +0000795*/
796static void columnMallocFailure(sqlite3_stmt *pStmt)
797{
798 /* If malloc() failed during an encoding conversion within an
799 ** sqlite3_column_XXX API, then set the return code of the statement to
800 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
801 ** and _finalize() will return NOMEM.
802 */
danielk197754f01982006-01-18 15:25:17 +0000803 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000804 if( p ){
805 p->rc = sqlite3ApiExit(p->db, p->rc);
806 sqlite3_mutex_leave(p->db->mutex);
807 }
danielk19772e588c72005-12-09 14:25:08 +0000808}
809
drh4f26d6c2004-05-26 23:25:30 +0000810/**************************** sqlite3_column_ *******************************
811** The following routines are used to access elements of the current row
812** in the result set.
813*/
danielk1977c572ef72004-05-27 09:28:41 +0000814const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000815 const void *val;
danielk19772e588c72005-12-09 14:25:08 +0000816 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +0000817 /* Even though there is no encoding conversion, value_blob() might
818 ** need to call malloc() to expand the result of a zeroblob()
819 ** expression.
820 */
821 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +0000822 return val;
danielk1977c572ef72004-05-27 09:28:41 +0000823}
drh4f26d6c2004-05-26 23:25:30 +0000824int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000825 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
826 columnMallocFailure(pStmt);
827 return val;
drh4f26d6c2004-05-26 23:25:30 +0000828}
829int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000830 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
831 columnMallocFailure(pStmt);
832 return val;
drh4f26d6c2004-05-26 23:25:30 +0000833}
834double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000835 double val = sqlite3_value_double( columnMem(pStmt,i) );
836 columnMallocFailure(pStmt);
837 return val;
drh4f26d6c2004-05-26 23:25:30 +0000838}
839int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000840 int val = sqlite3_value_int( columnMem(pStmt,i) );
841 columnMallocFailure(pStmt);
842 return val;
drh4f26d6c2004-05-26 23:25:30 +0000843}
drhefad9992004-06-22 12:13:55 +0000844sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000845 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
846 columnMallocFailure(pStmt);
847 return val;
drh4f26d6c2004-05-26 23:25:30 +0000848}
849const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000850 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
851 columnMallocFailure(pStmt);
852 return val;
drh4f26d6c2004-05-26 23:25:30 +0000853}
drhd1e47332005-06-26 17:55:33 +0000854sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +0000855 Mem *pOut = columnMem(pStmt, i);
856 if( pOut->flags&MEM_Static ){
857 pOut->flags &= ~MEM_Static;
858 pOut->flags |= MEM_Ephem;
859 }
drh32bc3f62007-08-21 20:25:39 +0000860 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +0000861 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +0000862}
drh6c626082004-11-14 21:56:29 +0000863#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000864const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000865 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
866 columnMallocFailure(pStmt);
867 return val;
drh4f26d6c2004-05-26 23:25:30 +0000868}
drh6c626082004-11-14 21:56:29 +0000869#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000870int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000871 int iType = sqlite3_value_type( columnMem(pStmt,i) );
872 columnMallocFailure(pStmt);
873 return iType;
drh4f26d6c2004-05-26 23:25:30 +0000874}
875
drh5e2517e2004-09-24 23:59:12 +0000876/*
877** Convert the N-th element of pStmt->pColName[] into a string using
878** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000879**
880** There are up to 5 names for each column. useType determines which
881** name is returned. Here are the names:
882**
883** 0 The column name as it should be displayed for output
884** 1 The datatype name for the column
885** 2 The name of the database that the column derives from
886** 3 The name of the table that the column derives from
887** 4 The name of the table column that the result column derives from
888**
889** If the result is not a simple column reference (if it is an expression
890** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000891*/
892static const void *columnName(
893 sqlite3_stmt *pStmt,
894 int N,
895 const void *(*xFunc)(Mem*),
896 int useType
897){
drh32bc3f62007-08-21 20:25:39 +0000898 const void *ret = 0;
drh5e2517e2004-09-24 23:59:12 +0000899 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000900 int n;
drhc6c7fd52009-04-08 23:05:28 +0000901 sqlite3 *db = p->db;
drh32bc3f62007-08-21 20:25:39 +0000902
drh9b4ea4a2009-04-10 20:32:00 +0000903 assert( db!=0 );
904 n = sqlite3_column_count(pStmt);
905 if( N<n && N>=0 ){
906 N += useType*n;
907 sqlite3_mutex_enter(db->mutex);
908 assert( db->mallocFailed==0 );
909 ret = xFunc(&p->aColName[N]);
910 /* A malloc may have failed inside of the xFunc() call. If this
911 ** is the case, clear the mallocFailed flag and return NULL.
912 */
913 if( db->mallocFailed ){
914 db->mallocFailed = 0;
915 ret = 0;
drh32bc3f62007-08-21 20:25:39 +0000916 }
drh9b4ea4a2009-04-10 20:32:00 +0000917 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +0000918 }
danielk197700fd9572005-12-07 06:27:43 +0000919 return ret;
drh5e2517e2004-09-24 23:59:12 +0000920}
921
drh4f26d6c2004-05-26 23:25:30 +0000922/*
923** Return the name of the Nth column of the result set returned by SQL
924** statement pStmt.
925*/
926const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000927 return columnName(
928 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +0000929}
drhe590fbd2005-05-20 19:36:01 +0000930#ifndef SQLITE_OMIT_UTF16
931const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000932 return columnName(
933 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +0000934}
935#endif
drh4f26d6c2004-05-26 23:25:30 +0000936
937/*
drh3f913572008-03-22 01:07:17 +0000938** Constraint: If you have ENABLE_COLUMN_METADATA then you must
939** not define OMIT_DECLTYPE.
940*/
941#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
942# error "Must not define both SQLITE_OMIT_DECLTYPE \
943 and SQLITE_ENABLE_COLUMN_METADATA"
944#endif
945
946#ifndef SQLITE_OMIT_DECLTYPE
947/*
drh6c626082004-11-14 21:56:29 +0000948** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +0000949** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +0000950*/
951const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000952 return columnName(
953 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +0000954}
drh6c626082004-11-14 21:56:29 +0000955#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +0000956const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000957 return columnName(
958 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +0000959}
drh6c626082004-11-14 21:56:29 +0000960#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +0000961#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +0000962
danielk19774b1ae992006-02-10 03:06:10 +0000963#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +0000964/*
965** Return the name of the database from which a result column derives.
966** NULL is returned if the result column is an expression or constant or
967** anything else which is not an unabiguous reference to a database column.
968*/
969const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000970 return columnName(
971 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +0000972}
973#ifndef SQLITE_OMIT_UTF16
974const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000975 return columnName(
976 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +0000977}
978#endif /* SQLITE_OMIT_UTF16 */
979
980/*
981** Return the name of the table from which a result column derives.
982** NULL is returned if the result column is an expression or constant or
983** anything else which is not an unabiguous reference to a database column.
984*/
985const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000986 return columnName(
987 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +0000988}
989#ifndef SQLITE_OMIT_UTF16
990const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000991 return columnName(
992 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +0000993}
994#endif /* SQLITE_OMIT_UTF16 */
995
996/*
997** Return the name of the table column from which a result column derives.
998** NULL is returned if the result column is an expression or constant or
999** anything else which is not an unabiguous reference to a database column.
1000*/
1001const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001002 return columnName(
1003 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001004}
1005#ifndef SQLITE_OMIT_UTF16
1006const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001007 return columnName(
1008 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001009}
1010#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001011#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001012
1013
drh4f26d6c2004-05-26 23:25:30 +00001014/******************************* sqlite3_bind_ ***************************
1015**
1016** Routines used to attach values to wildcards in a compiled SQL statement.
1017*/
1018/*
1019** Unbind the value bound to variable i in virtual machine p. This is the
1020** the same as binding a NULL value to the column. If the "i" parameter is
1021** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1022**
drh488e7b62008-10-06 12:46:43 +00001023** A successful evaluation of this routine acquires the mutex on p.
1024** the mutex is released if any kind of error occurs.
1025**
drh4f26d6c2004-05-26 23:25:30 +00001026** The error code stored in database p->db is overwritten with the return
1027** value in any case.
1028*/
1029static int vdbeUnbind(Vdbe *p, int i){
1030 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001031 if( vdbeSafetyNotNull(p) ){
1032 return SQLITE_MISUSE_BKPT;
1033 }
drh488e7b62008-10-06 12:46:43 +00001034 sqlite3_mutex_enter(p->db->mutex);
1035 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
1036 sqlite3Error(p->db, SQLITE_MISUSE, 0);
1037 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001038 sqlite3_log(SQLITE_MISUSE,
1039 "bind on a busy prepared statement: [%s]", p->zSql);
1040 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001041 }
1042 if( i<1 || i>p->nVar ){
1043 sqlite3Error(p->db, SQLITE_RANGE, 0);
drh488e7b62008-10-06 12:46:43 +00001044 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001045 return SQLITE_RANGE;
1046 }
1047 i--;
drh290c1942004-08-21 17:54:45 +00001048 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001049 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001050 pVar->flags = MEM_Null;
1051 sqlite3Error(p->db, SQLITE_OK, 0);
dan937d0de2009-10-15 18:35:38 +00001052
dan1d2ce4f2009-10-19 18:11:09 +00001053 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1054 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001055 **
1056 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1057 ** parameter in the WHERE clause might influence the choice of query plan
1058 ** for a statement, then the statement will be automatically recompiled,
1059 ** as if there had been a schema change, on the first sqlite3_step() call
1060 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001061 */
drh823e09a2009-10-19 20:15:38 +00001062 if( p->isPrepareV2 &&
1063 ((i<32 && p->expmask & ((u32)1 << i)) || p->expmask==0xffffffff)
1064 ){
dan937d0de2009-10-15 18:35:38 +00001065 p->expired = 1;
1066 }
drh4f26d6c2004-05-26 23:25:30 +00001067 return SQLITE_OK;
1068}
1069
1070/*
drh5e2517e2004-09-24 23:59:12 +00001071** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001072*/
drh5e2517e2004-09-24 23:59:12 +00001073static int bindText(
drh605264d2007-08-21 15:13:19 +00001074 sqlite3_stmt *pStmt, /* The statement to bind against */
1075 int i, /* Index of the parameter to bind */
1076 const void *zData, /* Pointer to the data to be bound */
1077 int nData, /* Number of bytes of data to be bound */
1078 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001079 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001080){
1081 Vdbe *p = (Vdbe *)pStmt;
1082 Mem *pVar;
1083 int rc;
1084
1085 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001086 if( rc==SQLITE_OK ){
1087 if( zData!=0 ){
1088 pVar = &p->aVar[i-1];
1089 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1090 if( rc==SQLITE_OK && encoding!=0 ){
1091 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1092 }
1093 sqlite3Error(p->db, rc, 0);
1094 rc = sqlite3ApiExit(p->db, rc);
drh27641702007-08-22 02:56:42 +00001095 }
drh488e7b62008-10-06 12:46:43 +00001096 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001097 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001098 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001099 }
drh605264d2007-08-21 15:13:19 +00001100 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001101}
drh5e2517e2004-09-24 23:59:12 +00001102
1103
1104/*
1105** Bind a blob value to an SQL statement variable.
1106*/
1107int sqlite3_bind_blob(
1108 sqlite3_stmt *pStmt,
1109 int i,
1110 const void *zData,
1111 int nData,
1112 void (*xDel)(void*)
1113){
1114 return bindText(pStmt, i, zData, nData, xDel, 0);
1115}
drh4f26d6c2004-05-26 23:25:30 +00001116int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1117 int rc;
1118 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001119 rc = vdbeUnbind(p, i);
1120 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001121 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001122 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001123 }
danielk1977f4618892004-06-28 13:09:11 +00001124 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001125}
1126int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001127 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001128}
drhefad9992004-06-22 12:13:55 +00001129int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001130 int rc;
1131 Vdbe *p = (Vdbe *)pStmt;
1132 rc = vdbeUnbind(p, i);
1133 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001134 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001135 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001136 }
1137 return rc;
1138}
drh605264d2007-08-21 15:13:19 +00001139int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1140 int rc;
1141 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001142 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001143 if( rc==SQLITE_OK ){
1144 sqlite3_mutex_leave(p->db->mutex);
1145 }
drh605264d2007-08-21 15:13:19 +00001146 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001147}
1148int sqlite3_bind_text(
1149 sqlite3_stmt *pStmt,
1150 int i,
1151 const char *zData,
1152 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001153 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001154){
drh5e2517e2004-09-24 23:59:12 +00001155 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001156}
drh6c626082004-11-14 21:56:29 +00001157#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001158int sqlite3_bind_text16(
1159 sqlite3_stmt *pStmt,
1160 int i,
1161 const void *zData,
1162 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001163 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001164){
drh5e2517e2004-09-24 23:59:12 +00001165 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001166}
drh6c626082004-11-14 21:56:29 +00001167#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001168int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1169 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001170 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001171 case SQLITE_INTEGER: {
1172 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1173 break;
1174 }
1175 case SQLITE_FLOAT: {
1176 rc = sqlite3_bind_double(pStmt, i, pValue->r);
1177 break;
1178 }
1179 case SQLITE_BLOB: {
1180 if( pValue->flags & MEM_Zero ){
1181 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1182 }else{
1183 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1184 }
1185 break;
1186 }
1187 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001188 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1189 pValue->enc);
1190 break;
1191 }
1192 default: {
1193 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001194 break;
1195 }
danielk197726e41442006-06-14 15:16:35 +00001196 }
1197 return rc;
1198}
drhb026e052007-05-02 01:34:31 +00001199int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1200 int rc;
1201 Vdbe *p = (Vdbe *)pStmt;
1202 rc = vdbeUnbind(p, i);
1203 if( rc==SQLITE_OK ){
1204 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001205 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001206 }
1207 return rc;
1208}
drh75f6a032004-07-15 14:15:00 +00001209
1210/*
1211** Return the number of wildcards that can be potentially bound to.
1212** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001213*/
1214int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001215 Vdbe *p = (Vdbe*)pStmt;
1216 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001217}
drh895d7472004-08-20 16:02:39 +00001218
1219/*
drhfa6bc002004-09-07 16:19:52 +00001220** Return the name of a wildcard parameter. Return NULL if the index
1221** is out of range or if the wildcard is unnamed.
1222**
1223** The result is always UTF-8.
1224*/
1225const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1226 Vdbe *p = (Vdbe*)pStmt;
drh124c0b42011-06-01 18:15:55 +00001227 if( p==0 || i<1 || i>p->nzVar ){
drhfa6bc002004-09-07 16:19:52 +00001228 return 0;
1229 }
drh895d7472004-08-20 16:02:39 +00001230 return p->azVar[i-1];
1231}
drhfa6bc002004-09-07 16:19:52 +00001232
1233/*
1234** Given a wildcard parameter name, return the index of the variable
1235** with that name. If there is no variable with the given name,
1236** return 0.
1237*/
drh5f18a222009-11-26 14:01:53 +00001238int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drhfa6bc002004-09-07 16:19:52 +00001239 int i;
1240 if( p==0 ){
1241 return 0;
1242 }
drh6a8903c2004-12-10 18:00:04 +00001243 if( zName ){
drh124c0b42011-06-01 18:15:55 +00001244 for(i=0; i<p->nzVar; i++){
drh6a8903c2004-12-10 18:00:04 +00001245 const char *z = p->azVar[i];
drh503a6862013-03-01 01:07:17 +00001246 if( z && strncmp(z,zName,nName)==0 && z[nName]==0 ){
drh6a8903c2004-12-10 18:00:04 +00001247 return i+1;
1248 }
drhfa6bc002004-09-07 16:19:52 +00001249 }
1250 }
1251 return 0;
1252}
drh5f18a222009-11-26 14:01:53 +00001253int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1254 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1255}
drhf8db1bc2005-04-22 02:38:37 +00001256
drh51942bc2005-06-12 22:01:42 +00001257/*
drhf8db1bc2005-04-22 02:38:37 +00001258** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001259*/
shane145834a2008-09-04 12:03:42 +00001260int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001261 Vdbe *pFrom = (Vdbe*)pFromStmt;
1262 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001263 int i;
1264 assert( pTo->db==pFrom->db );
1265 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001266 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001267 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001268 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001269 }
drh27641702007-08-22 02:56:42 +00001270 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001271 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001272}
drh51942bc2005-06-12 22:01:42 +00001273
shaneeec556d2008-10-12 00:27:53 +00001274#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001275/*
shane145834a2008-09-04 12:03:42 +00001276** Deprecated external interface. Internal/core SQLite code
1277** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001278**
1279** Is is misuse to call this routine with statements from different
1280** database connections. But as this is a deprecated interface, we
1281** will not bother to check for that condition.
1282**
1283** If the two statements contain a different number of bindings, then
1284** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1285** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001286*/
1287int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001288 Vdbe *pFrom = (Vdbe*)pFromStmt;
1289 Vdbe *pTo = (Vdbe*)pToStmt;
1290 if( pFrom->nVar!=pTo->nVar ){
1291 return SQLITE_ERROR;
1292 }
danc94b8592009-10-20 07:01:24 +00001293 if( pTo->isPrepareV2 && pTo->expmask ){
1294 pTo->expired = 1;
1295 }
1296 if( pFrom->isPrepareV2 && pFrom->expmask ){
1297 pFrom->expired = 1;
1298 }
shane145834a2008-09-04 12:03:42 +00001299 return sqlite3TransferBindings(pFromStmt, pToStmt);
1300}
shaneeec556d2008-10-12 00:27:53 +00001301#endif
shane145834a2008-09-04 12:03:42 +00001302
1303/*
drh51942bc2005-06-12 22:01:42 +00001304** Return the sqlite3* database handle to which the prepared statement given
1305** in the argument belongs. This is the same database handle that was
1306** the first argument to the sqlite3_prepare() that was used to create
1307** the statement in the first place.
1308*/
1309sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1310 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1311}
drhbb5a9c32008-06-19 02:52:25 +00001312
1313/*
drhf03d9cc2010-11-16 23:10:25 +00001314** Return true if the prepared statement is guaranteed to not modify the
1315** database.
1316*/
1317int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1318 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1319}
1320
1321/*
drh2fb66932011-11-25 17:21:47 +00001322** Return true if the prepared statement is in need of being reset.
1323*/
1324int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1325 Vdbe *v = (Vdbe*)pStmt;
dan857745c2014-07-19 17:57:10 +00001326 return v!=0 && v->pc>=0 && v->magic==VDBE_MAGIC_RUN;
drh2fb66932011-11-25 17:21:47 +00001327}
1328
1329/*
drhbb5a9c32008-06-19 02:52:25 +00001330** Return a pointer to the next prepared statement after pStmt associated
1331** with database connection pDb. If pStmt is NULL, return the first
1332** prepared statement for the database connection. Return NULL if there
1333** are no more.
1334*/
1335sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1336 sqlite3_stmt *pNext;
1337 sqlite3_mutex_enter(pDb->mutex);
1338 if( pStmt==0 ){
1339 pNext = (sqlite3_stmt*)pDb->pVdbe;
1340 }else{
1341 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1342 }
1343 sqlite3_mutex_leave(pDb->mutex);
1344 return pNext;
1345}
drhd1d38482008-10-07 23:46:38 +00001346
1347/*
1348** Return the value of a status counter for a prepared statement
1349*/
1350int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1351 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9b47ee32013-08-20 03:13:51 +00001352 u32 v = pVdbe->aCounter[op];
1353 if( resetFlag ) pVdbe->aCounter[op] = 0;
1354 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001355}