blob: c1edbe48e2cb596a84d1d10c61d4e82f7128c4a3 [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_Str;
139 p->flags |= MEM_Blob;
drh42262532010-09-08 16:30:36 +0000140 return p->n ? p->z : 0;
drh4f26d6c2004-05-26 23:25:30 +0000141 }else{
142 return sqlite3_value_text(pVal);
143 }
144}
145int sqlite3_value_bytes(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000146 return sqlite3ValueBytes(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000147}
148int sqlite3_value_bytes16(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000149 return sqlite3ValueBytes(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000150}
151double sqlite3_value_double(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000152 return sqlite3VdbeRealValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000153}
154int sqlite3_value_int(sqlite3_value *pVal){
drhb27b7f52008-12-10 18:03:45 +0000155 return (int)sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000156}
drhefad9992004-06-22 12:13:55 +0000157sqlite_int64 sqlite3_value_int64(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +0000158 return sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +0000159}
160const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000161 return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000162}
drh6c626082004-11-14 21:56:29 +0000163#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000164const void *sqlite3_value_text16(sqlite3_value* pVal){
drhb21c8cd2007-08-21 19:33:56 +0000165 return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000166}
danielk1977d8123362004-06-12 09:25:12 +0000167const void *sqlite3_value_text16be(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000168 return sqlite3ValueText(pVal, SQLITE_UTF16BE);
danielk1977d8123362004-06-12 09:25:12 +0000169}
170const void *sqlite3_value_text16le(sqlite3_value *pVal){
drhb21c8cd2007-08-21 19:33:56 +0000171 return sqlite3ValueText(pVal, SQLITE_UTF16LE);
danielk1977d8123362004-06-12 09:25:12 +0000172}
drh6c626082004-11-14 21:56:29 +0000173#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000174int sqlite3_value_type(sqlite3_value* pVal){
drh1b27b8c2014-02-10 03:21:57 +0000175 static const u8 aType[] = {
176 SQLITE_BLOB, /* 0x00 */
177 SQLITE_NULL, /* 0x01 */
178 SQLITE_TEXT, /* 0x02 */
179 SQLITE_NULL, /* 0x03 */
180 SQLITE_INTEGER, /* 0x04 */
181 SQLITE_NULL, /* 0x05 */
182 SQLITE_INTEGER, /* 0x06 */
183 SQLITE_NULL, /* 0x07 */
184 SQLITE_FLOAT, /* 0x08 */
185 SQLITE_NULL, /* 0x09 */
186 SQLITE_FLOAT, /* 0x0a */
187 SQLITE_NULL, /* 0x0b */
188 SQLITE_INTEGER, /* 0x0c */
189 SQLITE_NULL, /* 0x0d */
190 SQLITE_INTEGER, /* 0x0e */
191 SQLITE_NULL, /* 0x0f */
192 SQLITE_BLOB, /* 0x10 */
193 SQLITE_NULL, /* 0x11 */
194 SQLITE_TEXT, /* 0x12 */
195 SQLITE_NULL, /* 0x13 */
196 SQLITE_INTEGER, /* 0x14 */
197 SQLITE_NULL, /* 0x15 */
198 SQLITE_INTEGER, /* 0x16 */
199 SQLITE_NULL, /* 0x17 */
200 SQLITE_FLOAT, /* 0x18 */
201 SQLITE_NULL, /* 0x19 */
202 SQLITE_FLOAT, /* 0x1a */
203 SQLITE_NULL, /* 0x1b */
204 SQLITE_INTEGER, /* 0x1c */
205 SQLITE_NULL, /* 0x1d */
206 SQLITE_INTEGER, /* 0x1e */
207 SQLITE_NULL, /* 0x1f */
208 };
209 return aType[pVal->memType&0x1f];
drh4f26d6c2004-05-26 23:25:30 +0000210}
211
212/**************************** sqlite3_result_ *******************************
213** The following routines are used by user-defined functions to specify
214** the function result.
drh4c8555f2009-06-25 01:47:11 +0000215**
216** The setStrOrError() funtion calls sqlite3VdbeMemSetStr() to store the
217** result as a string or blob but if the string or blob is too large, it
218** then sets the error code to SQLITE_TOOBIG
drh4f26d6c2004-05-26 23:25:30 +0000219*/
drh4c8555f2009-06-25 01:47:11 +0000220static void setResultStrOrError(
221 sqlite3_context *pCtx, /* Function context */
222 const char *z, /* String pointer */
223 int n, /* Bytes in string, or negative */
224 u8 enc, /* Encoding of z. 0 for BLOBs */
225 void (*xDel)(void*) /* Destructor function */
226){
227 if( sqlite3VdbeMemSetStr(&pCtx->s, z, n, enc, xDel)==SQLITE_TOOBIG ){
228 sqlite3_result_error_toobig(pCtx);
229 }
230}
drh4f26d6c2004-05-26 23:25:30 +0000231void sqlite3_result_blob(
232 sqlite3_context *pCtx,
233 const void *z,
234 int n,
danielk1977d8123362004-06-12 09:25:12 +0000235 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000236){
drh5708d2d2005-06-22 10:53:59 +0000237 assert( n>=0 );
drh32bc3f62007-08-21 20:25:39 +0000238 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000239 setResultStrOrError(pCtx, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000240}
241void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
drh32bc3f62007-08-21 20:25:39 +0000242 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4f26d6c2004-05-26 23:25:30 +0000243 sqlite3VdbeMemSetDouble(&pCtx->s, rVal);
244}
245void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
drh32bc3f62007-08-21 20:25:39 +0000246 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000247 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000248 pCtx->fErrorOrAux = 1;
drhb21c8cd2007-08-21 19:33:56 +0000249 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000250}
danielk1977a1686c92006-01-23 07:52:37 +0000251#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000252void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
drh32bc3f62007-08-21 20:25:39 +0000253 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh69544ec2008-02-06 14:11:34 +0000254 pCtx->isError = SQLITE_ERROR;
drh9b47ee32013-08-20 03:13:51 +0000255 pCtx->fErrorOrAux = 1;
drhb21c8cd2007-08-21 19:33:56 +0000256 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000257}
danielk1977a1686c92006-01-23 07:52:37 +0000258#endif
drhf4479502004-05-27 03:12:53 +0000259void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh32bc3f62007-08-21 20:25:39 +0000260 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4f26d6c2004-05-26 23:25:30 +0000261 sqlite3VdbeMemSetInt64(&pCtx->s, (i64)iVal);
262}
263void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
drh32bc3f62007-08-21 20:25:39 +0000264 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4f26d6c2004-05-26 23:25:30 +0000265 sqlite3VdbeMemSetInt64(&pCtx->s, iVal);
266}
267void sqlite3_result_null(sqlite3_context *pCtx){
drh32bc3f62007-08-21 20:25:39 +0000268 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drhf4479502004-05-27 03:12:53 +0000269 sqlite3VdbeMemSetNull(&pCtx->s);
drh4f26d6c2004-05-26 23:25:30 +0000270}
271void sqlite3_result_text(
272 sqlite3_context *pCtx,
273 const char *z,
274 int n,
danielk1977d8123362004-06-12 09:25:12 +0000275 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000276){
drh32bc3f62007-08-21 20:25:39 +0000277 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000278 setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000279}
drh6c626082004-11-14 21:56:29 +0000280#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000281void sqlite3_result_text16(
282 sqlite3_context *pCtx,
283 const void *z,
284 int n,
danielk1977d8123362004-06-12 09:25:12 +0000285 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000286){
drh32bc3f62007-08-21 20:25:39 +0000287 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000288 setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000289}
290void sqlite3_result_text16be(
291 sqlite3_context *pCtx,
292 const void *z,
293 int n,
294 void (*xDel)(void *)
295){
drh32bc3f62007-08-21 20:25:39 +0000296 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000297 setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
danielk1977d8123362004-06-12 09:25:12 +0000298}
299void sqlite3_result_text16le(
300 sqlite3_context *pCtx,
301 const void *z,
302 int n,
303 void (*xDel)(void *)
304){
drh32bc3f62007-08-21 20:25:39 +0000305 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drh4c8555f2009-06-25 01:47:11 +0000306 setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000307}
drh6c626082004-11-14 21:56:29 +0000308#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000309void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
drh32bc3f62007-08-21 20:25:39 +0000310 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drhb21c8cd2007-08-21 19:33:56 +0000311 sqlite3VdbeMemCopy(&pCtx->s, pValue);
drh4f26d6c2004-05-26 23:25:30 +0000312}
drhb026e052007-05-02 01:34:31 +0000313void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
drh32bc3f62007-08-21 20:25:39 +0000314 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drhb026e052007-05-02 01:34:31 +0000315 sqlite3VdbeMemSetZeroBlob(&pCtx->s, n);
316}
drh69544ec2008-02-06 14:11:34 +0000317void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
318 pCtx->isError = errCode;
drh9b47ee32013-08-20 03:13:51 +0000319 pCtx->fErrorOrAux = 1;
drh51c7d862009-04-27 18:46:06 +0000320 if( pCtx->s.flags & MEM_Null ){
321 sqlite3VdbeMemSetStr(&pCtx->s, sqlite3ErrStr(errCode), -1,
322 SQLITE_UTF8, SQLITE_STATIC);
323 }
drh69544ec2008-02-06 14:11:34 +0000324}
drh4f26d6c2004-05-26 23:25:30 +0000325
drha0206bc2007-05-08 15:15:02 +0000326/* Force an SQLITE_TOOBIG error. */
327void sqlite3_result_error_toobig(sqlite3_context *pCtx){
drh32bc3f62007-08-21 20:25:39 +0000328 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
drhbb4957f2008-03-20 14:03:29 +0000329 pCtx->isError = SQLITE_TOOBIG;
drh9b47ee32013-08-20 03:13:51 +0000330 pCtx->fErrorOrAux = 1;
drhbb4957f2008-03-20 14:03:29 +0000331 sqlite3VdbeMemSetStr(&pCtx->s, "string or blob too big", -1,
332 SQLITE_UTF8, SQLITE_STATIC);
drha0206bc2007-05-08 15:15:02 +0000333}
334
danielk1977a1644fd2007-08-29 12:31:25 +0000335/* An SQLITE_NOMEM error. */
336void sqlite3_result_error_nomem(sqlite3_context *pCtx){
337 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
338 sqlite3VdbeMemSetNull(&pCtx->s);
drh69544ec2008-02-06 14:11:34 +0000339 pCtx->isError = SQLITE_NOMEM;
drh9b47ee32013-08-20 03:13:51 +0000340 pCtx->fErrorOrAux = 1;
danielk1977a1644fd2007-08-29 12:31:25 +0000341 pCtx->s.db->mallocFailed = 1;
342}
drh4f26d6c2004-05-26 23:25:30 +0000343
dan5cf53532010-05-01 16:40:20 +0000344/*
345** This function is called after a transaction has been committed. It
346** invokes callbacks registered with sqlite3_wal_hook() as required.
347*/
drh7ed91f22010-04-29 22:34:07 +0000348static int doWalCallbacks(sqlite3 *db){
dan8d22a172010-04-19 18:03:51 +0000349 int rc = SQLITE_OK;
dan5cf53532010-05-01 16:40:20 +0000350#ifndef SQLITE_OMIT_WAL
351 int i;
dan8d22a172010-04-19 18:03:51 +0000352 for(i=0; i<db->nDb; i++){
353 Btree *pBt = db->aDb[i].pBt;
354 if( pBt ){
drh7ed91f22010-04-29 22:34:07 +0000355 int nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
drh5def0842010-05-05 20:00:25 +0000356 if( db->xWalCallback && nEntry>0 && rc==SQLITE_OK ){
357 rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zName, nEntry);
dan8d22a172010-04-19 18:03:51 +0000358 }
359 }
360 }
dan5cf53532010-05-01 16:40:20 +0000361#endif
dan8d22a172010-04-19 18:03:51 +0000362 return rc;
363}
364
drh4f26d6c2004-05-26 23:25:30 +0000365/*
366** Execute the statement pStmt, either until a row of data is ready, the
367** statement is completely executed or an error occurs.
drhb900aaf2006-11-09 00:24:53 +0000368**
369** This routine implements the bulk of the logic behind the sqlite_step()
370** API. The only thing omitted is the automatic recompile if a
371** schema change has occurred. That detail is handled by the
372** outer sqlite3_step() wrapper procedure.
drh4f26d6c2004-05-26 23:25:30 +0000373*/
drhb900aaf2006-11-09 00:24:53 +0000374static int sqlite3Step(Vdbe *p){
drh9bb575f2004-09-06 17:24:11 +0000375 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000376 int rc;
377
danielk1977a185ddb2007-11-15 16:04:15 +0000378 assert(p);
379 if( p->magic!=VDBE_MAGIC_RUN ){
drh3674bfd2010-04-17 12:53:19 +0000380 /* We used to require that sqlite3_reset() be called before retrying
drh602acb42011-01-17 17:42:37 +0000381 ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
382 ** with version 3.7.0, we changed this so that sqlite3_reset() would
383 ** be called automatically instead of throwing the SQLITE_MISUSE error.
384 ** This "automatic-reset" change is not technically an incompatibility,
385 ** since any application that receives an SQLITE_MISUSE is broken by
386 ** definition.
387 **
388 ** Nevertheless, some published applications that were originally written
389 ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
drhb8a45bb2011-12-31 21:51:55 +0000390 ** returns, and those were broken by the automatic-reset change. As a
drh602acb42011-01-17 17:42:37 +0000391 ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
392 ** legacy behavior of returning SQLITE_MISUSE for cases where the
393 ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
394 ** or SQLITE_BUSY error.
drh3674bfd2010-04-17 12:53:19 +0000395 */
drh602acb42011-01-17 17:42:37 +0000396#ifdef SQLITE_OMIT_AUTORESET
397 if( p->rc==SQLITE_BUSY || p->rc==SQLITE_LOCKED ){
398 sqlite3_reset((sqlite3_stmt*)p);
399 }else{
400 return SQLITE_MISUSE_BKPT;
401 }
402#else
drh3674bfd2010-04-17 12:53:19 +0000403 sqlite3_reset((sqlite3_stmt*)p);
drh602acb42011-01-17 17:42:37 +0000404#endif
drhf1bfe9a2007-10-17 01:44:20 +0000405 }
406
dan14d4cc42010-01-20 14:25:37 +0000407 /* Check that malloc() has not failed. If it has, return early. */
drh17435752007-08-16 04:30:38 +0000408 db = p->db;
drhc456e572008-08-11 18:44:58 +0000409 if( db->mallocFailed ){
dan14d4cc42010-01-20 14:25:37 +0000410 p->rc = SQLITE_NOMEM;
drhc456e572008-08-11 18:44:58 +0000411 return SQLITE_NOMEM;
412 }
danielk1977261919c2005-12-06 12:52:59 +0000413
danielk1977a21c6b62005-01-24 10:25:59 +0000414 if( p->pc<=0 && p->expired ){
drhbee80652010-02-25 21:27:58 +0000415 p->rc = SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000416 rc = SQLITE_ERROR;
417 goto end_of_step;
danielk1977a21c6b62005-01-24 10:25:59 +0000418 }
danielk19771d850a72004-05-31 08:26:49 +0000419 if( p->pc<0 ){
drh15ca1df2006-07-26 13:43:30 +0000420 /* If there are no other statements currently running, then
421 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
422 ** from interrupting a statement that has not yet started.
423 */
drh4f7d3a52013-06-27 23:54:02 +0000424 if( db->nVdbeActive==0 ){
drh15ca1df2006-07-26 13:43:30 +0000425 db->u1.isInterrupted = 0;
426 }
427
drh648e2642013-07-11 15:03:32 +0000428 assert( db->nVdbeWrite>0 || db->autoCommit==0
429 || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
430 );
dan1da40a32009-09-19 17:00:31 +0000431
drh19e2d372005-08-29 23:00:03 +0000432#ifndef SQLITE_OMIT_TRACE
drh19e2d372005-08-29 23:00:03 +0000433 if( db->xProfile && !db->init.busy ){
drhb7e8ea22010-05-03 14:32:30 +0000434 sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
drh19e2d372005-08-29 23:00:03 +0000435 }
436#endif
drhc16a03b2004-09-15 13:38:10 +0000437
drh4f7d3a52013-06-27 23:54:02 +0000438 db->nVdbeActive++;
439 if( p->readOnly==0 ) db->nVdbeWrite++;
drh1713afb2013-06-28 01:24:57 +0000440 if( p->bIsReader ) db->nVdbeRead++;
danielk19771d850a72004-05-31 08:26:49 +0000441 p->pc = 0;
442 }
drhb7f91642004-10-31 02:22:47 +0000443#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000444 if( p->explain ){
445 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000446 }else
447#endif /* SQLITE_OMIT_EXPLAIN */
448 {
drh4f7d3a52013-06-27 23:54:02 +0000449 db->nVdbeExec++;
drh4f26d6c2004-05-26 23:25:30 +0000450 rc = sqlite3VdbeExec(p);
drh4f7d3a52013-06-27 23:54:02 +0000451 db->nVdbeExec--;
drh4f26d6c2004-05-26 23:25:30 +0000452 }
453
drh19e2d372005-08-29 23:00:03 +0000454#ifndef SQLITE_OMIT_TRACE
455 /* Invoke the profile callback if there is one
456 */
danielk19776ab3a2e2009-02-19 14:39:25 +0000457 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy && p->zSql ){
drhb7e8ea22010-05-03 14:32:30 +0000458 sqlite3_int64 iNow;
459 sqlite3OsCurrentTimeInt64(db->pVfs, &iNow);
drhdf0db0f2010-07-29 10:07:21 +0000460 db->xProfile(db->pProfileArg, p->zSql, (iNow - p->startTime)*1000000);
drh19e2d372005-08-29 23:00:03 +0000461 }
462#endif
463
dan8d22a172010-04-19 18:03:51 +0000464 if( rc==SQLITE_DONE ){
465 assert( p->rc==SQLITE_OK );
drh7ed91f22010-04-29 22:34:07 +0000466 p->rc = doWalCallbacks(db);
dan8d22a172010-04-19 18:03:51 +0000467 if( p->rc!=SQLITE_OK ){
468 rc = SQLITE_ERROR;
469 }
470 }
471
drh80cc85b2008-07-23 21:07:25 +0000472 db->errCode = rc;
danielk1977357864e2009-03-25 15:43:08 +0000473 if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
474 p->rc = SQLITE_NOMEM;
drhb900aaf2006-11-09 00:24:53 +0000475 }
danielk1977357864e2009-03-25 15:43:08 +0000476end_of_step:
477 /* At this point local variable rc holds the value that should be
478 ** returned if this statement was compiled using the legacy
479 ** sqlite3_prepare() interface. According to the docs, this can only
480 ** be one of the values in the first assert() below. Variable p->rc
481 ** contains the value that would be returned if sqlite3_finalize()
482 ** were called on statement p.
483 */
484 assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
485 || rc==SQLITE_BUSY || rc==SQLITE_MISUSE
486 );
487 assert( p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE );
488 if( p->isPrepareV2 && rc!=SQLITE_ROW && rc!=SQLITE_DONE ){
489 /* If this statement was prepared using sqlite3_prepare_v2(), and an
mistachkin48864df2013-03-21 21:20:32 +0000490 ** error has occurred, then return the error code in p->rc to the
danielk1977357864e2009-03-25 15:43:08 +0000491 ** caller. Set the error code in the database handle to the same value.
492 */
dan029ead62011-10-27 15:19:58 +0000493 rc = sqlite3VdbeTransferError(p);
danielk1977357864e2009-03-25 15:43:08 +0000494 }
495 return (rc&db->errMask);
drhb900aaf2006-11-09 00:24:53 +0000496}
497
498/*
499** This is the top-level implementation of sqlite3_step(). Call
500** sqlite3Step() to do most of the work. If a schema error occurs,
501** call sqlite3Reprepare() and try again.
502*/
drhb900aaf2006-11-09 00:24:53 +0000503int sqlite3_step(sqlite3_stmt *pStmt){
drha6129fa2010-02-24 17:15:19 +0000504 int rc = SQLITE_OK; /* Result from sqlite3Step() */
505 int rc2 = SQLITE_OK; /* Result from sqlite3Reprepare() */
506 Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
507 int cnt = 0; /* Counter to prevent infinite loop of reprepares */
508 sqlite3 *db; /* The database connection */
509
drh413c3d32010-02-23 20:11:56 +0000510 if( vdbeSafetyNotNull(v) ){
511 return SQLITE_MISUSE_BKPT;
danielk19778e556522007-11-13 10:30:24 +0000512 }
drh413c3d32010-02-23 20:11:56 +0000513 db = v->db;
514 sqlite3_mutex_enter(db->mutex);
drh37f58e92012-09-04 21:34:26 +0000515 v->doingRerun = 0;
drh413c3d32010-02-23 20:11:56 +0000516 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
drh24e713d2011-06-23 01:42:53 +0000517 && cnt++ < SQLITE_MAX_SCHEMA_RETRY
drha6129fa2010-02-24 17:15:19 +0000518 && (rc2 = rc = sqlite3Reprepare(v))==SQLITE_OK ){
drh413c3d32010-02-23 20:11:56 +0000519 sqlite3_reset(pStmt);
drh37f58e92012-09-04 21:34:26 +0000520 v->doingRerun = 1;
dan08f5f4c2011-06-27 19:37:23 +0000521 assert( v->expired==0 );
drh413c3d32010-02-23 20:11:56 +0000522 }
drha3cc0072013-12-13 16:23:55 +0000523 if( rc2!=SQLITE_OK ){
drh413c3d32010-02-23 20:11:56 +0000524 /* This case occurs after failing to recompile an sql statement.
525 ** The error message from the SQL compiler has already been loaded
526 ** into the database handle. This block copies the error message
527 ** from the database handle into the statement and sets the statement
528 ** program counter to 0 to ensure that when the statement is
529 ** finalized or reset the parser error message is available via
530 ** sqlite3_errmsg() and sqlite3_errcode().
531 */
532 const char *zErr = (const char *)sqlite3_value_text(db->pErr);
drha3cc0072013-12-13 16:23:55 +0000533 assert( zErr!=0 || db->mallocFailed );
drh413c3d32010-02-23 20:11:56 +0000534 sqlite3DbFree(db, v->zErrMsg);
535 if( !db->mallocFailed ){
536 v->zErrMsg = sqlite3DbStrDup(db, zErr);
drha6129fa2010-02-24 17:15:19 +0000537 v->rc = rc2;
drh413c3d32010-02-23 20:11:56 +0000538 } else {
539 v->zErrMsg = 0;
drha6129fa2010-02-24 17:15:19 +0000540 v->rc = rc = SQLITE_NOMEM;
drh413c3d32010-02-23 20:11:56 +0000541 }
542 }
543 rc = sqlite3ApiExit(db, rc);
544 sqlite3_mutex_leave(db->mutex);
danielk197776e8d1a2006-01-18 18:22:43 +0000545 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000546}
547
drh95a7b3e2013-09-16 12:57:19 +0000548
drh4f26d6c2004-05-26 23:25:30 +0000549/*
drheb2e1762004-05-27 01:53:56 +0000550** Extract the user data from a sqlite3_context structure and return a
551** pointer to it.
552*/
553void *sqlite3_user_data(sqlite3_context *p){
554 assert( p && p->pFunc );
555 return p->pFunc->pUserData;
556}
557
558/*
drhfa4a4b92008-03-19 21:45:51 +0000559** Extract the user data from a sqlite3_context structure and return a
560** pointer to it.
drh9f129f42010-08-31 15:27:32 +0000561**
562** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
563** returns a copy of the pointer to the database connection (the 1st
564** parameter) of the sqlite3_create_function() and
565** sqlite3_create_function16() routines that originally registered the
566** application defined function.
drhfa4a4b92008-03-19 21:45:51 +0000567*/
568sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
569 assert( p && p->pFunc );
570 return p->s.db;
571}
572
573/*
drh95a7b3e2013-09-16 12:57:19 +0000574** Return the current time for a statement
575*/
576sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
577 Vdbe *v = p->pVdbe;
578 int rc;
579 if( v->iCurrentTime==0 ){
580 rc = sqlite3OsCurrentTimeInt64(p->s.db->pVfs, &v->iCurrentTime);
581 if( rc ) v->iCurrentTime = 0;
582 }
583 return v->iCurrentTime;
584}
585
586/*
drhb7481e72006-09-16 21:45:14 +0000587** The following is the implementation of an SQL function that always
588** fails with an error message stating that the function is used in the
589** wrong context. The sqlite3_overload_function() API might construct
590** SQL function that use this routine so that the functions will exist
591** for name resolution but are actually overloaded by the xFindFunction
592** method of virtual tables.
593*/
594void sqlite3InvalidFunction(
595 sqlite3_context *context, /* The function calling context */
danielk197762c14b32008-11-19 09:05:26 +0000596 int NotUsed, /* Number of arguments to the function */
597 sqlite3_value **NotUsed2 /* Value of each argument */
drhb7481e72006-09-16 21:45:14 +0000598){
599 const char *zName = context->pFunc->zName;
600 char *zErr;
danielk197762c14b32008-11-19 09:05:26 +0000601 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhbc6160b2009-04-08 15:45:31 +0000602 zErr = sqlite3_mprintf(
drhb7481e72006-09-16 21:45:14 +0000603 "unable to use function %s in the requested context", zName);
604 sqlite3_result_error(context, zErr, -1);
danielk19771e536952007-08-16 10:09:01 +0000605 sqlite3_free(zErr);
drhb7481e72006-09-16 21:45:14 +0000606}
607
608/*
drheb2e1762004-05-27 01:53:56 +0000609** Allocate or return the aggregate context for a user function. A new
610** context is allocated on the first call. Subsequent calls return the
611** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000612*/
613void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drhb21c8cd2007-08-21 19:33:56 +0000614 Mem *pMem;
drh825c6622005-09-08 19:01:05 +0000615 assert( p && p->pFunc && p->pFunc->xStep );
drhb21c8cd2007-08-21 19:33:56 +0000616 assert( sqlite3_mutex_held(p->s.db->mutex) );
617 pMem = p->pMem;
drhd68eee02009-12-11 03:44:18 +0000618 testcase( nByte<0 );
drha10a34b2005-09-07 22:09:48 +0000619 if( (pMem->flags & MEM_Agg)==0 ){
drhd68eee02009-12-11 03:44:18 +0000620 if( nByte<=0 ){
danielk19775f096132008-03-28 15:44:09 +0000621 sqlite3VdbeMemReleaseExternal(pMem);
622 pMem->flags = MEM_Null;
drha10a34b2005-09-07 22:09:48 +0000623 pMem->z = 0;
drheb2e1762004-05-27 01:53:56 +0000624 }else{
danielk19775f096132008-03-28 15:44:09 +0000625 sqlite3VdbeMemGrow(pMem, nByte, 0);
drha10a34b2005-09-07 22:09:48 +0000626 pMem->flags = MEM_Agg;
drh3c024d62007-03-30 11:23:45 +0000627 pMem->u.pDef = p->pFunc;
danielk19775f096132008-03-28 15:44:09 +0000628 if( pMem->z ){
629 memset(pMem->z, 0, nByte);
630 }
drheb2e1762004-05-27 01:53:56 +0000631 }
632 }
drhabfcea22005-09-06 20:36:48 +0000633 return (void*)pMem->z;
drheb2e1762004-05-27 01:53:56 +0000634}
635
636/*
danielk1977682f68b2004-06-05 10:22:17 +0000637** Return the auxilary data pointer, if any, for the iArg'th argument to
638** the user-function defined by pCtx.
639*/
640void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
dan0c547792013-07-18 17:12:08 +0000641 AuxData *pAuxData;
drhb21c8cd2007-08-21 19:33:56 +0000642
643 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
dan0c547792013-07-18 17:12:08 +0000644 for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
645 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
danielk1977682f68b2004-06-05 10:22:17 +0000646 }
dan0c547792013-07-18 17:12:08 +0000647
648 return (pAuxData ? pAuxData->pAux : 0);
danielk1977682f68b2004-06-05 10:22:17 +0000649}
650
651/*
652** Set the auxilary data pointer and delete function, for the iArg'th
653** argument to the user-function defined by pCtx. Any previous value is
654** deleted by calling the delete function specified when it was set.
655*/
656void sqlite3_set_auxdata(
657 sqlite3_context *pCtx,
658 int iArg,
659 void *pAux,
660 void (*xDelete)(void*)
661){
dan0c547792013-07-18 17:12:08 +0000662 AuxData *pAuxData;
663 Vdbe *pVdbe = pCtx->pVdbe;
danielk1977682f68b2004-06-05 10:22:17 +0000664
drhb21c8cd2007-08-21 19:33:56 +0000665 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
dan0c547792013-07-18 17:12:08 +0000666 if( iArg<0 ) goto failed;
danielk1977682f68b2004-06-05 10:22:17 +0000667
dan0c547792013-07-18 17:12:08 +0000668 for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNext){
669 if( pAuxData->iOp==pCtx->iOp && pAuxData->iArg==iArg ) break;
670 }
671 if( pAuxData==0 ){
672 pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
673 if( !pAuxData ) goto failed;
674 pAuxData->iOp = pCtx->iOp;
675 pAuxData->iArg = iArg;
676 pAuxData->pNext = pVdbe->pAuxData;
677 pVdbe->pAuxData = pAuxData;
drh9b47ee32013-08-20 03:13:51 +0000678 if( pCtx->fErrorOrAux==0 ){
679 pCtx->isError = 0;
680 pCtx->fErrorOrAux = 1;
681 }
dan0c547792013-07-18 17:12:08 +0000682 }else if( pAuxData->xDelete ){
danielk1977682f68b2004-06-05 10:22:17 +0000683 pAuxData->xDelete(pAuxData->pAux);
684 }
dan0c547792013-07-18 17:12:08 +0000685
danielk1977682f68b2004-06-05 10:22:17 +0000686 pAuxData->pAux = pAux;
687 pAuxData->xDelete = xDelete;
danielk1977e0fc5262007-07-26 06:50:05 +0000688 return;
689
690failed:
691 if( xDelete ){
692 xDelete(pAux);
693 }
danielk1977682f68b2004-06-05 10:22:17 +0000694}
695
shaneeec556d2008-10-12 00:27:53 +0000696#ifndef SQLITE_OMIT_DEPRECATED
danielk1977682f68b2004-06-05 10:22:17 +0000697/*
drheb2e1762004-05-27 01:53:56 +0000698** Return the number of times the Step function of a aggregate has been
699** called.
700**
drhcf85a512006-02-09 18:35:29 +0000701** This function is deprecated. Do not use it for new code. It is
702** provide only to avoid breaking legacy code. New aggregate function
703** implementations should keep their own counts within their aggregate
704** context.
drheb2e1762004-05-27 01:53:56 +0000705*/
706int sqlite3_aggregate_count(sqlite3_context *p){
shanee34c6472009-03-05 04:23:47 +0000707 assert( p && p->pMem && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000708 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000709}
shaneeec556d2008-10-12 00:27:53 +0000710#endif
drheb2e1762004-05-27 01:53:56 +0000711
712/*
drh4f26d6c2004-05-26 23:25:30 +0000713** Return the number of columns in the result set for the statement pStmt.
714*/
715int sqlite3_column_count(sqlite3_stmt *pStmt){
716 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000717 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000718}
719
720/*
721** Return the number of values available from the current row of the
722** currently executing statement pStmt.
723*/
724int sqlite3_data_count(sqlite3_stmt *pStmt){
725 Vdbe *pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000726 if( pVm==0 || pVm->pResultSet==0 ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000727 return pVm->nResColumn;
728}
729
730
731/*
732** Check to see if column iCol of the given statement is valid. If
733** it is, return a pointer to the Mem for the value of that column.
734** If iCol is not valid, return a pointer to a Mem which has a value
735** of NULL.
736*/
737static Mem *columnMem(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000738 Vdbe *pVm;
drh32bc3f62007-08-21 20:25:39 +0000739 Mem *pOut;
740
741 pVm = (Vdbe *)pStmt;
drhd4e70eb2008-01-02 00:34:36 +0000742 if( pVm && pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
drh32bc3f62007-08-21 20:25:39 +0000743 sqlite3_mutex_enter(pVm->db->mutex);
drhd4e70eb2008-01-02 00:34:36 +0000744 pOut = &pVm->pResultSet[i];
drh32bc3f62007-08-21 20:25:39 +0000745 }else{
danielk197741f5b042009-06-06 14:13:26 +0000746 /* If the value passed as the second argument is out of range, return
747 ** a pointer to the following static Mem object which contains the
748 ** value SQL NULL. Even though the Mem structure contains an element
drhb8a45bb2011-12-31 21:51:55 +0000749 ** of type i64, on certain architectures (x86) with certain compiler
danielk197741f5b042009-06-06 14:13:26 +0000750 ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
751 ** instead of an 8-byte one. This all works fine, except that when
752 ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
753 ** that a Mem structure is located on an 8-byte boundary. To prevent
drhb8a45bb2011-12-31 21:51:55 +0000754 ** these assert()s from failing, when building with SQLITE_DEBUG defined
755 ** using gcc, we force nullMem to be 8-byte aligned using the magical
danielk197741f5b042009-06-06 14:13:26 +0000756 ** __attribute__((aligned(8))) macro. */
757 static const Mem nullMem
758#if defined(SQLITE_DEBUG) && defined(__GNUC__)
759 __attribute__((aligned(8)))
760#endif
drhfcd71b62011-04-05 22:08:24 +0000761 = {0, "", (double)0, {0}, 0, MEM_Null, SQLITE_NULL, 0,
762#ifdef SQLITE_DEBUG
763 0, 0, /* pScopyFrom, pFiller */
764#endif
765 0, 0 };
danielk197741f5b042009-06-06 14:13:26 +0000766
drh9b4ea4a2009-04-10 20:32:00 +0000767 if( pVm && ALWAYS(pVm->db) ){
drh27641702007-08-22 02:56:42 +0000768 sqlite3_mutex_enter(pVm->db->mutex);
769 sqlite3Error(pVm->db, SQLITE_RANGE, 0);
770 }
drh32bc3f62007-08-21 20:25:39 +0000771 pOut = (Mem*)&nullMem;
drh4f26d6c2004-05-26 23:25:30 +0000772 }
drh32bc3f62007-08-21 20:25:39 +0000773 return pOut;
drh4f26d6c2004-05-26 23:25:30 +0000774}
775
danielk19772e588c72005-12-09 14:25:08 +0000776/*
777** This function is called after invoking an sqlite3_value_XXX function on a
778** column value (i.e. a value returned by evaluating an SQL expression in the
779** select list of a SELECT statement) that may cause a malloc() failure. If
780** malloc() has failed, the threads mallocFailed flag is cleared and the result
781** code of statement pStmt set to SQLITE_NOMEM.
782**
drh32bc3f62007-08-21 20:25:39 +0000783** Specifically, this is called from within:
danielk19772e588c72005-12-09 14:25:08 +0000784**
785** sqlite3_column_int()
786** sqlite3_column_int64()
787** sqlite3_column_text()
788** sqlite3_column_text16()
789** sqlite3_column_real()
790** sqlite3_column_bytes()
791** sqlite3_column_bytes16()
drh42262532010-09-08 16:30:36 +0000792** sqiite3_column_blob()
danielk19772e588c72005-12-09 14:25:08 +0000793*/
794static void columnMallocFailure(sqlite3_stmt *pStmt)
795{
796 /* If malloc() failed during an encoding conversion within an
797 ** sqlite3_column_XXX API, then set the return code of the statement to
798 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
799 ** and _finalize() will return NOMEM.
800 */
danielk197754f01982006-01-18 15:25:17 +0000801 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000802 if( p ){
803 p->rc = sqlite3ApiExit(p->db, p->rc);
804 sqlite3_mutex_leave(p->db->mutex);
805 }
danielk19772e588c72005-12-09 14:25:08 +0000806}
807
drh4f26d6c2004-05-26 23:25:30 +0000808/**************************** sqlite3_column_ *******************************
809** The following routines are used to access elements of the current row
810** in the result set.
811*/
danielk1977c572ef72004-05-27 09:28:41 +0000812const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000813 const void *val;
danielk19772e588c72005-12-09 14:25:08 +0000814 val = sqlite3_value_blob( columnMem(pStmt,i) );
danielk1977c9cf9012007-05-30 10:36:47 +0000815 /* Even though there is no encoding conversion, value_blob() might
816 ** need to call malloc() to expand the result of a zeroblob()
817 ** expression.
818 */
819 columnMallocFailure(pStmt);
danielk19772e588c72005-12-09 14:25:08 +0000820 return val;
danielk1977c572ef72004-05-27 09:28:41 +0000821}
drh4f26d6c2004-05-26 23:25:30 +0000822int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000823 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
824 columnMallocFailure(pStmt);
825 return val;
drh4f26d6c2004-05-26 23:25:30 +0000826}
827int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000828 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
829 columnMallocFailure(pStmt);
830 return val;
drh4f26d6c2004-05-26 23:25:30 +0000831}
832double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000833 double val = sqlite3_value_double( columnMem(pStmt,i) );
834 columnMallocFailure(pStmt);
835 return val;
drh4f26d6c2004-05-26 23:25:30 +0000836}
837int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000838 int val = sqlite3_value_int( columnMem(pStmt,i) );
839 columnMallocFailure(pStmt);
840 return val;
drh4f26d6c2004-05-26 23:25:30 +0000841}
drhefad9992004-06-22 12:13:55 +0000842sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000843 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
844 columnMallocFailure(pStmt);
845 return val;
drh4f26d6c2004-05-26 23:25:30 +0000846}
847const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000848 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
849 columnMallocFailure(pStmt);
850 return val;
drh4f26d6c2004-05-26 23:25:30 +0000851}
drhd1e47332005-06-26 17:55:33 +0000852sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
danielk1977d0ffa1e2008-10-13 10:37:49 +0000853 Mem *pOut = columnMem(pStmt, i);
854 if( pOut->flags&MEM_Static ){
855 pOut->flags &= ~MEM_Static;
856 pOut->flags |= MEM_Ephem;
857 }
drh32bc3f62007-08-21 20:25:39 +0000858 columnMallocFailure(pStmt);
danielk1977d0ffa1e2008-10-13 10:37:49 +0000859 return (sqlite3_value *)pOut;
drhd1e47332005-06-26 17:55:33 +0000860}
drh6c626082004-11-14 21:56:29 +0000861#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000862const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000863 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
864 columnMallocFailure(pStmt);
865 return val;
drh4f26d6c2004-05-26 23:25:30 +0000866}
drh6c626082004-11-14 21:56:29 +0000867#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000868int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
drh32bc3f62007-08-21 20:25:39 +0000869 int iType = sqlite3_value_type( columnMem(pStmt,i) );
870 columnMallocFailure(pStmt);
871 return iType;
drh4f26d6c2004-05-26 23:25:30 +0000872}
873
drh5e2517e2004-09-24 23:59:12 +0000874/*
875** Convert the N-th element of pStmt->pColName[] into a string using
876** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000877**
878** There are up to 5 names for each column. useType determines which
879** name is returned. Here are the names:
880**
881** 0 The column name as it should be displayed for output
882** 1 The datatype name for the column
883** 2 The name of the database that the column derives from
884** 3 The name of the table that the column derives from
885** 4 The name of the table column that the result column derives from
886**
887** If the result is not a simple column reference (if it is an expression
888** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000889*/
890static const void *columnName(
891 sqlite3_stmt *pStmt,
892 int N,
893 const void *(*xFunc)(Mem*),
894 int useType
895){
drh32bc3f62007-08-21 20:25:39 +0000896 const void *ret = 0;
drh5e2517e2004-09-24 23:59:12 +0000897 Vdbe *p = (Vdbe *)pStmt;
drh32bc3f62007-08-21 20:25:39 +0000898 int n;
drhc6c7fd52009-04-08 23:05:28 +0000899 sqlite3 *db = p->db;
drh32bc3f62007-08-21 20:25:39 +0000900
drh9b4ea4a2009-04-10 20:32:00 +0000901 assert( db!=0 );
902 n = sqlite3_column_count(pStmt);
903 if( N<n && N>=0 ){
904 N += useType*n;
905 sqlite3_mutex_enter(db->mutex);
906 assert( db->mallocFailed==0 );
907 ret = xFunc(&p->aColName[N]);
908 /* A malloc may have failed inside of the xFunc() call. If this
909 ** is the case, clear the mallocFailed flag and return NULL.
910 */
911 if( db->mallocFailed ){
912 db->mallocFailed = 0;
913 ret = 0;
drh32bc3f62007-08-21 20:25:39 +0000914 }
drh9b4ea4a2009-04-10 20:32:00 +0000915 sqlite3_mutex_leave(db->mutex);
drh5e2517e2004-09-24 23:59:12 +0000916 }
danielk197700fd9572005-12-07 06:27:43 +0000917 return ret;
drh5e2517e2004-09-24 23:59:12 +0000918}
919
drh4f26d6c2004-05-26 23:25:30 +0000920/*
921** Return the name of the Nth column of the result set returned by SQL
922** statement pStmt.
923*/
924const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000925 return columnName(
926 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
drh4f26d6c2004-05-26 23:25:30 +0000927}
drhe590fbd2005-05-20 19:36:01 +0000928#ifndef SQLITE_OMIT_UTF16
929const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000930 return columnName(
931 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
drhe590fbd2005-05-20 19:36:01 +0000932}
933#endif
drh4f26d6c2004-05-26 23:25:30 +0000934
935/*
drh3f913572008-03-22 01:07:17 +0000936** Constraint: If you have ENABLE_COLUMN_METADATA then you must
937** not define OMIT_DECLTYPE.
938*/
939#if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
940# error "Must not define both SQLITE_OMIT_DECLTYPE \
941 and SQLITE_ENABLE_COLUMN_METADATA"
942#endif
943
944#ifndef SQLITE_OMIT_DECLTYPE
945/*
drh6c626082004-11-14 21:56:29 +0000946** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +0000947** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +0000948*/
949const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000950 return columnName(
951 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
drh6c626082004-11-14 21:56:29 +0000952}
drh6c626082004-11-14 21:56:29 +0000953#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +0000954const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000955 return columnName(
956 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
drh4f26d6c2004-05-26 23:25:30 +0000957}
drh6c626082004-11-14 21:56:29 +0000958#endif /* SQLITE_OMIT_UTF16 */
drh3f913572008-03-22 01:07:17 +0000959#endif /* SQLITE_OMIT_DECLTYPE */
drh4f26d6c2004-05-26 23:25:30 +0000960
danielk19774b1ae992006-02-10 03:06:10 +0000961#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhe590fbd2005-05-20 19:36:01 +0000962/*
963** Return the name of the database from which a result column derives.
964** NULL is returned if the result column is an expression or constant or
965** anything else which is not an unabiguous reference to a database column.
966*/
967const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000968 return columnName(
969 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +0000970}
971#ifndef SQLITE_OMIT_UTF16
972const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000973 return columnName(
974 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
drhe590fbd2005-05-20 19:36:01 +0000975}
976#endif /* SQLITE_OMIT_UTF16 */
977
978/*
979** Return the name of the table from which a result column derives.
980** NULL is returned if the result column is an expression or constant or
981** anything else which is not an unabiguous reference to a database column.
982*/
983const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000984 return columnName(
985 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +0000986}
987#ifndef SQLITE_OMIT_UTF16
988const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +0000989 return columnName(
990 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
drhe590fbd2005-05-20 19:36:01 +0000991}
992#endif /* SQLITE_OMIT_UTF16 */
993
994/*
995** Return the name of the table column from which a result column derives.
996** NULL is returned if the result column is an expression or constant or
997** anything else which is not an unabiguous reference to a database column.
998*/
999const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001000 return columnName(
1001 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001002}
1003#ifndef SQLITE_OMIT_UTF16
1004const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
danielk1977955de522006-02-10 02:27:42 +00001005 return columnName(
1006 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
drhe590fbd2005-05-20 19:36:01 +00001007}
1008#endif /* SQLITE_OMIT_UTF16 */
danielk19774b1ae992006-02-10 03:06:10 +00001009#endif /* SQLITE_ENABLE_COLUMN_METADATA */
drhe590fbd2005-05-20 19:36:01 +00001010
1011
drh4f26d6c2004-05-26 23:25:30 +00001012/******************************* sqlite3_bind_ ***************************
1013**
1014** Routines used to attach values to wildcards in a compiled SQL statement.
1015*/
1016/*
1017** Unbind the value bound to variable i in virtual machine p. This is the
1018** the same as binding a NULL value to the column. If the "i" parameter is
1019** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
1020**
drh488e7b62008-10-06 12:46:43 +00001021** A successful evaluation of this routine acquires the mutex on p.
1022** the mutex is released if any kind of error occurs.
1023**
drh4f26d6c2004-05-26 23:25:30 +00001024** The error code stored in database p->db is overwritten with the return
1025** value in any case.
1026*/
1027static int vdbeUnbind(Vdbe *p, int i){
1028 Mem *pVar;
drh413c3d32010-02-23 20:11:56 +00001029 if( vdbeSafetyNotNull(p) ){
1030 return SQLITE_MISUSE_BKPT;
1031 }
drh488e7b62008-10-06 12:46:43 +00001032 sqlite3_mutex_enter(p->db->mutex);
1033 if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
1034 sqlite3Error(p->db, SQLITE_MISUSE, 0);
1035 sqlite3_mutex_leave(p->db->mutex);
drh413c3d32010-02-23 20:11:56 +00001036 sqlite3_log(SQLITE_MISUSE,
1037 "bind on a busy prepared statement: [%s]", p->zSql);
1038 return SQLITE_MISUSE_BKPT;
drh4f26d6c2004-05-26 23:25:30 +00001039 }
1040 if( i<1 || i>p->nVar ){
1041 sqlite3Error(p->db, SQLITE_RANGE, 0);
drh488e7b62008-10-06 12:46:43 +00001042 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001043 return SQLITE_RANGE;
1044 }
1045 i--;
drh290c1942004-08-21 17:54:45 +00001046 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +00001047 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +00001048 pVar->flags = MEM_Null;
1049 sqlite3Error(p->db, SQLITE_OK, 0);
dan937d0de2009-10-15 18:35:38 +00001050
dan1d2ce4f2009-10-19 18:11:09 +00001051 /* If the bit corresponding to this variable in Vdbe.expmask is set, then
1052 ** binding a new value to this variable invalidates the current query plan.
drha7044002010-09-14 18:22:59 +00001053 **
1054 ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
1055 ** parameter in the WHERE clause might influence the choice of query plan
1056 ** for a statement, then the statement will be automatically recompiled,
1057 ** as if there had been a schema change, on the first sqlite3_step() call
1058 ** following any change to the bindings of that parameter.
dan1d2ce4f2009-10-19 18:11:09 +00001059 */
drh823e09a2009-10-19 20:15:38 +00001060 if( p->isPrepareV2 &&
1061 ((i<32 && p->expmask & ((u32)1 << i)) || p->expmask==0xffffffff)
1062 ){
dan937d0de2009-10-15 18:35:38 +00001063 p->expired = 1;
1064 }
drh4f26d6c2004-05-26 23:25:30 +00001065 return SQLITE_OK;
1066}
1067
1068/*
drh5e2517e2004-09-24 23:59:12 +00001069** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +00001070*/
drh5e2517e2004-09-24 23:59:12 +00001071static int bindText(
drh605264d2007-08-21 15:13:19 +00001072 sqlite3_stmt *pStmt, /* The statement to bind against */
1073 int i, /* Index of the parameter to bind */
1074 const void *zData, /* Pointer to the data to be bound */
1075 int nData, /* Number of bytes of data to be bound */
1076 void (*xDel)(void*), /* Destructor for the data */
drhb27b7f52008-12-10 18:03:45 +00001077 u8 encoding /* Encoding for the data */
drh4f26d6c2004-05-26 23:25:30 +00001078){
1079 Vdbe *p = (Vdbe *)pStmt;
1080 Mem *pVar;
1081 int rc;
1082
1083 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001084 if( rc==SQLITE_OK ){
1085 if( zData!=0 ){
1086 pVar = &p->aVar[i-1];
1087 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
1088 if( rc==SQLITE_OK && encoding!=0 ){
1089 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
1090 }
1091 sqlite3Error(p->db, rc, 0);
1092 rc = sqlite3ApiExit(p->db, rc);
drh27641702007-08-22 02:56:42 +00001093 }
drh488e7b62008-10-06 12:46:43 +00001094 sqlite3_mutex_leave(p->db->mutex);
drh94bb2ba2010-10-14 01:16:32 +00001095 }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
drh6fec9ee2010-10-12 02:13:32 +00001096 xDel((void*)zData);
drh4f26d6c2004-05-26 23:25:30 +00001097 }
drh605264d2007-08-21 15:13:19 +00001098 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001099}
drh5e2517e2004-09-24 23:59:12 +00001100
1101
1102/*
1103** Bind a blob value to an SQL statement variable.
1104*/
1105int sqlite3_bind_blob(
1106 sqlite3_stmt *pStmt,
1107 int i,
1108 const void *zData,
1109 int nData,
1110 void (*xDel)(void*)
1111){
1112 return bindText(pStmt, i, zData, nData, xDel, 0);
1113}
drh4f26d6c2004-05-26 23:25:30 +00001114int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
1115 int rc;
1116 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +00001117 rc = vdbeUnbind(p, i);
1118 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001119 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh488e7b62008-10-06 12:46:43 +00001120 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001121 }
danielk1977f4618892004-06-28 13:09:11 +00001122 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001123}
1124int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +00001125 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +00001126}
drhefad9992004-06-22 12:13:55 +00001127int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +00001128 int rc;
1129 Vdbe *p = (Vdbe *)pStmt;
1130 rc = vdbeUnbind(p, i);
1131 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +00001132 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh488e7b62008-10-06 12:46:43 +00001133 sqlite3_mutex_leave(p->db->mutex);
drh4f26d6c2004-05-26 23:25:30 +00001134 }
1135 return rc;
1136}
drh605264d2007-08-21 15:13:19 +00001137int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
1138 int rc;
1139 Vdbe *p = (Vdbe*)pStmt;
drh605264d2007-08-21 15:13:19 +00001140 rc = vdbeUnbind(p, i);
drh488e7b62008-10-06 12:46:43 +00001141 if( rc==SQLITE_OK ){
1142 sqlite3_mutex_leave(p->db->mutex);
1143 }
drh605264d2007-08-21 15:13:19 +00001144 return rc;
drh4f26d6c2004-05-26 23:25:30 +00001145}
1146int sqlite3_bind_text(
1147 sqlite3_stmt *pStmt,
1148 int i,
1149 const char *zData,
1150 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001151 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001152){
drh5e2517e2004-09-24 23:59:12 +00001153 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +00001154}
drh6c626082004-11-14 21:56:29 +00001155#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +00001156int sqlite3_bind_text16(
1157 sqlite3_stmt *pStmt,
1158 int i,
1159 const void *zData,
1160 int nData,
danielk1977d8123362004-06-12 09:25:12 +00001161 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +00001162){
drh5e2517e2004-09-24 23:59:12 +00001163 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +00001164}
drh6c626082004-11-14 21:56:29 +00001165#endif /* SQLITE_OMIT_UTF16 */
danielk197726e41442006-06-14 15:16:35 +00001166int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
1167 int rc;
drh1b27b8c2014-02-10 03:21:57 +00001168 switch( sqlite3_value_type((sqlite3_value*)pValue) ){
drh29def562009-04-14 12:43:33 +00001169 case SQLITE_INTEGER: {
1170 rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
1171 break;
1172 }
1173 case SQLITE_FLOAT: {
1174 rc = sqlite3_bind_double(pStmt, i, pValue->r);
1175 break;
1176 }
1177 case SQLITE_BLOB: {
1178 if( pValue->flags & MEM_Zero ){
1179 rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
1180 }else{
1181 rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
1182 }
1183 break;
1184 }
1185 case SQLITE_TEXT: {
drhac80db72009-04-14 12:58:20 +00001186 rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
1187 pValue->enc);
1188 break;
1189 }
1190 default: {
1191 rc = sqlite3_bind_null(pStmt, i);
drh29def562009-04-14 12:43:33 +00001192 break;
1193 }
danielk197726e41442006-06-14 15:16:35 +00001194 }
1195 return rc;
1196}
drhb026e052007-05-02 01:34:31 +00001197int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
1198 int rc;
1199 Vdbe *p = (Vdbe *)pStmt;
1200 rc = vdbeUnbind(p, i);
1201 if( rc==SQLITE_OK ){
1202 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
drh488e7b62008-10-06 12:46:43 +00001203 sqlite3_mutex_leave(p->db->mutex);
drhb026e052007-05-02 01:34:31 +00001204 }
1205 return rc;
1206}
drh75f6a032004-07-15 14:15:00 +00001207
1208/*
1209** Return the number of wildcards that can be potentially bound to.
1210** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +00001211*/
1212int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +00001213 Vdbe *p = (Vdbe*)pStmt;
1214 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +00001215}
drh895d7472004-08-20 16:02:39 +00001216
1217/*
drhfa6bc002004-09-07 16:19:52 +00001218** Return the name of a wildcard parameter. Return NULL if the index
1219** is out of range or if the wildcard is unnamed.
1220**
1221** The result is always UTF-8.
1222*/
1223const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
1224 Vdbe *p = (Vdbe*)pStmt;
drh124c0b42011-06-01 18:15:55 +00001225 if( p==0 || i<1 || i>p->nzVar ){
drhfa6bc002004-09-07 16:19:52 +00001226 return 0;
1227 }
drh895d7472004-08-20 16:02:39 +00001228 return p->azVar[i-1];
1229}
drhfa6bc002004-09-07 16:19:52 +00001230
1231/*
1232** Given a wildcard parameter name, return the index of the variable
1233** with that name. If there is no variable with the given name,
1234** return 0.
1235*/
drh5f18a222009-11-26 14:01:53 +00001236int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
drhfa6bc002004-09-07 16:19:52 +00001237 int i;
1238 if( p==0 ){
1239 return 0;
1240 }
drh6a8903c2004-12-10 18:00:04 +00001241 if( zName ){
drh124c0b42011-06-01 18:15:55 +00001242 for(i=0; i<p->nzVar; i++){
drh6a8903c2004-12-10 18:00:04 +00001243 const char *z = p->azVar[i];
drh503a6862013-03-01 01:07:17 +00001244 if( z && strncmp(z,zName,nName)==0 && z[nName]==0 ){
drh6a8903c2004-12-10 18:00:04 +00001245 return i+1;
1246 }
drhfa6bc002004-09-07 16:19:52 +00001247 }
1248 }
1249 return 0;
1250}
drh5f18a222009-11-26 14:01:53 +00001251int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1252 return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
1253}
drhf8db1bc2005-04-22 02:38:37 +00001254
drh51942bc2005-06-12 22:01:42 +00001255/*
drhf8db1bc2005-04-22 02:38:37 +00001256** Transfer all bindings from the first statement over to the second.
drhf8db1bc2005-04-22 02:38:37 +00001257*/
shane145834a2008-09-04 12:03:42 +00001258int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drhf8db1bc2005-04-22 02:38:37 +00001259 Vdbe *pFrom = (Vdbe*)pFromStmt;
1260 Vdbe *pTo = (Vdbe*)pToStmt;
drh0f5ea0b2009-04-09 14:02:44 +00001261 int i;
1262 assert( pTo->db==pFrom->db );
1263 assert( pTo->nVar==pFrom->nVar );
drh27641702007-08-22 02:56:42 +00001264 sqlite3_mutex_enter(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001265 for(i=0; i<pFrom->nVar; i++){
drh643167f2008-01-22 21:30:53 +00001266 sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
drhf8db1bc2005-04-22 02:38:37 +00001267 }
drh27641702007-08-22 02:56:42 +00001268 sqlite3_mutex_leave(pTo->db->mutex);
drh0f5ea0b2009-04-09 14:02:44 +00001269 return SQLITE_OK;
drhf8db1bc2005-04-22 02:38:37 +00001270}
drh51942bc2005-06-12 22:01:42 +00001271
shaneeec556d2008-10-12 00:27:53 +00001272#ifndef SQLITE_OMIT_DEPRECATED
drh51942bc2005-06-12 22:01:42 +00001273/*
shane145834a2008-09-04 12:03:42 +00001274** Deprecated external interface. Internal/core SQLite code
1275** should call sqlite3TransferBindings.
drh0f5ea0b2009-04-09 14:02:44 +00001276**
1277** Is is misuse to call this routine with statements from different
1278** database connections. But as this is a deprecated interface, we
1279** will not bother to check for that condition.
1280**
1281** If the two statements contain a different number of bindings, then
1282** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
1283** SQLITE_OK is returned.
shane145834a2008-09-04 12:03:42 +00001284*/
1285int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
drh0f5ea0b2009-04-09 14:02:44 +00001286 Vdbe *pFrom = (Vdbe*)pFromStmt;
1287 Vdbe *pTo = (Vdbe*)pToStmt;
1288 if( pFrom->nVar!=pTo->nVar ){
1289 return SQLITE_ERROR;
1290 }
danc94b8592009-10-20 07:01:24 +00001291 if( pTo->isPrepareV2 && pTo->expmask ){
1292 pTo->expired = 1;
1293 }
1294 if( pFrom->isPrepareV2 && pFrom->expmask ){
1295 pFrom->expired = 1;
1296 }
shane145834a2008-09-04 12:03:42 +00001297 return sqlite3TransferBindings(pFromStmt, pToStmt);
1298}
shaneeec556d2008-10-12 00:27:53 +00001299#endif
shane145834a2008-09-04 12:03:42 +00001300
1301/*
drh51942bc2005-06-12 22:01:42 +00001302** Return the sqlite3* database handle to which the prepared statement given
1303** in the argument belongs. This is the same database handle that was
1304** the first argument to the sqlite3_prepare() that was used to create
1305** the statement in the first place.
1306*/
1307sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1308 return pStmt ? ((Vdbe*)pStmt)->db : 0;
1309}
drhbb5a9c32008-06-19 02:52:25 +00001310
1311/*
drhf03d9cc2010-11-16 23:10:25 +00001312** Return true if the prepared statement is guaranteed to not modify the
1313** database.
1314*/
1315int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
1316 return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
1317}
1318
1319/*
drh2fb66932011-11-25 17:21:47 +00001320** Return true if the prepared statement is in need of being reset.
1321*/
1322int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
1323 Vdbe *v = (Vdbe*)pStmt;
1324 return v!=0 && v->pc>0 && v->magic==VDBE_MAGIC_RUN;
1325}
1326
1327/*
drhbb5a9c32008-06-19 02:52:25 +00001328** Return a pointer to the next prepared statement after pStmt associated
1329** with database connection pDb. If pStmt is NULL, return the first
1330** prepared statement for the database connection. Return NULL if there
1331** are no more.
1332*/
1333sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
1334 sqlite3_stmt *pNext;
1335 sqlite3_mutex_enter(pDb->mutex);
1336 if( pStmt==0 ){
1337 pNext = (sqlite3_stmt*)pDb->pVdbe;
1338 }else{
1339 pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
1340 }
1341 sqlite3_mutex_leave(pDb->mutex);
1342 return pNext;
1343}
drhd1d38482008-10-07 23:46:38 +00001344
1345/*
1346** Return the value of a status counter for a prepared statement
1347*/
1348int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
1349 Vdbe *pVdbe = (Vdbe*)pStmt;
drh9b47ee32013-08-20 03:13:51 +00001350 u32 v = pVdbe->aCounter[op];
1351 if( resetFlag ) pVdbe->aCounter[op] = 0;
1352 return (int)v;
drhd1d38482008-10-07 23:46:38 +00001353}