blob: 2d94ba0a989617cac6efe71d6307d66bcf63ef2c [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){
danielk1977dc8453f2004-06-12 00:42:34 +000061 return (const 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
drh1bcdb0c2004-08-28 14:49:46 +0000159 if( p==0 || p->magic!=VDBE_MAGIC_RUN ){
drh4f26d6c2004-05-26 23:25:30 +0000160 return SQLITE_MISUSE;
161 }
drh91b48aa2004-06-30 11:14:18 +0000162 if( p->aborted ){
163 return SQLITE_ABORT;
164 }
danielk1977a21c6b62005-01-24 10:25:59 +0000165 if( p->pc<=0 && p->expired ){
166 if( p->rc==SQLITE_OK ){
167 p->rc = SQLITE_SCHEMA;
168 }
169 return SQLITE_ERROR;
170 }
drh4f26d6c2004-05-26 23:25:30 +0000171 db = p->db;
172 if( sqlite3SafetyOn(db) ){
173 p->rc = SQLITE_MISUSE;
174 return SQLITE_MISUSE;
175 }
danielk19771d850a72004-05-31 08:26:49 +0000176 if( p->pc<0 ){
drh19e2d372005-08-29 23:00:03 +0000177#ifndef SQLITE_OMIT_TRACE
drhc16a03b2004-09-15 13:38:10 +0000178 /* Invoke the trace callback if there is one
179 */
drh19e2d372005-08-29 23:00:03 +0000180 if( db->xTrace && !db->init.busy ){
drhc16a03b2004-09-15 13:38:10 +0000181 assert( p->nOp>0 );
182 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
183 assert( p->aOp[p->nOp-1].p3!=0 );
184 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
185 sqlite3SafetyOff(db);
186 db->xTrace(db->pTraceArg, p->aOp[p->nOp-1].p3);
187 if( sqlite3SafetyOn(db) ){
188 p->rc = SQLITE_MISUSE;
189 return SQLITE_MISUSE;
190 }
191 }
drh19e2d372005-08-29 23:00:03 +0000192 if( db->xProfile && !db->init.busy ){
193 double rNow;
194 sqlite3OsCurrentTime(&rNow);
195 p->startTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0;
196 }
197#endif
drhc16a03b2004-09-15 13:38:10 +0000198
199 /* Print a copy of SQL as it is executed if the SQL_TRACE pragma is turned
200 ** on in debugging mode.
201 */
202#ifdef SQLITE_DEBUG
203 if( (db->flags & SQLITE_SqlTrace)!=0 ){
204 sqlite3DebugPrintf("SQL-trace: %s\n", p->aOp[p->nOp-1].p3);
205 }
206#endif /* SQLITE_DEBUG */
207
danielk19771d850a72004-05-31 08:26:49 +0000208 db->activeVdbeCnt++;
209 p->pc = 0;
210 }
drhb7f91642004-10-31 02:22:47 +0000211#ifndef SQLITE_OMIT_EXPLAIN
drh4f26d6c2004-05-26 23:25:30 +0000212 if( p->explain ){
213 rc = sqlite3VdbeList(p);
drhb7f91642004-10-31 02:22:47 +0000214 }else
215#endif /* SQLITE_OMIT_EXPLAIN */
216 {
drh4f26d6c2004-05-26 23:25:30 +0000217 rc = sqlite3VdbeExec(p);
218 }
219
220 if( sqlite3SafetyOff(db) ){
221 rc = SQLITE_MISUSE;
222 }
223
drh19e2d372005-08-29 23:00:03 +0000224#ifndef SQLITE_OMIT_TRACE
225 /* Invoke the profile callback if there is one
226 */
227 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy ){
228 double rNow;
229 u64 elapseTime;
230
231 sqlite3OsCurrentTime(&rNow);
232 elapseTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0 - p->startTime;
233 assert( p->nOp>0 );
234 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
235 assert( p->aOp[p->nOp-1].p3!=0 );
236 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
237 db->xProfile(db->pProfileArg, p->aOp[p->nOp-1].p3, elapseTime);
238 }
239#endif
240
drh130b9f42005-08-21 17:48:46 +0000241 sqlite3Error(p->db, rc, p->zErrMsg ? "%s" : 0, p->zErrMsg);
drh4f26d6c2004-05-26 23:25:30 +0000242 return rc;
243}
244
245/*
drheb2e1762004-05-27 01:53:56 +0000246** Extract the user data from a sqlite3_context structure and return a
247** pointer to it.
248*/
249void *sqlite3_user_data(sqlite3_context *p){
250 assert( p && p->pFunc );
251 return p->pFunc->pUserData;
252}
253
254/*
255** Allocate or return the aggregate context for a user function. A new
256** context is allocated on the first call. Subsequent calls return the
257** same context that was returned on prior calls.
drheb2e1762004-05-27 01:53:56 +0000258*/
259void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
260 assert( p && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000261 Mem *pMem = p->pMem;
drha10a34b2005-09-07 22:09:48 +0000262 if( (pMem->flags & MEM_Agg)==0 ){
263 if( nByte==0 ){
264 assert( pMem->flags==MEM_Null );
265 pMem->z = 0;
drheb2e1762004-05-27 01:53:56 +0000266 }else{
drha10a34b2005-09-07 22:09:48 +0000267 pMem->flags = MEM_Agg;
268 *(FuncDef**)&pMem->i = p->pFunc;
269 if( nByte<=NBFS ){
270 pMem->z = pMem->zShort;
271 memset(pMem->z, 0, nByte);
272 }else{
273 pMem->z = sqliteMalloc( nByte );
274 }
drheb2e1762004-05-27 01:53:56 +0000275 }
276 }
drhabfcea22005-09-06 20:36:48 +0000277 return (void*)pMem->z;
drheb2e1762004-05-27 01:53:56 +0000278}
279
280/*
danielk1977682f68b2004-06-05 10:22:17 +0000281** Return the auxilary data pointer, if any, for the iArg'th argument to
282** the user-function defined by pCtx.
283*/
284void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
285 VdbeFunc *pVdbeFunc = pCtx->pVdbeFunc;
286 if( !pVdbeFunc || iArg>=pVdbeFunc->nAux || iArg<0 ){
287 return 0;
288 }
drhf92c7ff2004-06-19 15:40:23 +0000289 return pVdbeFunc->apAux[iArg].pAux;
danielk1977682f68b2004-06-05 10:22:17 +0000290}
291
292/*
293** Set the auxilary data pointer and delete function, for the iArg'th
294** argument to the user-function defined by pCtx. Any previous value is
295** deleted by calling the delete function specified when it was set.
296*/
297void sqlite3_set_auxdata(
298 sqlite3_context *pCtx,
299 int iArg,
300 void *pAux,
301 void (*xDelete)(void*)
302){
303 struct AuxData *pAuxData;
drhf92c7ff2004-06-19 15:40:23 +0000304 VdbeFunc *pVdbeFunc;
danielk1977682f68b2004-06-05 10:22:17 +0000305 if( iArg<0 ) return;
306
drhf92c7ff2004-06-19 15:40:23 +0000307 pVdbeFunc = pCtx->pVdbeFunc;
308 if( !pVdbeFunc || pVdbeFunc->nAux<=iArg ){
309 int nMalloc = sizeof(VdbeFunc) + sizeof(struct AuxData)*iArg;
310 pCtx->pVdbeFunc = pVdbeFunc = sqliteRealloc(pVdbeFunc, nMalloc);
drh998da3a2004-06-19 15:22:56 +0000311 if( !pVdbeFunc ) return;
drh0e3d7472004-06-19 17:33:07 +0000312 memset(&pVdbeFunc->apAux[pVdbeFunc->nAux], 0,
313 sizeof(struct AuxData)*(iArg+1-pVdbeFunc->nAux));
drh998da3a2004-06-19 15:22:56 +0000314 pVdbeFunc->nAux = iArg+1;
315 pVdbeFunc->pFunc = pCtx->pFunc;
danielk1977682f68b2004-06-05 10:22:17 +0000316 }
317
drhf92c7ff2004-06-19 15:40:23 +0000318 pAuxData = &pVdbeFunc->apAux[iArg];
danielk1977682f68b2004-06-05 10:22:17 +0000319 if( pAuxData->pAux && pAuxData->xDelete ){
320 pAuxData->xDelete(pAuxData->pAux);
321 }
322 pAuxData->pAux = pAux;
323 pAuxData->xDelete = xDelete;
324}
325
326/*
drheb2e1762004-05-27 01:53:56 +0000327** Return the number of times the Step function of a aggregate has been
328** called.
329**
330** This routine is defined here in vdbe.c because it depends on knowing
331** the internals of the sqlite3_context structure which is only defined in
332** this source file.
333*/
334int sqlite3_aggregate_count(sqlite3_context *p){
335 assert( p && p->pFunc && p->pFunc->xStep );
drhabfcea22005-09-06 20:36:48 +0000336 return p->pMem->n;
drheb2e1762004-05-27 01:53:56 +0000337}
338
339/*
drh4f26d6c2004-05-26 23:25:30 +0000340** Return the number of columns in the result set for the statement pStmt.
341*/
342int sqlite3_column_count(sqlite3_stmt *pStmt){
343 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000344 return pVm ? pVm->nResColumn : 0;
drh4f26d6c2004-05-26 23:25:30 +0000345}
346
347/*
348** Return the number of values available from the current row of the
349** currently executing statement pStmt.
350*/
351int sqlite3_data_count(sqlite3_stmt *pStmt){
352 Vdbe *pVm = (Vdbe *)pStmt;
drh1bcdb0c2004-08-28 14:49:46 +0000353 if( pVm==0 || !pVm->resOnStack ) return 0;
drh4f26d6c2004-05-26 23:25:30 +0000354 return pVm->nResColumn;
355}
356
357
358/*
359** Check to see if column iCol of the given statement is valid. If
360** it is, return a pointer to the Mem for the value of that column.
361** If iCol is not valid, return a pointer to a Mem which has a value
362** of NULL.
363*/
364static Mem *columnMem(sqlite3_stmt *pStmt, int i){
365 Vdbe *pVm = (Vdbe *)pStmt;
366 int vals = sqlite3_data_count(pStmt);
367 if( i>=vals || i<0 ){
368 static Mem nullMem;
369 if( nullMem.flags==0 ){ nullMem.flags = MEM_Null; }
370 sqlite3Error(pVm->db, SQLITE_RANGE, 0);
371 return &nullMem;
372 }
373 return &pVm->pTos[(1-vals)+i];
374}
375
376/**************************** sqlite3_column_ *******************************
377** The following routines are used to access elements of the current row
378** in the result set.
379*/
danielk1977c572ef72004-05-27 09:28:41 +0000380const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
381 return sqlite3_value_blob( columnMem(pStmt,i) );
382}
drh4f26d6c2004-05-26 23:25:30 +0000383int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
384 return sqlite3_value_bytes( columnMem(pStmt,i) );
385}
386int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
387 return sqlite3_value_bytes16( columnMem(pStmt,i) );
388}
389double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
390 return sqlite3_value_double( columnMem(pStmt,i) );
391}
392int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
393 return sqlite3_value_int( columnMem(pStmt,i) );
394}
drhefad9992004-06-22 12:13:55 +0000395sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
drh4f26d6c2004-05-26 23:25:30 +0000396 return sqlite3_value_int64( columnMem(pStmt,i) );
397}
398const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
399 return sqlite3_value_text( columnMem(pStmt,i) );
400}
drhd1e47332005-06-26 17:55:33 +0000401#if 0
402sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
403 return columnMem(pStmt, i);
404}
405#endif
drh6c626082004-11-14 21:56:29 +0000406#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000407const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
408 return sqlite3_value_text16( columnMem(pStmt,i) );
409}
drh6c626082004-11-14 21:56:29 +0000410#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000411int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
412 return sqlite3_value_type( columnMem(pStmt,i) );
413}
414
drh5e2517e2004-09-24 23:59:12 +0000415/*
416** Convert the N-th element of pStmt->pColName[] into a string using
417** xFunc() then return that string. If N is out of range, return 0.
drhe590fbd2005-05-20 19:36:01 +0000418**
419** There are up to 5 names for each column. useType determines which
420** name is returned. Here are the names:
421**
422** 0 The column name as it should be displayed for output
423** 1 The datatype name for the column
424** 2 The name of the database that the column derives from
425** 3 The name of the table that the column derives from
426** 4 The name of the table column that the result column derives from
427**
428** If the result is not a simple column reference (if it is an expression
429** or a constant) then useTypes 2, 3, and 4 return NULL.
drh5e2517e2004-09-24 23:59:12 +0000430*/
431static const void *columnName(
432 sqlite3_stmt *pStmt,
433 int N,
434 const void *(*xFunc)(Mem*),
435 int useType
436){
437 Vdbe *p = (Vdbe *)pStmt;
438 int n = sqlite3_column_count(pStmt);
439
440 if( p==0 || N>=n || N<0 ){
441 return 0;
442 }
drhe590fbd2005-05-20 19:36:01 +0000443 N += useType*n;
drh5e2517e2004-09-24 23:59:12 +0000444 return xFunc(&p->aColName[N]);
445}
446
drh4f26d6c2004-05-26 23:25:30 +0000447
448/*
449** Return the name of the Nth column of the result set returned by SQL
450** statement pStmt.
451*/
452const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
drh5e2517e2004-09-24 23:59:12 +0000453 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 0);
drh4f26d6c2004-05-26 23:25:30 +0000454}
drhe590fbd2005-05-20 19:36:01 +0000455#ifndef SQLITE_OMIT_UTF16
456const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
457 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 0);
458}
459#endif
drh4f26d6c2004-05-26 23:25:30 +0000460
461/*
drh6c626082004-11-14 21:56:29 +0000462** Return the column declaration type (if applicable) of the 'i'th column
drhe590fbd2005-05-20 19:36:01 +0000463** of the result set of SQL statement pStmt.
drh6c626082004-11-14 21:56:29 +0000464*/
465const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
466 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 1);
467}
drh6c626082004-11-14 21:56:29 +0000468#ifndef SQLITE_OMIT_UTF16
danielk197776d505b2004-05-28 13:13:02 +0000469const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
drh5e2517e2004-09-24 23:59:12 +0000470 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 1);
drh4f26d6c2004-05-26 23:25:30 +0000471}
drh6c626082004-11-14 21:56:29 +0000472#endif /* SQLITE_OMIT_UTF16 */
drh4f26d6c2004-05-26 23:25:30 +0000473
drhe590fbd2005-05-20 19:36:01 +0000474#if !defined(SQLITE_OMIT_ORIGIN_NAMES) && 0
475/*
476** Return the name of the database from which a result column derives.
477** NULL is returned if the result column is an expression or constant or
478** anything else which is not an unabiguous reference to a database column.
479*/
480const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
481 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 2);
482}
483#ifndef SQLITE_OMIT_UTF16
484const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
485 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 2);
486}
487#endif /* SQLITE_OMIT_UTF16 */
488
489/*
490** Return the name of the table from which a result column derives.
491** NULL is returned if the result column is an expression or constant or
492** anything else which is not an unabiguous reference to a database column.
493*/
494const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
495 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 3);
496}
497#ifndef SQLITE_OMIT_UTF16
498const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
499 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 3);
500}
501#endif /* SQLITE_OMIT_UTF16 */
502
503/*
504** Return the name of the table column from which a result column derives.
505** NULL is returned if the result column is an expression or constant or
506** anything else which is not an unabiguous reference to a database column.
507*/
508const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
509 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, 4);
510}
511#ifndef SQLITE_OMIT_UTF16
512const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
513 return columnName(pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, 4);
514}
515#endif /* SQLITE_OMIT_UTF16 */
516#endif /* SQLITE_OMIT_ORIGIN_NAMES */
517
518
519
520
drh4f26d6c2004-05-26 23:25:30 +0000521/******************************* sqlite3_bind_ ***************************
522**
523** Routines used to attach values to wildcards in a compiled SQL statement.
524*/
525/*
526** Unbind the value bound to variable i in virtual machine p. This is the
527** the same as binding a NULL value to the column. If the "i" parameter is
528** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
529**
530** The error code stored in database p->db is overwritten with the return
531** value in any case.
532*/
533static int vdbeUnbind(Vdbe *p, int i){
534 Mem *pVar;
drh1bcdb0c2004-08-28 14:49:46 +0000535 if( p==0 || p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
drh473d1792005-06-06 17:54:55 +0000536 if( p ) sqlite3Error(p->db, SQLITE_MISUSE, 0);
drh4f26d6c2004-05-26 23:25:30 +0000537 return SQLITE_MISUSE;
538 }
539 if( i<1 || i>p->nVar ){
540 sqlite3Error(p->db, SQLITE_RANGE, 0);
541 return SQLITE_RANGE;
542 }
543 i--;
drh290c1942004-08-21 17:54:45 +0000544 pVar = &p->aVar[i];
danielk1977d8123362004-06-12 09:25:12 +0000545 sqlite3VdbeMemRelease(pVar);
drh4f26d6c2004-05-26 23:25:30 +0000546 pVar->flags = MEM_Null;
547 sqlite3Error(p->db, SQLITE_OK, 0);
548 return SQLITE_OK;
549}
550
551/*
drh5e2517e2004-09-24 23:59:12 +0000552** Bind a text or BLOB value.
drh4f26d6c2004-05-26 23:25:30 +0000553*/
drh5e2517e2004-09-24 23:59:12 +0000554static int bindText(
drhf4479502004-05-27 03:12:53 +0000555 sqlite3_stmt *pStmt,
drh4f26d6c2004-05-26 23:25:30 +0000556 int i,
557 const void *zData,
558 int nData,
drh5e2517e2004-09-24 23:59:12 +0000559 void (*xDel)(void*),
560 int encoding
drh4f26d6c2004-05-26 23:25:30 +0000561){
562 Vdbe *p = (Vdbe *)pStmt;
563 Mem *pVar;
564 int rc;
565
566 rc = vdbeUnbind(p, i);
drhfeac5f82004-08-01 00:10:45 +0000567 if( rc || zData==0 ){
drh4f26d6c2004-05-26 23:25:30 +0000568 return rc;
569 }
drh290c1942004-08-21 17:54:45 +0000570 pVar = &p->aVar[i-1];
drh5e2517e2004-09-24 23:59:12 +0000571 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
572 if( rc ){
573 return rc;
574 }
575 if( rc==SQLITE_OK && encoding!=0 ){
576 rc = sqlite3VdbeChangeEncoding(pVar, p->db->enc);
577 }
drh4f26d6c2004-05-26 23:25:30 +0000578 return rc;
579}
drh5e2517e2004-09-24 23:59:12 +0000580
581
582/*
583** Bind a blob value to an SQL statement variable.
584*/
585int sqlite3_bind_blob(
586 sqlite3_stmt *pStmt,
587 int i,
588 const void *zData,
589 int nData,
590 void (*xDel)(void*)
591){
592 return bindText(pStmt, i, zData, nData, xDel, 0);
593}
drh4f26d6c2004-05-26 23:25:30 +0000594int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
595 int rc;
596 Vdbe *p = (Vdbe *)pStmt;
drh4f26d6c2004-05-26 23:25:30 +0000597 rc = vdbeUnbind(p, i);
598 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +0000599 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
drh4f26d6c2004-05-26 23:25:30 +0000600 }
danielk1977f4618892004-06-28 13:09:11 +0000601 return rc;
drh4f26d6c2004-05-26 23:25:30 +0000602}
603int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
drhefad9992004-06-22 12:13:55 +0000604 return sqlite3_bind_int64(p, i, (i64)iValue);
drh4f26d6c2004-05-26 23:25:30 +0000605}
drhefad9992004-06-22 12:13:55 +0000606int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
drh4f26d6c2004-05-26 23:25:30 +0000607 int rc;
608 Vdbe *p = (Vdbe *)pStmt;
609 rc = vdbeUnbind(p, i);
610 if( rc==SQLITE_OK ){
drh290c1942004-08-21 17:54:45 +0000611 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
drh4f26d6c2004-05-26 23:25:30 +0000612 }
613 return rc;
614}
615int sqlite3_bind_null(sqlite3_stmt* p, int i){
616 return vdbeUnbind((Vdbe *)p, i);
617}
618int sqlite3_bind_text(
619 sqlite3_stmt *pStmt,
620 int i,
621 const char *zData,
622 int nData,
danielk1977d8123362004-06-12 09:25:12 +0000623 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +0000624){
drh5e2517e2004-09-24 23:59:12 +0000625 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
drh4f26d6c2004-05-26 23:25:30 +0000626}
drh6c626082004-11-14 21:56:29 +0000627#ifndef SQLITE_OMIT_UTF16
drh4f26d6c2004-05-26 23:25:30 +0000628int sqlite3_bind_text16(
629 sqlite3_stmt *pStmt,
630 int i,
631 const void *zData,
632 int nData,
danielk1977d8123362004-06-12 09:25:12 +0000633 void (*xDel)(void*)
drh4f26d6c2004-05-26 23:25:30 +0000634){
drh5e2517e2004-09-24 23:59:12 +0000635 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
drh4f26d6c2004-05-26 23:25:30 +0000636}
drh6c626082004-11-14 21:56:29 +0000637#endif /* SQLITE_OMIT_UTF16 */
drh75f6a032004-07-15 14:15:00 +0000638
639/*
640** Return the number of wildcards that can be potentially bound to.
641** This routine is added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +0000642*/
643int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
drh92febd92004-08-20 18:34:20 +0000644 Vdbe *p = (Vdbe*)pStmt;
645 return p ? p->nVar : 0;
drh75f6a032004-07-15 14:15:00 +0000646}
drh895d7472004-08-20 16:02:39 +0000647
648/*
drhfa6bc002004-09-07 16:19:52 +0000649** Create a mapping from variable numbers to variable names
650** in the Vdbe.azVar[] array, if such a mapping does not already
651** exist.
drh895d7472004-08-20 16:02:39 +0000652*/
drhfa6bc002004-09-07 16:19:52 +0000653static void createVarMap(Vdbe *p){
drh895d7472004-08-20 16:02:39 +0000654 if( !p->okVar ){
655 int j;
656 Op *pOp;
657 for(j=0, pOp=p->aOp; j<p->nOp; j++, pOp++){
658 if( pOp->opcode==OP_Variable ){
659 assert( pOp->p1>0 && pOp->p1<=p->nVar );
660 p->azVar[pOp->p1-1] = pOp->p3;
661 }
662 }
663 p->okVar = 1;
664 }
drhfa6bc002004-09-07 16:19:52 +0000665}
666
667/*
668** Return the name of a wildcard parameter. Return NULL if the index
669** is out of range or if the wildcard is unnamed.
670**
671** The result is always UTF-8.
672*/
673const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
674 Vdbe *p = (Vdbe*)pStmt;
675 if( p==0 || i<1 || i>p->nVar ){
676 return 0;
677 }
678 createVarMap(p);
drh895d7472004-08-20 16:02:39 +0000679 return p->azVar[i-1];
680}
drhfa6bc002004-09-07 16:19:52 +0000681
682/*
683** Given a wildcard parameter name, return the index of the variable
684** with that name. If there is no variable with the given name,
685** return 0.
686*/
687int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
688 Vdbe *p = (Vdbe*)pStmt;
689 int i;
690 if( p==0 ){
691 return 0;
692 }
693 createVarMap(p);
drh6a8903c2004-12-10 18:00:04 +0000694 if( zName ){
695 for(i=0; i<p->nVar; i++){
696 const char *z = p->azVar[i];
697 if( z && strcmp(z,zName)==0 ){
698 return i+1;
699 }
drhfa6bc002004-09-07 16:19:52 +0000700 }
701 }
702 return 0;
703}
drhf8db1bc2005-04-22 02:38:37 +0000704
drh51942bc2005-06-12 22:01:42 +0000705/*
drhf8db1bc2005-04-22 02:38:37 +0000706** Transfer all bindings from the first statement over to the second.
707** If the two statements contain a different number of bindings, then
708** an SQLITE_ERROR is returned.
709*/
710int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
711 Vdbe *pFrom = (Vdbe*)pFromStmt;
712 Vdbe *pTo = (Vdbe*)pToStmt;
713 int i, rc = SQLITE_OK;
714 if( (pFrom->magic!=VDBE_MAGIC_RUN && pFrom->magic!=VDBE_MAGIC_HALT)
715 || (pTo->magic!=VDBE_MAGIC_RUN && pTo->magic!=VDBE_MAGIC_HALT) ){
716 return SQLITE_MISUSE;
717 }
718 if( pFrom->nVar!=pTo->nVar ){
719 return SQLITE_ERROR;
720 }
721 for(i=0; rc==SQLITE_OK && i<pFrom->nVar; i++){
722 rc = sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
723 }
724 return rc;
725}
drh51942bc2005-06-12 22:01:42 +0000726
727/*
728** Return the sqlite3* database handle to which the prepared statement given
729** in the argument belongs. This is the same database handle that was
730** the first argument to the sqlite3_prepare() that was used to create
731** the statement in the first place.
732*/
733sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
734 return pStmt ? ((Vdbe*)pStmt)->db : 0;
735}