1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sqlite3api/TEST/SRC/test_schema.c Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,361 @@
1.4 +/*
1.5 +** 2006 June 10
1.6 +**
1.7 +** The author disclaims copyright to this source code. In place of
1.8 +** a legal notice, here is a blessing:
1.9 +**
1.10 +** May you do good and not evil.
1.11 +** May you find forgiveness for yourself and forgive others.
1.12 +** May you share freely, never taking more than you give.
1.13 +**
1.14 +*************************************************************************
1.15 +** Code for testing the virtual table interfaces. This code
1.16 +** is not included in the SQLite library. It is used for automated
1.17 +** testing of the SQLite library.
1.18 +**
1.19 +** $Id: test_schema.c,v 1.15 2008/07/07 14:50:14 drh Exp $
1.20 +*/
1.21 +
1.22 +/* The code in this file defines a sqlite3 virtual-table module that
1.23 +** provides a read-only view of the current database schema. There is one
1.24 +** row in the schema table for each column in the database schema.
1.25 +*/
1.26 +#define SCHEMA \
1.27 +"CREATE TABLE x(" \
1.28 + "database," /* Name of database (i.e. main, temp etc.) */ \
1.29 + "tablename," /* Name of table */ \
1.30 + "cid," /* Column number (from left-to-right, 0 upward) */ \
1.31 + "name," /* Column name */ \
1.32 + "type," /* Specified type (i.e. VARCHAR(32)) */ \
1.33 + "not_null," /* Boolean. True if NOT NULL was specified */ \
1.34 + "dflt_value," /* Default value for this column */ \
1.35 + "pk" /* True if this column is part of the primary key */ \
1.36 +")"
1.37 +
1.38 +/* If SQLITE_TEST is defined this code is preprocessed for use as part
1.39 +** of the sqlite test binary "testfixture". Otherwise it is preprocessed
1.40 +** to be compiled into an sqlite dynamic extension.
1.41 +*/
1.42 +#ifdef SQLITE_TEST
1.43 + #include "sqliteInt.h"
1.44 + #include "tcl.h"
1.45 +#else
1.46 + #include "sqlite3ext.h"
1.47 + SQLITE_EXTENSION_INIT1
1.48 +#endif
1.49 +
1.50 +#include <stdlib.h>
1.51 +#include <string.h>
1.52 +#include <assert.h>
1.53 +
1.54 +typedef struct schema_vtab schema_vtab;
1.55 +typedef struct schema_cursor schema_cursor;
1.56 +
1.57 +/* A schema table object */
1.58 +struct schema_vtab {
1.59 + sqlite3_vtab base;
1.60 + sqlite3 *db;
1.61 +};
1.62 +
1.63 +/* A schema table cursor object */
1.64 +struct schema_cursor {
1.65 + sqlite3_vtab_cursor base;
1.66 + sqlite3_stmt *pDbList;
1.67 + sqlite3_stmt *pTableList;
1.68 + sqlite3_stmt *pColumnList;
1.69 + int rowid;
1.70 +};
1.71 +
1.72 +/*
1.73 +** None of this works unless we have virtual tables.
1.74 +*/
1.75 +#ifndef SQLITE_OMIT_VIRTUALTABLE
1.76 +
1.77 +/*
1.78 +** Table destructor for the schema module.
1.79 +*/
1.80 +static int schemaDestroy(sqlite3_vtab *pVtab){
1.81 + sqlite3_free(pVtab);
1.82 + return 0;
1.83 +}
1.84 +
1.85 +/*
1.86 +** Table constructor for the schema module.
1.87 +*/
1.88 +static int schemaCreate(
1.89 + sqlite3 *db,
1.90 + void *pAux,
1.91 + int argc, const char *const*argv,
1.92 + sqlite3_vtab **ppVtab,
1.93 + char **pzErr
1.94 +){
1.95 + int rc = SQLITE_NOMEM;
1.96 + schema_vtab *pVtab = sqlite3_malloc(sizeof(schema_vtab));
1.97 + if( pVtab ){
1.98 + memset(pVtab, 0, sizeof(schema_vtab));
1.99 + pVtab->db = db;
1.100 +#ifndef SQLITE_OMIT_VIRTUALTABLE
1.101 + rc = sqlite3_declare_vtab(db, SCHEMA);
1.102 +#endif
1.103 + }
1.104 + *ppVtab = (sqlite3_vtab *)pVtab;
1.105 + return rc;
1.106 +}
1.107 +
1.108 +/*
1.109 +** Open a new cursor on the schema table.
1.110 +*/
1.111 +static int schemaOpen(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor){
1.112 + int rc = SQLITE_NOMEM;
1.113 + schema_cursor *pCur;
1.114 + pCur = sqlite3_malloc(sizeof(schema_cursor));
1.115 + if( pCur ){
1.116 + memset(pCur, 0, sizeof(schema_cursor));
1.117 + *ppCursor = (sqlite3_vtab_cursor *)pCur;
1.118 + rc = SQLITE_OK;
1.119 + }
1.120 + return rc;
1.121 +}
1.122 +
1.123 +/*
1.124 +** Close a schema table cursor.
1.125 +*/
1.126 +static int schemaClose(sqlite3_vtab_cursor *cur){
1.127 + schema_cursor *pCur = (schema_cursor *)cur;
1.128 + sqlite3_finalize(pCur->pDbList);
1.129 + sqlite3_finalize(pCur->pTableList);
1.130 + sqlite3_finalize(pCur->pColumnList);
1.131 + sqlite3_free(pCur);
1.132 + return SQLITE_OK;
1.133 +}
1.134 +
1.135 +/*
1.136 +** Retrieve a column of data.
1.137 +*/
1.138 +static int schemaColumn(sqlite3_vtab_cursor *cur, sqlite3_context *ctx, int i){
1.139 + schema_cursor *pCur = (schema_cursor *)cur;
1.140 + switch( i ){
1.141 + case 0:
1.142 + sqlite3_result_value(ctx, sqlite3_column_value(pCur->pDbList, 1));
1.143 + break;
1.144 + case 1:
1.145 + sqlite3_result_value(ctx, sqlite3_column_value(pCur->pTableList, 0));
1.146 + break;
1.147 + default:
1.148 + sqlite3_result_value(ctx, sqlite3_column_value(pCur->pColumnList, i-2));
1.149 + break;
1.150 + }
1.151 + return SQLITE_OK;
1.152 +}
1.153 +
1.154 +/*
1.155 +** Retrieve the current rowid.
1.156 +*/
1.157 +static int schemaRowid(sqlite3_vtab_cursor *cur, sqlite_int64 *pRowid){
1.158 + schema_cursor *pCur = (schema_cursor *)cur;
1.159 + *pRowid = pCur->rowid;
1.160 + return SQLITE_OK;
1.161 +}
1.162 +
1.163 +static int finalize(sqlite3_stmt **ppStmt){
1.164 + int rc = sqlite3_finalize(*ppStmt);
1.165 + *ppStmt = 0;
1.166 + return rc;
1.167 +}
1.168 +
1.169 +static int schemaEof(sqlite3_vtab_cursor *cur){
1.170 + schema_cursor *pCur = (schema_cursor *)cur;
1.171 + return (pCur->pDbList ? 0 : 1);
1.172 +}
1.173 +
1.174 +/*
1.175 +** Advance the cursor to the next row.
1.176 +*/
1.177 +static int schemaNext(sqlite3_vtab_cursor *cur){
1.178 + int rc = SQLITE_OK;
1.179 + schema_cursor *pCur = (schema_cursor *)cur;
1.180 + schema_vtab *pVtab = (schema_vtab *)(cur->pVtab);
1.181 + char *zSql = 0;
1.182 +
1.183 + while( !pCur->pColumnList || SQLITE_ROW!=sqlite3_step(pCur->pColumnList) ){
1.184 + if( SQLITE_OK!=(rc = finalize(&pCur->pColumnList)) ) goto next_exit;
1.185 +
1.186 + while( !pCur->pTableList || SQLITE_ROW!=sqlite3_step(pCur->pTableList) ){
1.187 + if( SQLITE_OK!=(rc = finalize(&pCur->pTableList)) ) goto next_exit;
1.188 +
1.189 + assert(pCur->pDbList);
1.190 + while( SQLITE_ROW!=sqlite3_step(pCur->pDbList) ){
1.191 + rc = finalize(&pCur->pDbList);
1.192 + goto next_exit;
1.193 + }
1.194 +
1.195 + /* Set zSql to the SQL to pull the list of tables from the
1.196 + ** sqlite_master (or sqlite_temp_master) table of the database
1.197 + ** identfied by the row pointed to by the SQL statement pCur->pDbList
1.198 + ** (iterating through a "PRAGMA database_list;" statement).
1.199 + */
1.200 + if( sqlite3_column_int(pCur->pDbList, 0)==1 ){
1.201 + zSql = sqlite3_mprintf(
1.202 + "SELECT name FROM sqlite_temp_master WHERE type='table'"
1.203 + );
1.204 + }else{
1.205 + sqlite3_stmt *pDbList = pCur->pDbList;
1.206 + zSql = sqlite3_mprintf(
1.207 + "SELECT name FROM %Q.sqlite_master WHERE type='table'",
1.208 + sqlite3_column_text(pDbList, 1)
1.209 + );
1.210 + }
1.211 + if( !zSql ){
1.212 + rc = SQLITE_NOMEM;
1.213 + goto next_exit;
1.214 + }
1.215 +
1.216 + rc = sqlite3_prepare(pVtab->db, zSql, -1, &pCur->pTableList, 0);
1.217 + sqlite3_free(zSql);
1.218 + if( rc!=SQLITE_OK ) goto next_exit;
1.219 + }
1.220 +
1.221 + /* Set zSql to the SQL to the table_info pragma for the table currently
1.222 + ** identified by the rows pointed to by statements pCur->pDbList and
1.223 + ** pCur->pTableList.
1.224 + */
1.225 + zSql = sqlite3_mprintf("PRAGMA %Q.table_info(%Q)",
1.226 + sqlite3_column_text(pCur->pDbList, 1),
1.227 + sqlite3_column_text(pCur->pTableList, 0)
1.228 + );
1.229 +
1.230 + if( !zSql ){
1.231 + rc = SQLITE_NOMEM;
1.232 + goto next_exit;
1.233 + }
1.234 + rc = sqlite3_prepare(pVtab->db, zSql, -1, &pCur->pColumnList, 0);
1.235 + sqlite3_free(zSql);
1.236 + if( rc!=SQLITE_OK ) goto next_exit;
1.237 + }
1.238 + pCur->rowid++;
1.239 +
1.240 +next_exit:
1.241 + /* TODO: Handle rc */
1.242 + return rc;
1.243 +}
1.244 +
1.245 +/*
1.246 +** Reset a schema table cursor.
1.247 +*/
1.248 +static int schemaFilter(
1.249 + sqlite3_vtab_cursor *pVtabCursor,
1.250 + int idxNum, const char *idxStr,
1.251 + int argc, sqlite3_value **argv
1.252 +){
1.253 + int rc;
1.254 + schema_vtab *pVtab = (schema_vtab *)(pVtabCursor->pVtab);
1.255 + schema_cursor *pCur = (schema_cursor *)pVtabCursor;
1.256 + pCur->rowid = 0;
1.257 + finalize(&pCur->pTableList);
1.258 + finalize(&pCur->pColumnList);
1.259 + finalize(&pCur->pDbList);
1.260 + rc = sqlite3_prepare(pVtab->db,"PRAGMA database_list", -1, &pCur->pDbList, 0);
1.261 + return (rc==SQLITE_OK ? schemaNext(pVtabCursor) : rc);
1.262 +}
1.263 +
1.264 +/*
1.265 +** Analyse the WHERE condition.
1.266 +*/
1.267 +static int schemaBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){
1.268 + return SQLITE_OK;
1.269 +}
1.270 +
1.271 +/*
1.272 +** A virtual table module that merely echos method calls into TCL
1.273 +** variables.
1.274 +*/
1.275 +static sqlite3_module schemaModule = {
1.276 + 0, /* iVersion */
1.277 + schemaCreate,
1.278 + schemaCreate,
1.279 + schemaBestIndex,
1.280 + schemaDestroy,
1.281 + schemaDestroy,
1.282 + schemaOpen, /* xOpen - open a cursor */
1.283 + schemaClose, /* xClose - close a cursor */
1.284 + schemaFilter, /* xFilter - configure scan constraints */
1.285 + schemaNext, /* xNext - advance a cursor */
1.286 + schemaEof, /* xEof */
1.287 + schemaColumn, /* xColumn - read data */
1.288 + schemaRowid, /* xRowid - read data */
1.289 + 0, /* xUpdate */
1.290 + 0, /* xBegin */
1.291 + 0, /* xSync */
1.292 + 0, /* xCommit */
1.293 + 0, /* xRollback */
1.294 + 0, /* xFindMethod */
1.295 + 0, /* xRename */
1.296 +};
1.297 +
1.298 +#endif /* !defined(SQLITE_OMIT_VIRTUALTABLE) */
1.299 +
1.300 +#ifdef SQLITE_TEST
1.301 +
1.302 +/*
1.303 +** Decode a pointer to an sqlite3 object.
1.304 +*/
1.305 +extern int getDbPointer(Tcl_Interp *interp, const char *zA, sqlite3 **ppDb);
1.306 +
1.307 +/*
1.308 +** Register the schema virtual table module.
1.309 +*/
1.310 +static int register_schema_module(
1.311 + ClientData clientData, /* Not used */
1.312 + Tcl_Interp *interp, /* The TCL interpreter that invoked this command */
1.313 + int objc, /* Number of arguments */
1.314 + Tcl_Obj *CONST objv[] /* Command arguments */
1.315 +){
1.316 + sqlite3 *db;
1.317 + if( objc!=2 ){
1.318 + Tcl_WrongNumArgs(interp, 1, objv, "DB");
1.319 + return TCL_ERROR;
1.320 + }
1.321 + if( getDbPointer(interp, Tcl_GetString(objv[1]), &db) ) return TCL_ERROR;
1.322 +#ifndef SQLITE_OMIT_VIRTUALTABLE
1.323 + sqlite3_create_module(db, "schema", &schemaModule, 0);
1.324 +#endif
1.325 + return TCL_OK;
1.326 +}
1.327 +
1.328 +/*
1.329 +** Register commands with the TCL interpreter.
1.330 +*/
1.331 +int Sqlitetestschema_Init(Tcl_Interp *interp){
1.332 + static struct {
1.333 + char *zName;
1.334 + Tcl_ObjCmdProc *xProc;
1.335 + void *clientData;
1.336 + } aObjCmd[] = {
1.337 + { "register_schema_module", register_schema_module, 0 },
1.338 + };
1.339 + int i;
1.340 + for(i=0; i<sizeof(aObjCmd)/sizeof(aObjCmd[0]); i++){
1.341 + Tcl_CreateObjCommand(interp, aObjCmd[i].zName,
1.342 + aObjCmd[i].xProc, aObjCmd[i].clientData, 0);
1.343 + }
1.344 + return TCL_OK;
1.345 +}
1.346 +
1.347 +#else
1.348 +
1.349 +/*
1.350 +** Extension load function.
1.351 +*/
1.352 +int sqlite3_extension_init(
1.353 + sqlite3 *db,
1.354 + char **pzErrMsg,
1.355 + const sqlite3_api_routines *pApi
1.356 +){
1.357 + SQLITE_EXTENSION_INIT2(pApi);
1.358 +#ifndef SQLITE_OMIT_VIRTUALTABLE
1.359 + sqlite3_create_module(db, "schema", &schemaModule, 0);
1.360 +#endif
1.361 + return 0;
1.362 +}
1.363 +
1.364 +#endif