blob: b9e0526c14111cbc430bf4ffa359926887438ef5 [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}
danielk1977a1686c92006-01-23 07:52:37 +000098#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +000099void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
100 pCtx->isError = 1;
danielk1977d8123362004-06-12 09:25:12 +0000101 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
drh4f26d6c2004-05-26 23:25:30 +0000102}
danielk1977a1686c92006-01-23 07:52:37 +0000103#endif
drhf4479502004-05-27 03:12:53 +0000104void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
drh4f26d6c2004-05-26 23:25:30 +0000105 sqlite3VdbeMemSetInt64(&pCtx->s, (i64)iVal);
106}
107void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
108 sqlite3VdbeMemSetInt64(&pCtx->s, iVal);
109}
110void sqlite3_result_null(sqlite3_context *pCtx){
drhf4479502004-05-27 03:12:53 +0000111 sqlite3VdbeMemSetNull(&pCtx->s);
drh4f26d6c2004-05-26 23:25:30 +0000112}
113void sqlite3_result_text(
114 sqlite3_context *pCtx,
115 const char *z,
116 int n,
danielk1977d8123362004-06-12 09:25:12 +0000117 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000118){
danielk1977d8123362004-06-12 09:25:12 +0000119 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF8, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000120}
drh6c626082004-11-14 21:56:29 +0000121#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000122void sqlite3_result_text16(
123 sqlite3_context *pCtx,
124 const void *z,
125 int n,
danielk1977d8123362004-06-12 09:25:12 +0000126 void (*xDel)(void *)
drh4f26d6c2004-05-26 23:25:30 +0000127){
danielk1977d8123362004-06-12 09:25:12 +0000128 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16NATIVE, xDel);
129}
130void sqlite3_result_text16be(
131 sqlite3_context *pCtx,
132 const void *z,
133 int n,
134 void (*xDel)(void *)
135){
136 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16BE, xDel);
137}
138void sqlite3_result_text16le(
139 sqlite3_context *pCtx,
140 const void *z,
141 int n,
142 void (*xDel)(void *)
143){
144 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16LE, xDel);
drh4f26d6c2004-05-26 23:25:30 +0000145}
drh6c626082004-11-14 21:56:29 +0000146#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000147void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
148 sqlite3VdbeMemCopy(&pCtx->s, pValue);
149}
150
151
152/*
153** Execute the statement pStmt, either until a row of data is ready, the
154** statement is completely executed or an error occurs.
155*/
156int sqlite3_step(sqlite3_stmt *pStmt){
157 Vdbe *p = (Vdbe*)pStmt;
drh9bb575f2004-09-06 17:24:11 +0000158 sqlite3 *db;
drh4f26d6c2004-05-26 23:25:30 +0000159 int rc;
160
danielk1977efaaf572006-01-16 11:29:19 +0000161 /* Assert that malloc() has not failed */
danielk19779e128002006-01-18 16:51:35 +0000162 assert( !sqlite3MallocFailed() );
danielk1977261919c2005-12-06 12:52:59 +0000163
drh1bcdb0c2004-08-28 14:49:46 +0000164 if( p==0 || p->magic!=VDBE_MAGIC_RUN ){
drh4f26d6c2004-05-26 23:25:30 +0000165 return SQLITE_MISUSE;
166 }
drh91b48aa2004-06-30 11:14:18 +0000167 if( p->aborted ){
168 return SQLITE_ABORT;
169 }
danielk1977a21c6b62005-01-24 10:25:59 +0000170 if( p->pc<=0 && p->expired ){
171 if( p->rc==SQLITE_OK ){
172 p->rc = SQLITE_SCHEMA;
173 }
174 return SQLITE_ERROR;
175 }
drh4f26d6c2004-05-26 23:25:30 +0000176 db = p->db;
177 if( sqlite3SafetyOn(db) ){
178 p->rc = SQLITE_MISUSE;
179 return SQLITE_MISUSE;
180 }
danielk19771d850a72004-05-31 08:26:49 +0000181 if( p->pc<0 ){
drh19e2d372005-08-29 23:00:03 +0000182#ifndef SQLITE_OMIT_TRACE
drhc16a03b2004-09-15 13:38:10 +0000183 /* Invoke the trace callback if there is one
184 */
drh19e2d372005-08-29 23:00:03 +0000185 if( db->xTrace && !db->init.busy ){
drhc16a03b2004-09-15 13:38:10 +0000186 assert( p->nOp>0 );
187 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
188 assert( p->aOp[p->nOp-1].p3!=0 );
189 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
190 sqlite3SafetyOff(db);
191 db->xTrace(db->pTraceArg, p->aOp[p->nOp-1].p3);
192 if( sqlite3SafetyOn(db) ){
193 p->rc = SQLITE_MISUSE;
194 return SQLITE_MISUSE;
195 }
196 }
drh19e2d372005-08-29 23:00:03 +0000197 if( db->xProfile && !db->init.busy ){
198 double rNow;
drh66560ad2006-01-06 14:32:19 +0000199 sqlite3OsCurrentTime(&rNow);
drh19e2d372005-08-29 23:00:03 +0000200 p->startTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0;
201 }
202#endif
drhc16a03b2004-09-15 13:38:10 +0000203
204 /* Print a copy of SQL as it is executed if the SQL_TRACE pragma is turned
205 ** on in debugging mode.
206 */
207#ifdef SQLITE_DEBUG
208 if( (db->flags & SQLITE_SqlTrace)!=0 ){
209 sqlite3DebugPrintf("SQL-trace: %s\n", p->aOp[p->nOp-1].p3);
210 }
211#endif /* SQLITE_DEBUG */
212
danielk19771d850a72004-05-31 08:26:49 +0000213 db->activeVdbeCnt++;
214 p->pc = 0;
215 }
drhb7f91642004-10-31 02:22:47 +0000216#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000217 if( p->explain ){
218 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000219 }else
220#endif /* SQLITE_OMIT_EXPLAIN */
221 {
drh4f26d6c2004-05-26 23:25:30 +0000222 rc = sqlite3VdbeExec(p);
223 }
224
225 if( sqlite3SafetyOff(db) ){
226 rc = SQLITE_MISUSE;
227 }
228
drh19e2d372005-08-29 23:00:03 +0000229#ifndef SQLITE_OMIT_TRACE
230 /* Invoke the profile callback if there is one
231 */
232 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy ){
233 double rNow;
234 u64 elapseTime;
235
drh66560ad2006-01-06 14:32:19 +0000236 sqlite3OsCurrentTime(&rNow);
drh19e2d372005-08-29 23:00:03 +0000237 elapseTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0 - p->startTime;
238 assert( p->nOp>0 );
239 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
240 assert( p->aOp[p->nOp-1].p3!=0 );
241 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
242 db->xProfile(db->pProfileArg, p->aOp[p->nOp-1].p3, elapseTime);
243 }
244#endif
245
danielk197797a227c2006-01-20 16:32:04 +0000246 sqlite3Error(p->db, rc, 0);
danielk197776e8d1a2006-01-18 18:22:43 +0000247 p->rc = sqlite3ApiExit(p->db, p->rc);
248 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000249}
250
251/*
drheb2e1762004-05-27 01:53:56 +0000252** Extract the user data from a sqlite3_context structure and return a
253** pointer to it.
254*/
255void *sqlite3_user_data(sqlite3_context *p){
256 assert( p && p->pFunc );
257 return p->pFunc->pUserData;
258}
259
260/*
261** Allocate or return the aggregate context for a user function. A new
262** context is allocated on the first call. Subsequent calls return the
263** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000264*/
265void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drhabfcea22005-09-06 20:36:48 +0000266 Mem *pMem = p->pMem;
drh825c6622005-09-08 19:01:05 +0000267 assert( p && p->pFunc && p->pFunc->xStep );
drha10a34b2005-09-07 22:09:48 +0000268 if( (pMem->flags & MEM_Agg)==0 ){
269 if( nByte==0 ){
270 assert( pMem->flags==MEM_Null );
271 pMem->z = 0;
drheb2e1762004-05-27 01:53:56 +0000272 }else{
drha10a34b2005-09-07 22:09:48 +0000273 pMem->flags = MEM_Agg;
drh5360ad32005-09-08 00:13:27 +0000274 pMem->xDel = sqlite3FreeX;
drha10a34b2005-09-07 22:09:48 +0000275 *(FuncDef**)&pMem->i = p->pFunc;
276 if( nByte<=NBFS ){
277 pMem->z = pMem->zShort;
278 memset(pMem->z, 0, nByte);
279 }else{
280 pMem->z = sqliteMalloc( nByte );
281 }
drheb2e1762004-05-27 01:53:56 +0000282 }
283 }
drhabfcea22005-09-06 20:36:48 +0000284 return (void*)pMem->z;
drheb2e1762004-05-27 01:53:56 +0000285}
286
287/*
danielk1977682f68b2004-06-05 10:22:17 +0000288** Return the auxilary data pointer, if any, for the iArg'th argument to
289** the user-function defined by pCtx.
290*/
291void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
292 VdbeFunc *pVdbeFunc = pCtx->pVdbeFunc;
293 if( !pVdbeFunc || iArg>=pVdbeFunc->nAux || iArg<0 ){
294 return 0;
295 }
drhf92c7ff2004-06-19 15:40:23 +0000296 return pVdbeFunc->apAux[iArg].pAux;
danielk1977682f68b2004-06-05 10:22:17 +0000297}
298
299/*
300** Set the auxilary data pointer and delete function, for the iArg'th
301** argument to the user-function defined by pCtx. Any previous value is
302** deleted by calling the delete function specified when it was set.
303*/
304void sqlite3_set_auxdata(
305 sqlite3_context *pCtx,
306 int iArg,
307 void *pAux,
308 void (*xDelete)(void*)
309){
310 struct AuxData *pAuxData;
drhf92c7ff2004-06-19 15:40:23 +0000311 VdbeFunc *pVdbeFunc;
danielk1977682f68b2004-06-05 10:22:17 +0000312 if( iArg<0 ) return;
313
drhf92c7ff2004-06-19 15:40:23 +0000314 pVdbeFunc = pCtx->pVdbeFunc;
315 if( !pVdbeFunc || pVdbeFunc->nAux<=iArg ){
316 int nMalloc = sizeof(VdbeFunc) + sizeof(struct AuxData)*iArg;
drh53f733c2005-09-16 02:38:09 +0000317 pVdbeFunc = sqliteRealloc(pVdbeFunc, nMalloc);
drh998da3a2004-06-19 15:22:56 +0000318 if( !pVdbeFunc ) return;
drh53f733c2005-09-16 02:38:09 +0000319 pCtx->pVdbeFunc = pVdbeFunc;
drh0e3d7472004-06-19 17:33:07 +0000320 memset(&pVdbeFunc->apAux[pVdbeFunc->nAux], 0,
321 sizeof(struct AuxData)*(iArg+1-pVdbeFunc->nAux));
drh998da3a2004-06-19 15:22:56 +0000322 pVdbeFunc->nAux = iArg+1;
323 pVdbeFunc->pFunc = pCtx->pFunc;
danielk1977682f68b2004-06-05 10:22:17 +0000324 }
325
drhf92c7ff2004-06-19 15:40:23 +0000326 pAuxData = &pVdbeFunc->apAux[iArg];
danielk1977682f68b2004-06-05 10:22:17 +0000327 if( pAuxData->pAux && pAuxData->xDelete ){
328 pAuxData->xDelete(pAuxData->pAux);
329 }
330 pAuxData->pAux = pAux;
331 pAuxData->xDelete = xDelete;
332}
333
334/*
drheb2e1762004-05-27 01:53:56 +0000335** Return the number of times the Step function of a aggregate has been
336** called.
337**
338** This routine is defined here in vdbe.c because it depends on knowing
339** the internals of the sqlite3_context structure which is only defined in
340** this source file.
341*/
342int sqlite3_aggregate_count(sqlite3_context *p){
343 assert( p && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000344 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000345}
346
347/*
drh4f26d6c2004-05-26 23:25:30 +0000348** Return the number of columns in the result set for the statement pStmt.
349*/
350int sqlite3_column_count(sqlite3_stmt *pStmt){
351 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000352 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000353}
354
355/*
356** Return the number of values available from the current row of the
357** currently executing statement pStmt.
358*/
359int sqlite3_data_count(sqlite3_stmt *pStmt){
360 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000361 if( pVm==0 || !pVm->resOnStack ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000362 return pVm->nResColumn;
363}
364
365
366/*
367** Check to see if column iCol of the given statement is valid. If
368** it is, return a pointer to the Mem for the value of that column.
369** If iCol is not valid, return a pointer to a Mem which has a value
370** of NULL.
371*/
372static Mem *columnMem(sqlite3_stmt *pStmt, int i){
373 Vdbe *pVm = (Vdbe *)pStmt;
374 int vals = sqlite3_data_count(pStmt);
375 if( i>=vals || i<0 ){
376 static Mem nullMem;
377 if( nullMem.flags==0 ){ nullMem.flags = MEM_Null; }
378 sqlite3Error(pVm->db, SQLITE_RANGE, 0);
379 return &nullMem;
380 }
381 return &pVm->pTos[(1-vals)+i];
382}
383
danielk19772e588c72005-12-09 14:25:08 +0000384/*
385** This function is called after invoking an sqlite3_value_XXX function on a
386** column value (i.e. a value returned by evaluating an SQL expression in the
387** select list of a SELECT statement) that may cause a malloc() failure. If
388** malloc() has failed, the threads mallocFailed flag is cleared and the result
389** code of statement pStmt set to SQLITE_NOMEM.
390**
391** Specificly, this is called from within:
392**
393** sqlite3_column_int()
394** sqlite3_column_int64()
395** sqlite3_column_text()
396** sqlite3_column_text16()
397** sqlite3_column_real()
398** sqlite3_column_bytes()
399** sqlite3_column_bytes16()
400**
401** But not for sqlite3_column_blob(), which never calls malloc().
402*/
403static void columnMallocFailure(sqlite3_stmt *pStmt)
404{
405 /* If malloc() failed during an encoding conversion within an
406 ** sqlite3_column_XXX API, then set the return code of the statement to
407 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
408 ** and _finalize() will return NOMEM.
409 */
danielk197754f01982006-01-18 15:25:17 +0000410 Vdbe *p = (Vdbe *)pStmt;
411 p->rc = sqlite3ApiExit(0, p->rc);
danielk19772e588c72005-12-09 14:25:08 +0000412}
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 */
danielk197754f01982006-01-18 15:25:17 +0000506 sqlite3ApiExit(0, 0);
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);
drh5e2517e2004-09-24 23:59:12 +0000634 if( rc==SQLITE_OK && encoding!=0 ){
danielk197714db2662006-01-09 16:12:04 +0000635 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
drh5e2517e2004-09-24 23:59:12 +0000636 }
danielk197754f01982006-01-18 15:25:17 +0000637
danielk1977771151b2006-01-17 13:21:40 +0000638 sqlite3Error(((Vdbe *)pStmt)->db, rc, 0);
danielk197754f01982006-01-18 15:25:17 +0000639 return sqlite3ApiExit(((Vdbe *)pStmt)->db, rc);
drh4f26d6c2004-05-26 23:25:30 +0000640}
drh5e2517e2004-09-24 23:59:12 +0000641
642
643/*
644** Bind a blob value to an SQL statement variable.
645*/
646int sqlite3_bind_blob(
647 sqlite3_stmt *pStmt,
648 int i,
649 const void *zData,
650 int nData,
651 void (*xDel)(void*)
652){
653 return bindText(pStmt, i, zData, nData, xDel, 0);
654}
drh4f26d6c2004-05-26 23:25:30 +0000655int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
656 int rc;
657 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +0000658 rc = vdbeUnbind(p, i);
659 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +0000660 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh4f26d6c2004-05-26 23:25:30 +0000661 }
danielk1977f4618892004-06-28 13:09:11 +0000662 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000663}
664int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +0000665 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +0000666}
drhefad9992004-06-22 12:13:55 +0000667int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +0000668 int rc;
669 Vdbe *p = (Vdbe *)pStmt;
670 rc = vdbeUnbind(p, i);
671 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +0000672 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh4f26d6c2004-05-26 23:25:30 +0000673 }
674 return rc;
675}
676int sqlite3_bind_null(sqlite3_stmt* p, int i){
677 return vdbeUnbind((Vdbe *)p, i);
678}
679int sqlite3_bind_text(
680 sqlite3_stmt *pStmt,
681 int i,
682 const char *zData,
683 int nData,
danielk1977d8123362004-06-12 09:25:12 +0000684 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +0000685){
drh5e2517e2004-09-24 23:59:12 +0000686 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000687}
drh6c626082004-11-14 21:56:29 +0000688#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000689int sqlite3_bind_text16(
690 sqlite3_stmt *pStmt,
691 int i,
692 const void *zData,
693 int nData,
danielk1977d8123362004-06-12 09:25:12 +0000694 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +0000695){
drh5e2517e2004-09-24 23:59:12 +0000696 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000697}
drh6c626082004-11-14 21:56:29 +0000698#endif /* SQLITE_OMIT_UTF16 */
drh75f6a032004-07-15 14:15:00 +0000699
700/*
701** Return the number of wildcards that can be potentially bound to.
702** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +0000703*/
704int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +0000705 Vdbe *p = (Vdbe*)pStmt;
706 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +0000707}
drh895d7472004-08-20 16:02:39 +0000708
709/*
drhfa6bc002004-09-07 16:19:52 +0000710** Create a mapping from variable numbers to variable names
711** in the Vdbe.azVar[] array, if such a mapping does not already
712** exist.
drh895d7472004-08-20 16:02:39 +0000713*/
drhfa6bc002004-09-07 16:19:52 +0000714static void createVarMap(Vdbe *p){
drh895d7472004-08-20 16:02:39 +0000715 if( !p->okVar ){
716 int j;
717 Op *pOp;
718 for(j=0, pOp=p->aOp; j<p->nOp; j++, pOp++){
719 if( pOp->opcode==OP_Variable ){
720 assert( pOp->p1>0 && pOp->p1<=p->nVar );
721 p->azVar[pOp->p1-1] = pOp->p3;
722 }
723 }
724 p->okVar = 1;
725 }
drhfa6bc002004-09-07 16:19:52 +0000726}
727
728/*
729** Return the name of a wildcard parameter. Return NULL if the index
730** is out of range or if the wildcard is unnamed.
731**
732** The result is always UTF-8.
733*/
734const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
735 Vdbe *p = (Vdbe*)pStmt;
736 if( p==0 || i<1 || i>p->nVar ){
737 return 0;
738 }
739 createVarMap(p);
drh895d7472004-08-20 16:02:39 +0000740 return p->azVar[i-1];
741}
drhfa6bc002004-09-07 16:19:52 +0000742
743/*
744** Given a wildcard parameter name, return the index of the variable
745** with that name. If there is no variable with the given name,
746** return 0.
747*/
748int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
749 Vdbe *p = (Vdbe*)pStmt;
750 int i;
751 if( p==0 ){
752 return 0;
753 }
754 createVarMap(p);
drh6a8903c2004-12-10 18:00:04 +0000755 if( zName ){
756 for(i=0; i<p->nVar; i++){
757 const char *z = p->azVar[i];
758 if( z && strcmp(z,zName)==0 ){
759 return i+1;
760 }
drhfa6bc002004-09-07 16:19:52 +0000761 }
762 }
763 return 0;
764}
drhf8db1bc2005-04-22 02:38:37 +0000765
drh51942bc2005-06-12 22:01:42 +0000766/*
drhf8db1bc2005-04-22 02:38:37 +0000767** Transfer all bindings from the first statement over to the second.
768** If the two statements contain a different number of bindings, then
769** an SQLITE_ERROR is returned.
770*/
771int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
772 Vdbe *pFrom = (Vdbe*)pFromStmt;
773 Vdbe *pTo = (Vdbe*)pToStmt;
774 int i, rc = SQLITE_OK;
775 if( (pFrom->magic!=VDBE_MAGIC_RUN && pFrom->magic!=VDBE_MAGIC_HALT)
776 || (pTo->magic!=VDBE_MAGIC_RUN && pTo->magic!=VDBE_MAGIC_HALT) ){
777 return SQLITE_MISUSE;
778 }
779 if( pFrom->nVar!=pTo->nVar ){
780 return SQLITE_ERROR;
781 }
782 for(i=0; rc==SQLITE_OK && i<pFrom->nVar; i++){
danielk1977950f0542006-01-18 05:51:57 +0000783 sqlite3MallocDisallow();
drhf8db1bc2005-04-22 02:38:37 +0000784 rc = sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
danielk1977950f0542006-01-18 05:51:57 +0000785 sqlite3MallocAllow();
drhf8db1bc2005-04-22 02:38:37 +0000786 }
787 return rc;
788}
drh51942bc2005-06-12 22:01:42 +0000789
790/*
791** Return the sqlite3* database handle to which the prepared statement given
792** in the argument belongs. This is the same database handle that was
793** the first argument to the sqlite3_prepare() that was used to create
794** the statement in the first place.
795*/
796sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
797 return pStmt ? ((Vdbe*)pStmt)->db : 0;
798}