4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
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.
11 *************************************************************************
13 ** This file contains code use to implement APIs that are part of the
16 #include "sqliteInt.h"
20 ** Return TRUE (non-zero) of the statement supplied as an argument needs
21 ** to be recompiled. A statement needs to be recompiled whenever the
22 ** execution environment changes in a way that would alter the program
23 ** that sqlite3_prepare() generates. For example, if new functions or
24 ** collating sequences are registered or if an authorizer function is
27 int sqlite3_expired(sqlite3_stmt *pStmt){
28 Vdbe *p = (Vdbe*)pStmt;
29 return p==0 || p->expired;
33 ** The following routine destroys a virtual machine that is created by
34 ** the sqlite3_compile() routine. The integer returned is an SQLITE_
35 ** success/failure code that describes the result of executing the virtual
38 ** This routine sets the error code and string returned by
39 ** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
41 int sqlite3_finalize(sqlite3_stmt *pStmt){
46 Vdbe *v = (Vdbe*)pStmt;
47 sqlite3_mutex *mutex = v->db->mutex;
48 sqlite3_mutex_enter(mutex);
49 rc = sqlite3VdbeFinalize(v);
50 sqlite3_mutex_leave(mutex);
56 ** Terminate the current execution of an SQL statement and reset it
57 ** back to its starting state so that it can be reused. A success code from
58 ** the prior execution is returned.
60 ** This routine sets the error code and string returned by
61 ** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
63 int sqlite3_reset(sqlite3_stmt *pStmt){
68 Vdbe *v = (Vdbe*)pStmt;
69 sqlite3_mutex_enter(v->db->mutex);
70 rc = sqlite3VdbeReset(v);
71 sqlite3VdbeMakeReady(v, -1, 0, 0, 0);
72 assert( (rc & (v->db->errMask))==rc );
73 sqlite3_mutex_leave(v->db->mutex);
79 ** Set all the parameters in the compiled SQL statement to NULL.
81 int sqlite3_clear_bindings(sqlite3_stmt *pStmt){
84 Vdbe *v = (Vdbe*)pStmt;
85 sqlite3_mutex_enter(v->db->mutex);
86 for(i=1; rc==SQLITE_OK && i<=sqlite3_bind_parameter_count(pStmt); i++){
87 rc = sqlite3_bind_null(pStmt, i);
89 sqlite3_mutex_leave(v->db->mutex);
94 /**************************** sqlite3_value_ *******************************
95 ** The following routines extract information from a Mem or sqlite3_value
98 const void *sqlite3_value_blob(sqlite3_value *pVal){
100 if( p->flags & (MEM_Blob|MEM_Str) ){
101 sqlite3VdbeMemExpandBlob(p);
102 p->flags &= ~MEM_Str;
103 p->flags |= MEM_Blob;
106 return sqlite3_value_text(pVal);
109 int sqlite3_value_bytes(sqlite3_value *pVal){
110 return sqlite3ValueBytes(pVal, SQLITE_UTF8);
112 int sqlite3_value_bytes16(sqlite3_value *pVal){
113 return sqlite3ValueBytes(pVal, SQLITE_UTF16NATIVE);
115 double sqlite3_value_double(sqlite3_value *pVal){
116 return sqlite3VdbeRealValue((Mem*)pVal);
118 int sqlite3_value_int(sqlite3_value *pVal){
119 return sqlite3VdbeIntValue((Mem*)pVal);
121 sqlite_int64 sqlite3_value_int64(sqlite3_value *pVal){
122 return sqlite3VdbeIntValue((Mem*)pVal);
124 const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
125 return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
127 #ifndef SQLITE_OMIT_UTF16
128 const void *sqlite3_value_text16(sqlite3_value* pVal){
129 return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
131 const void *sqlite3_value_text16be(sqlite3_value *pVal){
132 return sqlite3ValueText(pVal, SQLITE_UTF16BE);
134 const void *sqlite3_value_text16le(sqlite3_value *pVal){
135 return sqlite3ValueText(pVal, SQLITE_UTF16LE);
137 #endif /* SQLITE_OMIT_UTF16 */
138 int sqlite3_value_type(sqlite3_value* pVal){
142 /**************************** sqlite3_result_ *******************************
143 ** The following routines are used by user-defined functions to specify
144 ** the function result.
146 void sqlite3_result_blob(
147 sqlite3_context *pCtx,
153 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
154 sqlite3VdbeMemSetStr(&pCtx->s, z, n, 0, xDel);
156 void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
157 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
158 sqlite3VdbeMemSetDouble(&pCtx->s, rVal);
160 void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
161 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
163 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
165 #ifndef SQLITE_OMIT_UTF16
166 void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
167 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
169 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
172 void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
173 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
174 sqlite3VdbeMemSetInt64(&pCtx->s, (i64)iVal);
176 void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
177 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
178 sqlite3VdbeMemSetInt64(&pCtx->s, iVal);
180 void sqlite3_result_null(sqlite3_context *pCtx){
181 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
182 sqlite3VdbeMemSetNull(&pCtx->s);
184 void sqlite3_result_text(
185 sqlite3_context *pCtx,
190 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
191 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF8, xDel);
193 #ifndef SQLITE_OMIT_UTF16
194 void sqlite3_result_text16(
195 sqlite3_context *pCtx,
200 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
201 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16NATIVE, xDel);
203 void sqlite3_result_text16be(
204 sqlite3_context *pCtx,
209 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
210 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16BE, xDel);
212 void sqlite3_result_text16le(
213 sqlite3_context *pCtx,
218 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
219 sqlite3VdbeMemSetStr(&pCtx->s, z, n, SQLITE_UTF16LE, xDel);
221 #endif /* SQLITE_OMIT_UTF16 */
222 void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
223 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
224 sqlite3VdbeMemCopy(&pCtx->s, pValue);
226 void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
227 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
228 sqlite3VdbeMemSetZeroBlob(&pCtx->s, n);
231 /* Force an SQLITE_TOOBIG error. */
232 void sqlite3_result_error_toobig(sqlite3_context *pCtx){
233 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
234 sqlite3VdbeMemSetZeroBlob(&pCtx->s, SQLITE_MAX_LENGTH+1);
237 /* An SQLITE_NOMEM error. */
238 void sqlite3_result_error_nomem(sqlite3_context *pCtx){
239 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
240 sqlite3VdbeMemSetNull(&pCtx->s);
242 pCtx->s.db->mallocFailed = 1;
246 ** Execute the statement pStmt, either until a row of data is ready, the
247 ** statement is completely executed or an error occurs.
249 ** This routine implements the bulk of the logic behind the sqlite_step()
250 ** API. The only thing omitted is the automatic recompile if a
251 ** schema change has occurred. That detail is handled by the
252 ** outer sqlite3_step() wrapper procedure.
254 static int sqlite3Step(Vdbe *p){
258 /* Assert that malloc() has not failed */
260 assert( !db->mallocFailed );
262 if( p==0 || p->magic!=VDBE_MAGIC_RUN ){
263 return SQLITE_MISUSE;
268 if( p->pc<=0 && p->expired ){
269 if( p->rc==SQLITE_OK ){
270 p->rc = SQLITE_SCHEMA;
275 if( sqlite3SafetyOn(db) ){
276 p->rc = SQLITE_MISUSE;
277 return SQLITE_MISUSE;
280 /* If there are no other statements currently running, then
281 ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
282 ** from interrupting a statement that has not yet started.
284 if( db->activeVdbeCnt==0 ){
285 db->u1.isInterrupted = 0;
288 #ifndef SQLITE_OMIT_TRACE
289 /* Invoke the trace callback if there is one
291 if( db->xTrace && !db->init.busy ){
293 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
294 assert( p->aOp[p->nOp-1].p3!=0 );
295 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
296 sqlite3SafetyOff(db);
297 db->xTrace(db->pTraceArg, p->aOp[p->nOp-1].p3);
298 if( sqlite3SafetyOn(db) ){
299 p->rc = SQLITE_MISUSE;
300 return SQLITE_MISUSE;
303 if( db->xProfile && !db->init.busy ){
305 sqlite3OsCurrentTime(db->pVfs, &rNow);
306 p->startTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0;
310 /* Print a copy of SQL as it is executed if the SQL_TRACE pragma is turned
311 ** on in debugging mode.
314 if( (db->flags & SQLITE_SqlTrace)!=0 ){
315 sqlite3DebugPrintf("SQL-trace: %s\n", p->aOp[p->nOp-1].p3);
317 #endif /* SQLITE_DEBUG */
322 #ifndef SQLITE_OMIT_EXPLAIN
324 rc = sqlite3VdbeList(p);
326 #endif /* SQLITE_OMIT_EXPLAIN */
328 rc = sqlite3VdbeExec(p);
331 if( sqlite3SafetyOff(db) ){
335 #ifndef SQLITE_OMIT_TRACE
336 /* Invoke the profile callback if there is one
338 if( rc!=SQLITE_ROW && db->xProfile && !db->init.busy ){
342 sqlite3OsCurrentTime(db->pVfs, &rNow);
343 elapseTime = (rNow - (int)rNow)*3600.0*24.0*1000000000.0 - p->startTime;
345 assert( p->aOp[p->nOp-1].opcode==OP_Noop );
346 assert( p->aOp[p->nOp-1].p3!=0 );
347 assert( p->aOp[p->nOp-1].p3type==P3_DYNAMIC );
348 db->xProfile(db->pProfileArg, p->aOp[p->nOp-1].p3, elapseTime);
352 sqlite3Error(p->db, rc, 0);
353 p->rc = sqlite3ApiExit(p->db, p->rc);
355 assert( (rc&0xff)==rc );
356 if( p->zSql && (rc&0xff)<SQLITE_ROW ){
357 /* This behavior occurs if sqlite3_prepare_v2() was used to build
358 ** the prepared statement. Return error codes directly */
359 sqlite3Error(p->db, p->rc, 0);
362 /* This is for legacy sqlite3_prepare() builds and when the code
363 ** is SQLITE_ROW or SQLITE_DONE */
369 ** This is the top-level implementation of sqlite3_step(). Call
370 ** sqlite3Step() to do most of the work. If a schema error occurs,
371 ** call sqlite3Reprepare() and try again.
373 #ifdef SQLITE_OMIT_PARSER
374 int sqlite3_step(sqlite3_stmt *pStmt){
378 sqlite3_mutex_enter(v->db->mutex);
380 sqlite3_mutex_leave(v->db->mutex);
384 int sqlite3_step(sqlite3_stmt *pStmt){
387 Vdbe *v = (Vdbe*)pStmt;
388 sqlite3_mutex_enter(v->db->mutex);
389 while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
391 && sqlite3Reprepare(v) ){
392 sqlite3_reset(pStmt);
395 sqlite3_mutex_leave(v->db->mutex);
401 ** Extract the user data from a sqlite3_context structure and return a
404 void *sqlite3_user_data(sqlite3_context *p){
405 assert( p && p->pFunc );
406 return p->pFunc->pUserData;
410 ** The following is the implementation of an SQL function that always
411 ** fails with an error message stating that the function is used in the
412 ** wrong context. The sqlite3_overload_function() API might construct
413 ** SQL function that use this routine so that the functions will exist
414 ** for name resolution but are actually overloaded by the xFindFunction
415 ** method of virtual tables.
417 void sqlite3InvalidFunction(
418 sqlite3_context *context, /* The function calling context */
419 int argc, /* Number of arguments to the function */
420 sqlite3_value **argv /* Value of each argument */
422 const char *zName = context->pFunc->zName;
424 zErr = sqlite3MPrintf(0,
425 "unable to use function %s in the requested context", zName);
426 sqlite3_result_error(context, zErr, -1);
431 ** Allocate or return the aggregate context for a user function. A new
432 ** context is allocated on the first call. Subsequent calls return the
433 ** same context that was returned on prior calls.
435 void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
437 assert( p && p->pFunc && p->pFunc->xStep );
438 assert( sqlite3_mutex_held(p->s.db->mutex) );
440 if( (pMem->flags & MEM_Agg)==0 ){
442 assert( pMem->flags==MEM_Null );
445 pMem->flags = MEM_Agg;
446 pMem->xDel = sqlite3_free;
447 pMem->u.pDef = p->pFunc;
449 pMem->z = pMem->zShort;
450 memset(pMem->z, 0, nByte);
452 pMem->z = sqlite3DbMallocZero(p->s.db, nByte);
456 return (void*)pMem->z;
460 ** Return the auxilary data pointer, if any, for the iArg'th argument to
461 ** the user-function defined by pCtx.
463 void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
466 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
467 pVdbeFunc = pCtx->pVdbeFunc;
468 if( !pVdbeFunc || iArg>=pVdbeFunc->nAux || iArg<0 ){
471 return pVdbeFunc->apAux[iArg].pAux;
475 ** Set the auxilary data pointer and delete function, for the iArg'th
476 ** argument to the user-function defined by pCtx. Any previous value is
477 ** deleted by calling the delete function specified when it was set.
479 void sqlite3_set_auxdata(
480 sqlite3_context *pCtx,
483 void (*xDelete)(void*)
485 struct AuxData *pAuxData;
487 if( iArg<0 ) goto failed;
489 assert( sqlite3_mutex_held(pCtx->s.db->mutex) );
490 pVdbeFunc = pCtx->pVdbeFunc;
491 if( !pVdbeFunc || pVdbeFunc->nAux<=iArg ){
492 int nAux = (pVdbeFunc ? pVdbeFunc->nAux : 0);
493 int nMalloc = sizeof(VdbeFunc) + sizeof(struct AuxData)*iArg;
494 pVdbeFunc = sqlite3DbRealloc(pCtx->s.db, pVdbeFunc, nMalloc);
498 pCtx->pVdbeFunc = pVdbeFunc;
499 memset(&pVdbeFunc->apAux[nAux], 0, sizeof(struct AuxData)*(iArg+1-nAux));
500 pVdbeFunc->nAux = iArg+1;
501 pVdbeFunc->pFunc = pCtx->pFunc;
504 pAuxData = &pVdbeFunc->apAux[iArg];
505 if( pAuxData->pAux && pAuxData->xDelete ){
506 pAuxData->xDelete(pAuxData->pAux);
508 pAuxData->pAux = pAux;
509 pAuxData->xDelete = xDelete;
519 ** Return the number of times the Step function of a aggregate has been
522 ** This function is deprecated. Do not use it for new code. It is
523 ** provide only to avoid breaking legacy code. New aggregate function
524 ** implementations should keep their own counts within their aggregate
527 int sqlite3_aggregate_count(sqlite3_context *p){
528 assert( p && p->pFunc && p->pFunc->xStep );
533 ** Return the number of columns in the result set for the statement pStmt.
535 int sqlite3_column_count(sqlite3_stmt *pStmt){
536 Vdbe *pVm = (Vdbe *)pStmt;
537 return pVm ? pVm->nResColumn : 0;
541 ** Return the number of values available from the current row of the
542 ** currently executing statement pStmt.
544 int sqlite3_data_count(sqlite3_stmt *pStmt){
545 Vdbe *pVm = (Vdbe *)pStmt;
546 if( pVm==0 || !pVm->resOnStack ) return 0;
547 return pVm->nResColumn;
552 ** Check to see if column iCol of the given statement is valid. If
553 ** it is, return a pointer to the Mem for the value of that column.
554 ** If iCol is not valid, return a pointer to a Mem which has a value
557 static Mem *columnMem(sqlite3_stmt *pStmt, int i){
563 if( pVm && pVm->resOnStack && i<pVm->nResColumn && i>=0 ){
564 sqlite3_mutex_enter(pVm->db->mutex);
565 vals = sqlite3_data_count(pStmt);
566 pOut = &pVm->pTos[(1-vals)+i];
568 static const Mem nullMem = {{0}, 0.0, 0, "", 0, MEM_Null, SQLITE_NULL };
570 sqlite3_mutex_enter(pVm->db->mutex);
571 sqlite3Error(pVm->db, SQLITE_RANGE, 0);
573 pOut = (Mem*)&nullMem;
579 ** This function is called after invoking an sqlite3_value_XXX function on a
580 ** column value (i.e. a value returned by evaluating an SQL expression in the
581 ** select list of a SELECT statement) that may cause a malloc() failure. If
582 ** malloc() has failed, the threads mallocFailed flag is cleared and the result
583 ** code of statement pStmt set to SQLITE_NOMEM.
585 ** Specifically, this is called from within:
587 ** sqlite3_column_int()
588 ** sqlite3_column_int64()
589 ** sqlite3_column_text()
590 ** sqlite3_column_text16()
591 ** sqlite3_column_real()
592 ** sqlite3_column_bytes()
593 ** sqlite3_column_bytes16()
595 ** But not for sqlite3_column_blob(), which never calls malloc().
597 static void columnMallocFailure(sqlite3_stmt *pStmt)
599 /* If malloc() failed during an encoding conversion within an
600 ** sqlite3_column_XXX API, then set the return code of the statement to
601 ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
602 ** and _finalize() will return NOMEM.
604 Vdbe *p = (Vdbe *)pStmt;
606 p->rc = sqlite3ApiExit(p->db, p->rc);
607 sqlite3_mutex_leave(p->db->mutex);
611 /**************************** sqlite3_column_ *******************************
612 ** The following routines are used to access elements of the current row
613 ** in the result set.
615 const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
617 val = sqlite3_value_blob( columnMem(pStmt,i) );
618 /* Even though there is no encoding conversion, value_blob() might
619 ** need to call malloc() to expand the result of a zeroblob()
622 columnMallocFailure(pStmt);
625 int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
626 int val = sqlite3_value_bytes( columnMem(pStmt,i) );
627 columnMallocFailure(pStmt);
630 int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
631 int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
632 columnMallocFailure(pStmt);
635 double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
636 double val = sqlite3_value_double( columnMem(pStmt,i) );
637 columnMallocFailure(pStmt);
640 int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
641 int val = sqlite3_value_int( columnMem(pStmt,i) );
642 columnMallocFailure(pStmt);
645 sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
646 sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
647 columnMallocFailure(pStmt);
650 const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
651 const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
652 columnMallocFailure(pStmt);
655 sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
656 sqlite3_value *pOut = columnMem(pStmt, i);
657 columnMallocFailure(pStmt);
660 #ifndef SQLITE_OMIT_UTF16
661 const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
662 const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
663 columnMallocFailure(pStmt);
666 #endif /* SQLITE_OMIT_UTF16 */
667 int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
668 int iType = sqlite3_value_type( columnMem(pStmt,i) );
669 columnMallocFailure(pStmt);
673 /* The following function is experimental and subject to change or
675 /*int sqlite3_column_numeric_type(sqlite3_stmt *pStmt, int i){
676 ** return sqlite3_value_numeric_type( columnMem(pStmt,i) );
681 ** Convert the N-th element of pStmt->pColName[] into a string using
682 ** xFunc() then return that string. If N is out of range, return 0.
684 ** There are up to 5 names for each column. useType determines which
685 ** name is returned. Here are the names:
687 ** 0 The column name as it should be displayed for output
688 ** 1 The datatype name for the column
689 ** 2 The name of the database that the column derives from
690 ** 3 The name of the table that the column derives from
691 ** 4 The name of the table column that the result column derives from
693 ** If the result is not a simple column reference (if it is an expression
694 ** or a constant) then useTypes 2, 3, and 4 return NULL.
696 static const void *columnName(
699 const void *(*xFunc)(Mem*),
703 Vdbe *p = (Vdbe *)pStmt;
708 n = sqlite3_column_count(pStmt);
711 sqlite3_mutex_enter(p->db->mutex);
712 ret = xFunc(&p->aColName[N]);
714 /* A malloc may have failed inside of the xFunc() call. If this
715 ** is the case, clear the mallocFailed flag and return NULL.
717 if( p->db && p->db->mallocFailed ){
718 p->db->mallocFailed = 0;
721 sqlite3_mutex_leave(p->db->mutex);
728 ** Return the name of the Nth column of the result set returned by SQL
731 const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
733 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
735 #ifndef SQLITE_OMIT_UTF16
736 const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
738 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
743 ** Return the column declaration type (if applicable) of the 'i'th column
744 ** of the result set of SQL statement pStmt.
746 const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
748 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
750 #ifndef SQLITE_OMIT_UTF16
751 const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
753 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
755 #endif /* SQLITE_OMIT_UTF16 */
757 #ifdef SQLITE_ENABLE_COLUMN_METADATA
759 ** Return the name of the database from which a result column derives.
760 ** NULL is returned if the result column is an expression or constant or
761 ** anything else which is not an unabiguous reference to a database column.
763 const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
765 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
767 #ifndef SQLITE_OMIT_UTF16
768 const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
770 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
772 #endif /* SQLITE_OMIT_UTF16 */
775 ** Return the name of the table from which a result column derives.
776 ** NULL is returned if the result column is an expression or constant or
777 ** anything else which is not an unabiguous reference to a database column.
779 const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
781 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
783 #ifndef SQLITE_OMIT_UTF16
784 const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
786 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
788 #endif /* SQLITE_OMIT_UTF16 */
791 ** Return the name of the table column from which a result column derives.
792 ** NULL is returned if the result column is an expression or constant or
793 ** anything else which is not an unabiguous reference to a database column.
795 const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
797 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
799 #ifndef SQLITE_OMIT_UTF16
800 const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
802 pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
804 #endif /* SQLITE_OMIT_UTF16 */
805 #endif /* SQLITE_ENABLE_COLUMN_METADATA */
808 /******************************* sqlite3_bind_ ***************************
810 ** Routines used to attach values to wildcards in a compiled SQL statement.
813 ** Unbind the value bound to variable i in virtual machine p. This is the
814 ** the same as binding a NULL value to the column. If the "i" parameter is
815 ** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
817 ** The error code stored in database p->db is overwritten with the return
818 ** value in any case.
820 static int vdbeUnbind(Vdbe *p, int i){
822 if( p==0 || p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
823 if( p ) sqlite3Error(p->db, SQLITE_MISUSE, 0);
824 return SQLITE_MISUSE;
826 if( i<1 || i>p->nVar ){
827 sqlite3Error(p->db, SQLITE_RANGE, 0);
832 sqlite3VdbeMemRelease(pVar);
833 pVar->flags = MEM_Null;
834 sqlite3Error(p->db, SQLITE_OK, 0);
839 ** Bind a text or BLOB value.
842 sqlite3_stmt *pStmt, /* The statement to bind against */
843 int i, /* Index of the parameter to bind */
844 const void *zData, /* Pointer to the data to be bound */
845 int nData, /* Number of bytes of data to be bound */
846 void (*xDel)(void*), /* Destructor for the data */
847 int encoding /* Encoding for the data */
849 Vdbe *p = (Vdbe *)pStmt;
854 return SQLITE_MISUSE;
856 sqlite3_mutex_enter(p->db->mutex);
857 rc = vdbeUnbind(p, i);
858 if( rc==SQLITE_OK && zData!=0 ){
859 pVar = &p->aVar[i-1];
860 rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
861 if( rc==SQLITE_OK && encoding!=0 ){
862 rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
864 sqlite3Error(p->db, rc, 0);
865 rc = sqlite3ApiExit(p->db, rc);
867 sqlite3_mutex_leave(p->db->mutex);
873 ** Bind a blob value to an SQL statement variable.
875 int sqlite3_bind_blob(
882 return bindText(pStmt, i, zData, nData, xDel, 0);
884 int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
886 Vdbe *p = (Vdbe *)pStmt;
887 sqlite3_mutex_enter(p->db->mutex);
888 rc = vdbeUnbind(p, i);
890 sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
892 sqlite3_mutex_leave(p->db->mutex);
895 int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
896 return sqlite3_bind_int64(p, i, (i64)iValue);
898 int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
900 Vdbe *p = (Vdbe *)pStmt;
901 sqlite3_mutex_enter(p->db->mutex);
902 rc = vdbeUnbind(p, i);
904 sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
906 sqlite3_mutex_leave(p->db->mutex);
909 int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
911 Vdbe *p = (Vdbe*)pStmt;
912 sqlite3_mutex_enter(p->db->mutex);
913 rc = vdbeUnbind(p, i);
914 sqlite3_mutex_leave(p->db->mutex);
917 int sqlite3_bind_text(
924 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
926 #ifndef SQLITE_OMIT_UTF16
927 int sqlite3_bind_text16(
934 return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
936 #endif /* SQLITE_OMIT_UTF16 */
937 int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
939 Vdbe *p = (Vdbe *)pStmt;
940 sqlite3_mutex_enter(p->db->mutex);
941 rc = vdbeUnbind(p, i);
943 rc = sqlite3VdbeMemCopy(&p->aVar[i-1], pValue);
945 sqlite3_mutex_leave(p->db->mutex);
948 int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
950 Vdbe *p = (Vdbe *)pStmt;
951 sqlite3_mutex_enter(p->db->mutex);
952 rc = vdbeUnbind(p, i);
954 sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
956 sqlite3_mutex_leave(p->db->mutex);
961 ** Return the number of wildcards that can be potentially bound to.
962 ** This routine is added to support DBD::SQLite.
964 int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
965 Vdbe *p = (Vdbe*)pStmt;
966 return p ? p->nVar : 0;
970 ** Create a mapping from variable numbers to variable names
971 ** in the Vdbe.azVar[] array, if such a mapping does not already
974 static void createVarMap(Vdbe *p){
976 sqlite3_mutex_enter(p->db->mutex);
980 for(j=0, pOp=p->aOp; j<p->nOp; j++, pOp++){
981 if( pOp->opcode==OP_Variable ){
982 assert( pOp->p1>0 && pOp->p1<=p->nVar );
983 p->azVar[pOp->p1-1] = pOp->p3;
988 sqlite3_mutex_leave(p->db->mutex);
993 ** Return the name of a wildcard parameter. Return NULL if the index
994 ** is out of range or if the wildcard is unnamed.
996 ** The result is always UTF-8.
998 const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
999 Vdbe *p = (Vdbe*)pStmt;
1000 if( p==0 || i<1 || i>p->nVar ){
1004 return p->azVar[i-1];
1008 ** Given a wildcard parameter name, return the index of the variable
1009 ** with that name. If there is no variable with the given name,
1012 int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
1013 Vdbe *p = (Vdbe*)pStmt;
1020 for(i=0; i<p->nVar; i++){
1021 const char *z = p->azVar[i];
1022 if( z && strcmp(z,zName)==0 ){
1031 ** Transfer all bindings from the first statement over to the second.
1032 ** If the two statements contain a different number of bindings, then
1033 ** an SQLITE_ERROR is returned.
1035 int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
1036 Vdbe *pFrom = (Vdbe*)pFromStmt;
1037 Vdbe *pTo = (Vdbe*)pToStmt;
1038 int i, rc = SQLITE_OK;
1039 if( (pFrom->magic!=VDBE_MAGIC_RUN && pFrom->magic!=VDBE_MAGIC_HALT)
1040 || (pTo->magic!=VDBE_MAGIC_RUN && pTo->magic!=VDBE_MAGIC_HALT)
1041 || pTo->db!=pFrom->db ){
1042 return SQLITE_MISUSE;
1044 if( pFrom->nVar!=pTo->nVar ){
1045 return SQLITE_ERROR;
1047 sqlite3_mutex_enter(pTo->db->mutex);
1048 for(i=0; rc==SQLITE_OK && i<pFrom->nVar; i++){
1049 sqlite3MallocDisallow();
1050 rc = sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
1051 sqlite3MallocAllow();
1053 sqlite3_mutex_leave(pTo->db->mutex);
1054 assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
1059 ** Return the sqlite3* database handle to which the prepared statement given
1060 ** in the argument belongs. This is the same database handle that was
1061 ** the first argument to the sqlite3_prepare() that was used to create
1062 ** the statement in the first place.
1064 sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
1065 return pStmt ? ((Vdbe*)pStmt)->db : 0;