OLD | NEW |
(Empty) | |
| 1 /* |
| 2 ** 2006 June 10 |
| 3 ** |
| 4 ** The author disclaims copyright to this source code. In place of |
| 5 ** a legal notice, here is a blessing: |
| 6 ** |
| 7 ** May you do good and not evil. |
| 8 ** May you find forgiveness for yourself and forgive others. |
| 9 ** May you share freely, never taking more than you give. |
| 10 ** |
| 11 ************************************************************************* |
| 12 ** Code for testing the virtual table interfaces. This code |
| 13 ** is not included in the SQLite library. It is used for automated |
| 14 ** testing of the SQLite library. |
| 15 */ |
| 16 #include "sqliteInt.h" |
| 17 #if defined(INCLUDE_SQLITE_TCL_H) |
| 18 # include "sqlite_tcl.h" |
| 19 #else |
| 20 # include "tcl.h" |
| 21 #endif |
| 22 #include <stdlib.h> |
| 23 #include <string.h> |
| 24 |
| 25 #ifndef SQLITE_OMIT_VIRTUALTABLE |
| 26 |
| 27 typedef struct echo_vtab echo_vtab; |
| 28 typedef struct echo_cursor echo_cursor; |
| 29 |
| 30 /* |
| 31 ** The test module defined in this file uses four global Tcl variables to |
| 32 ** commicate with test-scripts: |
| 33 ** |
| 34 ** $::echo_module |
| 35 ** $::echo_module_sync_fail |
| 36 ** $::echo_module_begin_fail |
| 37 ** $::echo_module_cost |
| 38 ** |
| 39 ** The variable ::echo_module is a list. Each time one of the following |
| 40 ** methods is called, one or more elements are appended to the list. |
| 41 ** This is used for automated testing of virtual table modules. |
| 42 ** |
| 43 ** The ::echo_module_sync_fail variable is set by test scripts and read |
| 44 ** by code in this file. If it is set to the name of a real table in the |
| 45 ** the database, then all xSync operations on echo virtual tables that |
| 46 ** use the named table as a backing store will fail. |
| 47 */ |
| 48 |
| 49 /* |
| 50 ** Errors can be provoked within the following echo virtual table methods: |
| 51 ** |
| 52 ** xBestIndex xOpen xFilter xNext |
| 53 ** xColumn xRowid xUpdate xSync |
| 54 ** xBegin xRename |
| 55 ** |
| 56 ** This is done by setting the global tcl variable: |
| 57 ** |
| 58 ** echo_module_fail($method,$tbl) |
| 59 ** |
| 60 ** where $method is set to the name of the virtual table method to fail |
| 61 ** (i.e. "xBestIndex") and $tbl is the name of the table being echoed (not |
| 62 ** the name of the virtual table, the name of the underlying real table). |
| 63 */ |
| 64 |
| 65 /* |
| 66 ** An echo virtual-table object. |
| 67 ** |
| 68 ** echo.vtab.aIndex is an array of booleans. The nth entry is true if |
| 69 ** the nth column of the real table is the left-most column of an index |
| 70 ** (implicit or otherwise). In other words, if SQLite can optimize |
| 71 ** a query like "SELECT * FROM real_table WHERE col = ?". |
| 72 ** |
| 73 ** Member variable aCol[] contains copies of the column names of the real |
| 74 ** table. |
| 75 */ |
| 76 struct echo_vtab { |
| 77 sqlite3_vtab base; |
| 78 Tcl_Interp *interp; /* Tcl interpreter containing debug variables */ |
| 79 sqlite3 *db; /* Database connection */ |
| 80 |
| 81 int isPattern; |
| 82 int inTransaction; /* True if within a transaction */ |
| 83 char *zThis; /* Name of the echo table */ |
| 84 char *zTableName; /* Name of the real table */ |
| 85 char *zLogName; /* Name of the log table */ |
| 86 int nCol; /* Number of columns in the real table */ |
| 87 int *aIndex; /* Array of size nCol. True if column has an index */ |
| 88 char **aCol; /* Array of size nCol. Column names */ |
| 89 }; |
| 90 |
| 91 /* An echo cursor object */ |
| 92 struct echo_cursor { |
| 93 sqlite3_vtab_cursor base; |
| 94 sqlite3_stmt *pStmt; |
| 95 }; |
| 96 |
| 97 static int simulateVtabError(echo_vtab *p, const char *zMethod){ |
| 98 const char *zErr; |
| 99 char zVarname[128]; |
| 100 zVarname[127] = '\0'; |
| 101 sqlite3_snprintf(127, zVarname, "echo_module_fail(%s,%s)", zMethod, p->zTableN
ame); |
| 102 zErr = Tcl_GetVar(p->interp, zVarname, TCL_GLOBAL_ONLY); |
| 103 if( zErr ){ |
| 104 p->base.zErrMsg = sqlite3_mprintf("echo-vtab-error: %s", zErr); |
| 105 } |
| 106 return (zErr!=0); |
| 107 } |
| 108 |
| 109 /* |
| 110 ** Convert an SQL-style quoted string into a normal string by removing |
| 111 ** the quote characters. The conversion is done in-place. If the |
| 112 ** input does not begin with a quote character, then this routine |
| 113 ** is a no-op. |
| 114 ** |
| 115 ** Examples: |
| 116 ** |
| 117 ** "abc" becomes abc |
| 118 ** 'xyz' becomes xyz |
| 119 ** [pqr] becomes pqr |
| 120 ** `mno` becomes mno |
| 121 */ |
| 122 static void dequoteString(char *z){ |
| 123 int quote; |
| 124 int i, j; |
| 125 if( z==0 ) return; |
| 126 quote = z[0]; |
| 127 switch( quote ){ |
| 128 case '\'': break; |
| 129 case '"': break; |
| 130 case '`': break; /* For MySQL compatibility */ |
| 131 case '[': quote = ']'; break; /* For MS SqlServer compatibility */ |
| 132 default: return; |
| 133 } |
| 134 for(i=1, j=0; z[i]; i++){ |
| 135 if( z[i]==quote ){ |
| 136 if( z[i+1]==quote ){ |
| 137 z[j++] = quote; |
| 138 i++; |
| 139 }else{ |
| 140 z[j++] = 0; |
| 141 break; |
| 142 } |
| 143 }else{ |
| 144 z[j++] = z[i]; |
| 145 } |
| 146 } |
| 147 } |
| 148 |
| 149 /* |
| 150 ** Retrieve the column names for the table named zTab via database |
| 151 ** connection db. SQLITE_OK is returned on success, or an sqlite error |
| 152 ** code otherwise. |
| 153 ** |
| 154 ** If successful, the number of columns is written to *pnCol. *paCol is |
| 155 ** set to point at sqlite3_malloc()'d space containing the array of |
| 156 ** nCol column names. The caller is responsible for calling sqlite3_free |
| 157 ** on *paCol. |
| 158 */ |
| 159 static int getColumnNames( |
| 160 sqlite3 *db, |
| 161 const char *zTab, |
| 162 char ***paCol, |
| 163 int *pnCol |
| 164 ){ |
| 165 char **aCol = 0; |
| 166 char *zSql; |
| 167 sqlite3_stmt *pStmt = 0; |
| 168 int rc = SQLITE_OK; |
| 169 int nCol = 0; |
| 170 |
| 171 /* Prepare the statement "SELECT * FROM <tbl>". The column names |
| 172 ** of the result set of the compiled SELECT will be the same as |
| 173 ** the column names of table <tbl>. |
| 174 */ |
| 175 zSql = sqlite3_mprintf("SELECT * FROM %Q", zTab); |
| 176 if( !zSql ){ |
| 177 rc = SQLITE_NOMEM; |
| 178 goto out; |
| 179 } |
| 180 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0); |
| 181 sqlite3_free(zSql); |
| 182 |
| 183 if( rc==SQLITE_OK ){ |
| 184 int ii; |
| 185 int nBytes; |
| 186 char *zSpace; |
| 187 nCol = sqlite3_column_count(pStmt); |
| 188 |
| 189 /* Figure out how much space to allocate for the array of column names |
| 190 ** (including space for the strings themselves). Then allocate it. |
| 191 */ |
| 192 nBytes = sizeof(char *) * nCol; |
| 193 for(ii=0; ii<nCol; ii++){ |
| 194 const char *zName = sqlite3_column_name(pStmt, ii); |
| 195 if( !zName ){ |
| 196 rc = SQLITE_NOMEM; |
| 197 goto out; |
| 198 } |
| 199 nBytes += (int)strlen(zName)+1; |
| 200 } |
| 201 aCol = (char **)sqlite3MallocZero(nBytes); |
| 202 if( !aCol ){ |
| 203 rc = SQLITE_NOMEM; |
| 204 goto out; |
| 205 } |
| 206 |
| 207 /* Copy the column names into the allocated space and set up the |
| 208 ** pointers in the aCol[] array. |
| 209 */ |
| 210 zSpace = (char *)(&aCol[nCol]); |
| 211 for(ii=0; ii<nCol; ii++){ |
| 212 aCol[ii] = zSpace; |
| 213 sqlite3_snprintf(nBytes, zSpace, "%s", sqlite3_column_name(pStmt,ii)); |
| 214 zSpace += (int)strlen(zSpace) + 1; |
| 215 } |
| 216 assert( (zSpace-nBytes)==(char *)aCol ); |
| 217 } |
| 218 |
| 219 *paCol = aCol; |
| 220 *pnCol = nCol; |
| 221 |
| 222 out: |
| 223 sqlite3_finalize(pStmt); |
| 224 return rc; |
| 225 } |
| 226 |
| 227 /* |
| 228 ** Parameter zTab is the name of a table in database db with nCol |
| 229 ** columns. This function allocates an array of integers nCol in |
| 230 ** size and populates it according to any implicit or explicit |
| 231 ** indices on table zTab. |
| 232 ** |
| 233 ** If successful, SQLITE_OK is returned and *paIndex set to point |
| 234 ** at the allocated array. Otherwise, an error code is returned. |
| 235 ** |
| 236 ** See comments associated with the member variable aIndex above |
| 237 ** "struct echo_vtab" for details of the contents of the array. |
| 238 */ |
| 239 static int getIndexArray( |
| 240 sqlite3 *db, /* Database connection */ |
| 241 const char *zTab, /* Name of table in database db */ |
| 242 int nCol, |
| 243 int **paIndex |
| 244 ){ |
| 245 sqlite3_stmt *pStmt = 0; |
| 246 int *aIndex = 0; |
| 247 int rc; |
| 248 char *zSql; |
| 249 |
| 250 /* Allocate space for the index array */ |
| 251 aIndex = (int *)sqlite3MallocZero(sizeof(int) * nCol); |
| 252 if( !aIndex ){ |
| 253 rc = SQLITE_NOMEM; |
| 254 goto get_index_array_out; |
| 255 } |
| 256 |
| 257 /* Compile an sqlite pragma to loop through all indices on table zTab */ |
| 258 zSql = sqlite3_mprintf("PRAGMA index_list(%s)", zTab); |
| 259 if( !zSql ){ |
| 260 rc = SQLITE_NOMEM; |
| 261 goto get_index_array_out; |
| 262 } |
| 263 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0); |
| 264 sqlite3_free(zSql); |
| 265 |
| 266 /* For each index, figure out the left-most column and set the |
| 267 ** corresponding entry in aIndex[] to 1. |
| 268 */ |
| 269 while( pStmt && sqlite3_step(pStmt)==SQLITE_ROW ){ |
| 270 const char *zIdx = (const char *)sqlite3_column_text(pStmt, 1); |
| 271 sqlite3_stmt *pStmt2 = 0; |
| 272 if( zIdx==0 ) continue; |
| 273 zSql = sqlite3_mprintf("PRAGMA index_info(%s)", zIdx); |
| 274 if( !zSql ){ |
| 275 rc = SQLITE_NOMEM; |
| 276 goto get_index_array_out; |
| 277 } |
| 278 rc = sqlite3_prepare(db, zSql, -1, &pStmt2, 0); |
| 279 sqlite3_free(zSql); |
| 280 if( pStmt2 && sqlite3_step(pStmt2)==SQLITE_ROW ){ |
| 281 int cid = sqlite3_column_int(pStmt2, 1); |
| 282 assert( cid>=0 && cid<nCol ); |
| 283 aIndex[cid] = 1; |
| 284 } |
| 285 if( pStmt2 ){ |
| 286 rc = sqlite3_finalize(pStmt2); |
| 287 } |
| 288 if( rc!=SQLITE_OK ){ |
| 289 goto get_index_array_out; |
| 290 } |
| 291 } |
| 292 |
| 293 |
| 294 get_index_array_out: |
| 295 if( pStmt ){ |
| 296 int rc2 = sqlite3_finalize(pStmt); |
| 297 if( rc==SQLITE_OK ){ |
| 298 rc = rc2; |
| 299 } |
| 300 } |
| 301 if( rc!=SQLITE_OK ){ |
| 302 sqlite3_free(aIndex); |
| 303 aIndex = 0; |
| 304 } |
| 305 *paIndex = aIndex; |
| 306 return rc; |
| 307 } |
| 308 |
| 309 /* |
| 310 ** Global Tcl variable $echo_module is a list. This routine appends |
| 311 ** the string element zArg to that list in interpreter interp. |
| 312 */ |
| 313 static void appendToEchoModule(Tcl_Interp *interp, const char *zArg){ |
| 314 int flags = (TCL_APPEND_VALUE | TCL_LIST_ELEMENT | TCL_GLOBAL_ONLY); |
| 315 Tcl_SetVar(interp, "echo_module", (zArg?zArg:""), flags); |
| 316 } |
| 317 |
| 318 /* |
| 319 ** This function is called from within the echo-modules xCreate and |
| 320 ** xConnect methods. The argc and argv arguments are copies of those |
| 321 ** passed to the calling method. This function is responsible for |
| 322 ** calling sqlite3_declare_vtab() to declare the schema of the virtual |
| 323 ** table being created or connected. |
| 324 ** |
| 325 ** If the constructor was passed just one argument, i.e.: |
| 326 ** |
| 327 ** CREATE TABLE t1 AS echo(t2); |
| 328 ** |
| 329 ** Then t2 is assumed to be the name of a *real* database table. The |
| 330 ** schema of the virtual table is declared by passing a copy of the |
| 331 ** CREATE TABLE statement for the real table to sqlite3_declare_vtab(). |
| 332 ** Hence, the virtual table should have exactly the same column names and |
| 333 ** types as the real table. |
| 334 */ |
| 335 static int echoDeclareVtab( |
| 336 echo_vtab *pVtab, |
| 337 sqlite3 *db |
| 338 ){ |
| 339 int rc = SQLITE_OK; |
| 340 |
| 341 if( pVtab->zTableName ){ |
| 342 sqlite3_stmt *pStmt = 0; |
| 343 rc = sqlite3_prepare(db, |
| 344 "SELECT sql FROM sqlite_master WHERE type = 'table' AND name = ?", |
| 345 -1, &pStmt, 0); |
| 346 if( rc==SQLITE_OK ){ |
| 347 sqlite3_bind_text(pStmt, 1, pVtab->zTableName, -1, 0); |
| 348 if( sqlite3_step(pStmt)==SQLITE_ROW ){ |
| 349 int rc2; |
| 350 const char *zCreateTable = (const char *)sqlite3_column_text(pStmt, 0); |
| 351 rc = sqlite3_declare_vtab(db, zCreateTable); |
| 352 rc2 = sqlite3_finalize(pStmt); |
| 353 if( rc==SQLITE_OK ){ |
| 354 rc = rc2; |
| 355 } |
| 356 } else { |
| 357 rc = sqlite3_finalize(pStmt); |
| 358 if( rc==SQLITE_OK ){ |
| 359 rc = SQLITE_ERROR; |
| 360 } |
| 361 } |
| 362 if( rc==SQLITE_OK ){ |
| 363 rc = getColumnNames(db, pVtab->zTableName, &pVtab->aCol, &pVtab->nCol); |
| 364 } |
| 365 if( rc==SQLITE_OK ){ |
| 366 rc = getIndexArray(db, pVtab->zTableName, pVtab->nCol, &pVtab->aIndex); |
| 367 } |
| 368 } |
| 369 } |
| 370 |
| 371 return rc; |
| 372 } |
| 373 |
| 374 /* |
| 375 ** This function frees all runtime structures associated with the virtual |
| 376 ** table pVtab. |
| 377 */ |
| 378 static int echoDestructor(sqlite3_vtab *pVtab){ |
| 379 echo_vtab *p = (echo_vtab*)pVtab; |
| 380 sqlite3_free(p->aIndex); |
| 381 sqlite3_free(p->aCol); |
| 382 sqlite3_free(p->zThis); |
| 383 sqlite3_free(p->zTableName); |
| 384 sqlite3_free(p->zLogName); |
| 385 sqlite3_free(p); |
| 386 return 0; |
| 387 } |
| 388 |
| 389 typedef struct EchoModule EchoModule; |
| 390 struct EchoModule { |
| 391 Tcl_Interp *interp; |
| 392 }; |
| 393 |
| 394 /* |
| 395 ** This function is called to do the work of the xConnect() method - |
| 396 ** to allocate the required in-memory structures for a newly connected |
| 397 ** virtual table. |
| 398 */ |
| 399 static int echoConstructor( |
| 400 sqlite3 *db, |
| 401 void *pAux, |
| 402 int argc, const char *const*argv, |
| 403 sqlite3_vtab **ppVtab, |
| 404 char **pzErr |
| 405 ){ |
| 406 int rc; |
| 407 int i; |
| 408 echo_vtab *pVtab; |
| 409 |
| 410 /* Allocate the sqlite3_vtab/echo_vtab structure itself */ |
| 411 pVtab = sqlite3MallocZero( sizeof(*pVtab) ); |
| 412 if( !pVtab ){ |
| 413 return SQLITE_NOMEM; |
| 414 } |
| 415 pVtab->interp = ((EchoModule *)pAux)->interp; |
| 416 pVtab->db = db; |
| 417 |
| 418 /* Allocate echo_vtab.zThis */ |
| 419 pVtab->zThis = sqlite3_mprintf("%s", argv[2]); |
| 420 if( !pVtab->zThis ){ |
| 421 echoDestructor((sqlite3_vtab *)pVtab); |
| 422 return SQLITE_NOMEM; |
| 423 } |
| 424 |
| 425 /* Allocate echo_vtab.zTableName */ |
| 426 if( argc>3 ){ |
| 427 pVtab->zTableName = sqlite3_mprintf("%s", argv[3]); |
| 428 dequoteString(pVtab->zTableName); |
| 429 if( pVtab->zTableName && pVtab->zTableName[0]=='*' ){ |
| 430 char *z = sqlite3_mprintf("%s%s", argv[2], &(pVtab->zTableName[1])); |
| 431 sqlite3_free(pVtab->zTableName); |
| 432 pVtab->zTableName = z; |
| 433 pVtab->isPattern = 1; |
| 434 } |
| 435 if( !pVtab->zTableName ){ |
| 436 echoDestructor((sqlite3_vtab *)pVtab); |
| 437 return SQLITE_NOMEM; |
| 438 } |
| 439 } |
| 440 |
| 441 /* Log the arguments to this function to Tcl var ::echo_module */ |
| 442 for(i=0; i<argc; i++){ |
| 443 appendToEchoModule(pVtab->interp, argv[i]); |
| 444 } |
| 445 |
| 446 /* Invoke sqlite3_declare_vtab and set up other members of the echo_vtab |
| 447 ** structure. If an error occurs, delete the sqlite3_vtab structure and |
| 448 ** return an error code. |
| 449 */ |
| 450 rc = echoDeclareVtab(pVtab, db); |
| 451 if( rc!=SQLITE_OK ){ |
| 452 echoDestructor((sqlite3_vtab *)pVtab); |
| 453 return rc; |
| 454 } |
| 455 |
| 456 /* Success. Set *ppVtab and return */ |
| 457 *ppVtab = &pVtab->base; |
| 458 return SQLITE_OK; |
| 459 } |
| 460 |
| 461 /* |
| 462 ** Echo virtual table module xCreate method. |
| 463 */ |
| 464 static int echoCreate( |
| 465 sqlite3 *db, |
| 466 void *pAux, |
| 467 int argc, const char *const*argv, |
| 468 sqlite3_vtab **ppVtab, |
| 469 char **pzErr |
| 470 ){ |
| 471 int rc = SQLITE_OK; |
| 472 appendToEchoModule(((EchoModule *)pAux)->interp, "xCreate"); |
| 473 rc = echoConstructor(db, pAux, argc, argv, ppVtab, pzErr); |
| 474 |
| 475 /* If there were two arguments passed to the module at the SQL level |
| 476 ** (i.e. "CREATE VIRTUAL TABLE tbl USING echo(arg1, arg2)"), then |
| 477 ** the second argument is used as a table name. Attempt to create |
| 478 ** such a table with a single column, "logmsg". This table will |
| 479 ** be used to log calls to the xUpdate method. It will be deleted |
| 480 ** when the virtual table is DROPed. |
| 481 ** |
| 482 ** Note: The main point of this is to test that we can drop tables |
| 483 ** from within an xDestroy method call. |
| 484 */ |
| 485 if( rc==SQLITE_OK && argc==5 ){ |
| 486 char *zSql; |
| 487 echo_vtab *pVtab = *(echo_vtab **)ppVtab; |
| 488 pVtab->zLogName = sqlite3_mprintf("%s", argv[4]); |
| 489 zSql = sqlite3_mprintf("CREATE TABLE %Q(logmsg)", pVtab->zLogName); |
| 490 rc = sqlite3_exec(db, zSql, 0, 0, 0); |
| 491 sqlite3_free(zSql); |
| 492 if( rc!=SQLITE_OK ){ |
| 493 *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db)); |
| 494 } |
| 495 } |
| 496 |
| 497 if( *ppVtab && rc!=SQLITE_OK ){ |
| 498 echoDestructor(*ppVtab); |
| 499 *ppVtab = 0; |
| 500 } |
| 501 |
| 502 if( rc==SQLITE_OK ){ |
| 503 (*(echo_vtab**)ppVtab)->inTransaction = 1; |
| 504 } |
| 505 |
| 506 return rc; |
| 507 } |
| 508 |
| 509 /* |
| 510 ** Echo virtual table module xConnect method. |
| 511 */ |
| 512 static int echoConnect( |
| 513 sqlite3 *db, |
| 514 void *pAux, |
| 515 int argc, const char *const*argv, |
| 516 sqlite3_vtab **ppVtab, |
| 517 char **pzErr |
| 518 ){ |
| 519 appendToEchoModule(((EchoModule *)pAux)->interp, "xConnect"); |
| 520 return echoConstructor(db, pAux, argc, argv, ppVtab, pzErr); |
| 521 } |
| 522 |
| 523 /* |
| 524 ** Echo virtual table module xDisconnect method. |
| 525 */ |
| 526 static int echoDisconnect(sqlite3_vtab *pVtab){ |
| 527 appendToEchoModule(((echo_vtab *)pVtab)->interp, "xDisconnect"); |
| 528 return echoDestructor(pVtab); |
| 529 } |
| 530 |
| 531 /* |
| 532 ** Echo virtual table module xDestroy method. |
| 533 */ |
| 534 static int echoDestroy(sqlite3_vtab *pVtab){ |
| 535 int rc = SQLITE_OK; |
| 536 echo_vtab *p = (echo_vtab *)pVtab; |
| 537 appendToEchoModule(((echo_vtab *)pVtab)->interp, "xDestroy"); |
| 538 |
| 539 /* Drop the "log" table, if one exists (see echoCreate() for details) */ |
| 540 if( p && p->zLogName ){ |
| 541 char *zSql; |
| 542 zSql = sqlite3_mprintf("DROP TABLE %Q", p->zLogName); |
| 543 rc = sqlite3_exec(p->db, zSql, 0, 0, 0); |
| 544 sqlite3_free(zSql); |
| 545 } |
| 546 |
| 547 if( rc==SQLITE_OK ){ |
| 548 rc = echoDestructor(pVtab); |
| 549 } |
| 550 return rc; |
| 551 } |
| 552 |
| 553 /* |
| 554 ** Echo virtual table module xOpen method. |
| 555 */ |
| 556 static int echoOpen(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor){ |
| 557 echo_cursor *pCur; |
| 558 if( simulateVtabError((echo_vtab *)pVTab, "xOpen") ){ |
| 559 return SQLITE_ERROR; |
| 560 } |
| 561 pCur = sqlite3MallocZero(sizeof(echo_cursor)); |
| 562 *ppCursor = (sqlite3_vtab_cursor *)pCur; |
| 563 return (pCur ? SQLITE_OK : SQLITE_NOMEM); |
| 564 } |
| 565 |
| 566 /* |
| 567 ** Echo virtual table module xClose method. |
| 568 */ |
| 569 static int echoClose(sqlite3_vtab_cursor *cur){ |
| 570 int rc; |
| 571 echo_cursor *pCur = (echo_cursor *)cur; |
| 572 sqlite3_stmt *pStmt = pCur->pStmt; |
| 573 pCur->pStmt = 0; |
| 574 sqlite3_free(pCur); |
| 575 rc = sqlite3_finalize(pStmt); |
| 576 return rc; |
| 577 } |
| 578 |
| 579 /* |
| 580 ** Return non-zero if the cursor does not currently point to a valid record |
| 581 ** (i.e if the scan has finished), or zero otherwise. |
| 582 */ |
| 583 static int echoEof(sqlite3_vtab_cursor *cur){ |
| 584 return (((echo_cursor *)cur)->pStmt ? 0 : 1); |
| 585 } |
| 586 |
| 587 /* |
| 588 ** Echo virtual table module xNext method. |
| 589 */ |
| 590 static int echoNext(sqlite3_vtab_cursor *cur){ |
| 591 int rc = SQLITE_OK; |
| 592 echo_cursor *pCur = (echo_cursor *)cur; |
| 593 |
| 594 if( simulateVtabError((echo_vtab *)(cur->pVtab), "xNext") ){ |
| 595 return SQLITE_ERROR; |
| 596 } |
| 597 |
| 598 if( pCur->pStmt ){ |
| 599 rc = sqlite3_step(pCur->pStmt); |
| 600 if( rc==SQLITE_ROW ){ |
| 601 rc = SQLITE_OK; |
| 602 }else{ |
| 603 rc = sqlite3_finalize(pCur->pStmt); |
| 604 pCur->pStmt = 0; |
| 605 } |
| 606 } |
| 607 |
| 608 return rc; |
| 609 } |
| 610 |
| 611 /* |
| 612 ** Echo virtual table module xColumn method. |
| 613 */ |
| 614 static int echoColumn(sqlite3_vtab_cursor *cur, sqlite3_context *ctx, int i){ |
| 615 int iCol = i + 1; |
| 616 sqlite3_stmt *pStmt = ((echo_cursor *)cur)->pStmt; |
| 617 |
| 618 if( simulateVtabError((echo_vtab *)(cur->pVtab), "xColumn") ){ |
| 619 return SQLITE_ERROR; |
| 620 } |
| 621 |
| 622 if( !pStmt ){ |
| 623 sqlite3_result_null(ctx); |
| 624 }else{ |
| 625 assert( sqlite3_data_count(pStmt)>iCol ); |
| 626 sqlite3_result_value(ctx, sqlite3_column_value(pStmt, iCol)); |
| 627 } |
| 628 return SQLITE_OK; |
| 629 } |
| 630 |
| 631 /* |
| 632 ** Echo virtual table module xRowid method. |
| 633 */ |
| 634 static int echoRowid(sqlite3_vtab_cursor *cur, sqlite_int64 *pRowid){ |
| 635 sqlite3_stmt *pStmt = ((echo_cursor *)cur)->pStmt; |
| 636 |
| 637 if( simulateVtabError((echo_vtab *)(cur->pVtab), "xRowid") ){ |
| 638 return SQLITE_ERROR; |
| 639 } |
| 640 |
| 641 *pRowid = sqlite3_column_int64(pStmt, 0); |
| 642 return SQLITE_OK; |
| 643 } |
| 644 |
| 645 /* |
| 646 ** Compute a simple hash of the null terminated string zString. |
| 647 ** |
| 648 ** This module uses only sqlite3_index_info.idxStr, not |
| 649 ** sqlite3_index_info.idxNum. So to test idxNum, when idxStr is set |
| 650 ** in echoBestIndex(), idxNum is set to the corresponding hash value. |
| 651 ** In echoFilter(), code assert()s that the supplied idxNum value is |
| 652 ** indeed the hash of the supplied idxStr. |
| 653 */ |
| 654 static int hashString(const char *zString){ |
| 655 u32 val = 0; |
| 656 int ii; |
| 657 for(ii=0; zString[ii]; ii++){ |
| 658 val = (val << 3) + (int)zString[ii]; |
| 659 } |
| 660 return (int)(val&0x7fffffff); |
| 661 } |
| 662 |
| 663 /* |
| 664 ** Echo virtual table module xFilter method. |
| 665 */ |
| 666 static int echoFilter( |
| 667 sqlite3_vtab_cursor *pVtabCursor, |
| 668 int idxNum, const char *idxStr, |
| 669 int argc, sqlite3_value **argv |
| 670 ){ |
| 671 int rc; |
| 672 int i; |
| 673 |
| 674 echo_cursor *pCur = (echo_cursor *)pVtabCursor; |
| 675 echo_vtab *pVtab = (echo_vtab *)pVtabCursor->pVtab; |
| 676 sqlite3 *db = pVtab->db; |
| 677 |
| 678 if( simulateVtabError(pVtab, "xFilter") ){ |
| 679 return SQLITE_ERROR; |
| 680 } |
| 681 |
| 682 /* Check that idxNum matches idxStr */ |
| 683 assert( idxNum==hashString(idxStr) ); |
| 684 |
| 685 /* Log arguments to the ::echo_module Tcl variable */ |
| 686 appendToEchoModule(pVtab->interp, "xFilter"); |
| 687 appendToEchoModule(pVtab->interp, idxStr); |
| 688 for(i=0; i<argc; i++){ |
| 689 appendToEchoModule(pVtab->interp, (const char*)sqlite3_value_text(argv[i])); |
| 690 } |
| 691 |
| 692 sqlite3_finalize(pCur->pStmt); |
| 693 pCur->pStmt = 0; |
| 694 |
| 695 /* Prepare the SQL statement created by echoBestIndex and bind the |
| 696 ** runtime parameters passed to this function to it. |
| 697 */ |
| 698 rc = sqlite3_prepare(db, idxStr, -1, &pCur->pStmt, 0); |
| 699 assert( pCur->pStmt || rc!=SQLITE_OK ); |
| 700 for(i=0; rc==SQLITE_OK && i<argc; i++){ |
| 701 rc = sqlite3_bind_value(pCur->pStmt, i+1, argv[i]); |
| 702 } |
| 703 |
| 704 /* If everything was successful, advance to the first row of the scan */ |
| 705 if( rc==SQLITE_OK ){ |
| 706 rc = echoNext(pVtabCursor); |
| 707 } |
| 708 |
| 709 return rc; |
| 710 } |
| 711 |
| 712 |
| 713 /* |
| 714 ** A helper function used by echoUpdate() and echoBestIndex() for |
| 715 ** manipulating strings in concert with the sqlite3_mprintf() function. |
| 716 ** |
| 717 ** Parameter pzStr points to a pointer to a string allocated with |
| 718 ** sqlite3_mprintf. The second parameter, zAppend, points to another |
| 719 ** string. The two strings are concatenated together and *pzStr |
| 720 ** set to point at the result. The initial buffer pointed to by *pzStr |
| 721 ** is deallocated via sqlite3_free(). |
| 722 ** |
| 723 ** If the third argument, doFree, is true, then sqlite3_free() is |
| 724 ** also called to free the buffer pointed to by zAppend. |
| 725 */ |
| 726 static void string_concat(char **pzStr, char *zAppend, int doFree, int *pRc){ |
| 727 char *zIn = *pzStr; |
| 728 if( !zAppend && doFree && *pRc==SQLITE_OK ){ |
| 729 *pRc = SQLITE_NOMEM; |
| 730 } |
| 731 if( *pRc!=SQLITE_OK ){ |
| 732 sqlite3_free(zIn); |
| 733 zIn = 0; |
| 734 }else{ |
| 735 if( zIn ){ |
| 736 char *zTemp = zIn; |
| 737 zIn = sqlite3_mprintf("%s%s", zIn, zAppend); |
| 738 sqlite3_free(zTemp); |
| 739 }else{ |
| 740 zIn = sqlite3_mprintf("%s", zAppend); |
| 741 } |
| 742 if( !zIn ){ |
| 743 *pRc = SQLITE_NOMEM; |
| 744 } |
| 745 } |
| 746 *pzStr = zIn; |
| 747 if( doFree ){ |
| 748 sqlite3_free(zAppend); |
| 749 } |
| 750 } |
| 751 |
| 752 /* |
| 753 ** This function returns a pointer to an sqlite3_malloc()ed buffer |
| 754 ** containing the select-list (the thing between keywords SELECT and FROM) |
| 755 ** to query the underlying real table with for the scan described by |
| 756 ** argument pIdxInfo. |
| 757 ** |
| 758 ** If the current SQLite version is earlier than 3.10.0, this is just "*" |
| 759 ** (select all columns). Or, for version 3.10.0 and greater, the list of |
| 760 ** columns identified by the pIdxInfo->colUsed mask. |
| 761 */ |
| 762 static char *echoSelectList(echo_vtab *pTab, sqlite3_index_info *pIdxInfo){ |
| 763 char *zRet = 0; |
| 764 if( sqlite3_libversion_number()<3010000 ){ |
| 765 zRet = sqlite3_mprintf(", *"); |
| 766 }else{ |
| 767 int i; |
| 768 for(i=0; i<pTab->nCol; i++){ |
| 769 if( pIdxInfo->colUsed & ((sqlite3_uint64)1 << (i>=63 ? 63 : i)) ){ |
| 770 zRet = sqlite3_mprintf("%z, %s", zRet, pTab->aCol[i]); |
| 771 }else{ |
| 772 zRet = sqlite3_mprintf("%z, NULL", zRet); |
| 773 } |
| 774 if( !zRet ) break; |
| 775 } |
| 776 } |
| 777 return zRet; |
| 778 } |
| 779 |
| 780 /* |
| 781 ** The echo module implements the subset of query constraints and sort |
| 782 ** orders that may take advantage of SQLite indices on the underlying |
| 783 ** real table. For example, if the real table is declared as: |
| 784 ** |
| 785 ** CREATE TABLE real(a, b, c); |
| 786 ** CREATE INDEX real_index ON real(b); |
| 787 ** |
| 788 ** then the echo module handles WHERE or ORDER BY clauses that refer |
| 789 ** to the column "b", but not "a" or "c". If a multi-column index is |
| 790 ** present, only its left most column is considered. |
| 791 ** |
| 792 ** This xBestIndex method encodes the proposed search strategy as |
| 793 ** an SQL query on the real table underlying the virtual echo module |
| 794 ** table and stores the query in sqlite3_index_info.idxStr. The SQL |
| 795 ** statement is of the form: |
| 796 ** |
| 797 ** SELECT rowid, * FROM <real-table> ?<where-clause>? ?<order-by-clause>? |
| 798 ** |
| 799 ** where the <where-clause> and <order-by-clause> are determined |
| 800 ** by the contents of the structure pointed to by the pIdxInfo argument. |
| 801 */ |
| 802 static int echoBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){ |
| 803 int ii; |
| 804 char *zQuery = 0; |
| 805 char *zCol = 0; |
| 806 char *zNew; |
| 807 int nArg = 0; |
| 808 const char *zSep = "WHERE"; |
| 809 echo_vtab *pVtab = (echo_vtab *)tab; |
| 810 sqlite3_stmt *pStmt = 0; |
| 811 Tcl_Interp *interp = pVtab->interp; |
| 812 |
| 813 int nRow = 0; |
| 814 int useIdx = 0; |
| 815 int rc = SQLITE_OK; |
| 816 int useCost = 0; |
| 817 double cost = 0; |
| 818 int isIgnoreUsable = 0; |
| 819 if( Tcl_GetVar(interp, "echo_module_ignore_usable", TCL_GLOBAL_ONLY) ){ |
| 820 isIgnoreUsable = 1; |
| 821 } |
| 822 |
| 823 if( simulateVtabError(pVtab, "xBestIndex") ){ |
| 824 return SQLITE_ERROR; |
| 825 } |
| 826 |
| 827 /* Determine the number of rows in the table and store this value in local |
| 828 ** variable nRow. The 'estimated-cost' of the scan will be the number of |
| 829 ** rows in the table for a linear scan, or the log (base 2) of the |
| 830 ** number of rows if the proposed scan uses an index. |
| 831 */ |
| 832 if( Tcl_GetVar(interp, "echo_module_cost", TCL_GLOBAL_ONLY) ){ |
| 833 cost = atof(Tcl_GetVar(interp, "echo_module_cost", TCL_GLOBAL_ONLY)); |
| 834 useCost = 1; |
| 835 } else { |
| 836 zQuery = sqlite3_mprintf("SELECT count(*) FROM %Q", pVtab->zTableName); |
| 837 if( !zQuery ){ |
| 838 return SQLITE_NOMEM; |
| 839 } |
| 840 rc = sqlite3_prepare(pVtab->db, zQuery, -1, &pStmt, 0); |
| 841 sqlite3_free(zQuery); |
| 842 if( rc!=SQLITE_OK ){ |
| 843 return rc; |
| 844 } |
| 845 sqlite3_step(pStmt); |
| 846 nRow = sqlite3_column_int(pStmt, 0); |
| 847 rc = sqlite3_finalize(pStmt); |
| 848 if( rc!=SQLITE_OK ){ |
| 849 return rc; |
| 850 } |
| 851 } |
| 852 |
| 853 zCol = echoSelectList(pVtab, pIdxInfo); |
| 854 if( !zCol ) return SQLITE_NOMEM; |
| 855 zQuery = sqlite3_mprintf("SELECT rowid%z FROM %Q", zCol, pVtab->zTableName); |
| 856 if( !zQuery ) return SQLITE_NOMEM; |
| 857 |
| 858 for(ii=0; ii<pIdxInfo->nConstraint; ii++){ |
| 859 const struct sqlite3_index_constraint *pConstraint; |
| 860 struct sqlite3_index_constraint_usage *pUsage; |
| 861 int iCol; |
| 862 |
| 863 pConstraint = &pIdxInfo->aConstraint[ii]; |
| 864 pUsage = &pIdxInfo->aConstraintUsage[ii]; |
| 865 |
| 866 if( !isIgnoreUsable && !pConstraint->usable ) continue; |
| 867 |
| 868 iCol = pConstraint->iColumn; |
| 869 if( iCol<0 || pVtab->aIndex[iCol] ){ |
| 870 char *zNewCol = iCol>=0 ? pVtab->aCol[iCol] : "rowid"; |
| 871 char *zOp = 0; |
| 872 useIdx = 1; |
| 873 switch( pConstraint->op ){ |
| 874 case SQLITE_INDEX_CONSTRAINT_EQ: |
| 875 zOp = "="; break; |
| 876 case SQLITE_INDEX_CONSTRAINT_LT: |
| 877 zOp = "<"; break; |
| 878 case SQLITE_INDEX_CONSTRAINT_GT: |
| 879 zOp = ">"; break; |
| 880 case SQLITE_INDEX_CONSTRAINT_LE: |
| 881 zOp = "<="; break; |
| 882 case SQLITE_INDEX_CONSTRAINT_GE: |
| 883 zOp = ">="; break; |
| 884 case SQLITE_INDEX_CONSTRAINT_MATCH: |
| 885 /* Purposely translate the MATCH operator into a LIKE, which |
| 886 ** will be used by the next block of code to construct a new |
| 887 ** query. It should also be noted here that the next block |
| 888 ** of code requires the first letter of this operator to be |
| 889 ** in upper-case to trigger the special MATCH handling (i.e. |
| 890 ** wrapping the bound parameter with literal '%'s). |
| 891 */ |
| 892 zOp = "LIKE"; break; |
| 893 case SQLITE_INDEX_CONSTRAINT_LIKE: |
| 894 zOp = "like"; break; |
| 895 case SQLITE_INDEX_CONSTRAINT_GLOB: |
| 896 zOp = "glob"; break; |
| 897 case SQLITE_INDEX_CONSTRAINT_REGEXP: |
| 898 zOp = "regexp"; break; |
| 899 } |
| 900 if( zOp[0]=='L' ){ |
| 901 zNew = sqlite3_mprintf(" %s %s LIKE (SELECT '%%'||?||'%%')", |
| 902 zSep, zNewCol); |
| 903 } else { |
| 904 zNew = sqlite3_mprintf(" %s %s %s ?", zSep, zNewCol, zOp); |
| 905 } |
| 906 string_concat(&zQuery, zNew, 1, &rc); |
| 907 |
| 908 zSep = "AND"; |
| 909 pUsage->argvIndex = ++nArg; |
| 910 pUsage->omit = 1; |
| 911 } |
| 912 } |
| 913 |
| 914 /* If there is only one term in the ORDER BY clause, and it is |
| 915 ** on a column that this virtual table has an index for, then consume |
| 916 ** the ORDER BY clause. |
| 917 */ |
| 918 if( pIdxInfo->nOrderBy==1 && ( |
| 919 pIdxInfo->aOrderBy->iColumn<0 || |
| 920 pVtab->aIndex[pIdxInfo->aOrderBy->iColumn]) ){ |
| 921 int iCol = pIdxInfo->aOrderBy->iColumn; |
| 922 char *zNewCol = iCol>=0 ? pVtab->aCol[iCol] : "rowid"; |
| 923 char *zDir = pIdxInfo->aOrderBy->desc?"DESC":"ASC"; |
| 924 zNew = sqlite3_mprintf(" ORDER BY %s %s", zNewCol, zDir); |
| 925 string_concat(&zQuery, zNew, 1, &rc); |
| 926 pIdxInfo->orderByConsumed = 1; |
| 927 } |
| 928 |
| 929 appendToEchoModule(pVtab->interp, "xBestIndex");; |
| 930 appendToEchoModule(pVtab->interp, zQuery); |
| 931 |
| 932 if( !zQuery ){ |
| 933 return rc; |
| 934 } |
| 935 pIdxInfo->idxNum = hashString(zQuery); |
| 936 pIdxInfo->idxStr = zQuery; |
| 937 pIdxInfo->needToFreeIdxStr = 1; |
| 938 if( useCost ){ |
| 939 pIdxInfo->estimatedCost = cost; |
| 940 }else if( useIdx ){ |
| 941 /* Approximation of log2(nRow). */ |
| 942 for( ii=0; ii<(sizeof(int)*8)-1; ii++ ){ |
| 943 if( nRow & (1<<ii) ){ |
| 944 pIdxInfo->estimatedCost = (double)ii; |
| 945 } |
| 946 } |
| 947 }else{ |
| 948 pIdxInfo->estimatedCost = (double)nRow; |
| 949 } |
| 950 return rc; |
| 951 } |
| 952 |
| 953 /* |
| 954 ** The xUpdate method for echo module virtual tables. |
| 955 ** |
| 956 ** apData[0] apData[1] apData[2..] |
| 957 ** |
| 958 ** INTEGER DELETE |
| 959 ** |
| 960 ** INTEGER NULL (nCol args) UPDATE (do not set rowid) |
| 961 ** INTEGER INTEGER (nCol args) UPDATE (with SET rowid = <arg1>) |
| 962 ** |
| 963 ** NULL NULL (nCol args) INSERT INTO (automatic rowid value) |
| 964 ** NULL INTEGER (nCol args) INSERT (incl. rowid value) |
| 965 ** |
| 966 */ |
| 967 int echoUpdate( |
| 968 sqlite3_vtab *tab, |
| 969 int nData, |
| 970 sqlite3_value **apData, |
| 971 sqlite_int64 *pRowid |
| 972 ){ |
| 973 echo_vtab *pVtab = (echo_vtab *)tab; |
| 974 sqlite3 *db = pVtab->db; |
| 975 int rc = SQLITE_OK; |
| 976 |
| 977 sqlite3_stmt *pStmt = 0; |
| 978 char *z = 0; /* SQL statement to execute */ |
| 979 int bindArgZero = 0; /* True to bind apData[0] to sql var no. nData */ |
| 980 int bindArgOne = 0; /* True to bind apData[1] to sql var no. 1 */ |
| 981 int i; /* Counter variable used by for loops */ |
| 982 |
| 983 assert( nData==pVtab->nCol+2 || nData==1 ); |
| 984 |
| 985 /* Ticket #3083 - make sure we always start a transaction prior to |
| 986 ** making any changes to a virtual table */ |
| 987 assert( pVtab->inTransaction ); |
| 988 |
| 989 if( simulateVtabError(pVtab, "xUpdate") ){ |
| 990 return SQLITE_ERROR; |
| 991 } |
| 992 |
| 993 /* If apData[0] is an integer and nData>1 then do an UPDATE */ |
| 994 if( nData>1 && sqlite3_value_type(apData[0])==SQLITE_INTEGER ){ |
| 995 char *zSep = " SET"; |
| 996 z = sqlite3_mprintf("UPDATE %Q", pVtab->zTableName); |
| 997 if( !z ){ |
| 998 rc = SQLITE_NOMEM; |
| 999 } |
| 1000 |
| 1001 bindArgOne = (apData[1] && sqlite3_value_type(apData[1])==SQLITE_INTEGER); |
| 1002 bindArgZero = 1; |
| 1003 |
| 1004 if( bindArgOne ){ |
| 1005 string_concat(&z, " SET rowid=?1 ", 0, &rc); |
| 1006 zSep = ","; |
| 1007 } |
| 1008 for(i=2; i<nData; i++){ |
| 1009 if( apData[i]==0 ) continue; |
| 1010 string_concat(&z, sqlite3_mprintf( |
| 1011 "%s %Q=?%d", zSep, pVtab->aCol[i-2], i), 1, &rc); |
| 1012 zSep = ","; |
| 1013 } |
| 1014 string_concat(&z, sqlite3_mprintf(" WHERE rowid=?%d", nData), 1, &rc); |
| 1015 } |
| 1016 |
| 1017 /* If apData[0] is an integer and nData==1 then do a DELETE */ |
| 1018 else if( nData==1 && sqlite3_value_type(apData[0])==SQLITE_INTEGER ){ |
| 1019 z = sqlite3_mprintf("DELETE FROM %Q WHERE rowid = ?1", pVtab->zTableName); |
| 1020 if( !z ){ |
| 1021 rc = SQLITE_NOMEM; |
| 1022 } |
| 1023 bindArgZero = 1; |
| 1024 } |
| 1025 |
| 1026 /* If the first argument is NULL and there are more than two args, INSERT */ |
| 1027 else if( nData>2 && sqlite3_value_type(apData[0])==SQLITE_NULL ){ |
| 1028 int ii; |
| 1029 char *zInsert = 0; |
| 1030 char *zValues = 0; |
| 1031 |
| 1032 zInsert = sqlite3_mprintf("INSERT INTO %Q (", pVtab->zTableName); |
| 1033 if( !zInsert ){ |
| 1034 rc = SQLITE_NOMEM; |
| 1035 } |
| 1036 if( sqlite3_value_type(apData[1])==SQLITE_INTEGER ){ |
| 1037 bindArgOne = 1; |
| 1038 zValues = sqlite3_mprintf("?"); |
| 1039 string_concat(&zInsert, "rowid", 0, &rc); |
| 1040 } |
| 1041 |
| 1042 assert((pVtab->nCol+2)==nData); |
| 1043 for(ii=2; ii<nData; ii++){ |
| 1044 string_concat(&zInsert, |
| 1045 sqlite3_mprintf("%s%Q", zValues?", ":"", pVtab->aCol[ii-2]), 1, &rc); |
| 1046 string_concat(&zValues, |
| 1047 sqlite3_mprintf("%s?%d", zValues?", ":"", ii), 1, &rc); |
| 1048 } |
| 1049 |
| 1050 string_concat(&z, zInsert, 1, &rc); |
| 1051 string_concat(&z, ") VALUES(", 0, &rc); |
| 1052 string_concat(&z, zValues, 1, &rc); |
| 1053 string_concat(&z, ")", 0, &rc); |
| 1054 } |
| 1055 |
| 1056 /* Anything else is an error */ |
| 1057 else{ |
| 1058 assert(0); |
| 1059 return SQLITE_ERROR; |
| 1060 } |
| 1061 |
| 1062 if( rc==SQLITE_OK ){ |
| 1063 rc = sqlite3_prepare(db, z, -1, &pStmt, 0); |
| 1064 } |
| 1065 assert( rc!=SQLITE_OK || pStmt ); |
| 1066 sqlite3_free(z); |
| 1067 if( rc==SQLITE_OK ) { |
| 1068 if( bindArgZero ){ |
| 1069 sqlite3_bind_value(pStmt, nData, apData[0]); |
| 1070 } |
| 1071 if( bindArgOne ){ |
| 1072 sqlite3_bind_value(pStmt, 1, apData[1]); |
| 1073 } |
| 1074 for(i=2; i<nData && rc==SQLITE_OK; i++){ |
| 1075 if( apData[i] ) rc = sqlite3_bind_value(pStmt, i, apData[i]); |
| 1076 } |
| 1077 if( rc==SQLITE_OK ){ |
| 1078 sqlite3_step(pStmt); |
| 1079 rc = sqlite3_finalize(pStmt); |
| 1080 }else{ |
| 1081 sqlite3_finalize(pStmt); |
| 1082 } |
| 1083 } |
| 1084 |
| 1085 if( pRowid && rc==SQLITE_OK ){ |
| 1086 *pRowid = sqlite3_last_insert_rowid(db); |
| 1087 } |
| 1088 if( rc!=SQLITE_OK ){ |
| 1089 tab->zErrMsg = sqlite3_mprintf("echo-vtab-error: %s", sqlite3_errmsg(db)); |
| 1090 } |
| 1091 |
| 1092 return rc; |
| 1093 } |
| 1094 |
| 1095 /* |
| 1096 ** xBegin, xSync, xCommit and xRollback callbacks for echo module |
| 1097 ** virtual tables. Do nothing other than add the name of the callback |
| 1098 ** to the $::echo_module Tcl variable. |
| 1099 */ |
| 1100 static int echoTransactionCall(sqlite3_vtab *tab, const char *zCall){ |
| 1101 char *z; |
| 1102 echo_vtab *pVtab = (echo_vtab *)tab; |
| 1103 z = sqlite3_mprintf("echo(%s)", pVtab->zTableName); |
| 1104 if( z==0 ) return SQLITE_NOMEM; |
| 1105 appendToEchoModule(pVtab->interp, zCall); |
| 1106 appendToEchoModule(pVtab->interp, z); |
| 1107 sqlite3_free(z); |
| 1108 return SQLITE_OK; |
| 1109 } |
| 1110 static int echoBegin(sqlite3_vtab *tab){ |
| 1111 int rc; |
| 1112 echo_vtab *pVtab = (echo_vtab *)tab; |
| 1113 Tcl_Interp *interp = pVtab->interp; |
| 1114 const char *zVal; |
| 1115 |
| 1116 /* Ticket #3083 - do not start a transaction if we are already in |
| 1117 ** a transaction */ |
| 1118 assert( !pVtab->inTransaction ); |
| 1119 |
| 1120 if( simulateVtabError(pVtab, "xBegin") ){ |
| 1121 return SQLITE_ERROR; |
| 1122 } |
| 1123 |
| 1124 rc = echoTransactionCall(tab, "xBegin"); |
| 1125 |
| 1126 if( rc==SQLITE_OK ){ |
| 1127 /* Check if the $::echo_module_begin_fail variable is defined. If it is, |
| 1128 ** and it is set to the name of the real table underlying this virtual |
| 1129 ** echo module table, then cause this xSync operation to fail. |
| 1130 */ |
| 1131 zVal = Tcl_GetVar(interp, "echo_module_begin_fail", TCL_GLOBAL_ONLY); |
| 1132 if( zVal && 0==strcmp(zVal, pVtab->zTableName) ){ |
| 1133 rc = SQLITE_ERROR; |
| 1134 } |
| 1135 } |
| 1136 if( rc==SQLITE_OK ){ |
| 1137 pVtab->inTransaction = 1; |
| 1138 } |
| 1139 return rc; |
| 1140 } |
| 1141 static int echoSync(sqlite3_vtab *tab){ |
| 1142 int rc; |
| 1143 echo_vtab *pVtab = (echo_vtab *)tab; |
| 1144 Tcl_Interp *interp = pVtab->interp; |
| 1145 const char *zVal; |
| 1146 |
| 1147 /* Ticket #3083 - Only call xSync if we have previously started a |
| 1148 ** transaction */ |
| 1149 assert( pVtab->inTransaction ); |
| 1150 |
| 1151 if( simulateVtabError(pVtab, "xSync") ){ |
| 1152 return SQLITE_ERROR; |
| 1153 } |
| 1154 |
| 1155 rc = echoTransactionCall(tab, "xSync"); |
| 1156 |
| 1157 if( rc==SQLITE_OK ){ |
| 1158 /* Check if the $::echo_module_sync_fail variable is defined. If it is, |
| 1159 ** and it is set to the name of the real table underlying this virtual |
| 1160 ** echo module table, then cause this xSync operation to fail. |
| 1161 */ |
| 1162 zVal = Tcl_GetVar(interp, "echo_module_sync_fail", TCL_GLOBAL_ONLY); |
| 1163 if( zVal && 0==strcmp(zVal, pVtab->zTableName) ){ |
| 1164 rc = -1; |
| 1165 } |
| 1166 } |
| 1167 return rc; |
| 1168 } |
| 1169 static int echoCommit(sqlite3_vtab *tab){ |
| 1170 echo_vtab *pVtab = (echo_vtab*)tab; |
| 1171 int rc; |
| 1172 |
| 1173 /* Ticket #3083 - Only call xCommit if we have previously started |
| 1174 ** a transaction */ |
| 1175 assert( pVtab->inTransaction ); |
| 1176 |
| 1177 if( simulateVtabError(pVtab, "xCommit") ){ |
| 1178 return SQLITE_ERROR; |
| 1179 } |
| 1180 |
| 1181 sqlite3BeginBenignMalloc(); |
| 1182 rc = echoTransactionCall(tab, "xCommit"); |
| 1183 sqlite3EndBenignMalloc(); |
| 1184 pVtab->inTransaction = 0; |
| 1185 return rc; |
| 1186 } |
| 1187 static int echoRollback(sqlite3_vtab *tab){ |
| 1188 int rc; |
| 1189 echo_vtab *pVtab = (echo_vtab*)tab; |
| 1190 |
| 1191 /* Ticket #3083 - Only call xRollback if we have previously started |
| 1192 ** a transaction */ |
| 1193 assert( pVtab->inTransaction ); |
| 1194 |
| 1195 rc = echoTransactionCall(tab, "xRollback"); |
| 1196 pVtab->inTransaction = 0; |
| 1197 return rc; |
| 1198 } |
| 1199 |
| 1200 /* |
| 1201 ** Implementation of "GLOB" function on the echo module. Pass |
| 1202 ** all arguments to the ::echo_glob_overload procedure of TCL |
| 1203 ** and return the result of that procedure as a string. |
| 1204 */ |
| 1205 static void overloadedGlobFunction( |
| 1206 sqlite3_context *pContext, |
| 1207 int nArg, |
| 1208 sqlite3_value **apArg |
| 1209 ){ |
| 1210 Tcl_Interp *interp = sqlite3_user_data(pContext); |
| 1211 Tcl_DString str; |
| 1212 int i; |
| 1213 int rc; |
| 1214 Tcl_DStringInit(&str); |
| 1215 Tcl_DStringAppendElement(&str, "::echo_glob_overload"); |
| 1216 for(i=0; i<nArg; i++){ |
| 1217 Tcl_DStringAppendElement(&str, (char*)sqlite3_value_text(apArg[i])); |
| 1218 } |
| 1219 rc = Tcl_Eval(interp, Tcl_DStringValue(&str)); |
| 1220 Tcl_DStringFree(&str); |
| 1221 if( rc ){ |
| 1222 sqlite3_result_error(pContext, Tcl_GetStringResult(interp), -1); |
| 1223 }else{ |
| 1224 sqlite3_result_text(pContext, Tcl_GetStringResult(interp), |
| 1225 -1, SQLITE_TRANSIENT); |
| 1226 } |
| 1227 Tcl_ResetResult(interp); |
| 1228 } |
| 1229 |
| 1230 /* |
| 1231 ** This is the xFindFunction implementation for the echo module. |
| 1232 ** SQLite calls this routine when the first argument of a function |
| 1233 ** is a column of an echo virtual table. This routine can optionally |
| 1234 ** override the implementation of that function. It will choose to |
| 1235 ** do so if the function is named "glob", and a TCL command named |
| 1236 ** ::echo_glob_overload exists. |
| 1237 */ |
| 1238 static int echoFindFunction( |
| 1239 sqlite3_vtab *vtab, |
| 1240 int nArg, |
| 1241 const char *zFuncName, |
| 1242 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), |
| 1243 void **ppArg |
| 1244 ){ |
| 1245 echo_vtab *pVtab = (echo_vtab *)vtab; |
| 1246 Tcl_Interp *interp = pVtab->interp; |
| 1247 Tcl_CmdInfo info; |
| 1248 if( strcmp(zFuncName,"glob")!=0 ){ |
| 1249 return 0; |
| 1250 } |
| 1251 if( Tcl_GetCommandInfo(interp, "::echo_glob_overload", &info)==0 ){ |
| 1252 return 0; |
| 1253 } |
| 1254 *pxFunc = overloadedGlobFunction; |
| 1255 *ppArg = interp; |
| 1256 return 1; |
| 1257 } |
| 1258 |
| 1259 static int echoRename(sqlite3_vtab *vtab, const char *zNewName){ |
| 1260 int rc = SQLITE_OK; |
| 1261 echo_vtab *p = (echo_vtab *)vtab; |
| 1262 |
| 1263 if( simulateVtabError(p, "xRename") ){ |
| 1264 return SQLITE_ERROR; |
| 1265 } |
| 1266 |
| 1267 if( p->isPattern ){ |
| 1268 int nThis = (int)strlen(p->zThis); |
| 1269 char *zSql = sqlite3_mprintf("ALTER TABLE %s RENAME TO %s%s", |
| 1270 p->zTableName, zNewName, &p->zTableName[nThis] |
| 1271 ); |
| 1272 rc = sqlite3_exec(p->db, zSql, 0, 0, 0); |
| 1273 sqlite3_free(zSql); |
| 1274 } |
| 1275 |
| 1276 return rc; |
| 1277 } |
| 1278 |
| 1279 static int echoSavepoint(sqlite3_vtab *pVTab, int iSavepoint){ |
| 1280 assert( pVTab ); |
| 1281 return SQLITE_OK; |
| 1282 } |
| 1283 |
| 1284 static int echoRelease(sqlite3_vtab *pVTab, int iSavepoint){ |
| 1285 assert( pVTab ); |
| 1286 return SQLITE_OK; |
| 1287 } |
| 1288 |
| 1289 static int echoRollbackTo(sqlite3_vtab *pVTab, int iSavepoint){ |
| 1290 assert( pVTab ); |
| 1291 return SQLITE_OK; |
| 1292 } |
| 1293 |
| 1294 /* |
| 1295 ** A virtual table module that merely "echos" the contents of another |
| 1296 ** table (like an SQL VIEW). |
| 1297 */ |
| 1298 static sqlite3_module echoModule = { |
| 1299 1, /* iVersion */ |
| 1300 echoCreate, |
| 1301 echoConnect, |
| 1302 echoBestIndex, |
| 1303 echoDisconnect, |
| 1304 echoDestroy, |
| 1305 echoOpen, /* xOpen - open a cursor */ |
| 1306 echoClose, /* xClose - close a cursor */ |
| 1307 echoFilter, /* xFilter - configure scan constraints */ |
| 1308 echoNext, /* xNext - advance a cursor */ |
| 1309 echoEof, /* xEof */ |
| 1310 echoColumn, /* xColumn - read data */ |
| 1311 echoRowid, /* xRowid - read data */ |
| 1312 echoUpdate, /* xUpdate - write data */ |
| 1313 echoBegin, /* xBegin - begin transaction */ |
| 1314 echoSync, /* xSync - sync transaction */ |
| 1315 echoCommit, /* xCommit - commit transaction */ |
| 1316 echoRollback, /* xRollback - rollback transaction */ |
| 1317 echoFindFunction, /* xFindFunction - function overloading */ |
| 1318 echoRename /* xRename - rename the table */ |
| 1319 }; |
| 1320 |
| 1321 static sqlite3_module echoModuleV2 = { |
| 1322 2, /* iVersion */ |
| 1323 echoCreate, |
| 1324 echoConnect, |
| 1325 echoBestIndex, |
| 1326 echoDisconnect, |
| 1327 echoDestroy, |
| 1328 echoOpen, /* xOpen - open a cursor */ |
| 1329 echoClose, /* xClose - close a cursor */ |
| 1330 echoFilter, /* xFilter - configure scan constraints */ |
| 1331 echoNext, /* xNext - advance a cursor */ |
| 1332 echoEof, /* xEof */ |
| 1333 echoColumn, /* xColumn - read data */ |
| 1334 echoRowid, /* xRowid - read data */ |
| 1335 echoUpdate, /* xUpdate - write data */ |
| 1336 echoBegin, /* xBegin - begin transaction */ |
| 1337 echoSync, /* xSync - sync transaction */ |
| 1338 echoCommit, /* xCommit - commit transaction */ |
| 1339 echoRollback, /* xRollback - rollback transaction */ |
| 1340 echoFindFunction, /* xFindFunction - function overloading */ |
| 1341 echoRename, /* xRename - rename the table */ |
| 1342 echoSavepoint, |
| 1343 echoRelease, |
| 1344 echoRollbackTo |
| 1345 }; |
| 1346 |
| 1347 /* |
| 1348 ** Decode a pointer to an sqlite3 object. |
| 1349 */ |
| 1350 extern int getDbPointer(Tcl_Interp *interp, const char *zA, sqlite3 **ppDb); |
| 1351 extern const char *sqlite3ErrName(int); |
| 1352 |
| 1353 static void moduleDestroy(void *p){ |
| 1354 sqlite3_free(p); |
| 1355 } |
| 1356 |
| 1357 /* |
| 1358 ** Register the echo virtual table module. |
| 1359 */ |
| 1360 static int SQLITE_TCLAPI register_echo_module( |
| 1361 ClientData clientData, /* Pointer to sqlite3_enable_XXX function */ |
| 1362 Tcl_Interp *interp, /* The TCL interpreter that invoked this command */ |
| 1363 int objc, /* Number of arguments */ |
| 1364 Tcl_Obj *CONST objv[] /* Command arguments */ |
| 1365 ){ |
| 1366 int rc; |
| 1367 sqlite3 *db; |
| 1368 EchoModule *pMod; |
| 1369 if( objc!=2 ){ |
| 1370 Tcl_WrongNumArgs(interp, 1, objv, "DB"); |
| 1371 return TCL_ERROR; |
| 1372 } |
| 1373 if( getDbPointer(interp, Tcl_GetString(objv[1]), &db) ) return TCL_ERROR; |
| 1374 |
| 1375 /* Virtual table module "echo" */ |
| 1376 pMod = sqlite3_malloc(sizeof(EchoModule)); |
| 1377 pMod->interp = interp; |
| 1378 rc = sqlite3_create_module_v2( |
| 1379 db, "echo", &echoModule, (void*)pMod, moduleDestroy |
| 1380 ); |
| 1381 |
| 1382 /* Virtual table module "echo_v2" */ |
| 1383 if( rc==SQLITE_OK ){ |
| 1384 pMod = sqlite3_malloc(sizeof(EchoModule)); |
| 1385 pMod->interp = interp; |
| 1386 rc = sqlite3_create_module_v2(db, "echo_v2", |
| 1387 &echoModuleV2, (void*)pMod, moduleDestroy |
| 1388 ); |
| 1389 } |
| 1390 |
| 1391 Tcl_SetResult(interp, (char *)sqlite3ErrName(rc), TCL_STATIC); |
| 1392 return TCL_OK; |
| 1393 } |
| 1394 |
| 1395 /* |
| 1396 ** Tcl interface to sqlite3_declare_vtab, invoked as follows from Tcl: |
| 1397 ** |
| 1398 ** sqlite3_declare_vtab DB SQL |
| 1399 */ |
| 1400 static int SQLITE_TCLAPI declare_vtab( |
| 1401 ClientData clientData, /* Pointer to sqlite3_enable_XXX function */ |
| 1402 Tcl_Interp *interp, /* The TCL interpreter that invoked this command */ |
| 1403 int objc, /* Number of arguments */ |
| 1404 Tcl_Obj *CONST objv[] /* Command arguments */ |
| 1405 ){ |
| 1406 sqlite3 *db; |
| 1407 int rc; |
| 1408 if( objc!=3 ){ |
| 1409 Tcl_WrongNumArgs(interp, 1, objv, "DB SQL"); |
| 1410 return TCL_ERROR; |
| 1411 } |
| 1412 if( getDbPointer(interp, Tcl_GetString(objv[1]), &db) ) return TCL_ERROR; |
| 1413 rc = sqlite3_declare_vtab(db, Tcl_GetString(objv[2])); |
| 1414 if( rc!=SQLITE_OK ){ |
| 1415 Tcl_SetResult(interp, (char *)sqlite3_errmsg(db), TCL_VOLATILE); |
| 1416 return TCL_ERROR; |
| 1417 } |
| 1418 return TCL_OK; |
| 1419 } |
| 1420 |
| 1421 #endif /* ifndef SQLITE_OMIT_VIRTUALTABLE */ |
| 1422 |
| 1423 /* |
| 1424 ** Register commands with the TCL interpreter. |
| 1425 */ |
| 1426 int Sqlitetest8_Init(Tcl_Interp *interp){ |
| 1427 #ifndef SQLITE_OMIT_VIRTUALTABLE |
| 1428 static struct { |
| 1429 char *zName; |
| 1430 Tcl_ObjCmdProc *xProc; |
| 1431 void *clientData; |
| 1432 } aObjCmd[] = { |
| 1433 { "register_echo_module", register_echo_module, 0 }, |
| 1434 { "sqlite3_declare_vtab", declare_vtab, 0 }, |
| 1435 }; |
| 1436 int i; |
| 1437 for(i=0; i<sizeof(aObjCmd)/sizeof(aObjCmd[0]); i++){ |
| 1438 Tcl_CreateObjCommand(interp, aObjCmd[i].zName, |
| 1439 aObjCmd[i].xProc, aObjCmd[i].clientData, 0); |
| 1440 } |
| 1441 #endif |
| 1442 return TCL_OK; |
| 1443 } |
OLD | NEW |