blob: 9ab0474656f3b63e2180ec220aae510791ad6074 [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**
drhcf85a512006-02-09 18:35:29 +0000338** This function is deprecated. Do not use it for new code. It is
339** provide only to avoid breaking legacy code. New aggregate function
340** implementations should keep their own counts within their aggregate
341** context.
drheb2e1762004-05-27 01:53:56 +0000342*/
343int sqlite3_aggregate_count(sqlite3_context *p){
344 assert( p && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000345 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000346}
347
348/*
drh4f26d6c2004-05-26 23:25:30 +0000349** Return the number of columns in the result set for the statement pStmt.
350*/
351int sqlite3_column_count(sqlite3_stmt *pStmt){
352 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000353 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000354}
355
356/*
357** Return the number of values available from the current row of the
358** currently executing statement pStmt.
359*/
360int sqlite3_data_count(sqlite3_stmt *pStmt){
361 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000362 if( pVm==0 || !pVm->resOnStack ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000363 return pVm->nResColumn;
364}
365
366
367/*
368** Check to see if column iCol of the given statement is valid. If
369** it is, return a pointer to the Mem for the value of that column.
370** If iCol is not valid, return a pointer to a Mem which has a value
371** of NULL.
372*/
373static Mem *columnMem(sqlite3_stmt *pStmt, int i){
374 Vdbe *pVm = (Vdbe *)pStmt;
375 int vals = sqlite3_data_count(pStmt);
376 if( i>=vals || i<0 ){
377 static Mem nullMem;
378 if( nullMem.flags==0 ){ nullMem.flags = MEM_Null; }
379 sqlite3Error(pVm->db, SQLITE_RANGE, 0);
380 return &nullMem;
381 }
382 return &pVm->pTos[(1-vals)+i];
383}
384
danielk19772e588c72005-12-09 14:25:08 +0000385/*
386** This function is called after invoking an sqlite3_value_XXX function on a
387** column value (i.e. a value returned by evaluating an SQL expression in the
388** select list of a SELECT statement) that may cause a malloc() failure. If
389** malloc() has failed, the threads mallocFailed flag is cleared and the result
390** code of statement pStmt set to SQLITE_NOMEM.
391**
392** Specificly, this is called from within:
393**
394** sqlite3_column_int()
395** sqlite3_column_int64()
396** sqlite3_column_text()
397** sqlite3_column_text16()
398** sqlite3_column_real()
399** sqlite3_column_bytes()
400** sqlite3_column_bytes16()
401**
402** But not for sqlite3_column_blob(), which never calls malloc().
403*/
404static void columnMallocFailure(sqlite3_stmt *pStmt)
405{
406 /* If malloc() failed during an encoding conversion within an
407 ** sqlite3_column_XXX API, then set the return code of the statement to
408 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
409 ** and _finalize() will return NOMEM.
410 */
danielk197754f01982006-01-18 15:25:17 +0000411 Vdbe *p = (Vdbe *)pStmt;
412 p->rc = sqlite3ApiExit(0, p->rc);
danielk19772e588c72005-12-09 14:25:08 +0000413}
414
drh4f26d6c2004-05-26 23:25:30 +0000415/**************************** sqlite3_column_ *******************************
416** The following routines are used to access elements of the current row
417** in the result set.
418*/
danielk1977c572ef72004-05-27 09:28:41 +0000419const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000420 const void *val;
421 sqlite3MallocDisallow();
422 val = sqlite3_value_blob( columnMem(pStmt,i) );
423 sqlite3MallocAllow();
424 return val;
danielk1977c572ef72004-05-27 09:28:41 +0000425}
drh4f26d6c2004-05-26 23:25:30 +0000426int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000427 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
428 columnMallocFailure(pStmt);
429 return val;
drh4f26d6c2004-05-26 23:25:30 +0000430}
431int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000432 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
433 columnMallocFailure(pStmt);
434 return val;
drh4f26d6c2004-05-26 23:25:30 +0000435}
436double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000437 double val = sqlite3_value_double( columnMem(pStmt,i) );
438 columnMallocFailure(pStmt);
439 return val;
drh4f26d6c2004-05-26 23:25:30 +0000440}
441int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000442 int val = sqlite3_value_int( columnMem(pStmt,i) );
443 columnMallocFailure(pStmt);
444 return val;
drh4f26d6c2004-05-26 23:25:30 +0000445}
drhefad9992004-06-22 12:13:55 +0000446sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000447 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
448 columnMallocFailure(pStmt);
449 return val;
drh4f26d6c2004-05-26 23:25:30 +0000450}
451const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000452 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
453 columnMallocFailure(pStmt);
454 return val;
drh4f26d6c2004-05-26 23:25:30 +0000455}
drhd1e47332005-06-26 17:55:33 +0000456#if 0
457sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
458 return columnMem(pStmt, i);
459}
460#endif
drh6c626082004-11-14 21:56:29 +0000461#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000462const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000463 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
464 columnMallocFailure(pStmt);
465 return val;
drh4f26d6c2004-05-26 23:25:30 +0000466}
drh6c626082004-11-14 21:56:29 +0000467#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000468int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
469 return sqlite3_value_type( columnMem(pStmt,i) );
470}
471
drh5e2517e2004-09-24 23:59:12 +0000472/*
473** Convert the N-th element of pStmt->pColName[] into a string using
474** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000475**
476** There are up to 5 names for each column. useType determines which
477** name is returned. Here are the names:
478**
479** 0 The column name as it should be displayed for output
480** 1 The datatype name for the column
481** 2 The name of the database that the column derives from
482** 3 The name of the table that the column derives from
483** 4 The name of the table column that the result column derives from
484**
485** If the result is not a simple column reference (if it is an expression
486** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000487*/
488static const void *columnName(
489 sqlite3_stmt *pStmt,
490 int N,
491 const void *(*xFunc)(Mem*),
492 int useType
493){
danielk197700fd9572005-12-07 06:27:43 +0000494 const void *ret;
drh5e2517e2004-09-24 23:59:12 +0000495 Vdbe *p = (Vdbe *)pStmt;
496 int n = sqlite3_column_count(pStmt);
497
498 if( p==0 || N>=n || N<0 ){
499 return 0;
500 }
drhe590fbd2005-05-20 19:36:01 +0000501 N += useType*n;
danielk197700fd9572005-12-07 06:27:43 +0000502 ret = xFunc(&p->aColName[N]);
503
504 /* A malloc may have failed inside of the xFunc() call. If this is the case,
505 ** clear the mallocFailed flag and return NULL.
506 */
danielk197754f01982006-01-18 15:25:17 +0000507 sqlite3ApiExit(0, 0);
danielk197700fd9572005-12-07 06:27:43 +0000508 return ret;
drh5e2517e2004-09-24 23:59:12 +0000509}
510
drh4f26d6c2004-05-26 23:25:30 +0000511/*
512** Return the name of the Nth column of the result set returned by SQL
513** statement pStmt.
514*/
515const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
drh5e2517e2004-09-24 23:59:12 +0000516 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 0);
drh4f26d6c2004-05-26 23:25:30 +0000517}
drhe590fbd2005-05-20 19:36:01 +0000518#ifndef SQLITE_OMIT_UTF16
519const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
520 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 0);
521}
522#endif
drh4f26d6c2004-05-26 23:25:30 +0000523
524/*
drh6c626082004-11-14 21:56:29 +0000525** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +0000526** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +0000527*/
528const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
529 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 1);
530}
drh6c626082004-11-14 21:56:29 +0000531#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +0000532const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
drh5e2517e2004-09-24 23:59:12 +0000533 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 1);
drh4f26d6c2004-05-26 23:25:30 +0000534}
drh6c626082004-11-14 21:56:29 +0000535#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000536
drhe590fbd2005-05-20 19:36:01 +0000537#if !defined(SQLITE_OMIT_ORIGIN_NAMES) && 0
538/*
539** Return the name of the database from which a result column derives.
540** NULL is returned if the result column is an expression or constant or
541** anything else which is not an unabiguous reference to a database column.
542*/
543const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
544 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 2);
545}
546#ifndef SQLITE_OMIT_UTF16
547const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
548 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 2);
549}
550#endif /* SQLITE_OMIT_UTF16 */
551
552/*
553** Return the name of the table from which a result column derives.
554** NULL is returned if the result column is an expression or constant or
555** anything else which is not an unabiguous reference to a database column.
556*/
557const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
558 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 3);
559}
560#ifndef SQLITE_OMIT_UTF16
561const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
562 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 3);
563}
564#endif /* SQLITE_OMIT_UTF16 */
565
566/*
567** Return the name of the table column from which a result column derives.
568** NULL is returned if the result column is an expression or constant or
569** anything else which is not an unabiguous reference to a database column.
570*/
571const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
572 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 4);
573}
574#ifndef SQLITE_OMIT_UTF16
575const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
576 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 4);
577}
578#endif /* SQLITE_OMIT_UTF16 */
579#endif /* SQLITE_OMIT_ORIGIN_NAMES */
580
581
582
583
drh4f26d6c2004-05-26 23:25:30 +0000584/******************************* sqlite3_bind_ ***************************
585**
586** Routines used to attach values to wildcards in a compiled SQL statement.
587*/
588/*
589** Unbind the value bound to variable i in virtual machine p. This is the
590** the same as binding a NULL value to the column. If the "i" parameter is
591** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
592**
593** The error code stored in database p->db is overwritten with the return
594** value in any case.
595*/
596static int vdbeUnbind(Vdbe *p, int i){
597 Mem *pVar;
drh1bcdb0c2004-08-28 14:49:46 +0000598 if( p==0 || p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh473d1792005-06-06 17:54:55 +0000599 if( p ) sqlite3Error(p->db, SQLITE_MISUSE, 0);
drh4f26d6c2004-05-26 23:25:30 +0000600 return SQLITE_MISUSE;
601 }
602 if( i<1 || i>p->nVar ){
603 sqlite3Error(p->db, SQLITE_RANGE, 0);
604 return SQLITE_RANGE;
605 }
606 i--;
drh290c1942004-08-21 17:54:45 +0000607 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +0000608 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +0000609 pVar->flags = MEM_Null;
610 sqlite3Error(p->db, SQLITE_OK, 0);
611 return SQLITE_OK;
612}
613
614/*
drh5e2517e2004-09-24 23:59:12 +0000615** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +0000616*/
drh5e2517e2004-09-24 23:59:12 +0000617static int bindText(
drhf4479502004-05-27 03:12:53 +0000618 sqlite3_stmt *pStmt,
drh4f26d6c2004-05-26 23:25:30 +0000619 int i,
620 const void *zData,
621 int nData,
drh5e2517e2004-09-24 23:59:12 +0000622 void (*xDel)(void*),
623 int encoding
drh4f26d6c2004-05-26 23:25:30 +0000624){
625 Vdbe *p = (Vdbe *)pStmt;
626 Mem *pVar;
627 int rc;
628
629 rc = vdbeUnbind(p, i);
drhfeac5f82004-08-01 00:10:45 +0000630 if( rc || zData==0 ){
drh4f26d6c2004-05-26 23:25:30 +0000631 return rc;
632 }
drh290c1942004-08-21 17:54:45 +0000633 pVar = &p->aVar[i-1];
drh5e2517e2004-09-24 23:59:12 +0000634 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
drh5e2517e2004-09-24 23:59:12 +0000635 if( rc==SQLITE_OK && encoding!=0 ){
danielk197714db2662006-01-09 16:12:04 +0000636 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
drh5e2517e2004-09-24 23:59:12 +0000637 }
danielk197754f01982006-01-18 15:25:17 +0000638
danielk1977771151b2006-01-17 13:21:40 +0000639 sqlite3Error(((Vdbe *)pStmt)->db, rc, 0);
danielk197754f01982006-01-18 15:25:17 +0000640 return sqlite3ApiExit(((Vdbe *)pStmt)->db, rc);
drh4f26d6c2004-05-26 23:25:30 +0000641}
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++){
danielk1977950f0542006-01-18 05:51:57 +0000784 sqlite3MallocDisallow();
drhf8db1bc2005-04-22 02:38:37 +0000785 rc = sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
danielk1977950f0542006-01-18 05:51:57 +0000786 sqlite3MallocAllow();
drhf8db1bc2005-04-22 02:38:37 +0000787 }
788 return rc;
789}
drh51942bc2005-06-12 22:01:42 +0000790
791/*
792** Return the sqlite3* database handle to which the prepared statement given
793** in the argument belongs. This is the same database handle that was
794** the first argument to the sqlite3_prepare() that was used to create
795** the statement in the first place.
796*/
797sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
798 return pStmt ? ((Vdbe*)pStmt)->db : 0;
799}