blob: bad4a3600a4ff3bf61feb6cfcb594a1e72380db2 [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"
drh19e2d372005-08-29 23:00:03 +000018#include "os.h"
drh4f26d6c2004-05-26 23:25:30 +000019
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}
32
drh4f26d6c2004-05-26 23:25:30 +000033/**************************** sqlite3_value_ *******************************
34** The following routines extract information from a Mem or sqlite3_value
35** structure.
36*/
37const void *sqlite3_value_blob(sqlite3_value *pVal){
38 Mem *p = (Mem*)pVal;
39 if( p->flags & (MEM_Blob|MEM_Str) ){
40 return p->z;
41 }else{
42 return sqlite3_value_text(pVal);
43 }
44}
45int sqlite3_value_bytes(sqlite3_value *pVal){
danielk197713073932004-06-30 11:54:06 +000046 return sqlite3ValueBytes(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +000047}
48int sqlite3_value_bytes16(sqlite3_value *pVal){
danielk197713073932004-06-30 11:54:06 +000049 return sqlite3ValueBytes(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +000050}
51double sqlite3_value_double(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +000052 return sqlite3VdbeRealValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +000053}
54int sqlite3_value_int(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +000055 return sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +000056}
drhefad9992004-06-22 12:13:55 +000057sqlite_int64 sqlite3_value_int64(sqlite3_value *pVal){
drh6a6124e2004-06-27 01:56:33 +000058 return sqlite3VdbeIntValue((Mem*)pVal);
drh4f26d6c2004-05-26 23:25:30 +000059}
60const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
danielk197700fd9572005-12-07 06:27:43 +000061 return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +000062}
drh6c626082004-11-14 21:56:29 +000063#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +000064const void *sqlite3_value_text16(sqlite3_value* pVal){
danielk1977dc8453f2004-06-12 00:42:34 +000065 return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +000066}
danielk1977d8123362004-06-12 09:25:12 +000067const void *sqlite3_value_text16be(sqlite3_value *pVal){
68 return sqlite3ValueText(pVal, SQLITE_UTF16BE);
69}
70const void *sqlite3_value_text16le(sqlite3_value *pVal){
71 return sqlite3ValueText(pVal, SQLITE_UTF16LE);
72}
drh6c626082004-11-14 21:56:29 +000073#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +000074int sqlite3_value_type(sqlite3_value* pVal){
drhf4479502004-05-27 03:12:53 +000075 return pVal->type;
drh4f26d6c2004-05-26 23:25:30 +000076}
77
78/**************************** sqlite3_result_ *******************************
79** The following routines are used by user-defined functions to specify
80** the function result.
81*/
82void sqlite3_result_blob(
83 sqlite3_context *pCtx,
84 const void *z,
85 int n,
danielk1977d8123362004-06-12 09:25:12 +000086 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +000087){
drh5708d2d2005-06-22 10:53:59 +000088 assert( n>=0 );
danielk1977d8123362004-06-12 09:25:12 +000089 sqlite3VdbeMemSetStr(&pCtx->s, z, n, 0, xDel);
drh4f26d6c2004-05-26 23:25:30 +000090}
91void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
92 sqlite3VdbeMemSetDouble(&pCtx->s, rVal);
93}
94void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
95 pCtx->isError = 1;
danielk1977d8123362004-06-12 09:25:12 +000096 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +000097}
98void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
99 pCtx->isError = 1;
danielk1977d8123362004-06-12 09:25:12 +0000100 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000101}
drhf4479502004-05-27 03:12:53 +0000102void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh4f26d6c2004-05-26 23:25:30 +0000103 sqlite3VdbeMemSetInt64(&pCtx->s, (i64)iVal);
104}
105void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
106 sqlite3VdbeMemSetInt64(&pCtx->s, iVal);
107}
108void sqlite3_result_null(sqlite3_context *pCtx){
drhf4479502004-05-27 03:12:53 +0000109 sqlite3VdbeMemSetNull(&pCtx->s);
drh4f26d6c2004-05-26 23:25:30 +0000110}
111void sqlite3_result_text(
112 sqlite3_context *pCtx,
113 const char *z,
114 int n,
danielk1977d8123362004-06-12 09:25:12 +0000115 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000116){
danielk1977d8123362004-06-12 09:25:12 +0000117 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000118}
drh6c626082004-11-14 21:56:29 +0000119#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000120void sqlite3_result_text16(
121 sqlite3_context *pCtx,
122 const void *z,
123 int n,
danielk1977d8123362004-06-12 09:25:12 +0000124 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000125){
danielk1977d8123362004-06-12 09:25:12 +0000126 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16NATIVE, xDel);
127}
128void sqlite3_result_text16be(
129 sqlite3_context *pCtx,
130 const void *z,
131 int n,
132 void (*xDel)(void *)
133){
134 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16BE, xDel);
135}
136void sqlite3_result_text16le(
137 sqlite3_context *pCtx,
138 const void *z,
139 int n,
140 void (*xDel)(void *)
141){
142 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000143}
drh6c626082004-11-14 21:56:29 +0000144#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000145void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
146 sqlite3VdbeMemCopy(&pCtx->s, pValue);
147}
148
149
150/*
151** Execute the statement pStmt, either until a row of data is ready, the
152** statement is completely executed or an error occurs.
153*/
154int sqlite3_step(sqlite3_stmt *pStmt){
155 Vdbe *p = (Vdbe*)pStmt;
drh9bb575f2004-09-06 17:24:11 +0000156 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000157 int rc;
158
danielk1977efaaf572006-01-16 11:29:19 +0000159 /* Assert that malloc() has not failed */
160 assert( !sqlite3ThreadDataReadOnly()->mallocFailed );
danielk1977261919c2005-12-06 12:52:59 +0000161
drh1bcdb0c2004-08-28 14:49:46 +0000162 if( p==0 || p->magic!=VDBE_MAGIC_RUN ){
drh4f26d6c2004-05-26 23:25:30 +0000163 return SQLITE_MISUSE;
164 }
drh91b48aa2004-06-30 11:14:18 +0000165 if( p->aborted ){
166 return SQLITE_ABORT;
167 }
danielk1977a21c6b62005-01-24 10:25:59 +0000168 if( p->pc<=0 && p->expired ){
169 if( p->rc==SQLITE_OK ){
170 p->rc = SQLITE_SCHEMA;
171 }
172 return SQLITE_ERROR;
173 }
drh4f26d6c2004-05-26 23:25:30 +0000174 db = p->db;
175 if( sqlite3SafetyOn(db) ){
176 p->rc = SQLITE_MISUSE;
177 return SQLITE_MISUSE;
178 }
danielk19771d850a72004-05-31 08:26:49 +0000179 if( p->pc<0 ){
drh19e2d372005-08-29 23:00:03 +0000180#ifndef SQLITE_OMIT_TRACE
drhc16a03b2004-09-15 13:38:10 +0000181 /* Invoke the trace callback if there is one
182 */
drh19e2d372005-08-29 23:00:03 +0000183 if( db->xTrace && !db->init.busy ){
drhc16a03b2004-09-15 13:38:10 +0000184 assert( p->nOp>0 );
185 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
186 assert( p->aOp[p->nOp-1].p3!=0 );
187 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
188 sqlite3SafetyOff(db);
189 db->xTrace(db->pTraceArg, p->aOp[p->nOp-1].p3);
190 if( sqlite3SafetyOn(db) ){
191 p->rc = SQLITE_MISUSE;
192 return SQLITE_MISUSE;
193 }
194 }
drh19e2d372005-08-29 23:00:03 +0000195 if( db->xProfile && !db->init.busy ){
196 double rNow;
drh66560ad2006-01-06 14:32:19 +0000197 sqlite3OsCurrentTime(&rNow);
drh19e2d372005-08-29 23:00:03 +0000198 p->startTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0;
199 }
200#endif
drhc16a03b2004-09-15 13:38:10 +0000201
202 /* Print a copy of SQL as it is executed if the SQL_TRACE pragma is turned
203 ** on in debugging mode.
204 */
205#ifdef SQLITE_DEBUG
206 if( (db->flags & SQLITE_SqlTrace)!=0 ){
207 sqlite3DebugPrintf("SQL-trace: %s\n", p->aOp[p->nOp-1].p3);
208 }
209#endif /* SQLITE_DEBUG */
210
danielk19771d850a72004-05-31 08:26:49 +0000211 db->activeVdbeCnt++;
212 p->pc = 0;
213 }
drhb7f91642004-10-31 02:22:47 +0000214#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000215 if( p->explain ){
216 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000217 }else
218#endif /* SQLITE_OMIT_EXPLAIN */
219 {
drh4f26d6c2004-05-26 23:25:30 +0000220 rc = sqlite3VdbeExec(p);
221 }
222
223 if( sqlite3SafetyOff(db) ){
224 rc = SQLITE_MISUSE;
225 }
226
drh19e2d372005-08-29 23:00:03 +0000227#ifndef SQLITE_OMIT_TRACE
228 /* Invoke the profile callback if there is one
229 */
230 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy ){
231 double rNow;
232 u64 elapseTime;
233
drh66560ad2006-01-06 14:32:19 +0000234 sqlite3OsCurrentTime(&rNow);
drh19e2d372005-08-29 23:00:03 +0000235 elapseTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0 - p->startTime;
236 assert( p->nOp>0 );
237 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
238 assert( p->aOp[p->nOp-1].p3!=0 );
239 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
240 db->xProfile(db->pProfileArg, p->aOp[p->nOp-1].p3, elapseTime);
241 }
242#endif
243
drh130b9f42005-08-21 17:48:46 +0000244 sqlite3Error(p->db, rc, p->zErrMsg ? "%s" : 0, p->zErrMsg);
danielk19772e588c72005-12-09 14:25:08 +0000245 sqlite3MallocClearFailed();
drh4f26d6c2004-05-26 23:25:30 +0000246 return rc;
247}
248
249/*
drheb2e1762004-05-27 01:53:56 +0000250** Extract the user data from a sqlite3_context structure and return a
251** pointer to it.
252*/
253void *sqlite3_user_data(sqlite3_context *p){
254 assert( p && p->pFunc );
255 return p->pFunc->pUserData;
256}
257
258/*
259** Allocate or return the aggregate context for a user function. A new
260** context is allocated on the first call. Subsequent calls return the
261** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000262*/
263void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drhabfcea22005-09-06 20:36:48 +0000264 Mem *pMem = p->pMem;
drh825c6622005-09-08 19:01:05 +0000265 assert( p && p->pFunc && p->pFunc->xStep );
drha10a34b2005-09-07 22:09:48 +0000266 if( (pMem->flags & MEM_Agg)==0 ){
267 if( nByte==0 ){
268 assert( pMem->flags==MEM_Null );
269 pMem->z = 0;
drheb2e1762004-05-27 01:53:56 +0000270 }else{
drha10a34b2005-09-07 22:09:48 +0000271 pMem->flags = MEM_Agg;
drh5360ad32005-09-08 00:13:27 +0000272 pMem->xDel = sqlite3FreeX;
drha10a34b2005-09-07 22:09:48 +0000273 *(FuncDef**)&pMem->i = p->pFunc;
274 if( nByte<=NBFS ){
275 pMem->z = pMem->zShort;
276 memset(pMem->z, 0, nByte);
277 }else{
278 pMem->z = sqliteMalloc( nByte );
279 }
drheb2e1762004-05-27 01:53:56 +0000280 }
281 }
drhabfcea22005-09-06 20:36:48 +0000282 return (void*)pMem->z;
drheb2e1762004-05-27 01:53:56 +0000283}
284
285/*
danielk1977682f68b2004-06-05 10:22:17 +0000286** Return the auxilary data pointer, if any, for the iArg'th argument to
287** the user-function defined by pCtx.
288*/
289void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
290 VdbeFunc *pVdbeFunc = pCtx->pVdbeFunc;
291 if( !pVdbeFunc || iArg>=pVdbeFunc->nAux || iArg<0 ){
292 return 0;
293 }
drhf92c7ff2004-06-19 15:40:23 +0000294 return pVdbeFunc->apAux[iArg].pAux;
danielk1977682f68b2004-06-05 10:22:17 +0000295}
296
297/*
298** Set the auxilary data pointer and delete function, for the iArg'th
299** argument to the user-function defined by pCtx. Any previous value is
300** deleted by calling the delete function specified when it was set.
301*/
302void sqlite3_set_auxdata(
303 sqlite3_context *pCtx,
304 int iArg,
305 void *pAux,
306 void (*xDelete)(void*)
307){
308 struct AuxData *pAuxData;
drhf92c7ff2004-06-19 15:40:23 +0000309 VdbeFunc *pVdbeFunc;
danielk1977682f68b2004-06-05 10:22:17 +0000310 if( iArg<0 ) return;
311
drhf92c7ff2004-06-19 15:40:23 +0000312 pVdbeFunc = pCtx->pVdbeFunc;
313 if( !pVdbeFunc || pVdbeFunc->nAux<=iArg ){
314 int nMalloc = sizeof(VdbeFunc) + sizeof(struct AuxData)*iArg;
drh53f733c2005-09-16 02:38:09 +0000315 pVdbeFunc = sqliteRealloc(pVdbeFunc, nMalloc);
drh998da3a2004-06-19 15:22:56 +0000316 if( !pVdbeFunc ) return;
drh53f733c2005-09-16 02:38:09 +0000317 pCtx->pVdbeFunc = pVdbeFunc;
drh0e3d7472004-06-19 17:33:07 +0000318 memset(&pVdbeFunc->apAux[pVdbeFunc->nAux], 0,
319 sizeof(struct AuxData)*(iArg+1-pVdbeFunc->nAux));
drh998da3a2004-06-19 15:22:56 +0000320 pVdbeFunc->nAux = iArg+1;
321 pVdbeFunc->pFunc = pCtx->pFunc;
danielk1977682f68b2004-06-05 10:22:17 +0000322 }
323
drhf92c7ff2004-06-19 15:40:23 +0000324 pAuxData = &pVdbeFunc->apAux[iArg];
danielk1977682f68b2004-06-05 10:22:17 +0000325 if( pAuxData->pAux && pAuxData->xDelete ){
326 pAuxData->xDelete(pAuxData->pAux);
327 }
328 pAuxData->pAux = pAux;
329 pAuxData->xDelete = xDelete;
330}
331
332/*
drheb2e1762004-05-27 01:53:56 +0000333** Return the number of times the Step function of a aggregate has been
334** called.
335**
336** This routine is defined here in vdbe.c because it depends on knowing
337** the internals of the sqlite3_context structure which is only defined in
338** this source file.
339*/
340int sqlite3_aggregate_count(sqlite3_context *p){
341 assert( p && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000342 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000343}
344
345/*
drh4f26d6c2004-05-26 23:25:30 +0000346** Return the number of columns in the result set for the statement pStmt.
347*/
348int sqlite3_column_count(sqlite3_stmt *pStmt){
349 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000350 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000351}
352
353/*
354** Return the number of values available from the current row of the
355** currently executing statement pStmt.
356*/
357int sqlite3_data_count(sqlite3_stmt *pStmt){
358 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000359 if( pVm==0 || !pVm->resOnStack ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000360 return pVm->nResColumn;
361}
362
363
364/*
365** Check to see if column iCol of the given statement is valid. If
366** it is, return a pointer to the Mem for the value of that column.
367** If iCol is not valid, return a pointer to a Mem which has a value
368** of NULL.
369*/
370static Mem *columnMem(sqlite3_stmt *pStmt, int i){
371 Vdbe *pVm = (Vdbe *)pStmt;
372 int vals = sqlite3_data_count(pStmt);
373 if( i>=vals || i<0 ){
374 static Mem nullMem;
375 if( nullMem.flags==0 ){ nullMem.flags = MEM_Null; }
376 sqlite3Error(pVm->db, SQLITE_RANGE, 0);
377 return &nullMem;
378 }
379 return &pVm->pTos[(1-vals)+i];
380}
381
danielk19772e588c72005-12-09 14:25:08 +0000382/*
383** This function is called after invoking an sqlite3_value_XXX function on a
384** column value (i.e. a value returned by evaluating an SQL expression in the
385** select list of a SELECT statement) that may cause a malloc() failure. If
386** malloc() has failed, the threads mallocFailed flag is cleared and the result
387** code of statement pStmt set to SQLITE_NOMEM.
388**
389** Specificly, this is called from within:
390**
391** sqlite3_column_int()
392** sqlite3_column_int64()
393** sqlite3_column_text()
394** sqlite3_column_text16()
395** sqlite3_column_real()
396** sqlite3_column_bytes()
397** sqlite3_column_bytes16()
398**
399** But not for sqlite3_column_blob(), which never calls malloc().
400*/
401static void columnMallocFailure(sqlite3_stmt *pStmt)
402{
403 /* If malloc() failed during an encoding conversion within an
404 ** sqlite3_column_XXX API, then set the return code of the statement to
405 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
406 ** and _finalize() will return NOMEM.
407 */
drh6f7adc82006-01-11 21:41:20 +0000408 if( sqlite3ThreadDataReadOnly()->mallocFailed ){
danielk19772e588c72005-12-09 14:25:08 +0000409 ((Vdbe *)pStmt)->rc = SQLITE_NOMEM;
410 sqlite3MallocClearFailed();
411 }
412}
413
drh4f26d6c2004-05-26 23:25:30 +0000414/**************************** sqlite3_column_ *******************************
415** The following routines are used to access elements of the current row
416** in the result set.
417*/
danielk1977c572ef72004-05-27 09:28:41 +0000418const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000419 const void *val;
420 sqlite3MallocDisallow();
421 val = sqlite3_value_blob( columnMem(pStmt,i) );
422 sqlite3MallocAllow();
423 return val;
danielk1977c572ef72004-05-27 09:28:41 +0000424}
drh4f26d6c2004-05-26 23:25:30 +0000425int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000426 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
427 columnMallocFailure(pStmt);
428 return val;
drh4f26d6c2004-05-26 23:25:30 +0000429}
430int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000431 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
432 columnMallocFailure(pStmt);
433 return val;
drh4f26d6c2004-05-26 23:25:30 +0000434}
435double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000436 double val = sqlite3_value_double( columnMem(pStmt,i) );
437 columnMallocFailure(pStmt);
438 return val;
drh4f26d6c2004-05-26 23:25:30 +0000439}
440int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000441 int val = sqlite3_value_int( columnMem(pStmt,i) );
442 columnMallocFailure(pStmt);
443 return val;
drh4f26d6c2004-05-26 23:25:30 +0000444}
drhefad9992004-06-22 12:13:55 +0000445sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000446 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
447 columnMallocFailure(pStmt);
448 return val;
drh4f26d6c2004-05-26 23:25:30 +0000449}
450const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000451 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
452 columnMallocFailure(pStmt);
453 return val;
drh4f26d6c2004-05-26 23:25:30 +0000454}
drhd1e47332005-06-26 17:55:33 +0000455#if 0
456sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
457 return columnMem(pStmt, i);
458}
459#endif
drh6c626082004-11-14 21:56:29 +0000460#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000461const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000462 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
463 columnMallocFailure(pStmt);
464 return val;
drh4f26d6c2004-05-26 23:25:30 +0000465}
drh6c626082004-11-14 21:56:29 +0000466#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000467int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
468 return sqlite3_value_type( columnMem(pStmt,i) );
469}
470
drh5e2517e2004-09-24 23:59:12 +0000471/*
472** Convert the N-th element of pStmt->pColName[] into a string using
473** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000474**
475** There are up to 5 names for each column. useType determines which
476** name is returned. Here are the names:
477**
478** 0 The column name as it should be displayed for output
479** 1 The datatype name for the column
480** 2 The name of the database that the column derives from
481** 3 The name of the table that the column derives from
482** 4 The name of the table column that the result column derives from
483**
484** If the result is not a simple column reference (if it is an expression
485** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000486*/
487static const void *columnName(
488 sqlite3_stmt *pStmt,
489 int N,
490 const void *(*xFunc)(Mem*),
491 int useType
492){
danielk197700fd9572005-12-07 06:27:43 +0000493 const void *ret;
drh5e2517e2004-09-24 23:59:12 +0000494 Vdbe *p = (Vdbe *)pStmt;
495 int n = sqlite3_column_count(pStmt);
496
497 if( p==0 || N>=n || N<0 ){
498 return 0;
499 }
drhe590fbd2005-05-20 19:36:01 +0000500 N += useType*n;
danielk197700fd9572005-12-07 06:27:43 +0000501 ret = xFunc(&p->aColName[N]);
502
503 /* A malloc may have failed inside of the xFunc() call. If this is the case,
504 ** clear the mallocFailed flag and return NULL.
505 */
danielk19772e588c72005-12-09 14:25:08 +0000506 sqlite3MallocClearFailed();
danielk197700fd9572005-12-07 06:27:43 +0000507 return ret;
drh5e2517e2004-09-24 23:59:12 +0000508}
509
drh4f26d6c2004-05-26 23:25:30 +0000510/*
511** Return the name of the Nth column of the result set returned by SQL
512** statement pStmt.
513*/
514const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
drh5e2517e2004-09-24 23:59:12 +0000515 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 0);
drh4f26d6c2004-05-26 23:25:30 +0000516}
drhe590fbd2005-05-20 19:36:01 +0000517#ifndef SQLITE_OMIT_UTF16
518const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
519 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 0);
520}
521#endif
drh4f26d6c2004-05-26 23:25:30 +0000522
523/*
drh6c626082004-11-14 21:56:29 +0000524** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +0000525** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +0000526*/
527const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
528 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 1);
529}
drh6c626082004-11-14 21:56:29 +0000530#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +0000531const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
drh5e2517e2004-09-24 23:59:12 +0000532 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 1);
drh4f26d6c2004-05-26 23:25:30 +0000533}
drh6c626082004-11-14 21:56:29 +0000534#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000535
drhe590fbd2005-05-20 19:36:01 +0000536#if !defined(SQLITE_OMIT_ORIGIN_NAMES) && 0
537/*
538** Return the name of the database from which a result column derives.
539** NULL is returned if the result column is an expression or constant or
540** anything else which is not an unabiguous reference to a database column.
541*/
542const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
543 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 2);
544}
545#ifndef SQLITE_OMIT_UTF16
546const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
547 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 2);
548}
549#endif /* SQLITE_OMIT_UTF16 */
550
551/*
552** Return the name of the table from which a result column derives.
553** NULL is returned if the result column is an expression or constant or
554** anything else which is not an unabiguous reference to a database column.
555*/
556const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
557 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 3);
558}
559#ifndef SQLITE_OMIT_UTF16
560const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
561 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 3);
562}
563#endif /* SQLITE_OMIT_UTF16 */
564
565/*
566** Return the name of the table column from which a result column derives.
567** NULL is returned if the result column is an expression or constant or
568** anything else which is not an unabiguous reference to a database column.
569*/
570const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
571 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 4);
572}
573#ifndef SQLITE_OMIT_UTF16
574const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
575 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 4);
576}
577#endif /* SQLITE_OMIT_UTF16 */
578#endif /* SQLITE_OMIT_ORIGIN_NAMES */
579
580
581
582
drh4f26d6c2004-05-26 23:25:30 +0000583/******************************* sqlite3_bind_ ***************************
584**
585** Routines used to attach values to wildcards in a compiled SQL statement.
586*/
587/*
588** Unbind the value bound to variable i in virtual machine p. This is the
589** the same as binding a NULL value to the column. If the "i" parameter is
590** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
591**
592** The error code stored in database p->db is overwritten with the return
593** value in any case.
594*/
595static int vdbeUnbind(Vdbe *p, int i){
596 Mem *pVar;
drh1bcdb0c2004-08-28 14:49:46 +0000597 if( p==0 || p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh473d1792005-06-06 17:54:55 +0000598 if( p ) sqlite3Error(p->db, SQLITE_MISUSE, 0);
drh4f26d6c2004-05-26 23:25:30 +0000599 return SQLITE_MISUSE;
600 }
601 if( i<1 || i>p->nVar ){
602 sqlite3Error(p->db, SQLITE_RANGE, 0);
603 return SQLITE_RANGE;
604 }
605 i--;
drh290c1942004-08-21 17:54:45 +0000606 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +0000607 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +0000608 pVar->flags = MEM_Null;
609 sqlite3Error(p->db, SQLITE_OK, 0);
610 return SQLITE_OK;
611}
612
613/*
drh5e2517e2004-09-24 23:59:12 +0000614** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +0000615*/
drh5e2517e2004-09-24 23:59:12 +0000616static int bindText(
drhf4479502004-05-27 03:12:53 +0000617 sqlite3_stmt *pStmt,
drh4f26d6c2004-05-26 23:25:30 +0000618 int i,
619 const void *zData,
620 int nData,
drh5e2517e2004-09-24 23:59:12 +0000621 void (*xDel)(void*),
622 int encoding
drh4f26d6c2004-05-26 23:25:30 +0000623){
624 Vdbe *p = (Vdbe *)pStmt;
625 Mem *pVar;
626 int rc;
627
628 rc = vdbeUnbind(p, i);
drhfeac5f82004-08-01 00:10:45 +0000629 if( rc || zData==0 ){
drh4f26d6c2004-05-26 23:25:30 +0000630 return rc;
631 }
drh290c1942004-08-21 17:54:45 +0000632 pVar = &p->aVar[i-1];
drh5e2517e2004-09-24 23:59:12 +0000633 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
634 if( rc ){
635 return rc;
636 }
637 if( rc==SQLITE_OK && encoding!=0 ){
danielk197714db2662006-01-09 16:12:04 +0000638 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
drh5e2517e2004-09-24 23:59:12 +0000639 }
drh4f26d6c2004-05-26 23:25:30 +0000640 return rc;
641}
drh5e2517e2004-09-24 23:59:12 +0000642
643
644/*
645** Bind a blob value to an SQL statement variable.
646*/
647int sqlite3_bind_blob(
648 sqlite3_stmt *pStmt,
649 int i,
650 const void *zData,
651 int nData,
652 void (*xDel)(void*)
653){
654 return bindText(pStmt, i, zData, nData, xDel, 0);
655}
drh4f26d6c2004-05-26 23:25:30 +0000656int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
657 int rc;
658 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +0000659 rc = vdbeUnbind(p, i);
660 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +0000661 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh4f26d6c2004-05-26 23:25:30 +0000662 }
danielk1977f4618892004-06-28 13:09:11 +0000663 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000664}
665int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +0000666 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +0000667}
drhefad9992004-06-22 12:13:55 +0000668int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +0000669 int rc;
670 Vdbe *p = (Vdbe *)pStmt;
671 rc = vdbeUnbind(p, i);
672 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +0000673 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh4f26d6c2004-05-26 23:25:30 +0000674 }
675 return rc;
676}
677int sqlite3_bind_null(sqlite3_stmt* p, int i){
678 return vdbeUnbind((Vdbe *)p, i);
679}
680int sqlite3_bind_text(
681 sqlite3_stmt *pStmt,
682 int i,
683 const char *zData,
684 int nData,
danielk1977d8123362004-06-12 09:25:12 +0000685 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +0000686){
drh5e2517e2004-09-24 23:59:12 +0000687 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000688}
drh6c626082004-11-14 21:56:29 +0000689#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000690int sqlite3_bind_text16(
691 sqlite3_stmt *pStmt,
692 int i,
693 const void *zData,
694 int nData,
danielk1977d8123362004-06-12 09:25:12 +0000695 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +0000696){
drh5e2517e2004-09-24 23:59:12 +0000697 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000698}
drh6c626082004-11-14 21:56:29 +0000699#endif /* SQLITE_OMIT_UTF16 */
drh75f6a032004-07-15 14:15:00 +0000700
701/*
702** Return the number of wildcards that can be potentially bound to.
703** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +0000704*/
705int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +0000706 Vdbe *p = (Vdbe*)pStmt;
707 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +0000708}
drh895d7472004-08-20 16:02:39 +0000709
710/*
drhfa6bc002004-09-07 16:19:52 +0000711** Create a mapping from variable numbers to variable names
712** in the Vdbe.azVar[] array, if such a mapping does not already
713** exist.
drh895d7472004-08-20 16:02:39 +0000714*/
drhfa6bc002004-09-07 16:19:52 +0000715static void createVarMap(Vdbe *p){
drh895d7472004-08-20 16:02:39 +0000716 if( !p->okVar ){
717 int j;
718 Op *pOp;
719 for(j=0, pOp=p->aOp; j<p->nOp; j++, pOp++){
720 if( pOp->opcode==OP_Variable ){
721 assert( pOp->p1>0 && pOp->p1<=p->nVar );
722 p->azVar[pOp->p1-1] = pOp->p3;
723 }
724 }
725 p->okVar = 1;
726 }
drhfa6bc002004-09-07 16:19:52 +0000727}
728
729/*
730** Return the name of a wildcard parameter. Return NULL if the index
731** is out of range or if the wildcard is unnamed.
732**
733** The result is always UTF-8.
734*/
735const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
736 Vdbe *p = (Vdbe*)pStmt;
737 if( p==0 || i<1 || i>p->nVar ){
738 return 0;
739 }
740 createVarMap(p);
drh895d7472004-08-20 16:02:39 +0000741 return p->azVar[i-1];
742}
drhfa6bc002004-09-07 16:19:52 +0000743
744/*
745** Given a wildcard parameter name, return the index of the variable
746** with that name. If there is no variable with the given name,
747** return 0.
748*/
749int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
750 Vdbe *p = (Vdbe*)pStmt;
751 int i;
752 if( p==0 ){
753 return 0;
754 }
755 createVarMap(p);
drh6a8903c2004-12-10 18:00:04 +0000756 if( zName ){
757 for(i=0; i<p->nVar; i++){
758 const char *z = p->azVar[i];
759 if( z && strcmp(z,zName)==0 ){
760 return i+1;
761 }
drhfa6bc002004-09-07 16:19:52 +0000762 }
763 }
764 return 0;
765}
drhf8db1bc2005-04-22 02:38:37 +0000766
drh51942bc2005-06-12 22:01:42 +0000767/*
drhf8db1bc2005-04-22 02:38:37 +0000768** Transfer all bindings from the first statement over to the second.
769** If the two statements contain a different number of bindings, then
770** an SQLITE_ERROR is returned.
771*/
772int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
773 Vdbe *pFrom = (Vdbe*)pFromStmt;
774 Vdbe *pTo = (Vdbe*)pToStmt;
775 int i, rc = SQLITE_OK;
776 if( (pFrom->magic!=VDBE_MAGIC_RUN && pFrom->magic!=VDBE_MAGIC_HALT)
777 || (pTo->magic!=VDBE_MAGIC_RUN && pTo->magic!=VDBE_MAGIC_HALT) ){
778 return SQLITE_MISUSE;
779 }
780 if( pFrom->nVar!=pTo->nVar ){
781 return SQLITE_ERROR;
782 }
783 for(i=0; rc==SQLITE_OK && i<pFrom->nVar; i++){
784 rc = sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
785 }
786 return rc;
787}
drh51942bc2005-06-12 22:01:42 +0000788
789/*
790** Return the sqlite3* database handle to which the prepared statement given
791** in the argument belongs. This is the same database handle that was
792** the first argument to the sqlite3_prepare() that was used to create
793** the statement in the first place.
794*/
795sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
796 return pStmt ? ((Vdbe*)pStmt)->db : 0;
797}