175897234Sdrh /* 2b19a2bc6Sdrh ** 2001 September 15 375897234Sdrh ** 4b19a2bc6Sdrh ** The author disclaims copyright to this source code. In place of 5b19a2bc6Sdrh ** a legal notice, here is a blessing: 675897234Sdrh ** 7b19a2bc6Sdrh ** May you do good and not evil. 8b19a2bc6Sdrh ** May you find forgiveness for yourself and forgive others. 9b19a2bc6Sdrh ** May you share freely, never taking more than you give. 1075897234Sdrh ** 1175897234Sdrh ************************************************************************* 1275897234Sdrh ** Internal interface definitions for SQLite. 1375897234Sdrh ** 14*3aac2dd7Sdrh ** @(#) $Id: sqliteInt.h,v 1.221 2004/04/26 14:10:22 drh Exp $ 1575897234Sdrh */ 1658f391b3Sdrh #include "config.h" 1775897234Sdrh #include "sqlite.h" 18beae3194Sdrh #include "hash.h" 1975897234Sdrh #include "parse.h" 2075897234Sdrh #include <stdio.h> 2175897234Sdrh #include <stdlib.h> 2275897234Sdrh #include <string.h> 2375897234Sdrh #include <assert.h> 2475897234Sdrh 25967e8b73Sdrh /* 26a1b351afSdrh ** The maximum number of in-memory pages to use for the main database 27a1b351afSdrh ** table and for temporary tables. 28a1b351afSdrh */ 29603240cfSdrh #define MAX_PAGES 2000 30603240cfSdrh #define TEMP_PAGES 500 31a1b351afSdrh 32a1b351afSdrh /* 330bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered 340bd1f4eaSdrh ** distinct for the SELECT DISTINCT statement and for UNION or EXCEPT 350bd1f4eaSdrh ** compound queries. No other SQL database engine (among those tested) 360bd1f4eaSdrh ** works this way except for OCELOT. But the SQL92 spec implies that 370bd1f4eaSdrh ** this is how things should work. 380bd1f4eaSdrh ** 390bd1f4eaSdrh ** If the following macro is set to 0, then NULLs are indistinct for 400bd1f4eaSdrh ** SELECT DISTINCT and for UNION. 410bd1f4eaSdrh */ 420bd1f4eaSdrh #define NULL_ALWAYS_DISTINCT 0 430bd1f4eaSdrh 440bd1f4eaSdrh /* 450bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered 460bd1f4eaSdrh ** distinct when determining whether or not two entries are the same 470bd1f4eaSdrh ** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL, 480bd1f4eaSdrh ** OCELOT, and Firebird all work. The SQL92 spec explicitly says this 490bd1f4eaSdrh ** is the way things are suppose to work. 500bd1f4eaSdrh ** 510bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for 520bd1f4eaSdrh ** a UNIQUE index. In this mode, you can only have a single NULL entry 530bd1f4eaSdrh ** for a column declared UNIQUE. This is the way Informix and SQL Server 540bd1f4eaSdrh ** work. 550bd1f4eaSdrh */ 560bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1 570bd1f4eaSdrh 580bd1f4eaSdrh /* 59665de47aSdrh ** The maximum number of attached databases. This must be at least 2 60665de47aSdrh ** in order to support the main database file (0) and the file used to 61a3643a26Sjplyon ** hold temporary tables (1). And it must be less than 256 because 62665de47aSdrh ** an unsigned character is used to stored the database index. 63665de47aSdrh */ 64665de47aSdrh #define MAX_ATTACHED 10 65665de47aSdrh 66665de47aSdrh /* 6713bff815Sdrh ** The next macro is used to determine where TEMP tables and indices 6813bff815Sdrh ** are stored. Possible values: 6913bff815Sdrh ** 7013bff815Sdrh ** 0 Always use a temporary files 7113bff815Sdrh ** 1 Use a file unless overridden by "PRAGMA temp_store" 7213bff815Sdrh ** 2 Use memory unless overridden by "PRAGMA temp_store" 7313bff815Sdrh ** 3 Always use memory 7413bff815Sdrh */ 7513bff815Sdrh #ifndef TEMP_STORE 7613bff815Sdrh # define TEMP_STORE 1 7713bff815Sdrh #endif 7813bff815Sdrh 7913bff815Sdrh /* 8013bff815Sdrh ** When building SQLite for embedded systems where memory is scarce, 8113bff815Sdrh ** you can define one or more of the following macros to omit extra 8213bff815Sdrh ** features of the library and thus keep the size of the library to 8313bff815Sdrh ** a minimum. 8413bff815Sdrh */ 8513bff815Sdrh /* #define SQLITE_OMIT_AUTHORIZATION 1 */ 8670ce3f0cSdrh /* #define SQLITE_OMIT_INMEMORYDB 1 */ 8713bff815Sdrh /* #define SQLITE_OMIT_VACUUM 1 */ 880a5294bcSdrh /* #define SQLITE_OMIT_DATETIME_FUNCS 1 */ 89348bb5d6Sdanielk1977 /* #define SQLITE_OMIT_PROGRESS_CALLBACK 1 */ 9013bff815Sdrh 9113bff815Sdrh /* 925a2c2c20Sdrh ** Integers of known sizes. These typedefs might change for architectures 935a2c2c20Sdrh ** where the sizes very. Preprocessor macros are available so that the 945a2c2c20Sdrh ** types can be conveniently redefined at compile-type. Like this: 955a2c2c20Sdrh ** 965a2c2c20Sdrh ** cc '-DUINTPTR_TYPE=long long int' ... 9741a2b48bSdrh */ 98*3aac2dd7Sdrh #ifndef UINT64_TYPE 99*3aac2dd7Sdrh # define UINT64_TYPE unsigned long long int 100*3aac2dd7Sdrh #endif 1015a2c2c20Sdrh #ifndef UINT32_TYPE 1025a2c2c20Sdrh # define UINT32_TYPE unsigned int 1035a2c2c20Sdrh #endif 1045a2c2c20Sdrh #ifndef UINT16_TYPE 1055a2c2c20Sdrh # define UINT16_TYPE unsigned short int 1065a2c2c20Sdrh #endif 1075a2c2c20Sdrh #ifndef UINT8_TYPE 1085a2c2c20Sdrh # define UINT8_TYPE unsigned char 1095a2c2c20Sdrh #endif 110905793e2Sdrh #ifndef INT8_TYPE 111905793e2Sdrh # define INT8_TYPE signed char 112905793e2Sdrh #endif 1135a2c2c20Sdrh #ifndef INTPTR_TYPE 11458f391b3Sdrh # if SQLITE_PTR_SZ==4 1155a2c2c20Sdrh # define INTPTR_TYPE int 11658f391b3Sdrh # else 11758f391b3Sdrh # define INTPTR_TYPE long long 11858f391b3Sdrh # endif 1195a2c2c20Sdrh #endif 120*3aac2dd7Sdrh typedef UINT64_TYPE u64; /* 8-byte unsigned integer */ 1215a2c2c20Sdrh typedef UINT32_TYPE u32; /* 4-byte unsigned integer */ 1225a2c2c20Sdrh typedef UINT16_TYPE u16; /* 2-byte unsigned integer */ 1235a2c2c20Sdrh typedef UINT8_TYPE u8; /* 1-byte unsigned integer */ 124905793e2Sdrh typedef UINT8_TYPE i8; /* 1-byte signed integer */ 1255a2c2c20Sdrh typedef INTPTR_TYPE ptr; /* Big enough to hold a pointer */ 1265a2c2c20Sdrh typedef unsigned INTPTR_TYPE uptr; /* Big enough to hold a pointer */ 1275a2c2c20Sdrh 1285a2c2c20Sdrh /* 129905793e2Sdrh ** Defer sourcing vdbe.h until after the "u8" typedef is defined. 130905793e2Sdrh */ 131905793e2Sdrh #include "vdbe.h" 132*3aac2dd7Sdrh #include "btree.h" 133905793e2Sdrh 134905793e2Sdrh /* 135384eef32Sdrh ** Most C compilers these days recognize "long double", don't they? 136384eef32Sdrh ** Just in case we encounter one that does not, we will create a macro 137384eef32Sdrh ** for long double so that it can be easily changed to just "double". 138384eef32Sdrh */ 139384eef32Sdrh #ifndef LONGDOUBLE_TYPE 140384eef32Sdrh # define LONGDOUBLE_TYPE long double 141384eef32Sdrh #endif 142384eef32Sdrh 143384eef32Sdrh /* 1445a2c2c20Sdrh ** This macro casts a pointer to an integer. Useful for doing 1455a2c2c20Sdrh ** pointer arithmetic. 1465a2c2c20Sdrh */ 1475a2c2c20Sdrh #define Addr(X) ((uptr)X) 14841a2b48bSdrh 14941a2b48bSdrh /* 150872ff86fSdrh ** The maximum number of bytes of data that can be put into a single 15180ff32f5Sdrh ** row of a single table. The upper bound on this limit is 16777215 15280ff32f5Sdrh ** bytes (or 16MB-1). We have arbitrarily set the limit to just 1MB 15380ff32f5Sdrh ** here because the overflow page chain is inefficient for really big 15480ff32f5Sdrh ** records and we want to discourage people from thinking that 15580ff32f5Sdrh ** multi-megabyte records are OK. If your needs are different, you can 15680ff32f5Sdrh ** change this define and recompile to increase or decrease the record 15780ff32f5Sdrh ** size. 1589ac717d7Sdrh ** 1599ac717d7Sdrh ** The 16777198 is computed as follows: 238 bytes of payload on the 1609ac717d7Sdrh ** original pages plus 16448 overflow pages each holding 1020 bytes of 1619ac717d7Sdrh ** data. 162872ff86fSdrh */ 1638372b8d1Sdrh #define MAX_BYTES_PER_ROW 1048576 1648372b8d1Sdrh /* #define MAX_BYTES_PER_ROW 16777198 */ 165872ff86fSdrh 166872ff86fSdrh /* 167967e8b73Sdrh ** If memory allocation problems are found, recompile with 168967e8b73Sdrh ** 169967e8b73Sdrh ** -DMEMORY_DEBUG=1 170967e8b73Sdrh ** 171967e8b73Sdrh ** to enable some sanity checking on malloc() and free(). To 172967e8b73Sdrh ** check for memory leaks, recompile with 173967e8b73Sdrh ** 174967e8b73Sdrh ** -DMEMORY_DEBUG=2 175967e8b73Sdrh ** 176967e8b73Sdrh ** and a line of text will be written to standard error for 177967e8b73Sdrh ** each malloc() and free(). This output can be analyzed 178967e8b73Sdrh ** by an AWK script to determine if there are any leaks. 179967e8b73Sdrh */ 180dcc581ccSdrh #ifdef MEMORY_DEBUG 1818c1238aeSdrh # define sqliteMalloc(X) sqliteMalloc_(X,1,__FILE__,__LINE__) 1828c1238aeSdrh # define sqliteMallocRaw(X) sqliteMalloc_(X,0,__FILE__,__LINE__) 183dcc581ccSdrh # define sqliteFree(X) sqliteFree_(X,__FILE__,__LINE__) 184dcc581ccSdrh # define sqliteRealloc(X,Y) sqliteRealloc_(X,Y,__FILE__,__LINE__) 1856e142f54Sdrh # define sqliteStrDup(X) sqliteStrDup_(X,__FILE__,__LINE__) 1866e142f54Sdrh # define sqliteStrNDup(X,Y) sqliteStrNDup_(X,Y,__FILE__,__LINE__) 187c3c2fc9aSdrh void sqliteStrRealloc(char**); 188c3c2fc9aSdrh #else 1895f968436Sdrh # define sqliteRealloc_(X,Y) sqliteRealloc(X,Y) 190c3c2fc9aSdrh # define sqliteStrRealloc(X) 191dcc581ccSdrh #endif 192dcc581ccSdrh 19375897234Sdrh /* 194daffd0e5Sdrh ** This variable gets set if malloc() ever fails. After it gets set, 195daffd0e5Sdrh ** the SQLite library shuts down permanently. 196daffd0e5Sdrh */ 197daffd0e5Sdrh extern int sqlite_malloc_failed; 198daffd0e5Sdrh 199daffd0e5Sdrh /* 2006e142f54Sdrh ** The following global variables are used for testing and debugging 2018c82b350Sdrh ** only. They only work if MEMORY_DEBUG is defined. 2026e142f54Sdrh */ 2036e142f54Sdrh #ifdef MEMORY_DEBUG 2048c82b350Sdrh extern int sqlite_nMalloc; /* Number of sqliteMalloc() calls */ 2058c82b350Sdrh extern int sqlite_nFree; /* Number of sqliteFree() calls */ 2068c82b350Sdrh extern int sqlite_iMallocFail; /* Fail sqliteMalloc() after this many calls */ 2076e142f54Sdrh #endif 2086e142f54Sdrh 2096e142f54Sdrh /* 21075897234Sdrh ** Name of the master database table. The master database table 21175897234Sdrh ** is a special table that holds the names and attributes of all 21275897234Sdrh ** user tables and indices. 21375897234Sdrh */ 21475897234Sdrh #define MASTER_NAME "sqlite_master" 215e0bc4048Sdrh #define TEMP_MASTER_NAME "sqlite_temp_master" 21675897234Sdrh 21775897234Sdrh /* 218ed6c8671Sdrh ** The name of the schema table. 219ed6c8671Sdrh */ 220ed6c8671Sdrh #define SCHEMA_TABLE(x) (x?TEMP_MASTER_NAME:MASTER_NAME) 221ed6c8671Sdrh 222ed6c8671Sdrh /* 22375897234Sdrh ** A convenience macro that returns the number of elements in 22475897234Sdrh ** an array. 22575897234Sdrh */ 22675897234Sdrh #define ArraySize(X) (sizeof(X)/sizeof(X[0])) 22775897234Sdrh 22875897234Sdrh /* 22975897234Sdrh ** Forward references to structures 23075897234Sdrh */ 2317020f651Sdrh typedef struct Column Column; 23275897234Sdrh typedef struct Table Table; 23375897234Sdrh typedef struct Index Index; 23475897234Sdrh typedef struct Instruction Instruction; 23575897234Sdrh typedef struct Expr Expr; 23675897234Sdrh typedef struct ExprList ExprList; 23775897234Sdrh typedef struct Parse Parse; 23875897234Sdrh typedef struct Token Token; 23975897234Sdrh typedef struct IdList IdList; 240ad3cab52Sdrh typedef struct SrcList SrcList; 24175897234Sdrh typedef struct WhereInfo WhereInfo; 2426b56344dSdrh typedef struct WhereLevel WhereLevel; 2439bb61fe7Sdrh typedef struct Select Select; 2442282792aSdrh typedef struct AggExpr AggExpr; 2450bce8354Sdrh typedef struct FuncDef FuncDef; 246c3f9bad2Sdanielk1977 typedef struct Trigger Trigger; 247c3f9bad2Sdanielk1977 typedef struct TriggerStep TriggerStep; 248c3f9bad2Sdanielk1977 typedef struct TriggerStack TriggerStack; 249c2eef3b3Sdrh typedef struct FKey FKey; 250001bbcbbSdrh typedef struct Db Db; 25185e2096fSdrh typedef struct AuthContext AuthContext; 252001bbcbbSdrh 253001bbcbbSdrh /* 254001bbcbbSdrh ** Each database file to be accessed by the system is an instance 255001bbcbbSdrh ** of the following structure. There are normally two of these structures 256001bbcbbSdrh ** in the sqlite.aDb[] array. aDb[0] is the main database file and 257a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables. Additional 258a69d9168Sdrh ** databases may be attached. 259001bbcbbSdrh */ 260001bbcbbSdrh struct Db { 261001bbcbbSdrh char *zName; /* Name of this database */ 262001bbcbbSdrh Btree *pBt; /* The B*Tree structure for this database file */ 263001bbcbbSdrh int schema_cookie; /* Database schema version number for this file */ 264d24cc427Sdrh Hash tblHash; /* All tables indexed by name */ 265d24cc427Sdrh Hash idxHash; /* All (named) indices indexed by name */ 266d24cc427Sdrh Hash trigHash; /* All triggers indexed by name */ 267d24cc427Sdrh Hash aFKey; /* Foreign keys indexed by to-table */ 2681aa4965aSdrh u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */ 269d24cc427Sdrh u16 flags; /* Flags associated with this database */ 2704d189ca4Sdrh void *pAux; /* Auxiliary data. Usually NULL */ 2714d189ca4Sdrh void (*xFreeAux)(void*); /* Routine to free pAux */ 272001bbcbbSdrh }; 27375897234Sdrh 27475897234Sdrh /* 2758bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the 2768bf8dc92Sdrh ** Db.flags field. 2778bf8dc92Sdrh */ 2788bf8dc92Sdrh #define DbHasProperty(D,I,P) (((D)->aDb[I].flags&(P))==(P)) 2798bf8dc92Sdrh #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].flags&(P))!=0) 2808bf8dc92Sdrh #define DbSetProperty(D,I,P) (D)->aDb[I].flags|=(P) 2818bf8dc92Sdrh #define DbClearProperty(D,I,P) (D)->aDb[I].flags&=~(P) 2828bf8dc92Sdrh 2838bf8dc92Sdrh /* 2848bf8dc92Sdrh ** Allowed values for the DB.flags field. 2858bf8dc92Sdrh ** 2868bf8dc92Sdrh ** The DB_Locked flag is set when the first OP_Transaction or OP_Checkpoint 2878bf8dc92Sdrh ** opcode is emitted for a database. This prevents multiple occurances 2888bf8dc92Sdrh ** of those opcodes for the same database in the same program. Similarly, 2898bf8dc92Sdrh ** the DB_Cookie flag is set when the OP_VerifyCookie opcode is emitted, 2908bf8dc92Sdrh ** and prevents duplicate OP_VerifyCookies from taking up space and slowing 2918bf8dc92Sdrh ** down execution. 2928bf8dc92Sdrh ** 2938bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been 2948bf8dc92Sdrh ** read into internal hash tables. 2958bf8dc92Sdrh ** 2968bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that 2978bf8dc92Sdrh ** have been filled out. If the schema changes, these column names might 2988bf8dc92Sdrh ** changes and so the view will need to be reset. 2998bf8dc92Sdrh */ 3008bf8dc92Sdrh #define DB_Locked 0x0001 /* OP_Transaction opcode has been emitted */ 3018bf8dc92Sdrh #define DB_Cookie 0x0002 /* OP_VerifyCookie opcode has been emiited */ 3028bf8dc92Sdrh #define DB_SchemaLoaded 0x0004 /* The schema has been loaded */ 3038bf8dc92Sdrh #define DB_UnresetViews 0x0008 /* Some views have defined column names */ 3048bf8dc92Sdrh 3058bf8dc92Sdrh 3068bf8dc92Sdrh /* 307c9b84a1fSdrh ** Each database is an instance of the following structure. 308c9b84a1fSdrh ** 309c9b84a1fSdrh ** The sqlite.file_format is initialized by the database file 310c9b84a1fSdrh ** and helps determines how the data in the database file is 311c9b84a1fSdrh ** represented. This field allows newer versions of the library 312c9b84a1fSdrh ** to read and write older databases. The various file formats 313c9b84a1fSdrh ** are as follows: 314c9b84a1fSdrh ** 315c9b84a1fSdrh ** file_format==1 Version 2.1.0. 316c9b84a1fSdrh ** file_format==2 Version 2.2.0. Add support for INTEGER PRIMARY KEY. 317491791a8Sdrh ** file_format==3 Version 2.6.0. Fix empty-string index bug. 318491791a8Sdrh ** file_format==4 Version 2.7.0. Add support for separate numeric and 319c9b84a1fSdrh ** text datatypes. 32013bff815Sdrh ** 32113bff815Sdrh ** The sqlite.temp_store determines where temporary database files 32213bff815Sdrh ** are stored. If 1, then a file is created to hold those tables. If 32313bff815Sdrh ** 2, then they are held in memory. 0 means use the default value in 32413bff815Sdrh ** the TEMP_STORE macro. 325b0c374ffSrdc ** 326b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an 327b0c374ffSrdc ** insert statement. Inserts on views do not affect its value. Each 328b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside 329b0c374ffSrdc ** triggers as usual. The previous value will be restored once the trigger 330b0c374ffSrdc ** exits. Upon entering a before or instead of trigger, lastRowid is no 331b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1. 332b0c374ffSrdc ** 333b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no 334b0c374ffSrdc ** context. It is reset at start of sqlite_exec. 335b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last 336b0c374ffSrdc ** insert, update, or delete statement. It remains constant throughout the 337b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts. It keeps a 338b0c374ffSrdc ** context stack just like lastRowid so that the count of changes 339b0c374ffSrdc ** within a trigger is not seen outside the trigger. Changes to views do not 340b0c374ffSrdc ** affect the value of lsChange. 341b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since 342b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange. 34375897234Sdrh */ 34475897234Sdrh struct sqlite { 345001bbcbbSdrh int nDb; /* Number of backends currently in use */ 346001bbcbbSdrh Db *aDb; /* All backends */ 347001bbcbbSdrh Db aDbStatic[2]; /* Static space for the 2 default backends */ 3488c82b350Sdrh int flags; /* Miscellanous flags. See below */ 349973b6e33Sdrh u8 file_format; /* What file format version is this database? */ 350973b6e33Sdrh u8 safety_level; /* How aggressive at synching data to disk */ 35194e92032Sdrh u8 want_to_close; /* Close after all VDBEs are deallocated */ 3521d85d931Sdrh u8 temp_store; /* 1=file, 2=memory, 0=compile-time default */ 3531d85d931Sdrh u8 onError; /* Default conflict algorithm */ 354001bbcbbSdrh int next_cookie; /* Next value of aDb[0].schema_cookie */ 355cd61c281Sdrh int cache_size; /* Number of pages to use in the cache */ 3562803757aSdrh int nTable; /* Number of tables in the database */ 3572dfbbcafSdrh void *pBusyArg; /* 1st Argument to the busy callback */ 358353f57e0Sdrh int (*xBusyCallback)(void *,const char*,int); /* The busy callback */ 359aa940eacSdrh void *pCommitArg; /* Argument to xCommitCallback() */ 360aa940eacSdrh int (*xCommitCallback)(void*);/* Invoked at every commit. */ 3610bce8354Sdrh Hash aFunc; /* All functions that can be in SQL exprs */ 362b0c374ffSrdc int lastRowid; /* ROWID of most recent insert (see above) */ 3635cf8e8c7Sdrh int priorNewRowid; /* Last randomly generated ROWID */ 364247be43dSdrh int magic; /* Magic number for detect library misuse */ 365b0c374ffSrdc int nChange; /* Number of rows changed (see above) */ 366b0c374ffSrdc int lsChange; /* Last statement change count (see above) */ 367b0c374ffSrdc int csChange; /* Current statement change count (see above) */ 3681d85d931Sdrh struct sqliteInitInfo { /* Information used during initialization */ 3691d85d931Sdrh int iDb; /* When back is being initialized */ 3701d85d931Sdrh int newTnum; /* Rootpage of table being initialized */ 3711d85d931Sdrh u8 busy; /* TRUE if currently initializing */ 3721d85d931Sdrh } init; 373326dce74Sdrh struct Vdbe *pVdbe; /* List of active virtual machines */ 37418de4824Sdrh void (*xTrace)(void*,const char*); /* Trace function */ 37518de4824Sdrh void *pTraceArg; /* Argument to the trace function */ 376ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 377e22a334bSdrh int (*xAuth)(void*,int,const char*,const char*,const char*,const char*); 378e22a334bSdrh /* Access authorization function */ 379ed6c8671Sdrh void *pAuthArg; /* 1st argument to the access auth function */ 380ed6c8671Sdrh #endif 381348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK 382348bb5d6Sdanielk1977 int (*xProgress)(void *); /* The progress callback */ 383348bb5d6Sdanielk1977 void *pProgressArg; /* Argument to the progress callback */ 384348bb5d6Sdanielk1977 int nProgressOps; /* Number of opcodes for progress callback */ 385348bb5d6Sdanielk1977 #endif 38675897234Sdrh }; 38775897234Sdrh 38875897234Sdrh /* 3898bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields. 3908bf8dc92Sdrh ** 3918bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have 3928bf8dc92Sdrh ** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement 3938bf8dc92Sdrh ** transaction is active on that particular database file. 39475897234Sdrh */ 3954c504391Sdrh #define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */ 3964c504391Sdrh #define SQLITE_Initialized 0x00000002 /* True after initialization */ 3974c504391Sdrh #define SQLITE_Interrupt 0x00000004 /* Cancel current operation */ 398c4a3c779Sdrh #define SQLITE_InTrans 0x00000008 /* True if in a transaction */ 3995e00f6c7Sdrh #define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */ 400382c0247Sdrh #define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */ 401fcabd464Sdrh #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */ 402fcabd464Sdrh #define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */ 4031bee3d7bSdrh /* DELETE, or UPDATE and return */ 4041bee3d7bSdrh /* the count using a callback. */ 405fcabd464Sdrh #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */ 4066a535340Sdrh /* result set is empty */ 4078bf8dc92Sdrh #define SQLITE_ReportTypes 0x00000200 /* Include information on datatypes */ 4085080aaa7Sdrh /* in 4th argument of callback */ 40958b9576bSdrh 41058b9576bSdrh /* 411247be43dSdrh ** Possible values for the sqlite.magic field. 412247be43dSdrh ** The numbers are obtained at random and have no special meaning, other 413247be43dSdrh ** than being distinct from one another. 414247be43dSdrh */ 415247be43dSdrh #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */ 416247be43dSdrh #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */ 417247be43dSdrh #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */ 418247be43dSdrh #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */ 419247be43dSdrh 420247be43dSdrh /* 4210bce8354Sdrh ** Each SQL function is defined by an instance of the following 4220bce8354Sdrh ** structure. A pointer to this structure is stored in the sqlite.aFunc 4238e0a2f90Sdrh ** hash table. When multiple functions have the same name, the hash table 4248e0a2f90Sdrh ** points to a linked list of these structures. 4252803757aSdrh */ 4260bce8354Sdrh struct FuncDef { 4271350b030Sdrh void (*xFunc)(sqlite_func*,int,const char**); /* Regular function */ 42856c0e926Sdrh void (*xStep)(sqlite_func*,int,const char**); /* Aggregate function step */ 4291350b030Sdrh void (*xFinalize)(sqlite_func*); /* Aggregate function finializer */ 430268380caSdrh signed char nArg; /* Number of arguments. -1 means unlimited */ 431268380caSdrh signed char dataType; /* Arg that determines datatype. -1=NUMERIC, */ 432268380caSdrh /* -2=TEXT. -3=SQLITE_ARGS */ 433268380caSdrh u8 includeTypes; /* Add datatypes to args of xFunc and xStep */ 4341350b030Sdrh void *pUserData; /* User data parameter */ 4350bce8354Sdrh FuncDef *pNext; /* Next function with same name */ 4368e0a2f90Sdrh }; 4372803757aSdrh 4382803757aSdrh /* 439967e8b73Sdrh ** information about each column of an SQL table is held in an instance 4407020f651Sdrh ** of this structure. 4417020f651Sdrh */ 4427020f651Sdrh struct Column { 4437020f651Sdrh char *zName; /* Name of this column */ 4447020f651Sdrh char *zDflt; /* Default value of this column */ 445382c0247Sdrh char *zType; /* Data type for this column */ 4464a32431cSdrh u8 notNull; /* True if there is a NOT NULL constraint */ 44778100cc9Sdrh u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */ 4488e2ca029Sdrh u8 sortOrder; /* Some combination of SQLITE_SO_... values */ 449fcabd464Sdrh u8 dottedName; /* True if zName contains a "." character */ 4507020f651Sdrh }; 4517020f651Sdrh 4527020f651Sdrh /* 4538e2ca029Sdrh ** The allowed sort orders. 4548e2ca029Sdrh ** 4558e2ca029Sdrh ** The TEXT and NUM values use bits that do not overlap with DESC and ASC. 4568e2ca029Sdrh ** That way the two can be combined into a single number. 4578e2ca029Sdrh */ 4588e2ca029Sdrh #define SQLITE_SO_UNK 0 /* Use the default collating type. (SCT_NUM) */ 4598e2ca029Sdrh #define SQLITE_SO_TEXT 2 /* Sort using memcmp() */ 4608e2ca029Sdrh #define SQLITE_SO_NUM 4 /* Sort using sqliteCompare() */ 4618e2ca029Sdrh #define SQLITE_SO_TYPEMASK 6 /* Mask to extract the collating sequence */ 4628e2ca029Sdrh #define SQLITE_SO_ASC 0 /* Sort in ascending order */ 4638e2ca029Sdrh #define SQLITE_SO_DESC 1 /* Sort in descending order */ 4648e2ca029Sdrh #define SQLITE_SO_DIRMASK 1 /* Mask to extract the sort direction */ 4658e2ca029Sdrh 4668e2ca029Sdrh /* 46722f70c32Sdrh ** Each SQL table is represented in memory by an instance of the 46822f70c32Sdrh ** following structure. 46922f70c32Sdrh ** 470d24cc427Sdrh ** Table.zName is the name of the table. The case of the original 47122f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for 47222f70c32Sdrh ** comparisons. 47322f70c32Sdrh ** 474d24cc427Sdrh ** Table.nCol is the number of columns in this table. Table.aCol is a 47522f70c32Sdrh ** pointer to an array of Column structures, one for each column. 47622f70c32Sdrh ** 477d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of 478d24cc427Sdrh ** the column that is that key. Otherwise Table.iPKey is negative. Note 47922f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to 48022f70c32Sdrh ** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of 48122f70c32Sdrh ** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid 482d24cc427Sdrh ** is generated for each row of the table. Table.hasPrimKey is true if 48322f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise. 48422f70c32Sdrh ** 485d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the 486d24cc427Sdrh ** database file. If Table.iDb is the index of the database table backend 487d24cc427Sdrh ** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that 488d24cc427Sdrh ** holds temporary tables and indices. If Table.isTransient 48922f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted 490d24cc427Sdrh ** when the VDBE cursor to the table is closed. In this case Table.tnum 49122f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root 49222f70c32Sdrh ** page number. Transient tables are used to hold the results of a 49322f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause 49422f70c32Sdrh ** of a SELECT statement. 49575897234Sdrh */ 49675897234Sdrh struct Table { 49775897234Sdrh char *zName; /* Name of the table */ 49875897234Sdrh int nCol; /* Number of columns in this table */ 4997020f651Sdrh Column *aCol; /* Information about each column */ 500c8392586Sdrh int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */ 501967e8b73Sdrh Index *pIndex; /* List of SQL indexes on this table. */ 50222f70c32Sdrh int tnum; /* Root BTree node for this table (see note above) */ 503a76b5dfcSdrh Select *pSelect; /* NULL for tables. Points to definition if a view. */ 504717e6402Sdrh u8 readOnly; /* True if this table should not be written by the user */ 505d24cc427Sdrh u8 iDb; /* Index into sqlite.aDb[] of the backend for this table */ 50622f70c32Sdrh u8 isTransient; /* True if automatically deleted when VDBE finishes */ 5074a32431cSdrh u8 hasPrimKey; /* True if there exists a primary key */ 5089cfcf5d4Sdrh u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */ 509c3f9bad2Sdanielk1977 Trigger *pTrigger; /* List of SQL triggers on this table */ 510c2eef3b3Sdrh FKey *pFKey; /* Linked list of all foreign keys in this table */ 51175897234Sdrh }; 51275897234Sdrh 51375897234Sdrh /* 514c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure. 515c2eef3b3Sdrh ** 516c2eef3b3Sdrh ** A foreign key is associated with two tables. The "from" table is 517c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign 518c2eef3b3Sdrh ** key. The "to" table is the table that is named in the REFERENCES clause. 519c2eef3b3Sdrh ** Consider this example: 520c2eef3b3Sdrh ** 521c2eef3b3Sdrh ** CREATE TABLE ex1( 522c2eef3b3Sdrh ** a INTEGER PRIMARY KEY, 523c2eef3b3Sdrh ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x) 524c2eef3b3Sdrh ** ); 525c2eef3b3Sdrh ** 526c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2". 527c2eef3b3Sdrh ** 528c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure 529c2eef3b3Sdrh ** which is attached to the from-table. The to-table need not exist when 530c2eef3b3Sdrh ** the from-table is created. The existance of the to-table is not checked 531c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table. 532c2eef3b3Sdrh ** 533ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure 534c2eef3b3Sdrh ** given the name of a to-table. For each to-table, all foreign keys 535c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo 536c2eef3b3Sdrh ** field. 537c2eef3b3Sdrh */ 538c2eef3b3Sdrh struct FKey { 539c2eef3b3Sdrh Table *pFrom; /* The table that constains the REFERENCES clause */ 540c2eef3b3Sdrh FKey *pNextFrom; /* Next foreign key in pFrom */ 541c2eef3b3Sdrh char *zTo; /* Name of table that the key points to */ 542c2eef3b3Sdrh FKey *pNextTo; /* Next foreign key that points to zTo */ 543c2eef3b3Sdrh int nCol; /* Number of columns in this key */ 544c2eef3b3Sdrh struct sColMap { /* Mapping of columns in pFrom to columns in zTo */ 545c2eef3b3Sdrh int iFrom; /* Index of column in pFrom */ 546c2eef3b3Sdrh char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */ 547c2eef3b3Sdrh } *aCol; /* One entry for each of nCol column s */ 548c2eef3b3Sdrh u8 isDeferred; /* True if constraint checking is deferred till COMMIT */ 549c2eef3b3Sdrh u8 updateConf; /* How to resolve conflicts that occur on UPDATE */ 550c2eef3b3Sdrh u8 deleteConf; /* How to resolve conflicts that occur on DELETE */ 551c2eef3b3Sdrh u8 insertConf; /* How to resolve conflicts that occur on INSERT */ 552c2eef3b3Sdrh }; 553c2eef3b3Sdrh 554c2eef3b3Sdrh /* 555c2eef3b3Sdrh ** SQLite supports many different ways to resolve a contraint 55622f70c32Sdrh ** error. ROLLBACK processing means that a constraint violation 5570bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction 5581c92853dSdrh ** to be rolled back. ABORT processing means the operation in process 5591c92853dSdrh ** fails and any prior changes from that one operation are backed out, 5601c92853dSdrh ** but the transaction is not rolled back. FAIL processing means that 5611c92853dSdrh ** the operation in progress stops and returns an error code. But prior 5621c92853dSdrh ** changes due to the same operation are not backed out and no rollback 5631c92853dSdrh ** occurs. IGNORE means that the particular row that caused the constraint 5641c92853dSdrh ** error is not inserted or updated. Processing continues and no error 5651c92853dSdrh ** is returned. REPLACE means that preexisting database rows that caused 5661c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or 5671c92853dSdrh ** update can proceed. Processing continues and no error is reported. 5681c92853dSdrh ** 569c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys. 570c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the 571c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign 572c2eef3b3Sdrh ** key is set to NULL. CASCADE means that a DELETE or UPDATE of the 573c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the 574c2eef3b3Sdrh ** foreign key. 575c2eef3b3Sdrh ** 576968af52aSdrh ** The following symbolic values are used to record which type 5771c92853dSdrh ** of action to take. 5789cfcf5d4Sdrh */ 5799cfcf5d4Sdrh #define OE_None 0 /* There is no constraint to check */ 5801c92853dSdrh #define OE_Rollback 1 /* Fail the operation and rollback the transaction */ 5811c92853dSdrh #define OE_Abort 2 /* Back out changes but do no rollback transaction */ 5821c92853dSdrh #define OE_Fail 3 /* Stop the operation but leave all prior changes */ 5831c92853dSdrh #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */ 5841c92853dSdrh #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */ 585c2eef3b3Sdrh 586c2eef3b3Sdrh #define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */ 587c2eef3b3Sdrh #define OE_SetNull 7 /* Set the foreign key value to NULL */ 588c2eef3b3Sdrh #define OE_SetDflt 8 /* Set the foreign key value to its default */ 589c2eef3b3Sdrh #define OE_Cascade 9 /* Cascade the changes */ 590c2eef3b3Sdrh 591c2eef3b3Sdrh #define OE_Default 99 /* Do whatever the default action is */ 5929cfcf5d4Sdrh 5939cfcf5d4Sdrh /* 59466b89c8fSdrh ** Each SQL index is represented in memory by an 59575897234Sdrh ** instance of the following structure. 596967e8b73Sdrh ** 597967e8b73Sdrh ** The columns of the table that are to be indexed are described 598967e8b73Sdrh ** by the aiColumn[] field of this structure. For example, suppose 599967e8b73Sdrh ** we have the following table and index: 600967e8b73Sdrh ** 601967e8b73Sdrh ** CREATE TABLE Ex1(c1 int, c2 int, c3 text); 602967e8b73Sdrh ** CREATE INDEX Ex2 ON Ex1(c3,c1); 603967e8b73Sdrh ** 604967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are 605967e8b73Sdrh ** three columns in the table. In the Index structure describing 606967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed. 607967e8b73Sdrh ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the 608967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[]. 609967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in 610967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0. 611ea1ba17cSdrh ** 612ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns 613ea1ba17cSdrh ** must be unique and what to do if they are not. When Index.onError=OE_None, 614ea1ba17cSdrh ** it means this is not a unique index. Otherwise it is a unique index 615ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution 616ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique 617ea1ba17cSdrh ** element. 61875897234Sdrh */ 61975897234Sdrh struct Index { 62075897234Sdrh char *zName; /* Name of this index */ 621967e8b73Sdrh int nColumn; /* Number of columns in the table used by this index */ 622967e8b73Sdrh int *aiColumn; /* Which columns are used by this index. 1st is 0 */ 623967e8b73Sdrh Table *pTable; /* The SQL table being indexed */ 624be0072d2Sdrh int tnum; /* Page containing root of this index in database file */ 6259cfcf5d4Sdrh u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */ 626485b39b4Sdrh u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */ 627d24cc427Sdrh u8 iDb; /* Index in sqlite.aDb[] of where this index is stored */ 62875897234Sdrh Index *pNext; /* The next index associated with the same table */ 62975897234Sdrh }; 63075897234Sdrh 63175897234Sdrh /* 63275897234Sdrh ** Each token coming out of the lexer is an instance of 6334b59ab5eSdrh ** this structure. Tokens are also used as part of an expression. 6344efc4754Sdrh ** 6354efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and 6364efc4754Sdrh ** may contain random values. Do not make any assuptions about Token.dyn 6374efc4754Sdrh ** and Token.n when Token.z==0. 63875897234Sdrh */ 63975897234Sdrh struct Token { 64080ff32f5Sdrh const char *z; /* Text of the token. Not NULL-terminated! */ 6414b59ab5eSdrh unsigned dyn : 1; /* True for malloced memory, false for static */ 6426977fea8Sdrh unsigned n : 31; /* Number of characters in this token */ 64375897234Sdrh }; 64475897234Sdrh 64575897234Sdrh /* 64675897234Sdrh ** Each node of an expression in the parse tree is an instance 64722f70c32Sdrh ** of this structure. 64822f70c32Sdrh ** 64922f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused 65022f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer 65122f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused 65222f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression 65322f70c32Sdrh ** tree. 65422f70c32Sdrh ** 65522f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list 65622f70c32Sdrh ** of argument if the expression is a function. 65722f70c32Sdrh ** 6584b59ab5eSdrh ** Expr.token is the operator token for this node. For some expressions 6594b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave 6604b59ab5eSdrh ** rise to the Expr. In the latter case, the token is marked as being 6614b59ab5eSdrh ** a compound token. 66222f70c32Sdrh ** 66322f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table. 66422f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is 66522f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and 66622f70c32Sdrh ** Expr.iColumn is the column number for the specific column. If the 66722f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the 66822f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that 66922f70c32Sdrh ** it can be accessed after all aggregates are computed. 67022f70c32Sdrh ** 67122f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code 6727c972decSdrh ** representing which function. If the expression is an unbound variable 6737c972decSdrh ** marker (a question mark character '?' in the original SQL) then the 6747c972decSdrh ** Expr.iTable holds the index number for that variable. 67522f70c32Sdrh ** 67622f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement. The SELECT might 67722f70c32Sdrh ** be the right operand of an IN operator. Or, if a scalar SELECT appears 67822f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only 67922f70c32Sdrh ** operand. 68075897234Sdrh */ 68175897234Sdrh struct Expr { 6821cc093c2Sdrh u8 op; /* Operation performed by this node */ 6838e2ca029Sdrh u8 dataType; /* Either SQLITE_SO_TEXT or SQLITE_SO_NUM */ 684b5a20d3cSdrh u8 iDb; /* Database referenced by this expression */ 685e22a334bSdrh u8 flags; /* Various flags. See below */ 68675897234Sdrh Expr *pLeft, *pRight; /* Left and right subnodes */ 687d99f7068Sdrh ExprList *pList; /* A list of expressions used as function arguments 688d99f7068Sdrh ** or in "<expr> IN (<expr-list)" */ 68975897234Sdrh Token token; /* An operand token */ 6906977fea8Sdrh Token span; /* Complete text of the expression */ 691967e8b73Sdrh int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the 6928e2ca029Sdrh ** iColumn-th field of the iTable-th table. */ 693967e8b73Sdrh int iAgg; /* When op==TK_COLUMN and pParse->useAgg==TRUE, pull 694967e8b73Sdrh ** result from the iAgg-th element of the aggregator */ 695d99f7068Sdrh Select *pSelect; /* When the expression is a sub-select. Also the 696d99f7068Sdrh ** right side of "<expr> IN (<select>)" */ 69775897234Sdrh }; 69875897234Sdrh 69975897234Sdrh /* 7001f16230bSdrh ** The following are the meanings of bits in the Expr.flags field. 7011f16230bSdrh */ 7021f16230bSdrh #define EP_FromJoin 0x0001 /* Originated in ON or USING clause of a join */ 7031f16230bSdrh 7041f16230bSdrh /* 7051f16230bSdrh ** These macros can be used to test, set, or clear bits in the 7061f16230bSdrh ** Expr.flags field. 7071f16230bSdrh */ 7081f16230bSdrh #define ExprHasProperty(E,P) (((E)->flags&(P))==(P)) 7091f16230bSdrh #define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0) 7101f16230bSdrh #define ExprSetProperty(E,P) (E)->flags|=(P) 7111f16230bSdrh #define ExprClearProperty(E,P) (E)->flags&=~(P) 7121f16230bSdrh 7131f16230bSdrh /* 71475897234Sdrh ** A list of expressions. Each expression may optionally have a 71575897234Sdrh ** name. An expr/name combination can be used in several ways, such 71675897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the 71775897234Sdrh ** list of "ID = expr" items in an UPDATE. A list of expressions can 718ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName 71975897234Sdrh ** field is not used. 72075897234Sdrh */ 72175897234Sdrh struct ExprList { 72275897234Sdrh int nExpr; /* Number of expressions on the list */ 7234305d103Sdrh int nAlloc; /* Number of entries allocated below */ 7246d4abfbeSdrh struct ExprList_item { 72575897234Sdrh Expr *pExpr; /* The list of expressions */ 72675897234Sdrh char *zName; /* Token associated with this expression */ 7278e2ca029Sdrh u8 sortOrder; /* 1 for DESC or 0 for ASC */ 7288e2ca029Sdrh u8 isAgg; /* True if this is an aggregate like count(*) */ 7298e2ca029Sdrh u8 done; /* A flag to indicate when processing is finished */ 73075897234Sdrh } *a; /* One entry for each expression */ 73175897234Sdrh }; 73275897234Sdrh 73375897234Sdrh /* 734ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers, 735ad3cab52Sdrh ** such as the list "a,b,c" in the following statements: 736ad3cab52Sdrh ** 737ad3cab52Sdrh ** INSERT INTO t(a,b,c) VALUES ...; 738ad3cab52Sdrh ** CREATE INDEX idx ON t(a,b,c); 739ad3cab52Sdrh ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...; 740ad3cab52Sdrh ** 741ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of 742ad3cab52Sdrh ** column names after a table name in an INSERT statement. In the statement 743ad3cab52Sdrh ** 744ad3cab52Sdrh ** INSERT INTO t(a,b,c) ... 745ad3cab52Sdrh ** 746ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k. 74775897234Sdrh */ 74875897234Sdrh struct IdList { 74975897234Sdrh int nId; /* Number of identifiers on the list */ 7504305d103Sdrh int nAlloc; /* Number of entries allocated for a[] below */ 7516d4abfbeSdrh struct IdList_item { 752ad3cab52Sdrh char *zName; /* Name of the identifier */ 753967e8b73Sdrh int idx; /* Index in some Table.aCol[] of a column named zName */ 754ad3cab52Sdrh } *a; 755ad3cab52Sdrh }; 756ad3cab52Sdrh 757ad3cab52Sdrh /* 758ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement. 759ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of 760ad3cab52Sdrh ** the SrcList.a[] array. 761d24cc427Sdrh ** 762d24cc427Sdrh ** With the addition of multiple database support, the following structure 763d24cc427Sdrh ** can also be used to describe a particular table such as the table that 764d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL, 765d24cc427Sdrh ** such a table must be a simple name: ID. But in SQLite, the table can 766d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID. 767ad3cab52Sdrh */ 768ad3cab52Sdrh struct SrcList { 7694305d103Sdrh u16 nSrc; /* Number of tables or subqueries in the FROM clause */ 7704305d103Sdrh u16 nAlloc; /* Number of entries allocated in a[] below */ 771ad3cab52Sdrh struct SrcList_item { 772113088ecSdrh char *zDatabase; /* Name of database holding this table */ 773ad3cab52Sdrh char *zName; /* Name of the table */ 774ad3cab52Sdrh char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */ 775daffd0e5Sdrh Table *pTab; /* An SQL table corresponding to zName */ 776daffd0e5Sdrh Select *pSelect; /* A SELECT statement used in place of a table name */ 777ad3cab52Sdrh int jointype; /* Type of join between this table and the next */ 77863eb5f29Sdrh int iCursor; /* The VDBE cursor number used to access this table */ 779ad3cab52Sdrh Expr *pOn; /* The ON clause of a join */ 780ad3cab52Sdrh IdList *pUsing; /* The USING clause of a join */ 781113088ecSdrh } a[1]; /* One entry for each identifier on the list */ 78275897234Sdrh }; 78375897234Sdrh 78475897234Sdrh /* 78501f3f253Sdrh ** Permitted values of the SrcList.a.jointype field 78601f3f253Sdrh */ 78701f3f253Sdrh #define JT_INNER 0x0001 /* Any kind of inner or cross join */ 78801f3f253Sdrh #define JT_NATURAL 0x0002 /* True for a "natural" join */ 789195e6967Sdrh #define JT_LEFT 0x0004 /* Left outer join */ 790195e6967Sdrh #define JT_RIGHT 0x0008 /* Right outer join */ 79101f3f253Sdrh #define JT_OUTER 0x0010 /* The "OUTER" keyword is present */ 79201f3f253Sdrh #define JT_ERROR 0x0020 /* unknown or unsupported join type */ 79301f3f253Sdrh 79401f3f253Sdrh /* 7956b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo 7966b56344dSdrh ** structure contains a single instance of this structure. This structure 7976b56344dSdrh ** is intended to be private the the where.c module and should not be 7986b56344dSdrh ** access or modified by other modules. 7996b56344dSdrh */ 8006b56344dSdrh struct WhereLevel { 8016b56344dSdrh int iMem; /* Memory cell used by this level */ 8026b56344dSdrh Index *pIdx; /* Index used */ 8036b56344dSdrh int iCur; /* Cursor number used for this index */ 804487ab3caSdrh int score; /* How well this indexed scored */ 8056b56344dSdrh int brk; /* Jump here to break out of the loop */ 8066b56344dSdrh int cont; /* Jump here to continue with the next loop cycle */ 8076b56344dSdrh int op, p1, p2; /* Opcode used to terminate the loop */ 808ad2d8307Sdrh int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */ 809ad2d8307Sdrh int top; /* First instruction of interior of the loop */ 810d99f7068Sdrh int inOp, inP1, inP2;/* Opcode used to implement an IN operator */ 811c045ec51Sdrh int bRev; /* Do the scan in the reverse direction */ 8126b56344dSdrh }; 8136b56344dSdrh 8146b56344dSdrh /* 81575897234Sdrh ** The WHERE clause processing routine has two halves. The 81675897234Sdrh ** first part does the start of the WHERE loop and the second 81775897234Sdrh ** half does the tail of the WHERE loop. An instance of 81875897234Sdrh ** this structure is returned by the first half and passed 81975897234Sdrh ** into the second half to give some continuity. 82075897234Sdrh */ 82175897234Sdrh struct WhereInfo { 82275897234Sdrh Parse *pParse; 823ad3cab52Sdrh SrcList *pTabList; /* List of tables in the join */ 82419a775c2Sdrh int iContinue; /* Jump here to continue with next record */ 82519a775c2Sdrh int iBreak; /* Jump here to break out of the loop */ 8266b56344dSdrh int nLevel; /* Number of nested loop */ 827832508b7Sdrh int savedNTab; /* Value of pParse->nTab before WhereBegin() */ 828832508b7Sdrh int peakNTab; /* Value of pParse->nTab after WhereBegin() */ 8296b56344dSdrh WhereLevel a[1]; /* Information about each nest loop in the WHERE */ 83075897234Sdrh }; 83175897234Sdrh 83275897234Sdrh /* 8339bb61fe7Sdrh ** An instance of the following structure contains all information 8349bb61fe7Sdrh ** needed to generate code for a single SELECT statement. 835a76b5dfcSdrh ** 836a76b5dfcSdrh ** The zSelect field is used when the Select structure must be persistent. 837a76b5dfcSdrh ** Normally, the expression tree points to tokens in the original input 838a76b5dfcSdrh ** string that encodes the select. But if the Select structure must live 839a76b5dfcSdrh ** longer than its input string (for example when it is used to describe 840a76b5dfcSdrh ** a VIEW) we have to make a copy of the input string so that the nodes 841a76b5dfcSdrh ** of the expression tree will have something to point to. zSelect is used 842a76b5dfcSdrh ** to hold that copy. 843d11d382cSdrh ** 844d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0. 845d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the 846d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not 847d11d382cSdrh ** offset). But later on, nLimit and nOffset become the memory locations 848d11d382cSdrh ** in the VDBE that record the limit and offset counters. 8499bb61fe7Sdrh */ 8509bb61fe7Sdrh struct Select { 8519bb61fe7Sdrh ExprList *pEList; /* The fields of the result */ 8527b58daeaSdrh u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */ 8537b58daeaSdrh u8 isDistinct; /* True if the DISTINCT keyword is present */ 854ad3cab52Sdrh SrcList *pSrc; /* The FROM clause */ 8559bb61fe7Sdrh Expr *pWhere; /* The WHERE clause */ 8569bb61fe7Sdrh ExprList *pGroupBy; /* The GROUP BY clause */ 8579bb61fe7Sdrh Expr *pHaving; /* The HAVING clause */ 8589bb61fe7Sdrh ExprList *pOrderBy; /* The ORDER BY clause */ 859967e8b73Sdrh Select *pPrior; /* Prior select in a compound select statement */ 8609bbca4c1Sdrh int nLimit, nOffset; /* LIMIT and OFFSET values. -1 means not used */ 8617b58daeaSdrh int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */ 862a76b5dfcSdrh char *zSelect; /* Complete text of the SELECT command */ 8639bb61fe7Sdrh }; 8649bb61fe7Sdrh 8659bb61fe7Sdrh /* 866fef5208cSdrh ** The results of a select can be distributed in several ways. 867fef5208cSdrh */ 868fef5208cSdrh #define SRT_Callback 1 /* Invoke a callback with each row of result */ 869fef5208cSdrh #define SRT_Mem 2 /* Store result in a memory cell */ 87082c3d636Sdrh #define SRT_Set 3 /* Store result as unique keys in a table */ 87182c3d636Sdrh #define SRT_Union 5 /* Store result as keys in a table */ 87282c3d636Sdrh #define SRT_Except 6 /* Remove result from a UNION table */ 8735974a30fSdrh #define SRT_Table 7 /* Store result as data with a unique key */ 8742d0794e3Sdrh #define SRT_TempTable 8 /* Store result in a trasient table */ 875d7489c39Sdrh #define SRT_Discard 9 /* Do not save the results anywhere */ 876f46f905aSdrh #define SRT_Sorter 10 /* Store results in the sorter */ 877142e30dfSdrh #define SRT_Subroutine 11 /* Call a subroutine to handle results */ 878fef5208cSdrh 879fef5208cSdrh /* 8802282792aSdrh ** When a SELECT uses aggregate functions (like "count(*)" or "avg(f1)") 8812282792aSdrh ** we have to do some additional analysis of expressions. An instance 8822282792aSdrh ** of the following structure holds information about a single subexpression 8832282792aSdrh ** somewhere in the SELECT statement. An array of these structures holds 8842282792aSdrh ** all the information we need to generate code for aggregate 8852282792aSdrh ** expressions. 8862282792aSdrh ** 8872282792aSdrh ** Note that when analyzing a SELECT containing aggregates, both 8882282792aSdrh ** non-aggregate field variables and aggregate functions are stored 8892282792aSdrh ** in the AggExpr array of the Parser structure. 8902282792aSdrh ** 8912282792aSdrh ** The pExpr field points to an expression that is part of either the 8922282792aSdrh ** field list, the GROUP BY clause, the HAVING clause or the ORDER BY 8932282792aSdrh ** clause. The expression will be freed when those clauses are cleaned 8942282792aSdrh ** up. Do not try to delete the expression attached to AggExpr.pExpr. 8952282792aSdrh ** 8962282792aSdrh ** If AggExpr.pExpr==0, that means the expression is "count(*)". 8972282792aSdrh */ 8982282792aSdrh struct AggExpr { 8992282792aSdrh int isAgg; /* if TRUE contains an aggregate function */ 9002282792aSdrh Expr *pExpr; /* The expression */ 9010bce8354Sdrh FuncDef *pFunc; /* Information about the aggregate function */ 9022282792aSdrh }; 9032282792aSdrh 9042282792aSdrh /* 905f57b3399Sdrh ** An SQL parser context. A copy of this structure is passed through 906f57b3399Sdrh ** the parser and down into all the parser action routine in order to 907f57b3399Sdrh ** carry around information that is global to the entire parse. 90875897234Sdrh */ 90975897234Sdrh struct Parse { 91075897234Sdrh sqlite *db; /* The main database structure */ 9114c504391Sdrh int rc; /* Return code from execution */ 91275897234Sdrh char *zErrMsg; /* An error message */ 91375897234Sdrh Token sErrToken; /* The token at which the error occurred */ 91475897234Sdrh Token sFirstToken; /* The first token parsed */ 91575897234Sdrh Token sLastToken; /* The last token parsed */ 916326dce74Sdrh const char *zTail; /* All SQL text past the last semicolon parsed */ 91775897234Sdrh Table *pNewTable; /* A table being constructed by CREATE TABLE */ 91875897234Sdrh Vdbe *pVdbe; /* An engine for executing database bytecode */ 919836faa48Sdrh u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */ 920e0bc4048Sdrh u8 explain; /* True if the EXPLAIN flag is found on the query */ 921e0bc4048Sdrh u8 nameClash; /* A permanent table name clashes with temp table name */ 922e0bc4048Sdrh u8 useAgg; /* If true, extract field values from the aggregator 923e0bc4048Sdrh ** while generating expressions. Normally false */ 92475897234Sdrh int nErr; /* Number of errors seen */ 925832508b7Sdrh int nTab; /* Number of previously allocated VDBE cursors */ 92619a775c2Sdrh int nMem; /* Number of memory cells used so far */ 927fef5208cSdrh int nSet; /* Number of sets used so far */ 9282282792aSdrh int nAgg; /* Number of aggregate expressions */ 9297c972decSdrh int nVar; /* Number of '?' variables seen in the SQL so far */ 9302282792aSdrh AggExpr *aAgg; /* An array of aggregate expressions */ 9315cf590c1Sdrh const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */ 932f0f258b1Sdrh Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */ 933f0f258b1Sdrh TriggerStack *trigStack; /* Trigger actions being coded */ 93475897234Sdrh }; 93575897234Sdrh 936d99bc930Sdanielk1977 /* 93785e2096fSdrh ** An instance of the following structure can be declared on a stack and used 93885e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later. 93985e2096fSdrh */ 94085e2096fSdrh struct AuthContext { 94185e2096fSdrh const char *zAuthContext; /* Put saved Parse.zAuthContext here */ 94285e2096fSdrh Parse *pParse; /* The Parse structure */ 94385e2096fSdrh }; 94485e2096fSdrh 94585e2096fSdrh /* 946b0c374ffSrdc ** Bitfield flags for P2 value in OP_PutIntKey and OP_Delete 947b0c374ffSrdc */ 948b0c374ffSrdc #define OPFLAG_NCHANGE 1 /* Set to update db->nChange */ 949b0c374ffSrdc #define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */ 950b0c374ffSrdc #define OPFLAG_CSCHANGE 4 /* Set to update db->csChange */ 951b0c374ffSrdc 952b0c374ffSrdc /* 953d99bc930Sdanielk1977 * Each trigger present in the database schema is stored as an instance of 954d99bc930Sdanielk1977 * struct Trigger. 955d99bc930Sdanielk1977 * 956d99bc930Sdanielk1977 * Pointers to instances of struct Trigger are stored in two ways. 957d99bc930Sdanielk1977 * 1. In the "trigHash" hash table (part of the sqlite* that represents the 958d99bc930Sdanielk1977 * database). This allows Trigger structures to be retrieved by name. 959d99bc930Sdanielk1977 * 2. All triggers associated with a single table form a linked list, using the 960ad3cab52Sdrh * pNext member of struct Trigger. A pointer to the first element of the 961ad3cab52Sdrh * linked list is stored as the "pTrigger" member of the associated 962ad3cab52Sdrh * struct Table. 963d99bc930Sdanielk1977 * 964ad3cab52Sdrh * The "step_list" member points to the first element of a linked list 965ad3cab52Sdrh * containing the SQL statements specified as the trigger program. 966d99bc930Sdanielk1977 */ 967d99bc930Sdanielk1977 struct Trigger { 968d99bc930Sdanielk1977 char *name; /* The name of the trigger */ 969d99bc930Sdanielk1977 char *table; /* The table or view to which the trigger applies */ 970f0f258b1Sdrh u8 iDb; /* Database containing this trigger */ 97179a519c0Sdrh u8 iTabDb; /* Database containing Trigger.table */ 972f0f258b1Sdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */ 973f0f258b1Sdrh u8 tr_tm; /* One of TK_BEFORE, TK_AFTER */ 974d99bc930Sdanielk1977 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */ 975d99bc930Sdanielk1977 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger, 976d99bc930Sdanielk1977 the <column-list> is stored here */ 977d99bc930Sdanielk1977 int foreach; /* One of TK_ROW or TK_STATEMENT */ 9784312db55Sdrh Token nameToken; /* Token containing zName. Use during parsing only */ 979d99bc930Sdanielk1977 980d99bc930Sdanielk1977 TriggerStep *step_list; /* Link list of trigger program steps */ 981d99bc930Sdanielk1977 Trigger *pNext; /* Next trigger associated with the table */ 982c3f9bad2Sdanielk1977 }; 983d99bc930Sdanielk1977 984d99bc930Sdanielk1977 /* 985d99bc930Sdanielk1977 * An instance of struct TriggerStep is used to store a single SQL statement 986d99bc930Sdanielk1977 * that is a part of a trigger-program. 987d99bc930Sdanielk1977 * 988d99bc930Sdanielk1977 * Instances of struct TriggerStep are stored in a singly linked list (linked 989d99bc930Sdanielk1977 * using the "pNext" member) referenced by the "step_list" member of the 990d99bc930Sdanielk1977 * associated struct Trigger instance. The first element of the linked list is 991d99bc930Sdanielk1977 * the first step of the trigger-program. 992d99bc930Sdanielk1977 * 993d99bc930Sdanielk1977 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or 994d99bc930Sdanielk1977 * "SELECT" statement. The meanings of the other members is determined by the 995d99bc930Sdanielk1977 * value of "op" as follows: 996d99bc930Sdanielk1977 * 997d99bc930Sdanielk1977 * (op == TK_INSERT) 998d99bc930Sdanielk1977 * orconf -> stores the ON CONFLICT algorithm 999d99bc930Sdanielk1977 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then 1000d99bc930Sdanielk1977 * this stores a pointer to the SELECT statement. Otherwise NULL. 1001d99bc930Sdanielk1977 * target -> A token holding the name of the table to insert into. 1002d99bc930Sdanielk1977 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then 1003d99bc930Sdanielk1977 * this stores values to be inserted. Otherwise NULL. 1004d99bc930Sdanielk1977 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ... 1005ad3cab52Sdrh * statement, then this stores the column-names to be 1006ad3cab52Sdrh * inserted into. 1007d99bc930Sdanielk1977 * 1008d99bc930Sdanielk1977 * (op == TK_DELETE) 1009d99bc930Sdanielk1977 * target -> A token holding the name of the table to delete from. 1010d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the DELETE statement if one is specified. 1011d99bc930Sdanielk1977 * Otherwise NULL. 1012d99bc930Sdanielk1977 * 1013d99bc930Sdanielk1977 * (op == TK_UPDATE) 1014d99bc930Sdanielk1977 * target -> A token holding the name of the table to update rows of. 1015d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the UPDATE statement if one is specified. 1016d99bc930Sdanielk1977 * Otherwise NULL. 1017d99bc930Sdanielk1977 * pExprList -> A list of the columns to update and the expressions to update 1018ad3cab52Sdrh * them to. See sqliteUpdate() documentation of "pChanges" 1019ad3cab52Sdrh * argument. 1020d99bc930Sdanielk1977 * 1021d99bc930Sdanielk1977 */ 1022c3f9bad2Sdanielk1977 struct TriggerStep { 1023c3f9bad2Sdanielk1977 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */ 1024d99bc930Sdanielk1977 int orconf; /* OE_Rollback etc. */ 1025a69d9168Sdrh Trigger *pTrig; /* The trigger that this step is a part of */ 1026c3f9bad2Sdanielk1977 1027c3f9bad2Sdanielk1977 Select *pSelect; /* Valid for SELECT and sometimes 1028c3f9bad2Sdanielk1977 INSERT steps (when pExprList == 0) */ 1029c3f9bad2Sdanielk1977 Token target; /* Valid for DELETE, UPDATE, INSERT steps */ 1030c3f9bad2Sdanielk1977 Expr *pWhere; /* Valid for DELETE, UPDATE steps */ 1031c3f9bad2Sdanielk1977 ExprList *pExprList; /* Valid for UPDATE statements and sometimes 1032c3f9bad2Sdanielk1977 INSERT steps (when pSelect == 0) */ 1033c3f9bad2Sdanielk1977 IdList *pIdList; /* Valid for INSERT statements only */ 1034c3f9bad2Sdanielk1977 1035c3f9bad2Sdanielk1977 TriggerStep * pNext; /* Next in the link-list */ 1036c3f9bad2Sdanielk1977 }; 1037c3f9bad2Sdanielk1977 1038d99bc930Sdanielk1977 /* 1039d99bc930Sdanielk1977 * An instance of struct TriggerStack stores information required during code 1040d99bc930Sdanielk1977 * generation of a single trigger program. While the trigger program is being 1041d99bc930Sdanielk1977 * coded, its associated TriggerStack instance is pointed to by the 1042d99bc930Sdanielk1977 * "pTriggerStack" member of the Parse structure. 1043d99bc930Sdanielk1977 * 1044d99bc930Sdanielk1977 * The pTab member points to the table that triggers are being coded on. The 1045d99bc930Sdanielk1977 * newIdx member contains the index of the vdbe cursor that points at the temp 1046d99bc930Sdanielk1977 * table that stores the new.* references. If new.* references are not valid 1047d99bc930Sdanielk1977 * for the trigger being coded (for example an ON DELETE trigger), then newIdx 1048d99bc930Sdanielk1977 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references. 1049d99bc930Sdanielk1977 * 1050d99bc930Sdanielk1977 * The ON CONFLICT policy to be used for the trigger program steps is stored 1051d99bc930Sdanielk1977 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause 1052d99bc930Sdanielk1977 * specified for individual triggers steps is used. 1053d99bc930Sdanielk1977 * 1054d99bc930Sdanielk1977 * struct TriggerStack has a "pNext" member, to allow linked lists to be 1055d99bc930Sdanielk1977 * constructed. When coding nested triggers (triggers fired by other triggers) 1056d99bc930Sdanielk1977 * each nested trigger stores its parent trigger's TriggerStack as the "pNext" 1057d99bc930Sdanielk1977 * pointer. Once the nested trigger has been coded, the pNext value is restored 1058d99bc930Sdanielk1977 * to the pTriggerStack member of the Parse stucture and coding of the parent 1059d99bc930Sdanielk1977 * trigger continues. 1060d99bc930Sdanielk1977 * 1061d99bc930Sdanielk1977 * Before a nested trigger is coded, the linked list pointed to by the 1062d99bc930Sdanielk1977 * pTriggerStack is scanned to ensure that the trigger is not about to be coded 1063d99bc930Sdanielk1977 * recursively. If this condition is detected, the nested trigger is not coded. 1064d99bc930Sdanielk1977 */ 1065d99bc930Sdanielk1977 struct TriggerStack { 1066d99bc930Sdanielk1977 Table *pTab; /* Table that triggers are currently being coded on */ 1067d99bc930Sdanielk1977 int newIdx; /* Index of vdbe cursor to "new" temp table */ 1068d99bc930Sdanielk1977 int oldIdx; /* Index of vdbe cursor to "old" temp table */ 1069d99bc930Sdanielk1977 int orconf; /* Current orconf policy */ 10706f34903eSdanielk1977 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */ 1071e22a334bSdrh Trigger *pTrigger; /* The trigger currently being coded */ 1072e22a334bSdrh TriggerStack *pNext; /* Next trigger down on the trigger stack */ 1073c3f9bad2Sdanielk1977 }; 1074c3f9bad2Sdanielk1977 1075d99bc930Sdanielk1977 /* 1076f26e09c8Sdrh ** The following structure contains information used by the sqliteFix... 1077f26e09c8Sdrh ** routines as they walk the parse tree to make database references 1078f26e09c8Sdrh ** explicit. 1079f26e09c8Sdrh */ 1080f26e09c8Sdrh typedef struct DbFixer DbFixer; 1081f26e09c8Sdrh struct DbFixer { 1082f26e09c8Sdrh Parse *pParse; /* The parsing context. Error messages written here */ 1083f26e09c8Sdrh const char *zDb; /* Make sure all objects are contained in this database */ 1084f26e09c8Sdrh const char *zType; /* Type of the container - used for error messages */ 1085f26e09c8Sdrh const Token *pName; /* Name of the container - used for error messages */ 1086f26e09c8Sdrh }; 1087f26e09c8Sdrh 1088f26e09c8Sdrh /* 1089d99bc930Sdanielk1977 * This global flag is set for performance testing of triggers. When it is set 1090d99bc930Sdanielk1977 * SQLite will perform the overhead of building new and old trigger references 1091d99bc930Sdanielk1977 * even when no triggers exist 1092d99bc930Sdanielk1977 */ 1093c3f9bad2Sdanielk1977 extern int always_code_trigger_setup; 1094c3f9bad2Sdanielk1977 109575897234Sdrh /* 109675897234Sdrh ** Internal function prototypes 109775897234Sdrh */ 109875897234Sdrh int sqliteStrICmp(const char *, const char *); 109975897234Sdrh int sqliteStrNICmp(const char *, const char *, int); 110075897234Sdrh int sqliteHashNoCase(const char *, int); 1101bb07e9a3Sdrh int sqliteIsNumber(const char*); 110275897234Sdrh int sqliteCompare(const char *, const char *); 110375897234Sdrh int sqliteSortCompare(const char *, const char *); 11049bbca4c1Sdrh void sqliteRealToSortable(double r, char *); 1105dcc581ccSdrh #ifdef MEMORY_DEBUG 11068c1238aeSdrh void *sqliteMalloc_(int,int,char*,int); 1107dcc581ccSdrh void sqliteFree_(void*,char*,int); 1108dcc581ccSdrh void *sqliteRealloc_(void*,int,char*,int); 11096e142f54Sdrh char *sqliteStrDup_(const char*,char*,int); 11106e142f54Sdrh char *sqliteStrNDup_(const char*, int,char*,int); 1111ed6c8671Sdrh void sqliteCheckMemory(void*,int); 1112dcc581ccSdrh #else 111375897234Sdrh void *sqliteMalloc(int); 11148c1238aeSdrh void *sqliteMallocRaw(int); 111575897234Sdrh void sqliteFree(void*); 111675897234Sdrh void *sqliteRealloc(void*,int); 11176e142f54Sdrh char *sqliteStrDup(const char*); 11186e142f54Sdrh char *sqliteStrNDup(const char*, int); 1119ed6c8671Sdrh # define sqliteCheckMemory(a,b) 1120dcc581ccSdrh #endif 1121483750baSdrh char *sqliteMPrintf(const char*, ...); 11225f968436Sdrh char *sqliteVMPrintf(const char*, va_list); 112375897234Sdrh void sqliteSetString(char **, const char *, ...); 112475897234Sdrh void sqliteSetNString(char **, ...); 1125da93d238Sdrh void sqliteErrorMsg(Parse*, const char*, ...); 1126982cef7eSdrh void sqliteDequote(char*); 112717f71934Sdrh int sqliteKeywordCode(const char*, int); 112880ff32f5Sdrh int sqliteRunParser(Parse*, const char*, char **); 112975897234Sdrh void sqliteExec(Parse*); 113075897234Sdrh Expr *sqliteExpr(int, Expr*, Expr*, Token*); 1131e1b6a5b8Sdrh void sqliteExprSpan(Expr*,Token*,Token*); 113275897234Sdrh Expr *sqliteExprFunction(ExprList*, Token*); 113375897234Sdrh void sqliteExprDelete(Expr*); 113475897234Sdrh ExprList *sqliteExprListAppend(ExprList*,Expr*,Token*); 113575897234Sdrh void sqliteExprListDelete(ExprList*); 1136e0bc4048Sdrh int sqliteInit(sqlite*, char**); 11371c2d8414Sdrh void sqlitePragma(Parse*,Token*,Token*,int); 11381c2d8414Sdrh void sqliteResetInternalSchema(sqlite*, int); 1139e0bc4048Sdrh void sqliteBeginParse(Parse*,int); 11405e00f6c7Sdrh void sqliteRollbackInternalChanges(sqlite*); 1141e0bc4048Sdrh void sqliteCommitInternalChanges(sqlite*); 1142969fa7c1Sdrh Table *sqliteResultSetOfSelect(Parse*,char*,Select*); 1143e0bc4048Sdrh void sqliteOpenMasterTable(Vdbe *v, int); 1144e5f9c644Sdrh void sqliteStartTable(Parse*,Token*,Token*,int,int); 114575897234Sdrh void sqliteAddColumn(Parse*,Token*); 11469cfcf5d4Sdrh void sqliteAddNotNull(Parse*, int); 11479cfcf5d4Sdrh void sqliteAddPrimaryKey(Parse*, IdList*, int); 1148382c0247Sdrh void sqliteAddColumnType(Parse*,Token*,Token*); 11497020f651Sdrh void sqliteAddDefaultValue(Parse*,Token*,int); 1150fcb78a49Sdrh int sqliteCollateType(const char*, int); 11518e2ca029Sdrh void sqliteAddCollateType(Parse*, int); 1152969fa7c1Sdrh void sqliteEndTable(Parse*,Token*,Select*); 11536276c1cbSdrh void sqliteCreateView(Parse*,Token*,Token*,Select*,int); 1154417be79cSdrh int sqliteViewGetColumnNames(Parse*,Table*); 11554ff6dfa7Sdrh void sqliteDropTable(Parse*, Token*, int); 115675897234Sdrh void sqliteDeleteTable(sqlite*, Table*); 1157113088ecSdrh void sqliteInsert(Parse*, SrcList*, ExprList*, Select*, IdList*, int); 115875897234Sdrh IdList *sqliteIdListAppend(IdList*, Token*); 1159ad2d8307Sdrh int sqliteIdListIndex(IdList*,const char*); 1160113088ecSdrh SrcList *sqliteSrcListAppend(SrcList*, Token*, Token*); 1161ad3cab52Sdrh void sqliteSrcListAddAlias(SrcList*, Token*); 11626a3ea0e6Sdrh void sqliteSrcListAssignCursors(Parse*, SrcList*); 116375897234Sdrh void sqliteIdListDelete(IdList*); 1164ad3cab52Sdrh void sqliteSrcListDelete(SrcList*); 11654925ca00Sdrh void sqliteCreateIndex(Parse*,Token*,SrcList*,IdList*,int,Token*,Token*); 1166d24cc427Sdrh void sqliteDropIndex(Parse*, SrcList*); 116738640e15Sdrh void sqliteAddKeyType(Vdbe*, ExprList*); 116838640e15Sdrh void sqliteAddIdxKeyType(Vdbe*, Index*); 11691b2e0329Sdrh int sqliteSelect(Parse*, Select*, int, int, Select*, int, int*); 1170ad3cab52Sdrh Select *sqliteSelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*, 11719bbca4c1Sdrh int,int,int); 11729bb61fe7Sdrh void sqliteSelectDelete(Select*); 1173ff78bd2fSdrh void sqliteSelectUnbind(Select*); 1174812d7a21Sdrh Table *sqliteSrcListLookup(Parse*, SrcList*); 11755cf590c1Sdrh int sqliteIsReadOnly(Parse*, Table*, int); 1176113088ecSdrh void sqliteDeleteFrom(Parse*, SrcList*, Expr*); 1177113088ecSdrh void sqliteUpdate(Parse*, SrcList*, ExprList*, Expr*, int); 11786a3ea0e6Sdrh WhereInfo *sqliteWhereBegin(Parse*, SrcList*, Expr*, int, ExprList**); 117975897234Sdrh void sqliteWhereEnd(WhereInfo*); 118075897234Sdrh void sqliteExprCode(Parse*, Expr*); 1181268380caSdrh int sqliteExprCodeExprList(Parse*, ExprList*, int); 1182f5905aa7Sdrh void sqliteExprIfTrue(Parse*, Expr*, int, int); 1183f5905aa7Sdrh void sqliteExprIfFalse(Parse*, Expr*, int, int); 1184d24cc427Sdrh Table *sqliteFindTable(sqlite*,const char*, const char*); 1185a69d9168Sdrh Table *sqliteLocateTable(Parse*,const char*, const char*); 1186d24cc427Sdrh Index *sqliteFindIndex(sqlite*,const char*, const char*); 11876d4abfbeSdrh void sqliteUnlinkAndDeleteIndex(sqlite*,Index*); 1188d24cc427Sdrh void sqliteCopy(Parse*, SrcList*, Token*, Token*, int); 1189dce2cbe6Sdrh void sqliteVacuum(Parse*, Token*); 11906f8c91caSdrh int sqliteRunVacuum(char**, sqlite*); 1191e17a7e33Sdrh int sqliteGlobCompare(const unsigned char*,const unsigned char*); 1192dce2cbe6Sdrh int sqliteLikeCompare(const unsigned char*,const unsigned char*); 1193cce7d176Sdrh char *sqliteTableNameFromToken(Token*); 1194cce7d176Sdrh int sqliteExprCheck(Parse*, Expr*, int, int*); 1195c9b84a1fSdrh int sqliteExprType(Expr*); 1196d8bc7086Sdrh int sqliteExprCompare(Expr*, Expr*); 1197cce7d176Sdrh int sqliteFuncId(Token*); 11986a3ea0e6Sdrh int sqliteExprResolveIds(Parse*, SrcList*, ExprList*, Expr*); 11992282792aSdrh int sqliteExprAnalyzeAggregates(Parse*, Expr*); 1200d8bc7086Sdrh Vdbe *sqliteGetVdbe(Parse*); 1201bbd82df6Sdrh void sqliteRandomness(int, void*); 1202001bbcbbSdrh void sqliteRollbackAll(sqlite*); 12038bf8dc92Sdrh void sqliteCodeVerifySchema(Parse*, int); 12041c92853dSdrh void sqliteBeginTransaction(Parse*, int); 1205c4a3c779Sdrh void sqliteCommitTransaction(Parse*); 1206c4a3c779Sdrh void sqliteRollbackTransaction(Parse*); 12079208643dSdrh int sqliteExprIsConstant(Expr*); 1208e4de1febSdrh int sqliteExprIsInteger(Expr*, int*); 1209a9f9d1c0Sdrh int sqliteIsRowid(const char*); 121038640e15Sdrh void sqliteGenerateRowDelete(sqlite*, Vdbe*, Table*, int, int); 121138640e15Sdrh void sqliteGenerateRowIndexDelete(sqlite*, Vdbe*, Table*, int, char*); 12120ca3e24bSdrh void sqliteGenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int); 121370ce3f0cSdrh void sqliteCompleteInsertion(Parse*, Table*, int, char*, int, int, int); 1214cd44690aSdrh int sqliteOpenTableAndIndices(Parse*, Table*, int); 1215cabb0819Sdrh void sqliteBeginWriteOperation(Parse*, int, int); 12161c92853dSdrh void sqliteEndWriteOperation(Parse*); 1217ff78bd2fSdrh Expr *sqliteExprDup(Expr*); 12184b59ab5eSdrh void sqliteTokenCopy(Token*, Token*); 1219ff78bd2fSdrh ExprList *sqliteExprListDup(ExprList*); 1220ad3cab52Sdrh SrcList *sqliteSrcListDup(SrcList*); 1221ff78bd2fSdrh IdList *sqliteIdListDup(IdList*); 1222ff78bd2fSdrh Select *sqliteSelectDup(Select*); 12230bce8354Sdrh FuncDef *sqliteFindFunction(sqlite*,const char*,int,int,int); 122428f4b688Sdrh void sqliteRegisterBuiltinFunctions(sqlite*); 12257014aff3Sdrh void sqliteRegisterDateTimeFunctions(sqlite*); 1226247be43dSdrh int sqliteSafetyOn(sqlite*); 1227247be43dSdrh int sqliteSafetyOff(sqlite*); 1228c22bd47dSdrh int sqliteSafetyCheck(sqlite*); 1229e0bc4048Sdrh void sqliteChangeCookie(sqlite*, Vdbe*); 1230f0f258b1Sdrh void sqliteBeginTrigger(Parse*, Token*,int,int,IdList*,SrcList*,int,Expr*,int); 1231f0f258b1Sdrh void sqliteFinishTrigger(Parse*, TriggerStep*, Token*); 123279a519c0Sdrh void sqliteDropTrigger(Parse*, SrcList*); 123379a519c0Sdrh void sqliteDropTriggerPtr(Parse*, Trigger*, int); 1234dc379456Sdrh int sqliteTriggersExist(Parse* , Trigger* , int , int , int, ExprList*); 12356f34903eSdanielk1977 int sqliteCodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int, 12366f34903eSdanielk1977 int, int); 1237dc379456Sdrh void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*); 1238f0f258b1Sdrh void sqliteDeleteTriggerStep(TriggerStep*); 1239dc379456Sdrh TriggerStep *sqliteTriggerSelectStep(Select*); 1240dc379456Sdrh TriggerStep *sqliteTriggerInsertStep(Token*, IdList*, ExprList*, Select*, int); 1241dc379456Sdrh TriggerStep *sqliteTriggerUpdateStep(Token*, ExprList*, Expr*, int); 1242dc379456Sdrh TriggerStep *sqliteTriggerDeleteStep(Token*, Expr*); 12431d1f3055Sdrh void sqliteDeleteTrigger(Trigger*); 124401f3f253Sdrh int sqliteJoinType(Parse*, Token*, Token*, Token*); 1245c2eef3b3Sdrh void sqliteCreateForeignKey(Parse*, IdList*, Token*, IdList*, int); 1246c2eef3b3Sdrh void sqliteDeferForeignKey(Parse*, int); 1247ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 12486a3ea0e6Sdrh void sqliteAuthRead(Parse*,Expr*,SrcList*); 1249e22a334bSdrh int sqliteAuthCheck(Parse*,int, const char*, const char*, const char*); 125085e2096fSdrh void sqliteAuthContextPush(Parse*, AuthContext*, const char*); 125185e2096fSdrh void sqliteAuthContextPop(AuthContext*); 1252ed6c8671Sdrh #else 12536a3ea0e6Sdrh # define sqliteAuthRead(a,b,c) 12547a73eb48Sdrh # define sqliteAuthCheck(a,b,c,d,e) SQLITE_OK 125585e2096fSdrh # define sqliteAuthContextPush(a,b,c) 12567a73eb48Sdrh # define sqliteAuthContextPop(a) ((void)(a)) 1257ed6c8671Sdrh #endif 12584d189ca4Sdrh void sqliteAttach(Parse*, Token*, Token*, Token*); 12591c2d8414Sdrh void sqliteDetach(Parse*, Token*); 1260bb07e9a3Sdrh int sqliteBtreeFactory(const sqlite *db, const char *zFilename, 1261bb07e9a3Sdrh int mode, int nPg, Btree **ppBtree); 1262f26e09c8Sdrh int sqliteFixInit(DbFixer*, Parse*, int, const char*, const Token*); 1263f26e09c8Sdrh int sqliteFixSrcList(DbFixer*, SrcList*); 1264f26e09c8Sdrh int sqliteFixSelect(DbFixer*, Select*); 1265f26e09c8Sdrh int sqliteFixExpr(DbFixer*, Expr*); 1266f26e09c8Sdrh int sqliteFixExprList(DbFixer*, ExprList*); 1267f26e09c8Sdrh int sqliteFixTriggerStep(DbFixer*, TriggerStep*); 1268eb9a9e88Sdrh double sqliteAtoF(const char *z, const char **); 12695f968436Sdrh char *sqlite_snprintf(int,char*,const char*,...); 1270202b2df7Sdrh int sqliteFitsIn32Bits(const char *); 1271