blob: b0a1c612a5f021e2ef61a805ca4bd7ba4720f5aa [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
danielk1977261919c2005-12-06 12:52:59 +0000159 assert(!sqlite3Tsd()->mallocFailed);
160
drh1bcdb0c2004-08-28 14:49:46 +0000161 if( p==0 || p->magic!=VDBE_MAGIC_RUN ){
drh4f26d6c2004-05-26 23:25:30 +0000162 return SQLITE_MISUSE;
163 }
drh91b48aa2004-06-30 11:14:18 +0000164 if( p->aborted ){
165 return SQLITE_ABORT;
166 }
danielk1977a21c6b62005-01-24 10:25:59 +0000167 if( p->pc<=0 && p->expired ){
168 if( p->rc==SQLITE_OK ){
169 p->rc = SQLITE_SCHEMA;
170 }
171 return SQLITE_ERROR;
172 }
drh4f26d6c2004-05-26 23:25:30 +0000173 db = p->db;
174 if( sqlite3SafetyOn(db) ){
175 p->rc = SQLITE_MISUSE;
176 return SQLITE_MISUSE;
177 }
danielk19771d850a72004-05-31 08:26:49 +0000178 if( p->pc<0 ){
drh19e2d372005-08-29 23:00:03 +0000179#ifndef SQLITE_OMIT_TRACE
drhc16a03b2004-09-15 13:38:10 +0000180 /* Invoke the trace callback if there is one
181 */
drh19e2d372005-08-29 23:00:03 +0000182 if( db->xTrace && !db->init.busy ){
drhc16a03b2004-09-15 13:38:10 +0000183 assert( p->nOp>0 );
184 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
185 assert( p->aOp[p->nOp-1].p3!=0 );
186 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
187 sqlite3SafetyOff(db);
188 db->xTrace(db->pTraceArg, p->aOp[p->nOp-1].p3);
189 if( sqlite3SafetyOn(db) ){
190 p->rc = SQLITE_MISUSE;
191 return SQLITE_MISUSE;
192 }
193 }
drh19e2d372005-08-29 23:00:03 +0000194 if( db->xProfile && !db->init.busy ){
195 double rNow;
drh054889e2005-11-30 03:20:31 +0000196 sqlite3Os.xCurrentTime(&rNow);
drh19e2d372005-08-29 23:00:03 +0000197 p->startTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0;
198 }
199#endif
drhc16a03b2004-09-15 13:38:10 +0000200
201 /* Print a copy of SQL as it is executed if the SQL_TRACE pragma is turned
202 ** on in debugging mode.
203 */
204#ifdef SQLITE_DEBUG
205 if( (db->flags & SQLITE_SqlTrace)!=0 ){
206 sqlite3DebugPrintf("SQL-trace: %s\n", p->aOp[p->nOp-1].p3);
207 }
208#endif /* SQLITE_DEBUG */
209
danielk19771d850a72004-05-31 08:26:49 +0000210 db->activeVdbeCnt++;
211 p->pc = 0;
212 }
drhb7f91642004-10-31 02:22:47 +0000213#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000214 if( p->explain ){
215 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000216 }else
217#endif /* SQLITE_OMIT_EXPLAIN */
218 {
drh4f26d6c2004-05-26 23:25:30 +0000219 rc = sqlite3VdbeExec(p);
220 }
221
222 if( sqlite3SafetyOff(db) ){
223 rc = SQLITE_MISUSE;
224 }
225
drh19e2d372005-08-29 23:00:03 +0000226#ifndef SQLITE_OMIT_TRACE
227 /* Invoke the profile callback if there is one
228 */
229 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy ){
230 double rNow;
231 u64 elapseTime;
232
drh054889e2005-11-30 03:20:31 +0000233 sqlite3Os.xCurrentTime(&rNow);
drh19e2d372005-08-29 23:00:03 +0000234 elapseTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0 - p->startTime;
235 assert( p->nOp>0 );
236 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
237 assert( p->aOp[p->nOp-1].p3!=0 );
238 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
239 db->xProfile(db->pProfileArg, p->aOp[p->nOp-1].p3, elapseTime);
240 }
241#endif
242
drh130b9f42005-08-21 17:48:46 +0000243 sqlite3Error(p->db, rc, p->zErrMsg ? "%s" : 0, p->zErrMsg);
danielk19772e588c72005-12-09 14:25:08 +0000244 sqlite3MallocClearFailed();
drh4f26d6c2004-05-26 23:25:30 +0000245 return rc;
246}
247
248/*
drheb2e1762004-05-27 01:53:56 +0000249** Extract the user data from a sqlite3_context structure and return a
250** pointer to it.
251*/
252void *sqlite3_user_data(sqlite3_context *p){
253 assert( p && p->pFunc );
254 return p->pFunc->pUserData;
255}
256
257/*
258** Allocate or return the aggregate context for a user function. A new
259** context is allocated on the first call. Subsequent calls return the
260** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000261*/
262void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
drhabfcea22005-09-06 20:36:48 +0000263 Mem *pMem = p->pMem;
drh825c6622005-09-08 19:01:05 +0000264 assert( p && p->pFunc && p->pFunc->xStep );
drha10a34b2005-09-07 22:09:48 +0000265 if( (pMem->flags & MEM_Agg)==0 ){
266 if( nByte==0 ){
267 assert( pMem->flags==MEM_Null );
268 pMem->z = 0;
drheb2e1762004-05-27 01:53:56 +0000269 }else{
drha10a34b2005-09-07 22:09:48 +0000270 pMem->flags = MEM_Agg;
drh5360ad32005-09-08 00:13:27 +0000271 pMem->xDel = sqlite3FreeX;
drha10a34b2005-09-07 22:09:48 +0000272 *(FuncDef**)&pMem->i = p->pFunc;
273 if( nByte<=NBFS ){
274 pMem->z = pMem->zShort;
275 memset(pMem->z, 0, nByte);
276 }else{
277 pMem->z = sqliteMalloc( nByte );
278 }
drheb2e1762004-05-27 01:53:56 +0000279 }
280 }
drhabfcea22005-09-06 20:36:48 +0000281 return (void*)pMem->z;
drheb2e1762004-05-27 01:53:56 +0000282}
283
284/*
danielk1977682f68b2004-06-05 10:22:17 +0000285** Return the auxilary data pointer, if any, for the iArg'th argument to
286** the user-function defined by pCtx.
287*/
288void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
289 VdbeFunc *pVdbeFunc = pCtx->pVdbeFunc;
290 if( !pVdbeFunc || iArg>=pVdbeFunc->nAux || iArg<0 ){
291 return 0;
292 }
drhf92c7ff2004-06-19 15:40:23 +0000293 return pVdbeFunc->apAux[iArg].pAux;
danielk1977682f68b2004-06-05 10:22:17 +0000294}
295
296/*
297** Set the auxilary data pointer and delete function, for the iArg'th
298** argument to the user-function defined by pCtx. Any previous value is
299** deleted by calling the delete function specified when it was set.
300*/
301void sqlite3_set_auxdata(
302 sqlite3_context *pCtx,
303 int iArg,
304 void *pAux,
305 void (*xDelete)(void*)
306){
307 struct AuxData *pAuxData;
drhf92c7ff2004-06-19 15:40:23 +0000308 VdbeFunc *pVdbeFunc;
danielk1977682f68b2004-06-05 10:22:17 +0000309 if( iArg<0 ) return;
310
drhf92c7ff2004-06-19 15:40:23 +0000311 pVdbeFunc = pCtx->pVdbeFunc;
312 if( !pVdbeFunc || pVdbeFunc->nAux<=iArg ){
313 int nMalloc = sizeof(VdbeFunc) + sizeof(struct AuxData)*iArg;
drh53f733c2005-09-16 02:38:09 +0000314 pVdbeFunc = sqliteRealloc(pVdbeFunc, nMalloc);
drh998da3a2004-06-19 15:22:56 +0000315 if( !pVdbeFunc ) return;
drh53f733c2005-09-16 02:38:09 +0000316 pCtx->pVdbeFunc = pVdbeFunc;
drh0e3d7472004-06-19 17:33:07 +0000317 memset(&pVdbeFunc->apAux[pVdbeFunc->nAux], 0,
318 sizeof(struct AuxData)*(iArg+1-pVdbeFunc->nAux));
drh998da3a2004-06-19 15:22:56 +0000319 pVdbeFunc->nAux = iArg+1;
320 pVdbeFunc->pFunc = pCtx->pFunc;
danielk1977682f68b2004-06-05 10:22:17 +0000321 }
322
drhf92c7ff2004-06-19 15:40:23 +0000323 pAuxData = &pVdbeFunc->apAux[iArg];
danielk1977682f68b2004-06-05 10:22:17 +0000324 if( pAuxData->pAux && pAuxData->xDelete ){
325 pAuxData->xDelete(pAuxData->pAux);
326 }
327 pAuxData->pAux = pAux;
328 pAuxData->xDelete = xDelete;
329}
330
331/*
drheb2e1762004-05-27 01:53:56 +0000332** Return the number of times the Step function of a aggregate has been
333** called.
334**
335** This routine is defined here in vdbe.c because it depends on knowing
336** the internals of the sqlite3_context structure which is only defined in
337** this source file.
338*/
339int sqlite3_aggregate_count(sqlite3_context *p){
340 assert( p && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000341 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000342}
343
344/*
drh4f26d6c2004-05-26 23:25:30 +0000345** Return the number of columns in the result set for the statement pStmt.
346*/
347int sqlite3_column_count(sqlite3_stmt *pStmt){
348 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000349 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000350}
351
352/*
353** Return the number of values available from the current row of the
354** currently executing statement pStmt.
355*/
356int sqlite3_data_count(sqlite3_stmt *pStmt){
357 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000358 if( pVm==0 || !pVm->resOnStack ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000359 return pVm->nResColumn;
360}
361
362
363/*
364** Check to see if column iCol of the given statement is valid. If
365** it is, return a pointer to the Mem for the value of that column.
366** If iCol is not valid, return a pointer to a Mem which has a value
367** of NULL.
368*/
369static Mem *columnMem(sqlite3_stmt *pStmt, int i){
370 Vdbe *pVm = (Vdbe *)pStmt;
371 int vals = sqlite3_data_count(pStmt);
372 if( i>=vals || i<0 ){
373 static Mem nullMem;
374 if( nullMem.flags==0 ){ nullMem.flags = MEM_Null; }
375 sqlite3Error(pVm->db, SQLITE_RANGE, 0);
376 return &nullMem;
377 }
378 return &pVm->pTos[(1-vals)+i];
379}
380
danielk19772e588c72005-12-09 14:25:08 +0000381/*
382** This function is called after invoking an sqlite3_value_XXX function on a
383** column value (i.e. a value returned by evaluating an SQL expression in the
384** select list of a SELECT statement) that may cause a malloc() failure. If
385** malloc() has failed, the threads mallocFailed flag is cleared and the result
386** code of statement pStmt set to SQLITE_NOMEM.
387**
388** Specificly, this is called from within:
389**
390** sqlite3_column_int()
391** sqlite3_column_int64()
392** sqlite3_column_text()
393** sqlite3_column_text16()
394** sqlite3_column_real()
395** sqlite3_column_bytes()
396** sqlite3_column_bytes16()
397**
398** But not for sqlite3_column_blob(), which never calls malloc().
399*/
400static void columnMallocFailure(sqlite3_stmt *pStmt)
401{
402 /* If malloc() failed during an encoding conversion within an
403 ** sqlite3_column_XXX API, then set the return code of the statement to
404 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
405 ** and _finalize() will return NOMEM.
406 */
407 if( sqlite3Tsd()->mallocFailed ){
408 ((Vdbe *)pStmt)->rc = SQLITE_NOMEM;
409 sqlite3MallocClearFailed();
410 }
411}
412
drh4f26d6c2004-05-26 23:25:30 +0000413/**************************** sqlite3_column_ *******************************
414** The following routines are used to access elements of the current row
415** in the result set.
416*/
danielk1977c572ef72004-05-27 09:28:41 +0000417const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000418 const void *val;
419 sqlite3MallocDisallow();
420 val = sqlite3_value_blob( columnMem(pStmt,i) );
421 sqlite3MallocAllow();
422 return val;
danielk1977c572ef72004-05-27 09:28:41 +0000423}
drh4f26d6c2004-05-26 23:25:30 +0000424int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000425 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
426 columnMallocFailure(pStmt);
427 return val;
drh4f26d6c2004-05-26 23:25:30 +0000428}
429int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000430 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
431 columnMallocFailure(pStmt);
432 return val;
drh4f26d6c2004-05-26 23:25:30 +0000433}
434double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000435 double val = sqlite3_value_double( columnMem(pStmt,i) );
436 columnMallocFailure(pStmt);
437 return val;
drh4f26d6c2004-05-26 23:25:30 +0000438}
439int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000440 int val = sqlite3_value_int( columnMem(pStmt,i) );
441 columnMallocFailure(pStmt);
442 return val;
drh4f26d6c2004-05-26 23:25:30 +0000443}
drhefad9992004-06-22 12:13:55 +0000444sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000445 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
446 columnMallocFailure(pStmt);
447 return val;
drh4f26d6c2004-05-26 23:25:30 +0000448}
449const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000450 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
451 columnMallocFailure(pStmt);
452 return val;
drh4f26d6c2004-05-26 23:25:30 +0000453}
drhd1e47332005-06-26 17:55:33 +0000454#if 0
455sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
456 return columnMem(pStmt, i);
457}
458#endif
drh6c626082004-11-14 21:56:29 +0000459#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000460const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
danielk19772e588c72005-12-09 14:25:08 +0000461 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
462 columnMallocFailure(pStmt);
463 return val;
drh4f26d6c2004-05-26 23:25:30 +0000464}
drh6c626082004-11-14 21:56:29 +0000465#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000466int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
467 return sqlite3_value_type( columnMem(pStmt,i) );
468}
469
drh5e2517e2004-09-24 23:59:12 +0000470/*
471** Convert the N-th element of pStmt->pColName[] into a string using
472** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000473**
474** There are up to 5 names for each column. useType determines which
475** name is returned. Here are the names:
476**
477** 0 The column name as it should be displayed for output
478** 1 The datatype name for the column
479** 2 The name of the database that the column derives from
480** 3 The name of the table that the column derives from
481** 4 The name of the table column that the result column derives from
482**
483** If the result is not a simple column reference (if it is an expression
484** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000485*/
486static const void *columnName(
487 sqlite3_stmt *pStmt,
488 int N,
489 const void *(*xFunc)(Mem*),
490 int useType
491){
danielk197700fd9572005-12-07 06:27:43 +0000492 const void *ret;
drh5e2517e2004-09-24 23:59:12 +0000493 Vdbe *p = (Vdbe *)pStmt;
494 int n = sqlite3_column_count(pStmt);
495
496 if( p==0 || N>=n || N<0 ){
497 return 0;
498 }
drhe590fbd2005-05-20 19:36:01 +0000499 N += useType*n;
danielk197700fd9572005-12-07 06:27:43 +0000500 ret = xFunc(&p->aColName[N]);
501
502 /* A malloc may have failed inside of the xFunc() call. If this is the case,
503 ** clear the mallocFailed flag and return NULL.
504 */
danielk19772e588c72005-12-09 14:25:08 +0000505 sqlite3MallocClearFailed();
danielk197700fd9572005-12-07 06:27:43 +0000506 return ret;
drh5e2517e2004-09-24 23:59:12 +0000507}
508
drh4f26d6c2004-05-26 23:25:30 +0000509/*
510** Return the name of the Nth column of the result set returned by SQL
511** statement pStmt.
512*/
513const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
drh5e2517e2004-09-24 23:59:12 +0000514 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 0);
drh4f26d6c2004-05-26 23:25:30 +0000515}
drhe590fbd2005-05-20 19:36:01 +0000516#ifndef SQLITE_OMIT_UTF16
517const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
518 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 0);
519}
520#endif
drh4f26d6c2004-05-26 23:25:30 +0000521
522/*
drh6c626082004-11-14 21:56:29 +0000523** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +0000524** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +0000525*/
526const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
527 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 1);
528}
drh6c626082004-11-14 21:56:29 +0000529#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +0000530const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
drh5e2517e2004-09-24 23:59:12 +0000531 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 1);
drh4f26d6c2004-05-26 23:25:30 +0000532}
drh6c626082004-11-14 21:56:29 +0000533#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000534
drhe590fbd2005-05-20 19:36:01 +0000535#if !defined(SQLITE_OMIT_ORIGIN_NAMES) && 0
536/*
537** Return the name of the database from which a result column derives.
538** NULL is returned if the result column is an expression or constant or
539** anything else which is not an unabiguous reference to a database column.
540*/
541const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
542 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 2);
543}
544#ifndef SQLITE_OMIT_UTF16
545const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
546 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 2);
547}
548#endif /* SQLITE_OMIT_UTF16 */
549
550/*
551** Return the name of the table from which a result column derives.
552** NULL is returned if the result column is an expression or constant or
553** anything else which is not an unabiguous reference to a database column.
554*/
555const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
556 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 3);
557}
558#ifndef SQLITE_OMIT_UTF16
559const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
560 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 3);
561}
562#endif /* SQLITE_OMIT_UTF16 */
563
564/*
565** Return the name of the table column from which a result column derives.
566** NULL is returned if the result column is an expression or constant or
567** anything else which is not an unabiguous reference to a database column.
568*/
569const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
570 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 4);
571}
572#ifndef SQLITE_OMIT_UTF16
573const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
574 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 4);
575}
576#endif /* SQLITE_OMIT_UTF16 */
577#endif /* SQLITE_OMIT_ORIGIN_NAMES */
578
579
580
581
drh4f26d6c2004-05-26 23:25:30 +0000582/******************************* sqlite3_bind_ ***************************
583**
584** Routines used to attach values to wildcards in a compiled SQL statement.
585*/
586/*
587** Unbind the value bound to variable i in virtual machine p. This is the
588** the same as binding a NULL value to the column. If the "i" parameter is
589** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
590**
591** The error code stored in database p->db is overwritten with the return
592** value in any case.
593*/
594static int vdbeUnbind(Vdbe *p, int i){
595 Mem *pVar;
drh1bcdb0c2004-08-28 14:49:46 +0000596 if( p==0 || p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh473d1792005-06-06 17:54:55 +0000597 if( p ) sqlite3Error(p->db, SQLITE_MISUSE, 0);
drh4f26d6c2004-05-26 23:25:30 +0000598 return SQLITE_MISUSE;
599 }
600 if( i<1 || i>p->nVar ){
601 sqlite3Error(p->db, SQLITE_RANGE, 0);
602 return SQLITE_RANGE;
603 }
604 i--;
drh290c1942004-08-21 17:54:45 +0000605 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +0000606 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +0000607 pVar->flags = MEM_Null;
608 sqlite3Error(p->db, SQLITE_OK, 0);
609 return SQLITE_OK;
610}
611
612/*
drh5e2517e2004-09-24 23:59:12 +0000613** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +0000614*/
drh5e2517e2004-09-24 23:59:12 +0000615static int bindText(
drhf4479502004-05-27 03:12:53 +0000616 sqlite3_stmt *pStmt,
drh4f26d6c2004-05-26 23:25:30 +0000617 int i,
618 const void *zData,
619 int nData,
drh5e2517e2004-09-24 23:59:12 +0000620 void (*xDel)(void*),
621 int encoding
drh4f26d6c2004-05-26 23:25:30 +0000622){
623 Vdbe *p = (Vdbe *)pStmt;
624 Mem *pVar;
625 int rc;
626
627 rc = vdbeUnbind(p, i);
drhfeac5f82004-08-01 00:10:45 +0000628 if( rc || zData==0 ){
drh4f26d6c2004-05-26 23:25:30 +0000629 return rc;
630 }
drh290c1942004-08-21 17:54:45 +0000631 pVar = &p->aVar[i-1];
drh5e2517e2004-09-24 23:59:12 +0000632 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
633 if( rc ){
634 return rc;
635 }
636 if( rc==SQLITE_OK && encoding!=0 ){
637 rc = sqlite3VdbeChangeEncoding(pVar, p->db->enc);
638 }
drh4f26d6c2004-05-26 23:25:30 +0000639 return rc;
640}
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++){
783 rc = sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
784 }
785 return rc;
786}
drh51942bc2005-06-12 22:01:42 +0000787
788/*
789** Return the sqlite3* database handle to which the prepared statement given
790** in the argument belongs. This is the same database handle that was
791** the first argument to the sqlite3_prepare() that was used to create
792** the statement in the first place.
793*/
794sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
795 return pStmt ? ((Vdbe*)pStmt)->db : 0;
796}