blob: f657934283b60e31f23450c9e8565128b0594b84 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** A TCL Interface to SQLite
13**
drh23669402006-01-09 17:29:52 +000014** $Id: tclsqlite.c,v 1.148 2006/01/09 17:29:53 drh Exp $
drh75897232000-05-29 14:26:00 +000015*/
drh6d313162000-09-21 13:01:35 +000016#ifndef NO_TCL /* Omit this whole file if TCL is unavailable */
17
drh06b27182002-06-26 20:06:05 +000018#include "sqliteInt.h"
drh895d7472004-08-20 16:02:39 +000019#include "hash.h"
drh17a68932001-01-31 13:28:08 +000020#include "tcl.h"
drh75897232000-05-29 14:26:00 +000021#include <stdlib.h>
22#include <string.h>
drhce927062001-11-09 13:41:09 +000023#include <assert.h>
drhd1e47332005-06-26 17:55:33 +000024#include <ctype.h>
drh75897232000-05-29 14:26:00 +000025
drh29bc4612005-10-05 10:40:15 +000026/*
27 * Windows needs to know which symbols to export. Unix does not.
28 * BUILD_sqlite should be undefined for Unix.
29 */
30
31#ifdef BUILD_sqlite
32#undef TCL_STORAGE_CLASS
33#define TCL_STORAGE_CLASS DLLEXPORT
34#endif /* BUILD_sqlite */
35
danielk1977a21c6b62005-01-24 10:25:59 +000036#define NUM_PREPARED_STMTS 10
drhfb7e7652005-01-24 00:28:42 +000037#define MAX_PREPARED_STMTS 100
38
drh75897232000-05-29 14:26:00 +000039/*
drh98808ba2001-10-18 12:34:46 +000040** If TCL uses UTF-8 and SQLite is configured to use iso8859, then we
41** have to do a translation when going between the two. Set the
42** UTF_TRANSLATION_NEEDED macro to indicate that we need to do
43** this translation.
44*/
45#if defined(TCL_UTF_MAX) && !defined(SQLITE_UTF8)
46# define UTF_TRANSLATION_NEEDED 1
47#endif
48
49/*
drhcabb0812002-09-14 13:47:32 +000050** New SQL functions can be created as TCL scripts. Each such function
51** is described by an instance of the following structure.
52*/
53typedef struct SqlFunc SqlFunc;
54struct SqlFunc {
55 Tcl_Interp *interp; /* The TCL interpret to execute the function */
drhd1e47332005-06-26 17:55:33 +000056 Tcl_Obj *pScript; /* The Tcl_Obj representation of the script */
57 int useEvalObjv; /* True if it is safe to use Tcl_EvalObjv */
58 char *zName; /* Name of this function */
drhcabb0812002-09-14 13:47:32 +000059 SqlFunc *pNext; /* Next function on the list of them all */
60};
61
62/*
danielk19770202b292004-06-09 09:55:16 +000063** New collation sequences function can be created as TCL scripts. Each such
64** function is described by an instance of the following structure.
65*/
66typedef struct SqlCollate SqlCollate;
67struct SqlCollate {
68 Tcl_Interp *interp; /* The TCL interpret to execute the function */
69 char *zScript; /* The script to be run */
drhd1e47332005-06-26 17:55:33 +000070 SqlCollate *pNext; /* Next function on the list of them all */
danielk19770202b292004-06-09 09:55:16 +000071};
72
73/*
drhfb7e7652005-01-24 00:28:42 +000074** Prepared statements are cached for faster execution. Each prepared
75** statement is described by an instance of the following structure.
76*/
77typedef struct SqlPreparedStmt SqlPreparedStmt;
78struct SqlPreparedStmt {
79 SqlPreparedStmt *pNext; /* Next in linked list */
80 SqlPreparedStmt *pPrev; /* Previous on the list */
81 sqlite3_stmt *pStmt; /* The prepared statement */
82 int nSql; /* chars in zSql[] */
83 char zSql[1]; /* Text of the SQL statement */
84};
85
86/*
drhbec3f402000-08-04 13:49:02 +000087** There is one instance of this structure for each SQLite database
88** that has been opened by the SQLite TCL interface.
89*/
90typedef struct SqliteDb SqliteDb;
91struct SqliteDb {
drhdddca282006-01-03 00:33:50 +000092 sqlite3 *db; /* The "real" database structure. MUST BE FIRST */
drhd1e47332005-06-26 17:55:33 +000093 Tcl_Interp *interp; /* The interpreter used for this database */
94 char *zBusy; /* The busy callback routine */
95 char *zCommit; /* The commit hook callback routine */
96 char *zTrace; /* The trace callback routine */
drh19e2d372005-08-29 23:00:03 +000097 char *zProfile; /* The profile callback routine */
drhd1e47332005-06-26 17:55:33 +000098 char *zProgress; /* The progress callback routine */
99 char *zAuth; /* The authorization callback routine */
100 char *zNull; /* Text to substitute for an SQL NULL value */
101 SqlFunc *pFunc; /* List of SQL functions */
danielk197794eb6a12005-12-15 15:22:08 +0000102 Tcl_Obj *pUpdateHook; /* Update hook script (if any) */
danielk197771fd80b2005-12-16 06:54:01 +0000103 Tcl_Obj *pRollbackHook; /* Rollback hook script (if any) */
drhd1e47332005-06-26 17:55:33 +0000104 SqlCollate *pCollate; /* List of SQL collation functions */
105 int rc; /* Return code of most recent sqlite3_exec() */
106 Tcl_Obj *pCollateNeeded; /* Collation needed script */
drhfb7e7652005-01-24 00:28:42 +0000107 SqlPreparedStmt *stmtList; /* List of prepared statements*/
108 SqlPreparedStmt *stmtLast; /* Last statement in the list */
109 int maxStmt; /* The next maximum number of stmtList */
110 int nStmt; /* Number of statements in stmtList */
drh98808ba2001-10-18 12:34:46 +0000111};
drh297ecf12001-04-05 15:57:13 +0000112
drh6d313162000-09-21 13:01:35 +0000113/*
drhd1e47332005-06-26 17:55:33 +0000114** Look at the script prefix in pCmd. We will be executing this script
115** after first appending one or more arguments. This routine analyzes
116** the script to see if it is safe to use Tcl_EvalObjv() on the script
117** rather than the more general Tcl_EvalEx(). Tcl_EvalObjv() is much
118** faster.
119**
120** Scripts that are safe to use with Tcl_EvalObjv() consists of a
121** command name followed by zero or more arguments with no [...] or $
122** or {...} or ; to be seen anywhere. Most callback scripts consist
123** of just a single procedure name and they meet this requirement.
124*/
125static int safeToUseEvalObjv(Tcl_Interp *interp, Tcl_Obj *pCmd){
126 /* We could try to do something with Tcl_Parse(). But we will instead
127 ** just do a search for forbidden characters. If any of the forbidden
128 ** characters appear in pCmd, we will report the string as unsafe.
129 */
130 const char *z;
131 int n;
132 z = Tcl_GetStringFromObj(pCmd, &n);
133 while( n-- > 0 ){
134 int c = *(z++);
135 if( c=='$' || c=='[' || c==';' ) return 0;
136 }
137 return 1;
138}
139
140/*
141** Find an SqlFunc structure with the given name. Or create a new
142** one if an existing one cannot be found. Return a pointer to the
143** structure.
144*/
145static SqlFunc *findSqlFunc(SqliteDb *pDb, const char *zName){
146 SqlFunc *p, *pNew;
147 int i;
148 pNew = (SqlFunc*)Tcl_Alloc( sizeof(*pNew) + strlen(zName) + 1 );
149 pNew->zName = (char*)&pNew[1];
150 for(i=0; zName[i]; i++){ pNew->zName[i] = tolower(zName[i]); }
151 pNew->zName[i] = 0;
152 for(p=pDb->pFunc; p; p=p->pNext){
153 if( strcmp(p->zName, pNew->zName)==0 ){
154 Tcl_Free((char*)pNew);
155 return p;
156 }
157 }
158 pNew->interp = pDb->interp;
159 pNew->pScript = 0;
160 pNew->pNext = pDb->pFunc;
161 pDb->pFunc = pNew;
162 return pNew;
163}
164
165/*
drhfb7e7652005-01-24 00:28:42 +0000166** Finalize and free a list of prepared statements
167*/
168static void flushStmtCache( SqliteDb *pDb ){
169 SqlPreparedStmt *pPreStmt;
170
171 while( pDb->stmtList ){
172 sqlite3_finalize( pDb->stmtList->pStmt );
173 pPreStmt = pDb->stmtList;
174 pDb->stmtList = pDb->stmtList->pNext;
175 Tcl_Free( (char*)pPreStmt );
176 }
177 pDb->nStmt = 0;
178 pDb->stmtLast = 0;
179}
180
181/*
drh895d7472004-08-20 16:02:39 +0000182** TCL calls this procedure when an sqlite3 database command is
183** deleted.
drh75897232000-05-29 14:26:00 +0000184*/
185static void DbDeleteCmd(void *db){
drhbec3f402000-08-04 13:49:02 +0000186 SqliteDb *pDb = (SqliteDb*)db;
drhfb7e7652005-01-24 00:28:42 +0000187 flushStmtCache(pDb);
danielk19776f8a5032004-05-10 10:34:51 +0000188 sqlite3_close(pDb->db);
drhcabb0812002-09-14 13:47:32 +0000189 while( pDb->pFunc ){
190 SqlFunc *pFunc = pDb->pFunc;
191 pDb->pFunc = pFunc->pNext;
drhd1e47332005-06-26 17:55:33 +0000192 Tcl_DecrRefCount(pFunc->pScript);
drhcabb0812002-09-14 13:47:32 +0000193 Tcl_Free((char*)pFunc);
194 }
danielk19770202b292004-06-09 09:55:16 +0000195 while( pDb->pCollate ){
196 SqlCollate *pCollate = pDb->pCollate;
197 pDb->pCollate = pCollate->pNext;
198 Tcl_Free((char*)pCollate);
199 }
drhbec3f402000-08-04 13:49:02 +0000200 if( pDb->zBusy ){
201 Tcl_Free(pDb->zBusy);
202 }
drhb5a20d32003-04-23 12:25:23 +0000203 if( pDb->zTrace ){
204 Tcl_Free(pDb->zTrace);
drh0d1a6432003-04-03 15:46:04 +0000205 }
drh19e2d372005-08-29 23:00:03 +0000206 if( pDb->zProfile ){
207 Tcl_Free(pDb->zProfile);
208 }
drhe22a3342003-04-22 20:30:37 +0000209 if( pDb->zAuth ){
210 Tcl_Free(pDb->zAuth);
211 }
danielk197755c45f22005-04-03 23:54:43 +0000212 if( pDb->zNull ){
213 Tcl_Free(pDb->zNull);
214 }
danielk197794eb6a12005-12-15 15:22:08 +0000215 if( pDb->pUpdateHook ){
216 Tcl_DecrRefCount(pDb->pUpdateHook);
217 }
danielk197771fd80b2005-12-16 06:54:01 +0000218 if( pDb->pRollbackHook ){
219 Tcl_DecrRefCount(pDb->pRollbackHook);
220 }
danielk197794eb6a12005-12-15 15:22:08 +0000221 if( pDb->pCollateNeeded ){
222 Tcl_DecrRefCount(pDb->pCollateNeeded);
223 }
drhbec3f402000-08-04 13:49:02 +0000224 Tcl_Free((char*)pDb);
225}
226
227/*
228** This routine is called when a database file is locked while trying
229** to execute SQL.
230*/
danielk19772a764eb2004-06-12 01:43:26 +0000231static int DbBusyHandler(void *cd, int nTries){
drhbec3f402000-08-04 13:49:02 +0000232 SqliteDb *pDb = (SqliteDb*)cd;
233 int rc;
234 char zVal[30];
drhbec3f402000-08-04 13:49:02 +0000235
danielk19772a764eb2004-06-12 01:43:26 +0000236 sprintf(zVal, "%d", nTries);
drhd1e47332005-06-26 17:55:33 +0000237 rc = Tcl_VarEval(pDb->interp, pDb->zBusy, " ", zVal, (char*)0);
drhbec3f402000-08-04 13:49:02 +0000238 if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
239 return 0;
240 }
241 return 1;
drh75897232000-05-29 14:26:00 +0000242}
243
244/*
danielk1977348bb5d2003-10-18 09:37:26 +0000245** This routine is invoked as the 'progress callback' for the database.
246*/
247static int DbProgressHandler(void *cd){
248 SqliteDb *pDb = (SqliteDb*)cd;
249 int rc;
250
251 assert( pDb->zProgress );
252 rc = Tcl_Eval(pDb->interp, pDb->zProgress);
253 if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
254 return 1;
255 }
256 return 0;
257}
258
259/*
drhb5a20d32003-04-23 12:25:23 +0000260** This routine is called by the SQLite trace handler whenever a new
261** block of SQL is executed. The TCL script in pDb->zTrace is executed.
drh0d1a6432003-04-03 15:46:04 +0000262*/
drhb5a20d32003-04-23 12:25:23 +0000263static void DbTraceHandler(void *cd, const char *zSql){
drh0d1a6432003-04-03 15:46:04 +0000264 SqliteDb *pDb = (SqliteDb*)cd;
drhb5a20d32003-04-23 12:25:23 +0000265 Tcl_DString str;
drh0d1a6432003-04-03 15:46:04 +0000266
drhb5a20d32003-04-23 12:25:23 +0000267 Tcl_DStringInit(&str);
268 Tcl_DStringAppend(&str, pDb->zTrace, -1);
269 Tcl_DStringAppendElement(&str, zSql);
270 Tcl_Eval(pDb->interp, Tcl_DStringValue(&str));
271 Tcl_DStringFree(&str);
272 Tcl_ResetResult(pDb->interp);
drh0d1a6432003-04-03 15:46:04 +0000273}
274
275/*
drh19e2d372005-08-29 23:00:03 +0000276** This routine is called by the SQLite profile handler after a statement
277** SQL has executed. The TCL script in pDb->zProfile is evaluated.
278*/
279static void DbProfileHandler(void *cd, const char *zSql, sqlite_uint64 tm){
280 SqliteDb *pDb = (SqliteDb*)cd;
281 Tcl_DString str;
282 char zTm[100];
283
284 sqlite3_snprintf(sizeof(zTm)-1, zTm, "%lld", tm);
285 Tcl_DStringInit(&str);
286 Tcl_DStringAppend(&str, pDb->zProfile, -1);
287 Tcl_DStringAppendElement(&str, zSql);
288 Tcl_DStringAppendElement(&str, zTm);
289 Tcl_Eval(pDb->interp, Tcl_DStringValue(&str));
290 Tcl_DStringFree(&str);
291 Tcl_ResetResult(pDb->interp);
292}
293
294/*
drhaa940ea2004-01-15 02:44:03 +0000295** This routine is called when a transaction is committed. The
296** TCL script in pDb->zCommit is executed. If it returns non-zero or
297** if it throws an exception, the transaction is rolled back instead
298** of being committed.
299*/
300static int DbCommitHandler(void *cd){
301 SqliteDb *pDb = (SqliteDb*)cd;
302 int rc;
303
304 rc = Tcl_Eval(pDb->interp, pDb->zCommit);
305 if( rc!=TCL_OK || atoi(Tcl_GetStringResult(pDb->interp)) ){
306 return 1;
307 }
308 return 0;
309}
310
danielk197771fd80b2005-12-16 06:54:01 +0000311static void DbRollbackHandler(void *clientData){
312 SqliteDb *pDb = (SqliteDb*)clientData;
313 assert(pDb->pRollbackHook);
314 if( TCL_OK!=Tcl_EvalObjEx(pDb->interp, pDb->pRollbackHook, 0) ){
315 Tcl_BackgroundError(pDb->interp);
316 }
317}
318
danielk197794eb6a12005-12-15 15:22:08 +0000319static void DbUpdateHandler(
320 void *p,
321 int op,
322 const char *zDb,
323 const char *zTbl,
324 sqlite_int64 rowid
325){
326 SqliteDb *pDb = (SqliteDb *)p;
327 Tcl_Obj *pCmd;
328
329 assert( pDb->pUpdateHook );
330 assert( op==SQLITE_INSERT || op==SQLITE_UPDATE || op==SQLITE_DELETE );
331
332 pCmd = Tcl_DuplicateObj(pDb->pUpdateHook);
333 Tcl_IncrRefCount(pCmd);
334 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(
335 ( (op==SQLITE_INSERT)?"INSERT":(op==SQLITE_UPDATE)?"UPDATE":"DELETE"), -1));
336 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zDb, -1));
337 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewStringObj(zTbl, -1));
338 Tcl_ListObjAppendElement(0, pCmd, Tcl_NewWideIntObj(rowid));
339 Tcl_EvalObjEx(pDb->interp, pCmd, TCL_EVAL_DIRECT);
340}
341
danielk19777cedc8d2004-06-10 10:50:08 +0000342static void tclCollateNeeded(
343 void *pCtx,
drh9bb575f2004-09-06 17:24:11 +0000344 sqlite3 *db,
danielk19777cedc8d2004-06-10 10:50:08 +0000345 int enc,
346 const char *zName
347){
348 SqliteDb *pDb = (SqliteDb *)pCtx;
349 Tcl_Obj *pScript = Tcl_DuplicateObj(pDb->pCollateNeeded);
350 Tcl_IncrRefCount(pScript);
351 Tcl_ListObjAppendElement(0, pScript, Tcl_NewStringObj(zName, -1));
352 Tcl_EvalObjEx(pDb->interp, pScript, 0);
353 Tcl_DecrRefCount(pScript);
354}
355
drhaa940ea2004-01-15 02:44:03 +0000356/*
danielk19770202b292004-06-09 09:55:16 +0000357** This routine is called to evaluate an SQL collation function implemented
358** using TCL script.
359*/
360static int tclSqlCollate(
361 void *pCtx,
362 int nA,
363 const void *zA,
364 int nB,
365 const void *zB
366){
367 SqlCollate *p = (SqlCollate *)pCtx;
368 Tcl_Obj *pCmd;
369
370 pCmd = Tcl_NewStringObj(p->zScript, -1);
371 Tcl_IncrRefCount(pCmd);
372 Tcl_ListObjAppendElement(p->interp, pCmd, Tcl_NewStringObj(zA, nA));
373 Tcl_ListObjAppendElement(p->interp, pCmd, Tcl_NewStringObj(zB, nB));
drhd1e47332005-06-26 17:55:33 +0000374 Tcl_EvalObjEx(p->interp, pCmd, TCL_EVAL_DIRECT);
danielk19770202b292004-06-09 09:55:16 +0000375 Tcl_DecrRefCount(pCmd);
376 return (atoi(Tcl_GetStringResult(p->interp)));
377}
378
379/*
drhcabb0812002-09-14 13:47:32 +0000380** This routine is called to evaluate an SQL function implemented
381** using TCL script.
382*/
drhfb7e7652005-01-24 00:28:42 +0000383static void tclSqlFunc(sqlite3_context *context, int argc, sqlite3_value**argv){
danielk19776f8a5032004-05-10 10:34:51 +0000384 SqlFunc *p = sqlite3_user_data(context);
drhd1e47332005-06-26 17:55:33 +0000385 Tcl_Obj *pCmd;
drhcabb0812002-09-14 13:47:32 +0000386 int i;
387 int rc;
388
drhd1e47332005-06-26 17:55:33 +0000389 if( argc==0 ){
390 /* If there are no arguments to the function, call Tcl_EvalObjEx on the
391 ** script object directly. This allows the TCL compiler to generate
392 ** bytecode for the command on the first invocation and thus make
393 ** subsequent invocations much faster. */
394 pCmd = p->pScript;
395 Tcl_IncrRefCount(pCmd);
396 rc = Tcl_EvalObjEx(p->interp, pCmd, 0);
397 Tcl_DecrRefCount(pCmd);
398 }else{
399 /* If there are arguments to the function, make a shallow copy of the
400 ** script object, lappend the arguments, then evaluate the copy.
401 **
402 ** By "shallow" copy, we mean a only the outer list Tcl_Obj is duplicated.
403 ** The new Tcl_Obj contains pointers to the original list elements.
404 ** That way, when Tcl_EvalObjv() is run and shimmers the first element
405 ** of the list to tclCmdNameType, that alternate representation will
406 ** be preserved and reused on the next invocation.
407 */
408 Tcl_Obj **aArg;
409 int nArg;
410 if( Tcl_ListObjGetElements(p->interp, p->pScript, &nArg, &aArg) ){
411 sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
412 return;
413 }
414 pCmd = Tcl_NewListObj(nArg, aArg);
415 Tcl_IncrRefCount(pCmd);
416 for(i=0; i<argc; i++){
417 sqlite3_value *pIn = argv[i];
418 Tcl_Obj *pVal;
419
420 /* Set pVal to contain the i'th column of this row. */
421 switch( sqlite3_value_type(pIn) ){
422 case SQLITE_BLOB: {
423 int bytes = sqlite3_value_bytes(pIn);
424 pVal = Tcl_NewByteArrayObj(sqlite3_value_blob(pIn), bytes);
425 break;
426 }
427 case SQLITE_INTEGER: {
428 sqlite_int64 v = sqlite3_value_int64(pIn);
429 if( v>=-2147483647 && v<=2147483647 ){
430 pVal = Tcl_NewIntObj(v);
431 }else{
432 pVal = Tcl_NewWideIntObj(v);
433 }
434 break;
435 }
436 case SQLITE_FLOAT: {
437 double r = sqlite3_value_double(pIn);
438 pVal = Tcl_NewDoubleObj(r);
439 break;
440 }
441 case SQLITE_NULL: {
442 pVal = Tcl_NewStringObj("", 0);
443 break;
444 }
445 default: {
446 int bytes = sqlite3_value_bytes(pIn);
danielk197700fd9572005-12-07 06:27:43 +0000447 pVal = Tcl_NewStringObj((char *)sqlite3_value_text(pIn), bytes);
drhd1e47332005-06-26 17:55:33 +0000448 break;
449 }
450 }
451 rc = Tcl_ListObjAppendElement(p->interp, pCmd, pVal);
452 if( rc ){
453 Tcl_DecrRefCount(pCmd);
454 sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
455 return;
456 }
danielk197751ad0ec2004-05-24 12:39:02 +0000457 }
drhd1e47332005-06-26 17:55:33 +0000458 if( !p->useEvalObjv ){
459 /* Tcl_EvalObjEx() will automatically call Tcl_EvalObjv() if pCmd
460 ** is a list without a string representation. To prevent this from
461 ** happening, make sure pCmd has a valid string representation */
462 Tcl_GetString(pCmd);
463 }
464 rc = Tcl_EvalObjEx(p->interp, pCmd, TCL_EVAL_DIRECT);
465 Tcl_DecrRefCount(pCmd);
drhcabb0812002-09-14 13:47:32 +0000466 }
danielk1977562e8d32005-05-20 09:40:55 +0000467
drhc7f269d2005-05-05 10:30:29 +0000468 if( rc && rc!=TCL_RETURN ){
danielk19777e18c252004-05-25 11:47:24 +0000469 sqlite3_result_error(context, Tcl_GetStringResult(p->interp), -1);
drhcabb0812002-09-14 13:47:32 +0000470 }else{
drhc7f269d2005-05-05 10:30:29 +0000471 Tcl_Obj *pVar = Tcl_GetObjResult(p->interp);
472 int n;
473 u8 *data;
474 char *zType = pVar->typePtr ? pVar->typePtr->name : "";
475 char c = zType[0];
drhdf0bdda2005-06-25 19:31:48 +0000476 if( c=='b' && strcmp(zType,"bytearray")==0 && pVar->bytes==0 ){
drhd1e47332005-06-26 17:55:33 +0000477 /* Only return a BLOB type if the Tcl variable is a bytearray and
drhdf0bdda2005-06-25 19:31:48 +0000478 ** has no string representation. */
drhc7f269d2005-05-05 10:30:29 +0000479 data = Tcl_GetByteArrayFromObj(pVar, &n);
480 sqlite3_result_blob(context, data, n, SQLITE_TRANSIENT);
drhc7f269d2005-05-05 10:30:29 +0000481 }else if( (c=='b' && strcmp(zType,"boolean")==0) ||
482 (c=='i' && strcmp(zType,"int")==0) ){
483 Tcl_GetIntFromObj(0, pVar, &n);
484 sqlite3_result_int(context, n);
485 }else if( c=='d' && strcmp(zType,"double")==0 ){
486 double r;
487 Tcl_GetDoubleFromObj(0, pVar, &r);
488 sqlite3_result_double(context, r);
drhdf0bdda2005-06-25 19:31:48 +0000489 }else if( c=='w' && strcmp(zType,"wideInt")==0 ){
490 Tcl_WideInt v;
491 Tcl_GetWideIntFromObj(0, pVar, &v);
492 sqlite3_result_int64(context, v);
drhc7f269d2005-05-05 10:30:29 +0000493 }else{
danielk197700fd9572005-12-07 06:27:43 +0000494 data = (unsigned char *)Tcl_GetStringFromObj(pVar, &n);
495 sqlite3_result_text(context, (char *)data, n, SQLITE_TRANSIENT);
drhc7f269d2005-05-05 10:30:29 +0000496 }
drhcabb0812002-09-14 13:47:32 +0000497 }
498}
drh895d7472004-08-20 16:02:39 +0000499
drhe22a3342003-04-22 20:30:37 +0000500#ifndef SQLITE_OMIT_AUTHORIZATION
501/*
502** This is the authentication function. It appends the authentication
503** type code and the two arguments to zCmd[] then invokes the result
504** on the interpreter. The reply is examined to determine if the
505** authentication fails or succeeds.
506*/
507static int auth_callback(
508 void *pArg,
509 int code,
510 const char *zArg1,
511 const char *zArg2,
512 const char *zArg3,
513 const char *zArg4
514){
515 char *zCode;
516 Tcl_DString str;
517 int rc;
518 const char *zReply;
519 SqliteDb *pDb = (SqliteDb*)pArg;
520
521 switch( code ){
522 case SQLITE_COPY : zCode="SQLITE_COPY"; break;
523 case SQLITE_CREATE_INDEX : zCode="SQLITE_CREATE_INDEX"; break;
524 case SQLITE_CREATE_TABLE : zCode="SQLITE_CREATE_TABLE"; break;
525 case SQLITE_CREATE_TEMP_INDEX : zCode="SQLITE_CREATE_TEMP_INDEX"; break;
526 case SQLITE_CREATE_TEMP_TABLE : zCode="SQLITE_CREATE_TEMP_TABLE"; break;
527 case SQLITE_CREATE_TEMP_TRIGGER: zCode="SQLITE_CREATE_TEMP_TRIGGER"; break;
528 case SQLITE_CREATE_TEMP_VIEW : zCode="SQLITE_CREATE_TEMP_VIEW"; break;
529 case SQLITE_CREATE_TRIGGER : zCode="SQLITE_CREATE_TRIGGER"; break;
530 case SQLITE_CREATE_VIEW : zCode="SQLITE_CREATE_VIEW"; break;
531 case SQLITE_DELETE : zCode="SQLITE_DELETE"; break;
532 case SQLITE_DROP_INDEX : zCode="SQLITE_DROP_INDEX"; break;
533 case SQLITE_DROP_TABLE : zCode="SQLITE_DROP_TABLE"; break;
534 case SQLITE_DROP_TEMP_INDEX : zCode="SQLITE_DROP_TEMP_INDEX"; break;
535 case SQLITE_DROP_TEMP_TABLE : zCode="SQLITE_DROP_TEMP_TABLE"; break;
536 case SQLITE_DROP_TEMP_TRIGGER : zCode="SQLITE_DROP_TEMP_TRIGGER"; break;
537 case SQLITE_DROP_TEMP_VIEW : zCode="SQLITE_DROP_TEMP_VIEW"; break;
538 case SQLITE_DROP_TRIGGER : zCode="SQLITE_DROP_TRIGGER"; break;
539 case SQLITE_DROP_VIEW : zCode="SQLITE_DROP_VIEW"; break;
540 case SQLITE_INSERT : zCode="SQLITE_INSERT"; break;
541 case SQLITE_PRAGMA : zCode="SQLITE_PRAGMA"; break;
542 case SQLITE_READ : zCode="SQLITE_READ"; break;
543 case SQLITE_SELECT : zCode="SQLITE_SELECT"; break;
544 case SQLITE_TRANSACTION : zCode="SQLITE_TRANSACTION"; break;
545 case SQLITE_UPDATE : zCode="SQLITE_UPDATE"; break;
drh81e293b2003-06-06 19:00:42 +0000546 case SQLITE_ATTACH : zCode="SQLITE_ATTACH"; break;
547 case SQLITE_DETACH : zCode="SQLITE_DETACH"; break;
danielk19771c8c23c2004-11-12 15:53:37 +0000548 case SQLITE_ALTER_TABLE : zCode="SQLITE_ALTER_TABLE"; break;
danielk19771d54df82004-11-23 15:41:16 +0000549 case SQLITE_REINDEX : zCode="SQLITE_REINDEX"; break;
drhe6e04962005-07-23 02:17:03 +0000550 case SQLITE_ANALYZE : zCode="SQLITE_ANALYZE"; break;
drhe22a3342003-04-22 20:30:37 +0000551 default : zCode="????"; break;
552 }
553 Tcl_DStringInit(&str);
554 Tcl_DStringAppend(&str, pDb->zAuth, -1);
555 Tcl_DStringAppendElement(&str, zCode);
556 Tcl_DStringAppendElement(&str, zArg1 ? zArg1 : "");
557 Tcl_DStringAppendElement(&str, zArg2 ? zArg2 : "");
558 Tcl_DStringAppendElement(&str, zArg3 ? zArg3 : "");
559 Tcl_DStringAppendElement(&str, zArg4 ? zArg4 : "");
560 rc = Tcl_GlobalEval(pDb->interp, Tcl_DStringValue(&str));
561 Tcl_DStringFree(&str);
562 zReply = Tcl_GetStringResult(pDb->interp);
563 if( strcmp(zReply,"SQLITE_OK")==0 ){
564 rc = SQLITE_OK;
565 }else if( strcmp(zReply,"SQLITE_DENY")==0 ){
566 rc = SQLITE_DENY;
567 }else if( strcmp(zReply,"SQLITE_IGNORE")==0 ){
568 rc = SQLITE_IGNORE;
569 }else{
570 rc = 999;
571 }
572 return rc;
573}
574#endif /* SQLITE_OMIT_AUTHORIZATION */
drhcabb0812002-09-14 13:47:32 +0000575
576/*
danielk1977ef2cb632004-05-29 02:37:19 +0000577** zText is a pointer to text obtained via an sqlite3_result_text()
578** or similar interface. This routine returns a Tcl string object,
579** reference count set to 0, containing the text. If a translation
580** between iso8859 and UTF-8 is required, it is preformed.
581*/
582static Tcl_Obj *dbTextToObj(char const *zText){
583 Tcl_Obj *pVal;
584#ifdef UTF_TRANSLATION_NEEDED
585 Tcl_DString dCol;
586 Tcl_DStringInit(&dCol);
587 Tcl_ExternalToUtfDString(NULL, zText, -1, &dCol);
588 pVal = Tcl_NewStringObj(Tcl_DStringValue(&dCol), -1);
589 Tcl_DStringFree(&dCol);
590#else
591 pVal = Tcl_NewStringObj(zText, -1);
592#endif
593 return pVal;
594}
595
596/*
tpoindex1067fe12004-12-17 15:41:11 +0000597** This routine reads a line of text from FILE in, stores
598** the text in memory obtained from malloc() and returns a pointer
599** to the text. NULL is returned at end of file, or if malloc()
600** fails.
601**
602** The interface is like "readline" but no command-line editing
603** is done.
604**
605** copied from shell.c from '.import' command
606*/
607static char *local_getline(char *zPrompt, FILE *in){
608 char *zLine;
609 int nLine;
610 int n;
611 int eol;
612
613 nLine = 100;
614 zLine = malloc( nLine );
615 if( zLine==0 ) return 0;
616 n = 0;
617 eol = 0;
618 while( !eol ){
619 if( n+100>nLine ){
620 nLine = nLine*2 + 100;
621 zLine = realloc(zLine, nLine);
622 if( zLine==0 ) return 0;
623 }
624 if( fgets(&zLine[n], nLine - n, in)==0 ){
625 if( n==0 ){
626 free(zLine);
627 return 0;
628 }
629 zLine[n] = 0;
630 eol = 1;
631 break;
632 }
633 while( zLine[n] ){ n++; }
634 if( n>0 && zLine[n-1]=='\n' ){
635 n--;
636 zLine[n] = 0;
637 eol = 1;
638 }
639 }
640 zLine = realloc( zLine, n+1 );
641 return zLine;
642}
643
644/*
drh75897232000-05-29 14:26:00 +0000645** The "sqlite" command below creates a new Tcl command for each
646** connection it opens to an SQLite database. This routine is invoked
647** whenever one of those connection-specific commands is executed
648** in Tcl. For example, if you run Tcl code like this:
649**
drh9bb575f2004-09-06 17:24:11 +0000650** sqlite3 db1 "my_database"
drh75897232000-05-29 14:26:00 +0000651** db1 close
652**
653** The first command opens a connection to the "my_database" database
654** and calls that connection "db1". The second command causes this
655** subroutine to be invoked.
656*/
drh6d313162000-09-21 13:01:35 +0000657static int DbObjCmd(void *cd, Tcl_Interp *interp, int objc,Tcl_Obj *const*objv){
drhbec3f402000-08-04 13:49:02 +0000658 SqliteDb *pDb = (SqliteDb*)cd;
drh6d313162000-09-21 13:01:35 +0000659 int choice;
drh22fbcb82004-02-01 01:22:50 +0000660 int rc = TCL_OK;
drh0de8c112002-07-06 16:32:14 +0000661 static const char *DB_strs[] = {
drhfb7e7652005-01-24 00:28:42 +0000662 "authorizer", "busy", "cache",
663 "changes", "close", "collate",
664 "collation_needed", "commit_hook", "complete",
665 "copy", "errorcode", "eval",
drh97f2ebc2005-12-10 21:19:04 +0000666 "exists", "function", "last_insert_rowid",
667 "nullvalue", "onecolumn", "profile",
danielk197771fd80b2005-12-16 06:54:01 +0000668 "progress", "rekey", "rollback_hook",
drh6aafc292006-01-05 15:50:06 +0000669 "timeout", "total_changes", "trace",
670 "transaction", "update_hook", "version",
671 0
drh6d313162000-09-21 13:01:35 +0000672 };
drh411995d2002-06-25 19:31:18 +0000673 enum DB_enum {
drhfb7e7652005-01-24 00:28:42 +0000674 DB_AUTHORIZER, DB_BUSY, DB_CACHE,
675 DB_CHANGES, DB_CLOSE, DB_COLLATE,
676 DB_COLLATION_NEEDED, DB_COMMIT_HOOK, DB_COMPLETE,
677 DB_COPY, DB_ERRORCODE, DB_EVAL,
drh97f2ebc2005-12-10 21:19:04 +0000678 DB_EXISTS, DB_FUNCTION, DB_LAST_INSERT_ROWID,
679 DB_NULLVALUE, DB_ONECOLUMN, DB_PROFILE,
danielk197771fd80b2005-12-16 06:54:01 +0000680 DB_PROGRESS, DB_REKEY, DB_ROLLBACK_HOOK,
drh6aafc292006-01-05 15:50:06 +0000681 DB_TIMEOUT, DB_TOTAL_CHANGES, DB_TRACE,
682 DB_TRANSACTION, DB_UPDATE_HOOK, DB_VERSION
drh6d313162000-09-21 13:01:35 +0000683 };
tpoindex1067fe12004-12-17 15:41:11 +0000684 /* don't leave trailing commas on DB_enum, it confuses the AIX xlc compiler */
drh6d313162000-09-21 13:01:35 +0000685
686 if( objc<2 ){
687 Tcl_WrongNumArgs(interp, 1, objv, "SUBCOMMAND ...");
drh75897232000-05-29 14:26:00 +0000688 return TCL_ERROR;
689 }
drh411995d2002-06-25 19:31:18 +0000690 if( Tcl_GetIndexFromObj(interp, objv[1], DB_strs, "option", 0, &choice) ){
drh6d313162000-09-21 13:01:35 +0000691 return TCL_ERROR;
692 }
693
drh411995d2002-06-25 19:31:18 +0000694 switch( (enum DB_enum)choice ){
drh75897232000-05-29 14:26:00 +0000695
drhe22a3342003-04-22 20:30:37 +0000696 /* $db authorizer ?CALLBACK?
697 **
698 ** Invoke the given callback to authorize each SQL operation as it is
699 ** compiled. 5 arguments are appended to the callback before it is
700 ** invoked:
701 **
702 ** (1) The authorization type (ex: SQLITE_CREATE_TABLE, SQLITE_INSERT, ...)
703 ** (2) First descriptive name (depends on authorization type)
704 ** (3) Second descriptive name
705 ** (4) Name of the database (ex: "main", "temp")
706 ** (5) Name of trigger that is doing the access
707 **
708 ** The callback should return on of the following strings: SQLITE_OK,
709 ** SQLITE_IGNORE, or SQLITE_DENY. Any other return value is an error.
710 **
711 ** If this method is invoked with no arguments, the current authorization
712 ** callback string is returned.
713 */
714 case DB_AUTHORIZER: {
drh1211de32004-07-26 12:24:22 +0000715#ifdef SQLITE_OMIT_AUTHORIZATION
716 Tcl_AppendResult(interp, "authorization not available in this build", 0);
717 return TCL_ERROR;
718#else
drhe22a3342003-04-22 20:30:37 +0000719 if( objc>3 ){
720 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
drh0f14e2e2004-06-29 12:39:08 +0000721 return TCL_ERROR;
drhe22a3342003-04-22 20:30:37 +0000722 }else if( objc==2 ){
drhb5a20d32003-04-23 12:25:23 +0000723 if( pDb->zAuth ){
drhe22a3342003-04-22 20:30:37 +0000724 Tcl_AppendResult(interp, pDb->zAuth, 0);
725 }
726 }else{
727 char *zAuth;
728 int len;
729 if( pDb->zAuth ){
730 Tcl_Free(pDb->zAuth);
731 }
732 zAuth = Tcl_GetStringFromObj(objv[2], &len);
733 if( zAuth && len>0 ){
734 pDb->zAuth = Tcl_Alloc( len + 1 );
735 strcpy(pDb->zAuth, zAuth);
736 }else{
737 pDb->zAuth = 0;
738 }
drhe22a3342003-04-22 20:30:37 +0000739 if( pDb->zAuth ){
740 pDb->interp = interp;
danielk19776f8a5032004-05-10 10:34:51 +0000741 sqlite3_set_authorizer(pDb->db, auth_callback, pDb);
drhe22a3342003-04-22 20:30:37 +0000742 }else{
danielk19776f8a5032004-05-10 10:34:51 +0000743 sqlite3_set_authorizer(pDb->db, 0, 0);
drhe22a3342003-04-22 20:30:37 +0000744 }
drhe22a3342003-04-22 20:30:37 +0000745 }
drh1211de32004-07-26 12:24:22 +0000746#endif
drhe22a3342003-04-22 20:30:37 +0000747 break;
748 }
749
drhbec3f402000-08-04 13:49:02 +0000750 /* $db busy ?CALLBACK?
751 **
752 ** Invoke the given callback if an SQL statement attempts to open
753 ** a locked database file.
754 */
drh6d313162000-09-21 13:01:35 +0000755 case DB_BUSY: {
756 if( objc>3 ){
757 Tcl_WrongNumArgs(interp, 2, objv, "CALLBACK");
drhbec3f402000-08-04 13:49:02 +0000758 return TCL_ERROR;
drh6d313162000-09-21 13:01:35 +0000759 }else if( objc==2 ){
drhbec3f402000-08-04 13:49:02 +0000760 if( pDb->zBusy ){
761 Tcl_AppendResult(interp, pDb->zBusy, 0);
762 }
763 }else{
drh6d313162000-09-21 13:01:35 +0000764 char *zBusy;
765 int len;
drhbec3f402000-08-04 13:49:02 +0000766 if( pDb->zBusy ){
767 Tcl_Free(pDb->zBusy);
drhbec3f402000-08-04 13:49:02 +0000768 }
drh6d313162000-09-21 13:01:35 +0000769 zBusy = Tcl_GetStringFromObj(objv[2], &len);
770 if( zBusy && len>0 ){
771 pDb->zBusy = Tcl_Alloc( len + 1 );
772 strcpy(pDb->zBusy, zBusy);
773 }else{
774 pDb->zBusy = 0;
drhbec3f402000-08-04 13:49:02 +0000775 }
776 if( pDb->zBusy ){
777 pDb->interp = interp;
danielk19776f8a5032004-05-10 10:34:51 +0000778 sqlite3_busy_handler(pDb->db, DbBusyHandler, pDb);
drh6d313162000-09-21 13:01:35 +0000779 }else{
danielk19776f8a5032004-05-10 10:34:51 +0000780 sqlite3_busy_handler(pDb->db, 0, 0);
drhbec3f402000-08-04 13:49:02 +0000781 }
782 }
drh6d313162000-09-21 13:01:35 +0000783 break;
784 }
drhbec3f402000-08-04 13:49:02 +0000785
drhfb7e7652005-01-24 00:28:42 +0000786 /* $db cache flush
787 ** $db cache size n
788 **
789 ** Flush the prepared statement cache, or set the maximum number of
790 ** cached statements.
791 */
792 case DB_CACHE: {
793 char *subCmd;
794 int n;
795
796 if( objc<=2 ){
797 Tcl_WrongNumArgs(interp, 1, objv, "cache option ?arg?");
798 return TCL_ERROR;
799 }
800 subCmd = Tcl_GetStringFromObj( objv[2], 0 );
801 if( *subCmd=='f' && strcmp(subCmd,"flush")==0 ){
802 if( objc!=3 ){
803 Tcl_WrongNumArgs(interp, 2, objv, "flush");
804 return TCL_ERROR;
805 }else{
806 flushStmtCache( pDb );
807 }
808 }else if( *subCmd=='s' && strcmp(subCmd,"size")==0 ){
809 if( objc!=4 ){
810 Tcl_WrongNumArgs(interp, 2, objv, "size n");
811 return TCL_ERROR;
812 }else{
813 if( TCL_ERROR==Tcl_GetIntFromObj(interp, objv[3], &n) ){
814 Tcl_AppendResult( interp, "cannot convert \"",
815 Tcl_GetStringFromObj(objv[3],0), "\" to integer", 0);
816 return TCL_ERROR;
817 }else{
818 if( n<0 ){
819 flushStmtCache( pDb );
820 n = 0;
821 }else if( n>MAX_PREPARED_STMTS ){
822 n = MAX_PREPARED_STMTS;
823 }
824 pDb->maxStmt = n;
825 }
826 }
827 }else{
828 Tcl_AppendResult( interp, "bad option \"",
829 Tcl_GetStringFromObj(objv[0],0), "\": must be flush or size", 0);
830 return TCL_ERROR;
831 }
832 break;
833 }
834
danielk1977b28af712004-06-21 06:50:26 +0000835 /* $db changes
drhc8d30ac2002-04-12 10:08:59 +0000836 **
837 ** Return the number of rows that were modified, inserted, or deleted by
danielk1977b28af712004-06-21 06:50:26 +0000838 ** the most recent INSERT, UPDATE or DELETE statement, not including
839 ** any changes made by trigger programs.
drhc8d30ac2002-04-12 10:08:59 +0000840 */
841 case DB_CHANGES: {
842 Tcl_Obj *pResult;
drhc8d30ac2002-04-12 10:08:59 +0000843 if( objc!=2 ){
844 Tcl_WrongNumArgs(interp, 2, objv, "");
845 return TCL_ERROR;
846 }
drhc8d30ac2002-04-12 10:08:59 +0000847 pResult = Tcl_GetObjResult(interp);
danielk1977b28af712004-06-21 06:50:26 +0000848 Tcl_SetIntObj(pResult, sqlite3_changes(pDb->db));
rdcf146a772004-02-25 22:51:06 +0000849 break;
850 }
851
drh75897232000-05-29 14:26:00 +0000852 /* $db close
853 **
854 ** Shutdown the database
855 */
drh6d313162000-09-21 13:01:35 +0000856 case DB_CLOSE: {
857 Tcl_DeleteCommand(interp, Tcl_GetStringFromObj(objv[0], 0));
858 break;
859 }
drh75897232000-05-29 14:26:00 +0000860
drh0f14e2e2004-06-29 12:39:08 +0000861 /*
862 ** $db collate NAME SCRIPT
863 **
864 ** Create a new SQL collation function called NAME. Whenever
865 ** that function is called, invoke SCRIPT to evaluate the function.
866 */
867 case DB_COLLATE: {
868 SqlCollate *pCollate;
869 char *zName;
870 char *zScript;
871 int nScript;
872 if( objc!=4 ){
873 Tcl_WrongNumArgs(interp, 2, objv, "NAME SCRIPT");
874 return TCL_ERROR;
875 }
876 zName = Tcl_GetStringFromObj(objv[2], 0);
877 zScript = Tcl_GetStringFromObj(objv[3], &nScript);
878 pCollate = (SqlCollate*)Tcl_Alloc( sizeof(*pCollate) + nScript + 1 );
879 if( pCollate==0 ) return TCL_ERROR;
880 pCollate->interp = interp;
881 pCollate->pNext = pDb->pCollate;
882 pCollate->zScript = (char*)&pCollate[1];
883 pDb->pCollate = pCollate;
884 strcpy(pCollate->zScript, zScript);
885 if( sqlite3_create_collation(pDb->db, zName, SQLITE_UTF8,
886 pCollate, tclSqlCollate) ){
danielk19779636c4e2005-01-25 04:27:54 +0000887 Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
drh0f14e2e2004-06-29 12:39:08 +0000888 return TCL_ERROR;
889 }
890 break;
891 }
892
893 /*
894 ** $db collation_needed SCRIPT
895 **
896 ** Create a new SQL collation function called NAME. Whenever
897 ** that function is called, invoke SCRIPT to evaluate the function.
898 */
899 case DB_COLLATION_NEEDED: {
900 if( objc!=3 ){
901 Tcl_WrongNumArgs(interp, 2, objv, "SCRIPT");
902 return TCL_ERROR;
903 }
904 if( pDb->pCollateNeeded ){
905 Tcl_DecrRefCount(pDb->pCollateNeeded);
906 }
907 pDb->pCollateNeeded = Tcl_DuplicateObj(objv[2]);
908 Tcl_IncrRefCount(pDb->pCollateNeeded);
909 sqlite3_collation_needed(pDb->db, pDb, tclCollateNeeded);
910 break;
911 }
912
drh19e2d372005-08-29 23:00:03 +0000913 /* $db commit_hook ?CALLBACK?
914 **
915 ** Invoke the given callback just before committing every SQL transaction.
916 ** If the callback throws an exception or returns non-zero, then the
917 ** transaction is aborted. If CALLBACK is an empty string, the callback
918 ** is disabled.
919 */
920 case DB_COMMIT_HOOK: {
921 if( objc>3 ){
922 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
923 return TCL_ERROR;
924 }else if( objc==2 ){
925 if( pDb->zCommit ){
926 Tcl_AppendResult(interp, pDb->zCommit, 0);
927 }
928 }else{
929 char *zCommit;
930 int len;
931 if( pDb->zCommit ){
932 Tcl_Free(pDb->zCommit);
933 }
934 zCommit = Tcl_GetStringFromObj(objv[2], &len);
935 if( zCommit && len>0 ){
936 pDb->zCommit = Tcl_Alloc( len + 1 );
937 strcpy(pDb->zCommit, zCommit);
938 }else{
939 pDb->zCommit = 0;
940 }
941 if( pDb->zCommit ){
942 pDb->interp = interp;
943 sqlite3_commit_hook(pDb->db, DbCommitHandler, pDb);
944 }else{
945 sqlite3_commit_hook(pDb->db, 0, 0);
946 }
947 }
948 break;
949 }
950
drh75897232000-05-29 14:26:00 +0000951 /* $db complete SQL
952 **
953 ** Return TRUE if SQL is a complete SQL statement. Return FALSE if
954 ** additional lines of input are needed. This is similar to the
955 ** built-in "info complete" command of Tcl.
956 */
drh6d313162000-09-21 13:01:35 +0000957 case DB_COMPLETE: {
drhccae6022005-02-26 17:31:26 +0000958#ifndef SQLITE_OMIT_COMPLETE
drh6d313162000-09-21 13:01:35 +0000959 Tcl_Obj *pResult;
960 int isComplete;
961 if( objc!=3 ){
962 Tcl_WrongNumArgs(interp, 2, objv, "SQL");
drh75897232000-05-29 14:26:00 +0000963 return TCL_ERROR;
964 }
danielk19776f8a5032004-05-10 10:34:51 +0000965 isComplete = sqlite3_complete( Tcl_GetStringFromObj(objv[2], 0) );
drh6d313162000-09-21 13:01:35 +0000966 pResult = Tcl_GetObjResult(interp);
967 Tcl_SetBooleanObj(pResult, isComplete);
drhccae6022005-02-26 17:31:26 +0000968#endif
drh6d313162000-09-21 13:01:35 +0000969 break;
970 }
drhdcd997e2003-01-31 17:21:49 +0000971
drh19e2d372005-08-29 23:00:03 +0000972 /* $db copy conflict-algorithm table filename ?SEPARATOR? ?NULLINDICATOR?
973 **
974 ** Copy data into table from filename, optionally using SEPARATOR
975 ** as column separators. If a column contains a null string, or the
976 ** value of NULLINDICATOR, a NULL is inserted for the column.
977 ** conflict-algorithm is one of the sqlite conflict algorithms:
978 ** rollback, abort, fail, ignore, replace
979 ** On success, return the number of lines processed, not necessarily same
980 ** as 'db changes' due to conflict-algorithm selected.
981 **
982 ** This code is basically an implementation/enhancement of
983 ** the sqlite3 shell.c ".import" command.
984 **
985 ** This command usage is equivalent to the sqlite2.x COPY statement,
986 ** which imports file data into a table using the PostgreSQL COPY file format:
987 ** $db copy $conflit_algo $table_name $filename \t \\N
988 */
989 case DB_COPY: {
990 char *zTable; /* Insert data into this table */
991 char *zFile; /* The file from which to extract data */
992 char *zConflict; /* The conflict algorithm to use */
993 sqlite3_stmt *pStmt; /* A statement */
994 int rc; /* Result code */
995 int nCol; /* Number of columns in the table */
996 int nByte; /* Number of bytes in an SQL string */
997 int i, j; /* Loop counters */
998 int nSep; /* Number of bytes in zSep[] */
999 int nNull; /* Number of bytes in zNull[] */
1000 char *zSql; /* An SQL statement */
1001 char *zLine; /* A single line of input from the file */
1002 char **azCol; /* zLine[] broken up into columns */
1003 char *zCommit; /* How to commit changes */
1004 FILE *in; /* The input file */
1005 int lineno = 0; /* Line number of input file */
1006 char zLineNum[80]; /* Line number print buffer */
1007 Tcl_Obj *pResult; /* interp result */
1008
1009 char *zSep;
1010 char *zNull;
1011 if( objc<5 || objc>7 ){
1012 Tcl_WrongNumArgs(interp, 2, objv,
1013 "CONFLICT-ALGORITHM TABLE FILENAME ?SEPARATOR? ?NULLINDICATOR?");
1014 return TCL_ERROR;
1015 }
1016 if( objc>=6 ){
1017 zSep = Tcl_GetStringFromObj(objv[5], 0);
1018 }else{
1019 zSep = "\t";
1020 }
1021 if( objc>=7 ){
1022 zNull = Tcl_GetStringFromObj(objv[6], 0);
1023 }else{
1024 zNull = "";
1025 }
1026 zConflict = Tcl_GetStringFromObj(objv[2], 0);
1027 zTable = Tcl_GetStringFromObj(objv[3], 0);
1028 zFile = Tcl_GetStringFromObj(objv[4], 0);
1029 nSep = strlen(zSep);
1030 nNull = strlen(zNull);
1031 if( nSep==0 ){
1032 Tcl_AppendResult(interp, "Error: non-null separator required for copy", 0);
1033 return TCL_ERROR;
1034 }
1035 if(sqlite3StrICmp(zConflict, "rollback") != 0 &&
1036 sqlite3StrICmp(zConflict, "abort" ) != 0 &&
1037 sqlite3StrICmp(zConflict, "fail" ) != 0 &&
1038 sqlite3StrICmp(zConflict, "ignore" ) != 0 &&
1039 sqlite3StrICmp(zConflict, "replace" ) != 0 ) {
1040 Tcl_AppendResult(interp, "Error: \"", zConflict,
1041 "\", conflict-algorithm must be one of: rollback, "
1042 "abort, fail, ignore, or replace", 0);
1043 return TCL_ERROR;
1044 }
1045 zSql = sqlite3_mprintf("SELECT * FROM '%q'", zTable);
1046 if( zSql==0 ){
1047 Tcl_AppendResult(interp, "Error: no such table: ", zTable, 0);
1048 return TCL_ERROR;
1049 }
1050 nByte = strlen(zSql);
1051 rc = sqlite3_prepare(pDb->db, zSql, 0, &pStmt, 0);
1052 sqlite3_free(zSql);
1053 if( rc ){
1054 Tcl_AppendResult(interp, "Error: ", sqlite3_errmsg(pDb->db), 0);
1055 nCol = 0;
1056 }else{
1057 nCol = sqlite3_column_count(pStmt);
1058 }
1059 sqlite3_finalize(pStmt);
1060 if( nCol==0 ) {
1061 return TCL_ERROR;
1062 }
1063 zSql = malloc( nByte + 50 + nCol*2 );
1064 if( zSql==0 ) {
1065 Tcl_AppendResult(interp, "Error: can't malloc()", 0);
1066 return TCL_ERROR;
1067 }
1068 sqlite3_snprintf(nByte+50, zSql, "INSERT OR %q INTO '%q' VALUES(?",
1069 zConflict, zTable);
1070 j = strlen(zSql);
1071 for(i=1; i<nCol; i++){
1072 zSql[j++] = ',';
1073 zSql[j++] = '?';
1074 }
1075 zSql[j++] = ')';
1076 zSql[j] = 0;
1077 rc = sqlite3_prepare(pDb->db, zSql, 0, &pStmt, 0);
1078 free(zSql);
1079 if( rc ){
1080 Tcl_AppendResult(interp, "Error: ", sqlite3_errmsg(pDb->db), 0);
1081 sqlite3_finalize(pStmt);
1082 return TCL_ERROR;
1083 }
1084 in = fopen(zFile, "rb");
1085 if( in==0 ){
1086 Tcl_AppendResult(interp, "Error: cannot open file: ", zFile, NULL);
1087 sqlite3_finalize(pStmt);
1088 return TCL_ERROR;
1089 }
1090 azCol = malloc( sizeof(azCol[0])*(nCol+1) );
1091 if( azCol==0 ) {
1092 Tcl_AppendResult(interp, "Error: can't malloc()", 0);
1093 return TCL_ERROR;
1094 }
1095 sqlite3_exec(pDb->db, "BEGIN", 0, 0, 0);
1096 zCommit = "COMMIT";
1097 while( (zLine = local_getline(0, in))!=0 ){
1098 char *z;
1099 i = 0;
1100 lineno++;
1101 azCol[0] = zLine;
1102 for(i=0, z=zLine; *z; z++){
1103 if( *z==zSep[0] && strncmp(z, zSep, nSep)==0 ){
1104 *z = 0;
1105 i++;
1106 if( i<nCol ){
1107 azCol[i] = &z[nSep];
1108 z += nSep-1;
1109 }
1110 }
1111 }
1112 if( i+1!=nCol ){
1113 char *zErr;
1114 zErr = malloc(200 + strlen(zFile));
1115 sprintf(zErr,"Error: %s line %d: expected %d columns of data but found %d",
1116 zFile, lineno, nCol, i+1);
1117 Tcl_AppendResult(interp, zErr, 0);
1118 free(zErr);
1119 zCommit = "ROLLBACK";
1120 break;
1121 }
1122 for(i=0; i<nCol; i++){
1123 /* check for null data, if so, bind as null */
1124 if ((nNull>0 && strcmp(azCol[i], zNull)==0) || strlen(azCol[i])==0) {
1125 sqlite3_bind_null(pStmt, i+1);
1126 }else{
1127 sqlite3_bind_text(pStmt, i+1, azCol[i], -1, SQLITE_STATIC);
1128 }
1129 }
1130 sqlite3_step(pStmt);
1131 rc = sqlite3_reset(pStmt);
1132 free(zLine);
1133 if( rc!=SQLITE_OK ){
1134 Tcl_AppendResult(interp,"Error: ", sqlite3_errmsg(pDb->db), 0);
1135 zCommit = "ROLLBACK";
1136 break;
1137 }
1138 }
1139 free(azCol);
1140 fclose(in);
1141 sqlite3_finalize(pStmt);
1142 sqlite3_exec(pDb->db, zCommit, 0, 0, 0);
1143
1144 if( zCommit[0] == 'C' ){
1145 /* success, set result as number of lines processed */
1146 pResult = Tcl_GetObjResult(interp);
1147 Tcl_SetIntObj(pResult, lineno);
1148 rc = TCL_OK;
1149 }else{
1150 /* failure, append lineno where failed */
1151 sprintf(zLineNum,"%d",lineno);
1152 Tcl_AppendResult(interp,", failed while processing line: ",zLineNum,0);
1153 rc = TCL_ERROR;
1154 }
1155 break;
1156 }
1157
drhdcd997e2003-01-31 17:21:49 +00001158 /*
1159 ** $db errorcode
1160 **
1161 ** Return the numeric error code that was returned by the most recent
danielk19776f8a5032004-05-10 10:34:51 +00001162 ** call to sqlite3_exec().
drhdcd997e2003-01-31 17:21:49 +00001163 */
1164 case DB_ERRORCODE: {
danielk1977f3ce83f2004-06-14 11:43:46 +00001165 Tcl_SetObjResult(interp, Tcl_NewIntObj(sqlite3_errcode(pDb->db)));
drhdcd997e2003-01-31 17:21:49 +00001166 break;
1167 }
drh75897232000-05-29 14:26:00 +00001168
1169 /*
drh895d7472004-08-20 16:02:39 +00001170 ** $db eval $sql ?array? ?{ ...code... }?
drh1807ce32004-09-07 13:20:35 +00001171 ** $db onecolumn $sql
drh75897232000-05-29 14:26:00 +00001172 **
1173 ** The SQL statement in $sql is evaluated. For each row, the values are
drhbec3f402000-08-04 13:49:02 +00001174 ** placed in elements of the array named "array" and ...code... is executed.
drh75897232000-05-29 14:26:00 +00001175 ** If "array" and "code" are omitted, then no callback is every invoked.
1176 ** If "array" is an empty string, then the values are placed in variables
1177 ** that have the same name as the fields extracted by the query.
drh1807ce32004-09-07 13:20:35 +00001178 **
1179 ** The onecolumn method is the equivalent of:
1180 ** lindex [$db eval $sql] 0
drh75897232000-05-29 14:26:00 +00001181 */
drh1807ce32004-09-07 13:20:35 +00001182 case DB_ONECOLUMN:
drh97f2ebc2005-12-10 21:19:04 +00001183 case DB_EVAL:
1184 case DB_EXISTS: {
drh9d74b4c2004-08-24 15:23:34 +00001185 char const *zSql; /* Next SQL statement to execute */
1186 char const *zLeft; /* What is left after first stmt in zSql */
1187 sqlite3_stmt *pStmt; /* Compiled SQL statment */
drh92febd92004-08-20 18:34:20 +00001188 Tcl_Obj *pArray; /* Name of array into which results are written */
1189 Tcl_Obj *pScript; /* Script to run for each result set */
drh1d895032004-08-26 00:56:05 +00001190 Tcl_Obj **apParm; /* Parameters that need a Tcl_DecrRefCount() */
1191 int nParm; /* Number of entries used in apParm[] */
1192 Tcl_Obj *aParm[10]; /* Static space for apParm[] in the common case */
drh1807ce32004-09-07 13:20:35 +00001193 Tcl_Obj *pRet; /* Value to be returned */
drhfb7e7652005-01-24 00:28:42 +00001194 SqlPreparedStmt *pPreStmt; /* Pointer to a prepared statement */
1195 int rc2;
danielk1977ef2cb632004-05-29 02:37:19 +00001196
drh97f2ebc2005-12-10 21:19:04 +00001197 if( choice==DB_EVAL ){
drh1807ce32004-09-07 13:20:35 +00001198 if( objc<3 || objc>5 ){
1199 Tcl_WrongNumArgs(interp, 2, objv, "SQL ?ARRAY-NAME? ?SCRIPT?");
1200 return TCL_ERROR;
1201 }
1202 pRet = Tcl_NewObj();
1203 Tcl_IncrRefCount(pRet);
drh97f2ebc2005-12-10 21:19:04 +00001204 }else{
1205 if( objc!=3 ){
1206 Tcl_WrongNumArgs(interp, 2, objv, "SQL");
1207 return TCL_ERROR;
1208 }
drh97f2ebc2005-12-10 21:19:04 +00001209 if( choice==DB_EXISTS ){
drh446a9b82006-01-04 18:13:26 +00001210 pRet = Tcl_NewBooleanObj(0);
1211 Tcl_IncrRefCount(pRet);
1212 }else{
1213 pRet = 0;
drh97f2ebc2005-12-10 21:19:04 +00001214 }
danielk197730ccda12004-05-27 12:11:31 +00001215 }
drh92febd92004-08-20 18:34:20 +00001216 if( objc==3 ){
1217 pArray = pScript = 0;
1218 }else if( objc==4 ){
1219 pArray = 0;
1220 pScript = objv[3];
1221 }else{
1222 pArray = objv[3];
1223 if( Tcl_GetString(pArray)[0]==0 ) pArray = 0;
1224 pScript = objv[4];
1225 }
danielk197730ccda12004-05-27 12:11:31 +00001226
drh1d895032004-08-26 00:56:05 +00001227 Tcl_IncrRefCount(objv[2]);
danielk197730ccda12004-05-27 12:11:31 +00001228 zSql = Tcl_GetStringFromObj(objv[2], 0);
drh90b6bb12004-09-13 13:16:31 +00001229 while( rc==TCL_OK && zSql[0] ){
drhfb7e7652005-01-24 00:28:42 +00001230 int i; /* Loop counter */
1231 int nVar; /* Number of bind parameters in the pStmt */
1232 int nCol; /* Number of columns in the result set */
drh92febd92004-08-20 18:34:20 +00001233 Tcl_Obj **apColName = 0; /* Array of column names */
drhfb7e7652005-01-24 00:28:42 +00001234 int len; /* String length of zSql */
danielk197730ccda12004-05-27 12:11:31 +00001235
drhfb7e7652005-01-24 00:28:42 +00001236 /* Try to find a SQL statement that has already been compiled and
1237 ** which matches the next sequence of SQL.
1238 */
1239 pStmt = 0;
1240 pPreStmt = pDb->stmtList;
1241 len = strlen(zSql);
1242 if( pPreStmt && sqlite3_expired(pPreStmt->pStmt) ){
1243 flushStmtCache(pDb);
1244 pPreStmt = 0;
danielk197730ccda12004-05-27 12:11:31 +00001245 }
drhfb7e7652005-01-24 00:28:42 +00001246 for(; pPreStmt; pPreStmt=pPreStmt->pNext){
1247 int n = pPreStmt->nSql;
1248 if( len>=n
1249 && memcmp(pPreStmt->zSql, zSql, n)==0
1250 && (zSql[n]==0 || zSql[n-1]==';')
1251 ){
1252 pStmt = pPreStmt->pStmt;
1253 zLeft = &zSql[pPreStmt->nSql];
1254
1255 /* When a prepared statement is found, unlink it from the
1256 ** cache list. It will later be added back to the beginning
1257 ** of the cache list in order to implement LRU replacement.
1258 */
1259 if( pPreStmt->pPrev ){
1260 pPreStmt->pPrev->pNext = pPreStmt->pNext;
1261 }else{
1262 pDb->stmtList = pPreStmt->pNext;
1263 }
1264 if( pPreStmt->pNext ){
1265 pPreStmt->pNext->pPrev = pPreStmt->pPrev;
1266 }else{
1267 pDb->stmtLast = pPreStmt->pPrev;
1268 }
1269 pDb->nStmt--;
1270 break;
1271 }
1272 }
1273
1274 /* If no prepared statement was found. Compile the SQL text
1275 */
drh92febd92004-08-20 18:34:20 +00001276 if( pStmt==0 ){
drhfb7e7652005-01-24 00:28:42 +00001277 if( SQLITE_OK!=sqlite3_prepare(pDb->db, zSql, -1, &pStmt, &zLeft) ){
drh92febd92004-08-20 18:34:20 +00001278 Tcl_SetObjResult(interp, dbTextToObj(sqlite3_errmsg(pDb->db)));
1279 rc = TCL_ERROR;
1280 break;
danielk197730ccda12004-05-27 12:11:31 +00001281 }
drhfb7e7652005-01-24 00:28:42 +00001282 if( pStmt==0 ){
1283 if( SQLITE_OK!=sqlite3_errcode(pDb->db) ){
1284 /* A compile-time error in the statement
1285 */
1286 Tcl_SetObjResult(interp, dbTextToObj(sqlite3_errmsg(pDb->db)));
1287 rc = TCL_ERROR;
1288 break;
1289 }else{
1290 /* The statement was a no-op. Continue to the next statement
1291 ** in the SQL string.
1292 */
1293 zSql = zLeft;
1294 continue;
1295 }
1296 }
1297 assert( pPreStmt==0 );
danielk197730ccda12004-05-27 12:11:31 +00001298 }
1299
drhfb7e7652005-01-24 00:28:42 +00001300 /* Bind values to parameters that begin with $ or :
1301 */
drh92febd92004-08-20 18:34:20 +00001302 nVar = sqlite3_bind_parameter_count(pStmt);
drh1d895032004-08-26 00:56:05 +00001303 nParm = 0;
1304 if( nVar>sizeof(aParm)/sizeof(aParm[0]) ){
1305 apParm = (Tcl_Obj**)Tcl_Alloc(nVar*sizeof(apParm[0]));
1306 }else{
1307 apParm = aParm;
1308 }
drh92febd92004-08-20 18:34:20 +00001309 for(i=1; i<=nVar; i++){
1310 const char *zVar = sqlite3_bind_parameter_name(pStmt, i);
drhc8f90792005-01-12 00:08:24 +00001311 if( zVar!=0 && (zVar[0]=='$' || zVar[0]==':') ){
drh92febd92004-08-20 18:34:20 +00001312 Tcl_Obj *pVar = Tcl_GetVar2Ex(interp, &zVar[1], 0, 0);
1313 if( pVar ){
1314 int n;
1315 u8 *data;
1316 char *zType = pVar->typePtr ? pVar->typePtr->name : "";
1317 char c = zType[0];
drhdf0bdda2005-06-25 19:31:48 +00001318 if( c=='b' && strcmp(zType,"bytearray")==0 && pVar->bytes==0 ){
1319 /* Only load a BLOB type if the Tcl variable is a bytearray and
1320 ** has no string representation. */
drh92febd92004-08-20 18:34:20 +00001321 data = Tcl_GetByteArrayFromObj(pVar, &n);
1322 sqlite3_bind_blob(pStmt, i, data, n, SQLITE_STATIC);
drh1d895032004-08-26 00:56:05 +00001323 Tcl_IncrRefCount(pVar);
1324 apParm[nParm++] = pVar;
drh92febd92004-08-20 18:34:20 +00001325 }else if( (c=='b' && strcmp(zType,"boolean")==0) ||
1326 (c=='i' && strcmp(zType,"int")==0) ){
1327 Tcl_GetIntFromObj(interp, pVar, &n);
1328 sqlite3_bind_int(pStmt, i, n);
1329 }else if( c=='d' && strcmp(zType,"double")==0 ){
1330 double r;
1331 Tcl_GetDoubleFromObj(interp, pVar, &r);
1332 sqlite3_bind_double(pStmt, i, r);
drhdf0bdda2005-06-25 19:31:48 +00001333 }else if( c=='w' && strcmp(zType,"wideInt")==0 ){
1334 Tcl_WideInt v;
1335 Tcl_GetWideIntFromObj(interp, pVar, &v);
1336 sqlite3_bind_int64(pStmt, i, v);
drh92febd92004-08-20 18:34:20 +00001337 }else{
danielk197700fd9572005-12-07 06:27:43 +00001338 data = (unsigned char *)Tcl_GetStringFromObj(pVar, &n);
1339 sqlite3_bind_text(pStmt, i, (char *)data, n, SQLITE_STATIC);
drh1d895032004-08-26 00:56:05 +00001340 Tcl_IncrRefCount(pVar);
1341 apParm[nParm++] = pVar;
drh92febd92004-08-20 18:34:20 +00001342 }
drhfb7e7652005-01-24 00:28:42 +00001343 }else{
1344 sqlite3_bind_null( pStmt, i );
drh92febd92004-08-20 18:34:20 +00001345 }
1346 }
1347 }
drh92febd92004-08-20 18:34:20 +00001348
1349 /* Compute column names */
1350 nCol = sqlite3_column_count(pStmt);
1351 if( pScript ){
1352 apColName = (Tcl_Obj**)Tcl_Alloc( sizeof(Tcl_Obj*)*nCol );
1353 if( apColName==0 ) break;
1354 for(i=0; i<nCol; i++){
1355 apColName[i] = dbTextToObj(sqlite3_column_name(pStmt,i));
1356 Tcl_IncrRefCount(apColName[i]);
1357 }
1358 }
1359
1360 /* If results are being stored in an array variable, then create
1361 ** the array(*) entry for that array
1362 */
1363 if( pArray ){
1364 Tcl_Obj *pColList = Tcl_NewObj();
drh3ced14a2005-03-31 18:26:20 +00001365 Tcl_Obj *pStar = Tcl_NewStringObj("*", -1);
drh92febd92004-08-20 18:34:20 +00001366 Tcl_IncrRefCount(pColList);
1367 for(i=0; i<nCol; i++){
1368 Tcl_ListObjAppendElement(interp, pColList, apColName[i]);
1369 }
drh3ced14a2005-03-31 18:26:20 +00001370 Tcl_ObjSetVar2(interp, pArray, pStar, pColList,0);
1371 Tcl_DecrRefCount(pColList);
1372 Tcl_DecrRefCount(pStar);
drh92febd92004-08-20 18:34:20 +00001373 }
1374
1375 /* Execute the SQL
1376 */
drh90b6bb12004-09-13 13:16:31 +00001377 while( rc==TCL_OK && pStmt && SQLITE_ROW==sqlite3_step(pStmt) ){
drh92febd92004-08-20 18:34:20 +00001378 for(i=0; i<nCol; i++){
danielk197730ccda12004-05-27 12:11:31 +00001379 Tcl_Obj *pVal;
1380
1381 /* Set pVal to contain the i'th column of this row. */
drh92febd92004-08-20 18:34:20 +00001382 switch( sqlite3_column_type(pStmt, i) ){
1383 case SQLITE_BLOB: {
1384 int bytes = sqlite3_column_bytes(pStmt, i);
1385 pVal = Tcl_NewByteArrayObj(sqlite3_column_blob(pStmt, i), bytes);
1386 break;
1387 }
1388 case SQLITE_INTEGER: {
1389 sqlite_int64 v = sqlite3_column_int64(pStmt, i);
1390 if( v>=-2147483647 && v<=2147483647 ){
1391 pVal = Tcl_NewIntObj(v);
1392 }else{
1393 pVal = Tcl_NewWideIntObj(v);
1394 }
1395 break;
1396 }
1397 case SQLITE_FLOAT: {
1398 double r = sqlite3_column_double(pStmt, i);
1399 pVal = Tcl_NewDoubleObj(r);
1400 break;
1401 }
danielk197755c45f22005-04-03 23:54:43 +00001402 case SQLITE_NULL: {
1403 pVal = dbTextToObj(pDb->zNull);
1404 break;
1405 }
drh92febd92004-08-20 18:34:20 +00001406 default: {
danielk197700fd9572005-12-07 06:27:43 +00001407 pVal = dbTextToObj((char *)sqlite3_column_text(pStmt, i));
drh92febd92004-08-20 18:34:20 +00001408 break;
1409 }
danielk197730ccda12004-05-27 12:11:31 +00001410 }
1411
drh92febd92004-08-20 18:34:20 +00001412 if( pScript ){
1413 if( pArray==0 ){
1414 Tcl_ObjSetVar2(interp, apColName[i], 0, pVal, 0);
danielk197730ccda12004-05-27 12:11:31 +00001415 }else{
drh92febd92004-08-20 18:34:20 +00001416 Tcl_ObjSetVar2(interp, pArray, apColName[i], pVal, 0);
danielk197730ccda12004-05-27 12:11:31 +00001417 }
drh1807ce32004-09-07 13:20:35 +00001418 }else if( choice==DB_ONECOLUMN ){
drh97f2ebc2005-12-10 21:19:04 +00001419 assert( pRet==0 );
drh1807ce32004-09-07 13:20:35 +00001420 if( pRet==0 ){
1421 pRet = pVal;
1422 Tcl_IncrRefCount(pRet);
1423 }
drh90b6bb12004-09-13 13:16:31 +00001424 rc = TCL_BREAK;
drh97f2ebc2005-12-10 21:19:04 +00001425 i = nCol;
1426 }else if( choice==DB_EXISTS ){
drh446a9b82006-01-04 18:13:26 +00001427 Tcl_DecrRefCount(pRet);
1428 pRet = Tcl_NewBooleanObj(1);
1429 Tcl_IncrRefCount(pRet);
drh97f2ebc2005-12-10 21:19:04 +00001430 rc = TCL_BREAK;
1431 i = nCol;
danielk197730ccda12004-05-27 12:11:31 +00001432 }else{
danielk197730ccda12004-05-27 12:11:31 +00001433 Tcl_ListObjAppendElement(interp, pRet, pVal);
1434 }
1435 }
1436
drh92febd92004-08-20 18:34:20 +00001437 if( pScript ){
1438 rc = Tcl_EvalObjEx(interp, pScript, 0);
drh90b6bb12004-09-13 13:16:31 +00001439 if( rc==TCL_CONTINUE ){
1440 rc = TCL_OK;
1441 }
danielk197730ccda12004-05-27 12:11:31 +00001442 }
1443 }
drh90b6bb12004-09-13 13:16:31 +00001444 if( rc==TCL_BREAK ){
1445 rc = TCL_OK;
1446 }
drh92febd92004-08-20 18:34:20 +00001447
1448 /* Free the column name objects */
1449 if( pScript ){
1450 for(i=0; i<nCol; i++){
1451 Tcl_DecrRefCount(apColName[i]);
1452 }
1453 Tcl_Free((char*)apColName);
1454 }
1455
drh1d895032004-08-26 00:56:05 +00001456 /* Free the bound string and blob parameters */
1457 for(i=0; i<nParm; i++){
1458 Tcl_DecrRefCount(apParm[i]);
1459 }
1460 if( apParm!=aParm ){
1461 Tcl_Free((char*)apParm);
1462 }
1463
drhfb7e7652005-01-24 00:28:42 +00001464 /* Reset the statement. If the result code is SQLITE_SCHEMA, then
1465 ** flush the statement cache and try the statement again.
drh92febd92004-08-20 18:34:20 +00001466 */
drhfb7e7652005-01-24 00:28:42 +00001467 rc2 = sqlite3_reset(pStmt);
1468 if( SQLITE_SCHEMA==rc2 ){
1469 /* After a schema change, flush the cache and try to run the
1470 ** statement again
1471 */
1472 flushStmtCache( pDb );
1473 sqlite3_finalize(pStmt);
1474 if( pPreStmt ) Tcl_Free((char*)pPreStmt);
danielk197730ccda12004-05-27 12:11:31 +00001475 continue;
drhfb7e7652005-01-24 00:28:42 +00001476 }else if( SQLITE_OK!=rc2 ){
1477 /* If a run-time error occurs, report the error and stop reading
1478 ** the SQL
1479 */
danielk1977ef2cb632004-05-29 02:37:19 +00001480 Tcl_SetObjResult(interp, dbTextToObj(sqlite3_errmsg(pDb->db)));
drhfb7e7652005-01-24 00:28:42 +00001481 sqlite3_finalize(pStmt);
danielk197730ccda12004-05-27 12:11:31 +00001482 rc = TCL_ERROR;
drhfb7e7652005-01-24 00:28:42 +00001483 if( pPreStmt ) Tcl_Free((char*)pPreStmt);
danielk197730ccda12004-05-27 12:11:31 +00001484 break;
drhfb7e7652005-01-24 00:28:42 +00001485 }else if( pDb->maxStmt<=0 ){
1486 /* If the cache is turned off, deallocated the statement */
1487 if( pPreStmt ) Tcl_Free((char*)pPreStmt);
1488 sqlite3_finalize(pStmt);
1489 }else{
1490 /* Everything worked and the cache is operational.
1491 ** Create a new SqlPreparedStmt structure if we need one.
1492 ** (If we already have one we can just reuse it.)
1493 */
1494 if( pPreStmt==0 ){
1495 len = zLeft - zSql;
1496 pPreStmt = (SqlPreparedStmt*)Tcl_Alloc( sizeof(*pPreStmt) + len );
1497 if( pPreStmt==0 ) return TCL_ERROR;
1498 pPreStmt->pStmt = pStmt;
1499 pPreStmt->nSql = len;
1500 memcpy(pPreStmt->zSql, zSql, len);
1501 pPreStmt->zSql[len] = 0;
1502 }
1503
1504 /* Add the prepared statement to the beginning of the cache list
1505 */
1506 pPreStmt->pNext = pDb->stmtList;
1507 pPreStmt->pPrev = 0;
1508 if( pDb->stmtList ){
1509 pDb->stmtList->pPrev = pPreStmt;
1510 }
1511 pDb->stmtList = pPreStmt;
1512 if( pDb->stmtLast==0 ){
1513 assert( pDb->nStmt==0 );
1514 pDb->stmtLast = pPreStmt;
1515 }else{
1516 assert( pDb->nStmt>0 );
1517 }
1518 pDb->nStmt++;
1519
1520 /* If we have too many statement in cache, remove the surplus from the
1521 ** end of the cache list.
1522 */
1523 while( pDb->nStmt>pDb->maxStmt ){
1524 sqlite3_finalize(pDb->stmtLast->pStmt);
1525 pDb->stmtLast = pDb->stmtLast->pPrev;
1526 Tcl_Free((char*)pDb->stmtLast->pNext);
1527 pDb->stmtLast->pNext = 0;
1528 pDb->nStmt--;
1529 }
danielk197730ccda12004-05-27 12:11:31 +00001530 }
1531
drhfb7e7652005-01-24 00:28:42 +00001532 /* Proceed to the next statement */
danielk197730ccda12004-05-27 12:11:31 +00001533 zSql = zLeft;
1534 }
drh1d895032004-08-26 00:56:05 +00001535 Tcl_DecrRefCount(objv[2]);
danielk197730ccda12004-05-27 12:11:31 +00001536
drh1807ce32004-09-07 13:20:35 +00001537 if( pRet ){
1538 if( rc==TCL_OK ){
1539 Tcl_SetObjResult(interp, pRet);
1540 }
1541 Tcl_DecrRefCount(pRet);
danielk197730ccda12004-05-27 12:11:31 +00001542 }
danielk197730ccda12004-05-27 12:11:31 +00001543 break;
1544 }
drhbec3f402000-08-04 13:49:02 +00001545
1546 /*
drhcabb0812002-09-14 13:47:32 +00001547 ** $db function NAME SCRIPT
1548 **
1549 ** Create a new SQL function called NAME. Whenever that function is
1550 ** called, invoke SCRIPT to evaluate the function.
1551 */
1552 case DB_FUNCTION: {
1553 SqlFunc *pFunc;
drhd1e47332005-06-26 17:55:33 +00001554 Tcl_Obj *pScript;
drhcabb0812002-09-14 13:47:32 +00001555 char *zName;
drhcabb0812002-09-14 13:47:32 +00001556 if( objc!=4 ){
1557 Tcl_WrongNumArgs(interp, 2, objv, "NAME SCRIPT");
1558 return TCL_ERROR;
1559 }
1560 zName = Tcl_GetStringFromObj(objv[2], 0);
drhd1e47332005-06-26 17:55:33 +00001561 pScript = objv[3];
1562 pFunc = findSqlFunc(pDb, zName);
drhcabb0812002-09-14 13:47:32 +00001563 if( pFunc==0 ) return TCL_ERROR;
drhd1e47332005-06-26 17:55:33 +00001564 if( pFunc->pScript ){
1565 Tcl_DecrRefCount(pFunc->pScript);
1566 }
1567 pFunc->pScript = pScript;
1568 Tcl_IncrRefCount(pScript);
1569 pFunc->useEvalObjv = safeToUseEvalObjv(interp, pScript);
danielk1977c8c11582004-06-29 13:41:21 +00001570 rc = sqlite3_create_function(pDb->db, zName, -1, SQLITE_UTF8,
danielk1977d8123362004-06-12 09:25:12 +00001571 pFunc, tclSqlFunc, 0, 0);
drhfb7e7652005-01-24 00:28:42 +00001572 if( rc!=SQLITE_OK ){
danielk19779636c4e2005-01-25 04:27:54 +00001573 rc = TCL_ERROR;
1574 Tcl_SetResult(interp, (char *)sqlite3_errmsg(pDb->db), TCL_VOLATILE);
drhfb7e7652005-01-24 00:28:42 +00001575 }else{
1576 /* Must flush any cached statements */
1577 flushStmtCache( pDb );
1578 }
drhcabb0812002-09-14 13:47:32 +00001579 break;
1580 }
1581
1582 /*
drh19e2d372005-08-29 23:00:03 +00001583 ** $db nullvalue ?STRING?
1584 **
1585 ** Change text used when a NULL comes back from the database. If ?STRING?
1586 ** is not present, then the current string used for NULL is returned.
1587 ** If STRING is present, then STRING is returned.
1588 **
1589 */
1590 case DB_NULLVALUE: {
1591 if( objc!=2 && objc!=3 ){
1592 Tcl_WrongNumArgs(interp, 2, objv, "NULLVALUE");
1593 return TCL_ERROR;
1594 }
1595 if( objc==3 ){
1596 int len;
1597 char *zNull = Tcl_GetStringFromObj(objv[2], &len);
1598 if( pDb->zNull ){
1599 Tcl_Free(pDb->zNull);
1600 }
1601 if( zNull && len>0 ){
1602 pDb->zNull = Tcl_Alloc( len + 1 );
1603 strncpy(pDb->zNull, zNull, len);
1604 pDb->zNull[len] = '\0';
1605 }else{
1606 pDb->zNull = 0;
1607 }
1608 }
1609 Tcl_SetObjResult(interp, dbTextToObj(pDb->zNull));
1610 break;
1611 }
1612
1613 /*
drhaf9ff332002-01-16 21:00:27 +00001614 ** $db last_insert_rowid
1615 **
1616 ** Return an integer which is the ROWID for the most recent insert.
1617 */
1618 case DB_LAST_INSERT_ROWID: {
1619 Tcl_Obj *pResult;
1620 int rowid;
1621 if( objc!=2 ){
1622 Tcl_WrongNumArgs(interp, 2, objv, "");
1623 return TCL_ERROR;
1624 }
danielk19776f8a5032004-05-10 10:34:51 +00001625 rowid = sqlite3_last_insert_rowid(pDb->db);
drhaf9ff332002-01-16 21:00:27 +00001626 pResult = Tcl_GetObjResult(interp);
1627 Tcl_SetIntObj(pResult, rowid);
1628 break;
1629 }
1630
1631 /*
drh1807ce32004-09-07 13:20:35 +00001632 ** The DB_ONECOLUMN method is implemented together with DB_EVAL.
drh5d9d7572003-08-19 14:31:01 +00001633 */
drh1807ce32004-09-07 13:20:35 +00001634
1635 /* $db progress ?N CALLBACK?
1636 **
1637 ** Invoke the given callback every N virtual machine opcodes while executing
1638 ** queries.
1639 */
1640 case DB_PROGRESS: {
1641 if( objc==2 ){
1642 if( pDb->zProgress ){
1643 Tcl_AppendResult(interp, pDb->zProgress, 0);
1644 }
1645 }else if( objc==4 ){
1646 char *zProgress;
1647 int len;
1648 int N;
1649 if( TCL_OK!=Tcl_GetIntFromObj(interp, objv[2], &N) ){
1650 return TCL_ERROR;
1651 };
1652 if( pDb->zProgress ){
1653 Tcl_Free(pDb->zProgress);
1654 }
1655 zProgress = Tcl_GetStringFromObj(objv[3], &len);
1656 if( zProgress && len>0 ){
1657 pDb->zProgress = Tcl_Alloc( len + 1 );
1658 strcpy(pDb->zProgress, zProgress);
1659 }else{
1660 pDb->zProgress = 0;
1661 }
1662#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1663 if( pDb->zProgress ){
1664 pDb->interp = interp;
1665 sqlite3_progress_handler(pDb->db, N, DbProgressHandler, pDb);
1666 }else{
1667 sqlite3_progress_handler(pDb->db, 0, 0, 0);
1668 }
1669#endif
1670 }else{
1671 Tcl_WrongNumArgs(interp, 2, objv, "N CALLBACK");
drh5d9d7572003-08-19 14:31:01 +00001672 return TCL_ERROR;
1673 }
drh5d9d7572003-08-19 14:31:01 +00001674 break;
1675 }
1676
drh19e2d372005-08-29 23:00:03 +00001677 /* $db profile ?CALLBACK?
1678 **
1679 ** Make arrangements to invoke the CALLBACK routine after each SQL statement
1680 ** that has run. The text of the SQL and the amount of elapse time are
1681 ** appended to CALLBACK before the script is run.
1682 */
1683 case DB_PROFILE: {
1684 if( objc>3 ){
1685 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
1686 return TCL_ERROR;
1687 }else if( objc==2 ){
1688 if( pDb->zProfile ){
1689 Tcl_AppendResult(interp, pDb->zProfile, 0);
1690 }
1691 }else{
1692 char *zProfile;
1693 int len;
1694 if( pDb->zProfile ){
1695 Tcl_Free(pDb->zProfile);
1696 }
1697 zProfile = Tcl_GetStringFromObj(objv[2], &len);
1698 if( zProfile && len>0 ){
1699 pDb->zProfile = Tcl_Alloc( len + 1 );
1700 strcpy(pDb->zProfile, zProfile);
1701 }else{
1702 pDb->zProfile = 0;
1703 }
1704#ifndef SQLITE_OMIT_TRACE
1705 if( pDb->zProfile ){
1706 pDb->interp = interp;
1707 sqlite3_profile(pDb->db, DbProfileHandler, pDb);
1708 }else{
1709 sqlite3_profile(pDb->db, 0, 0);
1710 }
1711#endif
1712 }
1713 break;
1714 }
1715
drh5d9d7572003-08-19 14:31:01 +00001716 /*
drh22fbcb82004-02-01 01:22:50 +00001717 ** $db rekey KEY
1718 **
1719 ** Change the encryption key on the currently open database.
1720 */
1721 case DB_REKEY: {
1722 int nKey;
1723 void *pKey;
1724 if( objc!=3 ){
1725 Tcl_WrongNumArgs(interp, 2, objv, "KEY");
1726 return TCL_ERROR;
1727 }
1728 pKey = Tcl_GetByteArrayFromObj(objv[2], &nKey);
drh9eb9e262004-02-11 02:18:05 +00001729#ifdef SQLITE_HAS_CODEC
drh2011d5f2004-07-22 02:40:37 +00001730 rc = sqlite3_rekey(pDb->db, pKey, nKey);
drh22fbcb82004-02-01 01:22:50 +00001731 if( rc ){
danielk1977f20b21c2004-05-31 23:56:42 +00001732 Tcl_AppendResult(interp, sqlite3ErrStr(rc), 0);
drh22fbcb82004-02-01 01:22:50 +00001733 rc = TCL_ERROR;
1734 }
1735#endif
1736 break;
1737 }
1738
1739 /*
drhbec3f402000-08-04 13:49:02 +00001740 ** $db timeout MILLESECONDS
1741 **
1742 ** Delay for the number of milliseconds specified when a file is locked.
1743 */
drh6d313162000-09-21 13:01:35 +00001744 case DB_TIMEOUT: {
drhbec3f402000-08-04 13:49:02 +00001745 int ms;
drh6d313162000-09-21 13:01:35 +00001746 if( objc!=3 ){
1747 Tcl_WrongNumArgs(interp, 2, objv, "MILLISECONDS");
drhbec3f402000-08-04 13:49:02 +00001748 return TCL_ERROR;
1749 }
drh6d313162000-09-21 13:01:35 +00001750 if( Tcl_GetIntFromObj(interp, objv[2], &ms) ) return TCL_ERROR;
danielk19776f8a5032004-05-10 10:34:51 +00001751 sqlite3_busy_timeout(pDb->db, ms);
drh6d313162000-09-21 13:01:35 +00001752 break;
drh75897232000-05-29 14:26:00 +00001753 }
danielk197755c45f22005-04-03 23:54:43 +00001754
1755 /*
drh0f14e2e2004-06-29 12:39:08 +00001756 ** $db total_changes
1757 **
1758 ** Return the number of rows that were modified, inserted, or deleted
1759 ** since the database handle was created.
1760 */
1761 case DB_TOTAL_CHANGES: {
1762 Tcl_Obj *pResult;
1763 if( objc!=2 ){
1764 Tcl_WrongNumArgs(interp, 2, objv, "");
1765 return TCL_ERROR;
1766 }
1767 pResult = Tcl_GetObjResult(interp);
1768 Tcl_SetIntObj(pResult, sqlite3_total_changes(pDb->db));
1769 break;
1770 }
1771
drhb5a20d32003-04-23 12:25:23 +00001772 /* $db trace ?CALLBACK?
1773 **
1774 ** Make arrangements to invoke the CALLBACK routine for each SQL statement
1775 ** that is executed. The text of the SQL is appended to CALLBACK before
1776 ** it is executed.
1777 */
1778 case DB_TRACE: {
1779 if( objc>3 ){
1780 Tcl_WrongNumArgs(interp, 2, objv, "?CALLBACK?");
drhb97759e2004-06-29 11:26:59 +00001781 return TCL_ERROR;
drhb5a20d32003-04-23 12:25:23 +00001782 }else if( objc==2 ){
1783 if( pDb->zTrace ){
1784 Tcl_AppendResult(interp, pDb->zTrace, 0);
1785 }
1786 }else{
1787 char *zTrace;
1788 int len;
1789 if( pDb->zTrace ){
1790 Tcl_Free(pDb->zTrace);
1791 }
1792 zTrace = Tcl_GetStringFromObj(objv[2], &len);
1793 if( zTrace && len>0 ){
1794 pDb->zTrace = Tcl_Alloc( len + 1 );
1795 strcpy(pDb->zTrace, zTrace);
1796 }else{
1797 pDb->zTrace = 0;
1798 }
drh19e2d372005-08-29 23:00:03 +00001799#ifndef SQLITE_OMIT_TRACE
drhb5a20d32003-04-23 12:25:23 +00001800 if( pDb->zTrace ){
1801 pDb->interp = interp;
danielk19776f8a5032004-05-10 10:34:51 +00001802 sqlite3_trace(pDb->db, DbTraceHandler, pDb);
drhb5a20d32003-04-23 12:25:23 +00001803 }else{
danielk19776f8a5032004-05-10 10:34:51 +00001804 sqlite3_trace(pDb->db, 0, 0);
drhb5a20d32003-04-23 12:25:23 +00001805 }
drh19e2d372005-08-29 23:00:03 +00001806#endif
drhb5a20d32003-04-23 12:25:23 +00001807 }
1808 break;
1809 }
1810
drh3d214232005-08-02 12:21:08 +00001811 /* $db transaction [-deferred|-immediate|-exclusive] SCRIPT
1812 **
1813 ** Start a new transaction (if we are not already in the midst of a
1814 ** transaction) and execute the TCL script SCRIPT. After SCRIPT
1815 ** completes, either commit the transaction or roll it back if SCRIPT
1816 ** throws an exception. Or if no new transation was started, do nothing.
1817 ** pass the exception on up the stack.
1818 **
1819 ** This command was inspired by Dave Thomas's talk on Ruby at the
1820 ** 2005 O'Reilly Open Source Convention (OSCON).
1821 */
1822 case DB_TRANSACTION: {
1823 int inTrans;
1824 Tcl_Obj *pScript;
1825 const char *zBegin = "BEGIN";
1826 if( objc!=3 && objc!=4 ){
1827 Tcl_WrongNumArgs(interp, 2, objv, "[TYPE] SCRIPT");
1828 return TCL_ERROR;
1829 }
1830 if( objc==3 ){
1831 pScript = objv[2];
1832 } else {
1833 static const char *TTYPE_strs[] = {
drhce604012005-08-16 11:11:34 +00001834 "deferred", "exclusive", "immediate", 0
drh3d214232005-08-02 12:21:08 +00001835 };
1836 enum TTYPE_enum {
1837 TTYPE_DEFERRED, TTYPE_EXCLUSIVE, TTYPE_IMMEDIATE
1838 };
1839 int ttype;
drhb5555e72005-08-02 17:15:14 +00001840 if( Tcl_GetIndexFromObj(interp, objv[2], TTYPE_strs, "transaction type",
drh3d214232005-08-02 12:21:08 +00001841 0, &ttype) ){
1842 return TCL_ERROR;
1843 }
1844 switch( (enum TTYPE_enum)ttype ){
1845 case TTYPE_DEFERRED: /* no-op */; break;
1846 case TTYPE_EXCLUSIVE: zBegin = "BEGIN EXCLUSIVE"; break;
1847 case TTYPE_IMMEDIATE: zBegin = "BEGIN IMMEDIATE"; break;
1848 }
1849 pScript = objv[3];
1850 }
1851 inTrans = !sqlite3_get_autocommit(pDb->db);
1852 if( !inTrans ){
1853 sqlite3_exec(pDb->db, zBegin, 0, 0, 0);
1854 }
1855 rc = Tcl_EvalObjEx(interp, pScript, 0);
1856 if( !inTrans ){
1857 const char *zEnd;
1858 if( rc==TCL_ERROR ){
1859 zEnd = "ROLLBACK";
1860 } else {
1861 zEnd = "COMMIT";
1862 }
1863 sqlite3_exec(pDb->db, zEnd, 0, 0, 0);
1864 }
1865 break;
1866 }
1867
danielk197794eb6a12005-12-15 15:22:08 +00001868 /*
1869 ** $db update_hook ?script?
danielk197771fd80b2005-12-16 06:54:01 +00001870 ** $db rollback_hook ?script?
danielk197794eb6a12005-12-15 15:22:08 +00001871 */
danielk197771fd80b2005-12-16 06:54:01 +00001872 case DB_UPDATE_HOOK:
1873 case DB_ROLLBACK_HOOK: {
1874
1875 /* set ppHook to point at pUpdateHook or pRollbackHook, depending on
1876 ** whether [$db update_hook] or [$db rollback_hook] was invoked.
1877 */
1878 Tcl_Obj **ppHook;
1879 if( choice==DB_UPDATE_HOOK ){
1880 ppHook = &pDb->pUpdateHook;
1881 }else{
1882 ppHook = &pDb->pRollbackHook;
1883 }
1884
danielk197794eb6a12005-12-15 15:22:08 +00001885 if( objc!=2 && objc!=3 ){
1886 Tcl_WrongNumArgs(interp, 2, objv, "?SCRIPT?");
1887 return TCL_ERROR;
1888 }
danielk197771fd80b2005-12-16 06:54:01 +00001889 if( *ppHook ){
1890 Tcl_SetObjResult(interp, *ppHook);
danielk197794eb6a12005-12-15 15:22:08 +00001891 if( objc==3 ){
danielk197771fd80b2005-12-16 06:54:01 +00001892 Tcl_DecrRefCount(*ppHook);
1893 *ppHook = 0;
danielk197794eb6a12005-12-15 15:22:08 +00001894 }
1895 }
1896 if( objc==3 ){
danielk197771fd80b2005-12-16 06:54:01 +00001897 assert( !(*ppHook) );
danielk197794eb6a12005-12-15 15:22:08 +00001898 if( Tcl_GetCharLength(objv[2])>0 ){
danielk197771fd80b2005-12-16 06:54:01 +00001899 *ppHook = objv[2];
1900 Tcl_IncrRefCount(*ppHook);
danielk197794eb6a12005-12-15 15:22:08 +00001901 }
1902 }
danielk197771fd80b2005-12-16 06:54:01 +00001903
1904 sqlite3_update_hook(pDb->db, (pDb->pUpdateHook?DbUpdateHandler:0), pDb);
1905 sqlite3_rollback_hook(pDb->db,(pDb->pRollbackHook?DbRollbackHandler:0),pDb);
1906
danielk197794eb6a12005-12-15 15:22:08 +00001907 break;
1908 }
1909
danielk19774397de52005-01-12 12:44:03 +00001910 /* $db version
1911 **
1912 ** Return the version string for this database.
1913 */
1914 case DB_VERSION: {
1915 Tcl_SetResult(interp, (char *)sqlite3_libversion(), TCL_STATIC);
1916 break;
1917 }
1918
tpoindex1067fe12004-12-17 15:41:11 +00001919
drh6d313162000-09-21 13:01:35 +00001920 } /* End of the SWITCH statement */
drh22fbcb82004-02-01 01:22:50 +00001921 return rc;
drh75897232000-05-29 14:26:00 +00001922}
1923
1924/*
drh9bb575f2004-09-06 17:24:11 +00001925** sqlite3 DBNAME FILENAME ?MODE? ?-key KEY?
drh75897232000-05-29 14:26:00 +00001926**
1927** This is the main Tcl command. When the "sqlite" Tcl command is
1928** invoked, this routine runs to process that command.
1929**
1930** The first argument, DBNAME, is an arbitrary name for a new
1931** database connection. This command creates a new command named
1932** DBNAME that is used to control that connection. The database
1933** connection is deleted when the DBNAME command is deleted.
1934**
1935** The second argument is the name of the directory that contains
1936** the sqlite database that is to be accessed.
drhfbc3eab2001-04-06 16:13:42 +00001937**
1938** For testing purposes, we also support the following:
1939**
drh9bb575f2004-09-06 17:24:11 +00001940** sqlite3 -encoding
drhfbc3eab2001-04-06 16:13:42 +00001941**
1942** Return the encoding used by LIKE and GLOB operators. Choices
1943** are UTF-8 and iso8859.
1944**
drh9bb575f2004-09-06 17:24:11 +00001945** sqlite3 -version
drh647cb0e2002-11-04 19:32:25 +00001946**
1947** Return the version number of the SQLite library.
1948**
drh9bb575f2004-09-06 17:24:11 +00001949** sqlite3 -tcl-uses-utf
drhfbc3eab2001-04-06 16:13:42 +00001950**
1951** Return "1" if compiled with a Tcl uses UTF-8. Return "0" if
1952** not. Used by tests to make sure the library was compiled
1953** correctly.
drh75897232000-05-29 14:26:00 +00001954*/
drh22fbcb82004-02-01 01:22:50 +00001955static int DbMain(void *cd, Tcl_Interp *interp, int objc,Tcl_Obj *const*objv){
drhbec3f402000-08-04 13:49:02 +00001956 SqliteDb *p;
drh22fbcb82004-02-01 01:22:50 +00001957 void *pKey = 0;
1958 int nKey = 0;
1959 const char *zArg;
drh75897232000-05-29 14:26:00 +00001960 char *zErrMsg;
drh22fbcb82004-02-01 01:22:50 +00001961 const char *zFile;
drh22fbcb82004-02-01 01:22:50 +00001962 if( objc==2 ){
1963 zArg = Tcl_GetStringFromObj(objv[1], 0);
drh22fbcb82004-02-01 01:22:50 +00001964 if( strcmp(zArg,"-version")==0 ){
danielk19776f8a5032004-05-10 10:34:51 +00001965 Tcl_AppendResult(interp,sqlite3_version,0);
drh647cb0e2002-11-04 19:32:25 +00001966 return TCL_OK;
1967 }
drh9eb9e262004-02-11 02:18:05 +00001968 if( strcmp(zArg,"-has-codec")==0 ){
1969#ifdef SQLITE_HAS_CODEC
drh22fbcb82004-02-01 01:22:50 +00001970 Tcl_AppendResult(interp,"1",0);
1971#else
1972 Tcl_AppendResult(interp,"0",0);
1973#endif
1974 return TCL_OK;
1975 }
1976 if( strcmp(zArg,"-tcl-uses-utf")==0 ){
drhfbc3eab2001-04-06 16:13:42 +00001977#ifdef TCL_UTF_MAX
1978 Tcl_AppendResult(interp,"1",0);
1979#else
1980 Tcl_AppendResult(interp,"0",0);
1981#endif
1982 return TCL_OK;
1983 }
1984 }
drh22fbcb82004-02-01 01:22:50 +00001985 if( objc==5 || objc==6 ){
1986 zArg = Tcl_GetStringFromObj(objv[objc-2], 0);
1987 if( strcmp(zArg,"-key")==0 ){
1988 pKey = Tcl_GetByteArrayFromObj(objv[objc-1], &nKey);
1989 objc -= 2;
1990 }
1991 }
1992 if( objc!=3 && objc!=4 ){
1993 Tcl_WrongNumArgs(interp, 1, objv,
drh9eb9e262004-02-11 02:18:05 +00001994#ifdef SQLITE_HAS_CODEC
1995 "HANDLE FILENAME ?-key CODEC-KEY?"
drh22fbcb82004-02-01 01:22:50 +00001996#else
1997 "HANDLE FILENAME ?MODE?"
1998#endif
1999 );
drh75897232000-05-29 14:26:00 +00002000 return TCL_ERROR;
2001 }
drh75897232000-05-29 14:26:00 +00002002 zErrMsg = 0;
drh4cdc9e82000-08-04 14:56:24 +00002003 p = (SqliteDb*)Tcl_Alloc( sizeof(*p) );
drh75897232000-05-29 14:26:00 +00002004 if( p==0 ){
drhbec3f402000-08-04 13:49:02 +00002005 Tcl_SetResult(interp, "malloc failed", TCL_STATIC);
2006 return TCL_ERROR;
2007 }
2008 memset(p, 0, sizeof(*p));
drh22fbcb82004-02-01 01:22:50 +00002009 zFile = Tcl_GetStringFromObj(objv[2], 0);
danielk19774f057f92004-06-08 00:02:33 +00002010 sqlite3_open(zFile, &p->db);
danielk197780290862004-05-22 09:21:21 +00002011 if( SQLITE_OK!=sqlite3_errcode(p->db) ){
2012 zErrMsg = strdup(sqlite3_errmsg(p->db));
2013 sqlite3_close(p->db);
2014 p->db = 0;
2015 }
drh2011d5f2004-07-22 02:40:37 +00002016#ifdef SQLITE_HAS_CODEC
2017 sqlite3_key(p->db, pKey, nKey);
drheb8ed702004-02-11 10:37:23 +00002018#endif
drhbec3f402000-08-04 13:49:02 +00002019 if( p->db==0 ){
drh75897232000-05-29 14:26:00 +00002020 Tcl_SetResult(interp, zErrMsg, TCL_VOLATILE);
drhbec3f402000-08-04 13:49:02 +00002021 Tcl_Free((char*)p);
drh75897232000-05-29 14:26:00 +00002022 free(zErrMsg);
2023 return TCL_ERROR;
2024 }
drhfb7e7652005-01-24 00:28:42 +00002025 p->maxStmt = NUM_PREPARED_STMTS;
drh22fbcb82004-02-01 01:22:50 +00002026 zArg = Tcl_GetStringFromObj(objv[1], 0);
2027 Tcl_CreateObjCommand(interp, zArg, DbObjCmd, (char*)p, DbDeleteCmd);
drhc22bd472002-05-10 13:14:07 +00002028
2029 /* If compiled with SQLITE_TEST turned on, then register the "md5sum"
drh06b27182002-06-26 20:06:05 +00002030 ** SQL function.
drhc22bd472002-05-10 13:14:07 +00002031 */
drh28b4e482002-03-11 02:06:13 +00002032#ifdef SQLITE_TEST
2033 {
drh9bb575f2004-09-06 17:24:11 +00002034 extern void Md5_Register(sqlite3*);
drh3b93bc82005-01-13 23:54:32 +00002035#ifdef SQLITE_MEMDEBUG
danielk197713073932004-06-30 11:54:06 +00002036 int mallocfail = sqlite3_iMallocFail;
2037 sqlite3_iMallocFail = 0;
danielk19775b59af82004-06-30 12:42:59 +00002038#endif
drhc22bd472002-05-10 13:14:07 +00002039 Md5_Register(p->db);
drh3b93bc82005-01-13 23:54:32 +00002040#ifdef SQLITE_MEMDEBUG
danielk197713073932004-06-30 11:54:06 +00002041 sqlite3_iMallocFail = mallocfail;
danielk19775b59af82004-06-30 12:42:59 +00002042#endif
danielk19777ddad962005-12-12 06:53:03 +00002043 }
drh28b4e482002-03-11 02:06:13 +00002044#endif
danielk19777cedc8d2004-06-10 10:50:08 +00002045 p->interp = interp;
drh75897232000-05-29 14:26:00 +00002046 return TCL_OK;
2047}
2048
2049/*
drh90ca9752001-09-28 17:47:14 +00002050** Provide a dummy Tcl_InitStubs if we are using this as a static
2051** library.
2052*/
2053#ifndef USE_TCL_STUBS
2054# undef Tcl_InitStubs
2055# define Tcl_InitStubs(a,b,c)
2056#endif
2057
2058/*
drh29bc4612005-10-05 10:40:15 +00002059** Make sure we have a PACKAGE_VERSION macro defined. This will be
2060** defined automatically by the TEA makefile. But other makefiles
2061** do not define it.
2062*/
2063#ifndef PACKAGE_VERSION
2064# define PACKAGE_VERSION SQLITE_VERSION
2065#endif
2066
2067/*
drh75897232000-05-29 14:26:00 +00002068** Initialize this module.
2069**
2070** This Tcl module contains only a single new Tcl command named "sqlite".
2071** (Hence there is no namespace. There is no point in using a namespace
2072** if the extension only supplies one new name!) The "sqlite" command is
2073** used to open a new SQLite database. See the DbMain() routine above
2074** for additional information.
2075*/
drh29bc4612005-10-05 10:40:15 +00002076EXTERN int Sqlite3_Init(Tcl_Interp *interp){
drh92febd92004-08-20 18:34:20 +00002077 Tcl_InitStubs(interp, "8.4", 0);
drhef4ac8f2004-06-19 00:16:31 +00002078 Tcl_CreateObjCommand(interp, "sqlite3", (Tcl_ObjCmdProc*)DbMain, 0, 0);
drh29bc4612005-10-05 10:40:15 +00002079 Tcl_PkgProvide(interp, "sqlite3", PACKAGE_VERSION);
drh49766d62005-01-08 18:42:28 +00002080 Tcl_CreateObjCommand(interp, "sqlite", (Tcl_ObjCmdProc*)DbMain, 0, 0);
drh29bc4612005-10-05 10:40:15 +00002081 Tcl_PkgProvide(interp, "sqlite", PACKAGE_VERSION);
drh90ca9752001-09-28 17:47:14 +00002082 return TCL_OK;
2083}
drh29bc4612005-10-05 10:40:15 +00002084EXTERN int Tclsqlite3_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
2085EXTERN int Sqlite3_SafeInit(Tcl_Interp *interp){ return TCL_OK; }
2086EXTERN int Tclsqlite3_SafeInit(Tcl_Interp *interp){ return TCL_OK; }
drh49766d62005-01-08 18:42:28 +00002087
2088#ifndef SQLITE_3_SUFFIX_ONLY
drh29bc4612005-10-05 10:40:15 +00002089EXTERN int Sqlite_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
2090EXTERN int Tclsqlite_Init(Tcl_Interp *interp){ return Sqlite3_Init(interp); }
2091EXTERN int Sqlite_SafeInit(Tcl_Interp *interp){ return TCL_OK; }
2092EXTERN int Tclsqlite_SafeInit(Tcl_Interp *interp){ return TCL_OK; }
drh49766d62005-01-08 18:42:28 +00002093#endif
drh75897232000-05-29 14:26:00 +00002094
drh3e27c022004-07-23 00:01:38 +00002095#ifdef TCLSH
2096/*****************************************************************************
2097** The code that follows is used to build standalone TCL interpreters
drh75897232000-05-29 14:26:00 +00002098*/
drh348784e2000-05-29 20:41:49 +00002099
2100/*
drh3e27c022004-07-23 00:01:38 +00002101** If the macro TCLSH is one, then put in code this for the
2102** "main" routine that will initialize Tcl and take input from
2103** standard input.
drh348784e2000-05-29 20:41:49 +00002104*/
drh3e27c022004-07-23 00:01:38 +00002105#if TCLSH==1
drh348784e2000-05-29 20:41:49 +00002106static char zMainloop[] =
2107 "set line {}\n"
2108 "while {![eof stdin]} {\n"
2109 "if {$line!=\"\"} {\n"
2110 "puts -nonewline \"> \"\n"
2111 "} else {\n"
2112 "puts -nonewline \"% \"\n"
2113 "}\n"
2114 "flush stdout\n"
2115 "append line [gets stdin]\n"
2116 "if {[info complete $line]} {\n"
2117 "if {[catch {uplevel #0 $line} result]} {\n"
2118 "puts stderr \"Error: $result\"\n"
2119 "} elseif {$result!=\"\"} {\n"
2120 "puts $result\n"
2121 "}\n"
2122 "set line {}\n"
2123 "} else {\n"
2124 "append line \\n\n"
2125 "}\n"
2126 "}\n"
2127;
drh3e27c022004-07-23 00:01:38 +00002128#endif
2129
2130/*
2131** If the macro TCLSH is two, then get the main loop code out of
2132** the separate file "spaceanal_tcl.h".
2133*/
2134#if TCLSH==2
2135static char zMainloop[] =
2136#include "spaceanal_tcl.h"
2137;
2138#endif
drh348784e2000-05-29 20:41:49 +00002139
2140#define TCLSH_MAIN main /* Needed to fake out mktclapp */
2141int TCLSH_MAIN(int argc, char **argv){
2142 Tcl_Interp *interp;
drh297ecf12001-04-05 15:57:13 +00002143 Tcl_FindExecutable(argv[0]);
drh348784e2000-05-29 20:41:49 +00002144 interp = Tcl_CreateInterp();
drh38f82712004-06-18 17:10:16 +00002145 Sqlite3_Init(interp);
drhd9b02572001-04-15 00:37:09 +00002146#ifdef SQLITE_TEST
drhd1bf3512001-04-07 15:24:33 +00002147 {
2148 extern int Sqlitetest1_Init(Tcl_Interp*);
drh5c4d9702001-08-20 00:33:58 +00002149 extern int Sqlitetest2_Init(Tcl_Interp*);
2150 extern int Sqlitetest3_Init(Tcl_Interp*);
drha6064dc2003-12-19 02:52:05 +00002151 extern int Sqlitetest4_Init(Tcl_Interp*);
danielk1977998b56c2004-05-06 23:37:52 +00002152 extern int Sqlitetest5_Init(Tcl_Interp*);
drh9c06c952005-11-26 00:25:00 +00002153 extern int Sqlitetest6_Init(Tcl_Interp*);
drhefc251d2001-07-01 22:12:01 +00002154 extern int Md5_Init(Tcl_Interp*);
drh2e66f0b2005-04-28 17:18:48 +00002155 extern int Sqlitetestsse_Init(Tcl_Interp*);
drh23669402006-01-09 17:29:52 +00002156 extern int Sqlitetestasync_Init(Tcl_Interp*);
drh2e66f0b2005-04-28 17:18:48 +00002157
danielk19776490beb2004-05-11 06:17:21 +00002158 Sqlitetest1_Init(interp);
drh5c4d9702001-08-20 00:33:58 +00002159 Sqlitetest2_Init(interp);
drhde647132004-05-07 17:57:49 +00002160 Sqlitetest3_Init(interp);
danielk1977fc57d7b2004-05-26 02:04:57 +00002161 Sqlitetest4_Init(interp);
danielk1977998b56c2004-05-06 23:37:52 +00002162 Sqlitetest5_Init(interp);
drh9c06c952005-11-26 00:25:00 +00002163 Sqlitetest6_Init(interp);
drh23669402006-01-09 17:29:52 +00002164 Sqlitetestasync_Init(interp);
drhefc251d2001-07-01 22:12:01 +00002165 Md5_Init(interp);
drh89dec812005-04-28 19:03:37 +00002166#ifdef SQLITE_SSE
drh2e66f0b2005-04-28 17:18:48 +00002167 Sqlitetestsse_Init(interp);
2168#endif
drhd1bf3512001-04-07 15:24:33 +00002169 }
2170#endif
drh3e27c022004-07-23 00:01:38 +00002171 if( argc>=2 || TCLSH==2 ){
drh348784e2000-05-29 20:41:49 +00002172 int i;
2173 Tcl_SetVar(interp,"argv0",argv[1],TCL_GLOBAL_ONLY);
2174 Tcl_SetVar(interp,"argv", "", TCL_GLOBAL_ONLY);
drh61212b62004-12-02 20:17:00 +00002175 for(i=3-TCLSH; i<argc; i++){
drh348784e2000-05-29 20:41:49 +00002176 Tcl_SetVar(interp, "argv", argv[i],
2177 TCL_GLOBAL_ONLY | TCL_LIST_ELEMENT | TCL_APPEND_VALUE);
2178 }
drh3e27c022004-07-23 00:01:38 +00002179 if( TCLSH==1 && Tcl_EvalFile(interp, argv[1])!=TCL_OK ){
drh0de8c112002-07-06 16:32:14 +00002180 const char *zInfo = Tcl_GetVar(interp, "errorInfo", TCL_GLOBAL_ONLY);
drhc61053b2000-06-04 12:58:36 +00002181 if( zInfo==0 ) zInfo = interp->result;
2182 fprintf(stderr,"%s: %s\n", *argv, zInfo);
drh348784e2000-05-29 20:41:49 +00002183 return 1;
2184 }
drh3e27c022004-07-23 00:01:38 +00002185 }
2186 if( argc<=1 || TCLSH==2 ){
drh348784e2000-05-29 20:41:49 +00002187 Tcl_GlobalEval(interp, zMainloop);
2188 }
2189 return 0;
2190}
2191#endif /* TCLSH */
drh6d313162000-09-21 13:01:35 +00002192
2193#endif /* !defined(NO_TCL) */