xref: /sqlite-3.40.0/src/sqliteInt.h (revision b0c374ff)
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*b0c374ffSrdc ** @(#) $Id: sqliteInt.h,v 1.215 2004/02/20 22:53:39 rdc Exp $
1575897234Sdrh */
1658f391b3Sdrh #include "config.h"
1775897234Sdrh #include "sqlite.h"
18beae3194Sdrh #include "hash.h"
1975897234Sdrh #include "vdbe.h"
2075897234Sdrh #include "parse.h"
21be0072d2Sdrh #include "btree.h"
2275897234Sdrh #include <stdio.h>
2375897234Sdrh #include <stdlib.h>
2475897234Sdrh #include <string.h>
2575897234Sdrh #include <assert.h>
2675897234Sdrh 
27967e8b73Sdrh /*
28a1b351afSdrh ** The maximum number of in-memory pages to use for the main database
29a1b351afSdrh ** table and for temporary tables.
30a1b351afSdrh */
31603240cfSdrh #define MAX_PAGES   2000
32603240cfSdrh #define TEMP_PAGES   500
33a1b351afSdrh 
34a1b351afSdrh /*
350bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
360bd1f4eaSdrh ** distinct for the SELECT DISTINCT statement and for UNION or EXCEPT
370bd1f4eaSdrh ** compound queries.  No other SQL database engine (among those tested)
380bd1f4eaSdrh ** works this way except for OCELOT.  But the SQL92 spec implies that
390bd1f4eaSdrh ** this is how things should work.
400bd1f4eaSdrh **
410bd1f4eaSdrh ** If the following macro is set to 0, then NULLs are indistinct for
420bd1f4eaSdrh ** SELECT DISTINCT and for UNION.
430bd1f4eaSdrh */
440bd1f4eaSdrh #define NULL_ALWAYS_DISTINCT 0
450bd1f4eaSdrh 
460bd1f4eaSdrh /*
470bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
480bd1f4eaSdrh ** distinct when determining whether or not two entries are the same
490bd1f4eaSdrh ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
500bd1f4eaSdrh ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
510bd1f4eaSdrh ** is the way things are suppose to work.
520bd1f4eaSdrh **
530bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for
540bd1f4eaSdrh ** a UNIQUE index.  In this mode, you can only have a single NULL entry
550bd1f4eaSdrh ** for a column declared UNIQUE.  This is the way Informix and SQL Server
560bd1f4eaSdrh ** work.
570bd1f4eaSdrh */
580bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1
590bd1f4eaSdrh 
600bd1f4eaSdrh /*
61665de47aSdrh ** The maximum number of attached databases.  This must be at least 2
62665de47aSdrh ** in order to support the main database file (0) and the file used to
63a3643a26Sjplyon ** hold temporary tables (1).  And it must be less than 256 because
64665de47aSdrh ** an unsigned character is used to stored the database index.
65665de47aSdrh */
66665de47aSdrh #define MAX_ATTACHED 10
67665de47aSdrh 
68665de47aSdrh /*
6913bff815Sdrh ** The next macro is used to determine where TEMP tables and indices
7013bff815Sdrh ** are stored.  Possible values:
7113bff815Sdrh **
7213bff815Sdrh **   0    Always use a temporary files
7313bff815Sdrh **   1    Use a file unless overridden by "PRAGMA temp_store"
7413bff815Sdrh **   2    Use memory unless overridden by "PRAGMA temp_store"
7513bff815Sdrh **   3    Always use memory
7613bff815Sdrh */
7713bff815Sdrh #ifndef TEMP_STORE
7813bff815Sdrh # define TEMP_STORE 1
7913bff815Sdrh #endif
8013bff815Sdrh 
8113bff815Sdrh /*
8213bff815Sdrh ** When building SQLite for embedded systems where memory is scarce,
8313bff815Sdrh ** you can define one or more of the following macros to omit extra
8413bff815Sdrh ** features of the library and thus keep the size of the library to
8513bff815Sdrh ** a minimum.
8613bff815Sdrh */
8713bff815Sdrh /* #define SQLITE_OMIT_AUTHORIZATION  1 */
8870ce3f0cSdrh /* #define SQLITE_OMIT_INMEMORYDB     1 */
8913bff815Sdrh /* #define SQLITE_OMIT_VACUUM         1 */
900a5294bcSdrh /* #define SQLITE_OMIT_DATETIME_FUNCS 1 */
91348bb5d6Sdanielk1977 /* #define SQLITE_OMIT_PROGRESS_CALLBACK 1 */
9213bff815Sdrh 
9313bff815Sdrh /*
945a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
955a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
965a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
975a2c2c20Sdrh **
985a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
9941a2b48bSdrh */
1005a2c2c20Sdrh #ifndef UINT32_TYPE
1015a2c2c20Sdrh # define UINT32_TYPE unsigned int
1025a2c2c20Sdrh #endif
1035a2c2c20Sdrh #ifndef UINT16_TYPE
1045a2c2c20Sdrh # define UINT16_TYPE unsigned short int
1055a2c2c20Sdrh #endif
1065a2c2c20Sdrh #ifndef UINT8_TYPE
1075a2c2c20Sdrh # define UINT8_TYPE unsigned char
1085a2c2c20Sdrh #endif
1095a2c2c20Sdrh #ifndef INTPTR_TYPE
11058f391b3Sdrh # if SQLITE_PTR_SZ==4
1115a2c2c20Sdrh #   define INTPTR_TYPE int
11258f391b3Sdrh # else
11358f391b3Sdrh #   define INTPTR_TYPE long long
11458f391b3Sdrh # endif
1155a2c2c20Sdrh #endif
1165a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
1175a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
1185a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
1195a2c2c20Sdrh typedef INTPTR_TYPE ptr;           /* Big enough to hold a pointer */
1205a2c2c20Sdrh typedef unsigned INTPTR_TYPE uptr; /* Big enough to hold a pointer */
1215a2c2c20Sdrh 
1225a2c2c20Sdrh /*
123384eef32Sdrh ** Most C compilers these days recognize "long double", don't they?
124384eef32Sdrh ** Just in case we encounter one that does not, we will create a macro
125384eef32Sdrh ** for long double so that it can be easily changed to just "double".
126384eef32Sdrh */
127384eef32Sdrh #ifndef LONGDOUBLE_TYPE
128384eef32Sdrh # define LONGDOUBLE_TYPE long double
129384eef32Sdrh #endif
130384eef32Sdrh 
131384eef32Sdrh /*
1325a2c2c20Sdrh ** This macro casts a pointer to an integer.  Useful for doing
1335a2c2c20Sdrh ** pointer arithmetic.
1345a2c2c20Sdrh */
1355a2c2c20Sdrh #define Addr(X)  ((uptr)X)
13641a2b48bSdrh 
13741a2b48bSdrh /*
138872ff86fSdrh ** The maximum number of bytes of data that can be put into a single
13980ff32f5Sdrh ** row of a single table.  The upper bound on this limit is 16777215
14080ff32f5Sdrh ** bytes (or 16MB-1).  We have arbitrarily set the limit to just 1MB
14180ff32f5Sdrh ** here because the overflow page chain is inefficient for really big
14280ff32f5Sdrh ** records and we want to discourage people from thinking that
14380ff32f5Sdrh ** multi-megabyte records are OK.  If your needs are different, you can
14480ff32f5Sdrh ** change this define and recompile to increase or decrease the record
14580ff32f5Sdrh ** size.
1469ac717d7Sdrh **
1479ac717d7Sdrh ** The 16777198 is computed as follows:  238 bytes of payload on the
1489ac717d7Sdrh ** original pages plus 16448 overflow pages each holding 1020 bytes of
1499ac717d7Sdrh ** data.
150872ff86fSdrh */
1518372b8d1Sdrh #define MAX_BYTES_PER_ROW  1048576
1528372b8d1Sdrh /* #define MAX_BYTES_PER_ROW 16777198 */
153872ff86fSdrh 
154872ff86fSdrh /*
155967e8b73Sdrh ** If memory allocation problems are found, recompile with
156967e8b73Sdrh **
157967e8b73Sdrh **      -DMEMORY_DEBUG=1
158967e8b73Sdrh **
159967e8b73Sdrh ** to enable some sanity checking on malloc() and free().  To
160967e8b73Sdrh ** check for memory leaks, recompile with
161967e8b73Sdrh **
162967e8b73Sdrh **      -DMEMORY_DEBUG=2
163967e8b73Sdrh **
164967e8b73Sdrh ** and a line of text will be written to standard error for
165967e8b73Sdrh ** each malloc() and free().  This output can be analyzed
166967e8b73Sdrh ** by an AWK script to determine if there are any leaks.
167967e8b73Sdrh */
168dcc581ccSdrh #ifdef MEMORY_DEBUG
1698c1238aeSdrh # define sqliteMalloc(X)    sqliteMalloc_(X,1,__FILE__,__LINE__)
1708c1238aeSdrh # define sqliteMallocRaw(X) sqliteMalloc_(X,0,__FILE__,__LINE__)
171dcc581ccSdrh # define sqliteFree(X)      sqliteFree_(X,__FILE__,__LINE__)
172dcc581ccSdrh # define sqliteRealloc(X,Y) sqliteRealloc_(X,Y,__FILE__,__LINE__)
1736e142f54Sdrh # define sqliteStrDup(X)    sqliteStrDup_(X,__FILE__,__LINE__)
1746e142f54Sdrh # define sqliteStrNDup(X,Y) sqliteStrNDup_(X,Y,__FILE__,__LINE__)
175c3c2fc9aSdrh   void sqliteStrRealloc(char**);
176c3c2fc9aSdrh #else
177c3c2fc9aSdrh # define sqliteStrRealloc(X)
178dcc581ccSdrh #endif
179dcc581ccSdrh 
18075897234Sdrh /*
181daffd0e5Sdrh ** This variable gets set if malloc() ever fails.  After it gets set,
182daffd0e5Sdrh ** the SQLite library shuts down permanently.
183daffd0e5Sdrh */
184daffd0e5Sdrh extern int sqlite_malloc_failed;
185daffd0e5Sdrh 
186daffd0e5Sdrh /*
1876e142f54Sdrh ** The following global variables are used for testing and debugging
1888c82b350Sdrh ** only.  They only work if MEMORY_DEBUG is defined.
1896e142f54Sdrh */
1906e142f54Sdrh #ifdef MEMORY_DEBUG
1918c82b350Sdrh extern int sqlite_nMalloc;       /* Number of sqliteMalloc() calls */
1928c82b350Sdrh extern int sqlite_nFree;         /* Number of sqliteFree() calls */
1938c82b350Sdrh extern int sqlite_iMallocFail;   /* Fail sqliteMalloc() after this many calls */
1946e142f54Sdrh #endif
1956e142f54Sdrh 
1966e142f54Sdrh /*
19775897234Sdrh ** Name of the master database table.  The master database table
19875897234Sdrh ** is a special table that holds the names and attributes of all
19975897234Sdrh ** user tables and indices.
20075897234Sdrh */
20175897234Sdrh #define MASTER_NAME       "sqlite_master"
202e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
20375897234Sdrh 
20475897234Sdrh /*
205ed6c8671Sdrh ** The name of the schema table.
206ed6c8671Sdrh */
207ed6c8671Sdrh #define SCHEMA_TABLE(x)  (x?TEMP_MASTER_NAME:MASTER_NAME)
208ed6c8671Sdrh 
209ed6c8671Sdrh /*
21075897234Sdrh ** A convenience macro that returns the number of elements in
21175897234Sdrh ** an array.
21275897234Sdrh */
21375897234Sdrh #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
21475897234Sdrh 
21575897234Sdrh /*
21675897234Sdrh ** Forward references to structures
21775897234Sdrh */
2187020f651Sdrh typedef struct Column Column;
21975897234Sdrh typedef struct Table Table;
22075897234Sdrh typedef struct Index Index;
22175897234Sdrh typedef struct Instruction Instruction;
22275897234Sdrh typedef struct Expr Expr;
22375897234Sdrh typedef struct ExprList ExprList;
22475897234Sdrh typedef struct Parse Parse;
22575897234Sdrh typedef struct Token Token;
22675897234Sdrh typedef struct IdList IdList;
227ad3cab52Sdrh typedef struct SrcList SrcList;
22875897234Sdrh typedef struct WhereInfo WhereInfo;
2296b56344dSdrh typedef struct WhereLevel WhereLevel;
2309bb61fe7Sdrh typedef struct Select Select;
2312282792aSdrh typedef struct AggExpr AggExpr;
2320bce8354Sdrh typedef struct FuncDef FuncDef;
233c3f9bad2Sdanielk1977 typedef struct Trigger Trigger;
234c3f9bad2Sdanielk1977 typedef struct TriggerStep TriggerStep;
235c3f9bad2Sdanielk1977 typedef struct TriggerStack TriggerStack;
236c2eef3b3Sdrh typedef struct FKey FKey;
237001bbcbbSdrh typedef struct Db Db;
23885e2096fSdrh typedef struct AuthContext AuthContext;
239001bbcbbSdrh 
240001bbcbbSdrh /*
241001bbcbbSdrh ** Each database file to be accessed by the system is an instance
242001bbcbbSdrh ** of the following structure.  There are normally two of these structures
243001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
244a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
245a69d9168Sdrh ** databases may be attached.
246001bbcbbSdrh */
247001bbcbbSdrh struct Db {
248001bbcbbSdrh   char *zName;         /* Name of this database */
249001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
250001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
251d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
252d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
253d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
254d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
2551aa4965aSdrh   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
256d24cc427Sdrh   u16 flags;           /* Flags associated with this database */
2574d189ca4Sdrh   void *pAux;          /* Auxiliary data.  Usually NULL */
2584d189ca4Sdrh   void (*xFreeAux)(void*);  /* Routine to free pAux */
259001bbcbbSdrh };
26075897234Sdrh 
26175897234Sdrh /*
2628bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
2638bf8dc92Sdrh ** Db.flags field.
2648bf8dc92Sdrh */
2658bf8dc92Sdrh #define DbHasProperty(D,I,P)     (((D)->aDb[I].flags&(P))==(P))
2668bf8dc92Sdrh #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].flags&(P))!=0)
2678bf8dc92Sdrh #define DbSetProperty(D,I,P)     (D)->aDb[I].flags|=(P)
2688bf8dc92Sdrh #define DbClearProperty(D,I,P)   (D)->aDb[I].flags&=~(P)
2698bf8dc92Sdrh 
2708bf8dc92Sdrh /*
2718bf8dc92Sdrh ** Allowed values for the DB.flags field.
2728bf8dc92Sdrh **
2738bf8dc92Sdrh ** The DB_Locked flag is set when the first OP_Transaction or OP_Checkpoint
2748bf8dc92Sdrh ** opcode is emitted for a database.  This prevents multiple occurances
2758bf8dc92Sdrh ** of those opcodes for the same database in the same program.  Similarly,
2768bf8dc92Sdrh ** the DB_Cookie flag is set when the OP_VerifyCookie opcode is emitted,
2778bf8dc92Sdrh ** and prevents duplicate OP_VerifyCookies from taking up space and slowing
2788bf8dc92Sdrh ** down execution.
2798bf8dc92Sdrh **
2808bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
2818bf8dc92Sdrh ** read into internal hash tables.
2828bf8dc92Sdrh **
2838bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
2848bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
2858bf8dc92Sdrh ** changes and so the view will need to be reset.
2868bf8dc92Sdrh */
2878bf8dc92Sdrh #define DB_Locked          0x0001  /* OP_Transaction opcode has been emitted */
2888bf8dc92Sdrh #define DB_Cookie          0x0002  /* OP_VerifyCookie opcode has been emiited */
2898bf8dc92Sdrh #define DB_SchemaLoaded    0x0004  /* The schema has been loaded */
2908bf8dc92Sdrh #define DB_UnresetViews    0x0008  /* Some views have defined column names */
2918bf8dc92Sdrh 
2928bf8dc92Sdrh 
2938bf8dc92Sdrh /*
294c9b84a1fSdrh ** Each database is an instance of the following structure.
295c9b84a1fSdrh **
296c9b84a1fSdrh ** The sqlite.file_format is initialized by the database file
297c9b84a1fSdrh ** and helps determines how the data in the database file is
298c9b84a1fSdrh ** represented.  This field allows newer versions of the library
299c9b84a1fSdrh ** to read and write older databases.  The various file formats
300c9b84a1fSdrh ** are as follows:
301c9b84a1fSdrh **
302c9b84a1fSdrh **     file_format==1    Version 2.1.0.
303c9b84a1fSdrh **     file_format==2    Version 2.2.0. Add support for INTEGER PRIMARY KEY.
304491791a8Sdrh **     file_format==3    Version 2.6.0. Fix empty-string index bug.
305491791a8Sdrh **     file_format==4    Version 2.7.0. Add support for separate numeric and
306c9b84a1fSdrh **                       text datatypes.
30713bff815Sdrh **
30813bff815Sdrh ** The sqlite.temp_store determines where temporary database files
30913bff815Sdrh ** are stored.  If 1, then a file is created to hold those tables.  If
31013bff815Sdrh ** 2, then they are held in memory.  0 means use the default value in
31113bff815Sdrh ** the TEMP_STORE macro.
312*b0c374ffSrdc **
313*b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
314*b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
315*b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
316*b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
317*b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
318*b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
319*b0c374ffSrdc **
320*b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
321*b0c374ffSrdc ** context.  It is reset at start of sqlite_exec.
322*b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
323*b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
324*b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
325*b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
326*b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
327*b0c374ffSrdc ** affect the value of lsChange.
328*b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
329*b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
33075897234Sdrh */
33175897234Sdrh struct sqlite {
332001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
333001bbcbbSdrh   Db *aDb;                      /* All backends */
334001bbcbbSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
3358c82b350Sdrh   int flags;                    /* Miscellanous flags. See below */
336973b6e33Sdrh   u8 file_format;               /* What file format version is this database? */
337973b6e33Sdrh   u8 safety_level;              /* How aggressive at synching data to disk */
33894e92032Sdrh   u8 want_to_close;             /* Close after all VDBEs are deallocated */
3391d85d931Sdrh   u8 temp_store;                /* 1=file, 2=memory, 0=compile-time default */
3401d85d931Sdrh   u8 onError;                   /* Default conflict algorithm */
341001bbcbbSdrh   int next_cookie;              /* Next value of aDb[0].schema_cookie */
342cd61c281Sdrh   int cache_size;               /* Number of pages to use in the cache */
3432803757aSdrh   int nTable;                   /* Number of tables in the database */
3442dfbbcafSdrh   void *pBusyArg;               /* 1st Argument to the busy callback */
345353f57e0Sdrh   int (*xBusyCallback)(void *,const char*,int);  /* The busy callback */
346aa940eacSdrh   void *pCommitArg;             /* Argument to xCommitCallback() */
347aa940eacSdrh   int (*xCommitCallback)(void*);/* Invoked at every commit. */
3480bce8354Sdrh   Hash aFunc;                   /* All functions that can be in SQL exprs */
349*b0c374ffSrdc   int lastRowid;                /* ROWID of most recent insert (see above) */
3505cf8e8c7Sdrh   int priorNewRowid;            /* Last randomly generated ROWID */
351247be43dSdrh   int magic;                    /* Magic number for detect library misuse */
352*b0c374ffSrdc   int nChange;                  /* Number of rows changed (see above) */
353*b0c374ffSrdc   int lsChange;                 /* Last statement change count (see above) */
354*b0c374ffSrdc   int csChange;                 /* Current statement change count (see above) */
3551d85d931Sdrh   struct sqliteInitInfo {       /* Information used during initialization */
3561d85d931Sdrh     int iDb;                       /* When back is being initialized */
3571d85d931Sdrh     int newTnum;                   /* Rootpage of table being initialized */
3581d85d931Sdrh     u8 busy;                       /* TRUE if currently initializing */
3591d85d931Sdrh   } init;
360326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
36118de4824Sdrh   void (*xTrace)(void*,const char*);     /* Trace function */
36218de4824Sdrh   void *pTraceArg;                       /* Argument to the trace function */
363ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
364e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
365e22a334bSdrh                                 /* Access authorization function */
366ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
367ed6c8671Sdrh #endif
368348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
369348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
370348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
371348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
372348bb5d6Sdanielk1977 #endif
37375897234Sdrh };
37475897234Sdrh 
37575897234Sdrh /*
3768bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
3778bf8dc92Sdrh **
3788bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
3798bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
3808bf8dc92Sdrh ** transaction is active on that particular database file.
38175897234Sdrh */
3824c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
3834c504391Sdrh #define SQLITE_Initialized    0x00000002  /* True after initialization */
3844c504391Sdrh #define SQLITE_Interrupt      0x00000004  /* Cancel current operation */
385c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
3865e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
387382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
388fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
389fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
3901bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
3911bee3d7bSdrh                                           /*   the count using a callback. */
392fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
3936a535340Sdrh                                           /*   result set is empty */
3948bf8dc92Sdrh #define SQLITE_ReportTypes    0x00000200  /* Include information on datatypes */
3955080aaa7Sdrh                                           /*   in 4th argument of callback */
39658b9576bSdrh 
39758b9576bSdrh /*
398247be43dSdrh ** Possible values for the sqlite.magic field.
399247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
400247be43dSdrh ** than being distinct from one another.
401247be43dSdrh */
402247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
403247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
404247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
405247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
406247be43dSdrh 
407247be43dSdrh /*
4080bce8354Sdrh ** Each SQL function is defined by an instance of the following
4090bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
4108e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
4118e0a2f90Sdrh ** points to a linked list of these structures.
4122803757aSdrh */
4130bce8354Sdrh struct FuncDef {
4141350b030Sdrh   void (*xFunc)(sqlite_func*,int,const char**);  /* Regular function */
41556c0e926Sdrh   void (*xStep)(sqlite_func*,int,const char**);  /* Aggregate function step */
4161350b030Sdrh   void (*xFinalize)(sqlite_func*);           /* Aggregate function finializer */
4178e0a2f90Sdrh   int nArg;                                  /* Number of arguments */
418c9b84a1fSdrh   int dataType;                              /* Datatype of the result */
4191350b030Sdrh   void *pUserData;                           /* User data parameter */
4200bce8354Sdrh   FuncDef *pNext;                            /* Next function with same name */
4218e0a2f90Sdrh };
4222803757aSdrh 
4232803757aSdrh /*
424967e8b73Sdrh ** information about each column of an SQL table is held in an instance
4257020f651Sdrh ** of this structure.
4267020f651Sdrh */
4277020f651Sdrh struct Column {
4287020f651Sdrh   char *zName;     /* Name of this column */
4297020f651Sdrh   char *zDflt;     /* Default value of this column */
430382c0247Sdrh   char *zType;     /* Data type for this column */
4314a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
43278100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
4338e2ca029Sdrh   u8 sortOrder;    /* Some combination of SQLITE_SO_... values */
434fcabd464Sdrh   u8 dottedName;   /* True if zName contains a "." character */
4357020f651Sdrh };
4367020f651Sdrh 
4377020f651Sdrh /*
4388e2ca029Sdrh ** The allowed sort orders.
4398e2ca029Sdrh **
4408e2ca029Sdrh ** The TEXT and NUM values use bits that do not overlap with DESC and ASC.
4418e2ca029Sdrh ** That way the two can be combined into a single number.
4428e2ca029Sdrh */
4438e2ca029Sdrh #define SQLITE_SO_UNK       0  /* Use the default collating type.  (SCT_NUM) */
4448e2ca029Sdrh #define SQLITE_SO_TEXT      2  /* Sort using memcmp() */
4458e2ca029Sdrh #define SQLITE_SO_NUM       4  /* Sort using sqliteCompare() */
4468e2ca029Sdrh #define SQLITE_SO_TYPEMASK  6  /* Mask to extract the collating sequence */
4478e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
4488e2ca029Sdrh #define SQLITE_SO_DESC      1  /* Sort in descending order */
4498e2ca029Sdrh #define SQLITE_SO_DIRMASK   1  /* Mask to extract the sort direction */
4508e2ca029Sdrh 
4518e2ca029Sdrh /*
45222f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
45322f70c32Sdrh ** following structure.
45422f70c32Sdrh **
455d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
45622f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
45722f70c32Sdrh ** comparisons.
45822f70c32Sdrh **
459d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
46022f70c32Sdrh ** pointer to an array of Column structures, one for each column.
46122f70c32Sdrh **
462d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
463d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
46422f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
46522f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
46622f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
467d24cc427Sdrh ** is generated for each row of the table.  Table.hasPrimKey is true if
46822f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
46922f70c32Sdrh **
470d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
471d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
472d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
473d24cc427Sdrh ** holds temporary tables and indices.  If Table.isTransient
47422f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted
475d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
47622f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
47722f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
47822f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
47922f70c32Sdrh ** of a SELECT statement.
48075897234Sdrh */
48175897234Sdrh struct Table {
48275897234Sdrh   char *zName;     /* Name of the table */
48375897234Sdrh   int nCol;        /* Number of columns in this table */
4847020f651Sdrh   Column *aCol;    /* Information about each column */
485c8392586Sdrh   int iPKey;       /* If not less then 0, use aCol[iPKey] as the primary key */
486967e8b73Sdrh   Index *pIndex;   /* List of SQL indexes on this table. */
48722f70c32Sdrh   int tnum;        /* Root BTree node for this table (see note above) */
488a76b5dfcSdrh   Select *pSelect; /* NULL for tables.  Points to definition if a view. */
489717e6402Sdrh   u8 readOnly;     /* True if this table should not be written by the user */
490d24cc427Sdrh   u8 iDb;          /* Index into sqlite.aDb[] of the backend for this table */
49122f70c32Sdrh   u8 isTransient;  /* True if automatically deleted when VDBE finishes */
4924a32431cSdrh   u8 hasPrimKey;   /* True if there exists a primary key */
4939cfcf5d4Sdrh   u8 keyConf;      /* What to do in case of uniqueness conflict on iPKey */
494c3f9bad2Sdanielk1977   Trigger *pTrigger; /* List of SQL triggers on this table */
495c2eef3b3Sdrh   FKey *pFKey;       /* Linked list of all foreign keys in this table */
49675897234Sdrh };
49775897234Sdrh 
49875897234Sdrh /*
499c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
500c2eef3b3Sdrh **
501c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
502c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
503c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
504c2eef3b3Sdrh ** Consider this example:
505c2eef3b3Sdrh **
506c2eef3b3Sdrh **     CREATE TABLE ex1(
507c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
508c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
509c2eef3b3Sdrh **     );
510c2eef3b3Sdrh **
511c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
512c2eef3b3Sdrh **
513c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
514c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
515c2eef3b3Sdrh ** the from-table is created.  The existance of the to-table is not checked
516c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
517c2eef3b3Sdrh **
518ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
519c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
520c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
521c2eef3b3Sdrh ** field.
522c2eef3b3Sdrh */
523c2eef3b3Sdrh struct FKey {
524c2eef3b3Sdrh   Table *pFrom;     /* The table that constains the REFERENCES clause */
525c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
526c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
527c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
528c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
529c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
530c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
531c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
532c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
533c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
534c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
535c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
536c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
537c2eef3b3Sdrh };
538c2eef3b3Sdrh 
539c2eef3b3Sdrh /*
540c2eef3b3Sdrh ** SQLite supports many different ways to resolve a contraint
54122f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
5420bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
5431c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
5441c92853dSdrh ** fails and any prior changes from that one operation are backed out,
5451c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
5461c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
5471c92853dSdrh ** changes due to the same operation are not backed out and no rollback
5481c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
5491c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
5501c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
5511c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
5521c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
5531c92853dSdrh **
554c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
555c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
556c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
557c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
558c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
559c2eef3b3Sdrh ** foreign key.
560c2eef3b3Sdrh **
561968af52aSdrh ** The following symbolic values are used to record which type
5621c92853dSdrh ** of action to take.
5639cfcf5d4Sdrh */
5649cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
5651c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
5661c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
5671c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
5681c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
5691c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
570c2eef3b3Sdrh 
571c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
572c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
573c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
574c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
575c2eef3b3Sdrh 
576c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
5779cfcf5d4Sdrh 
5789cfcf5d4Sdrh /*
57966b89c8fSdrh ** Each SQL index is represented in memory by an
58075897234Sdrh ** instance of the following structure.
581967e8b73Sdrh **
582967e8b73Sdrh ** The columns of the table that are to be indexed are described
583967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
584967e8b73Sdrh ** we have the following table and index:
585967e8b73Sdrh **
586967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
587967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
588967e8b73Sdrh **
589967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
590967e8b73Sdrh ** three columns in the table.  In the Index structure describing
591967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
592967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
593967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
594967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
595967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
596ea1ba17cSdrh **
597ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
598ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
599ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
600ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
601ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
602ea1ba17cSdrh ** element.
60375897234Sdrh */
60475897234Sdrh struct Index {
60575897234Sdrh   char *zName;     /* Name of this index */
606967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
607967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
608967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
609be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
6109cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
611485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
612d24cc427Sdrh   u8 iDb;          /* Index in sqlite.aDb[] of where this index is stored */
61375897234Sdrh   Index *pNext;    /* The next index associated with the same table */
61475897234Sdrh };
61575897234Sdrh 
61675897234Sdrh /*
61775897234Sdrh ** Each token coming out of the lexer is an instance of
6184b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
6194efc4754Sdrh **
6204efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
6214efc4754Sdrh ** may contain random values.  Do not make any assuptions about Token.dyn
6224efc4754Sdrh ** and Token.n when Token.z==0.
62375897234Sdrh */
62475897234Sdrh struct Token {
62580ff32f5Sdrh   const char *z;      /* Text of the token.  Not NULL-terminated! */
6264b59ab5eSdrh   unsigned dyn  : 1;  /* True for malloced memory, false for static */
6276977fea8Sdrh   unsigned n    : 31; /* Number of characters in this token */
62875897234Sdrh };
62975897234Sdrh 
63075897234Sdrh /*
63175897234Sdrh ** Each node of an expression in the parse tree is an instance
63222f70c32Sdrh ** of this structure.
63322f70c32Sdrh **
63422f70c32Sdrh ** Expr.op is the opcode.  The integer parser token codes are reused
63522f70c32Sdrh ** as opcodes here.  For example, the parser defines TK_GE to be an integer
63622f70c32Sdrh ** code representing the ">=" operator.  This same integer code is reused
63722f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
63822f70c32Sdrh ** tree.
63922f70c32Sdrh **
64022f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
64122f70c32Sdrh ** of argument if the expression is a function.
64222f70c32Sdrh **
6434b59ab5eSdrh ** Expr.token is the operator token for this node.  For some expressions
6444b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave
6454b59ab5eSdrh ** rise to the Expr.  In the latter case, the token is marked as being
6464b59ab5eSdrh ** a compound token.
64722f70c32Sdrh **
64822f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
64922f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
65022f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
65122f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
65222f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
65322f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
65422f70c32Sdrh ** it can be accessed after all aggregates are computed.
65522f70c32Sdrh **
65622f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code
6577c972decSdrh ** representing which function.  If the expression is an unbound variable
6587c972decSdrh ** marker (a question mark character '?' in the original SQL) then the
6597c972decSdrh ** Expr.iTable holds the index number for that variable.
66022f70c32Sdrh **
66122f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
66222f70c32Sdrh ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
66322f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
66422f70c32Sdrh ** operand.
66575897234Sdrh */
66675897234Sdrh struct Expr {
6671cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
6688e2ca029Sdrh   u8 dataType;           /* Either SQLITE_SO_TEXT or SQLITE_SO_NUM */
669b5a20d3cSdrh   u8 iDb;                /* Database referenced by this expression */
670e22a334bSdrh   u8 flags;              /* Various flags.  See below */
67175897234Sdrh   Expr *pLeft, *pRight;  /* Left and right subnodes */
672d99f7068Sdrh   ExprList *pList;       /* A list of expressions used as function arguments
673d99f7068Sdrh                          ** or in "<expr> IN (<expr-list)" */
67475897234Sdrh   Token token;           /* An operand token */
6756977fea8Sdrh   Token span;            /* Complete text of the expression */
676967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
6778e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
678967e8b73Sdrh   int iAgg;              /* When op==TK_COLUMN and pParse->useAgg==TRUE, pull
679967e8b73Sdrh                          ** result from the iAgg-th element of the aggregator */
680d99f7068Sdrh   Select *pSelect;       /* When the expression is a sub-select.  Also the
681d99f7068Sdrh                          ** right side of "<expr> IN (<select>)" */
68275897234Sdrh };
68375897234Sdrh 
68475897234Sdrh /*
6851f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
6861f16230bSdrh */
6871f16230bSdrh #define EP_FromJoin     0x0001  /* Originated in ON or USING clause of a join */
6881f16230bSdrh 
6891f16230bSdrh /*
6901f16230bSdrh ** These macros can be used to test, set, or clear bits in the
6911f16230bSdrh ** Expr.flags field.
6921f16230bSdrh */
6931f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
6941f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
6951f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
6961f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
6971f16230bSdrh 
6981f16230bSdrh /*
69975897234Sdrh ** A list of expressions.  Each expression may optionally have a
70075897234Sdrh ** name.  An expr/name combination can be used in several ways, such
70175897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
70275897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
703ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
70475897234Sdrh ** field is not used.
70575897234Sdrh */
70675897234Sdrh struct ExprList {
70775897234Sdrh   int nExpr;             /* Number of expressions on the list */
7084305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
7096d4abfbeSdrh   struct ExprList_item {
71075897234Sdrh     Expr *pExpr;           /* The list of expressions */
71175897234Sdrh     char *zName;           /* Token associated with this expression */
7128e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
7138e2ca029Sdrh     u8 isAgg;              /* True if this is an aggregate like count(*) */
7148e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
71575897234Sdrh   } *a;                  /* One entry for each expression */
71675897234Sdrh };
71775897234Sdrh 
71875897234Sdrh /*
719ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
720ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
721ad3cab52Sdrh **
722ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
723ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
724ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
725ad3cab52Sdrh **
726ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
727ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
728ad3cab52Sdrh **
729ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
730ad3cab52Sdrh **
731ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
73275897234Sdrh */
73375897234Sdrh struct IdList {
73475897234Sdrh   int nId;         /* Number of identifiers on the list */
7354305d103Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
7366d4abfbeSdrh   struct IdList_item {
737ad3cab52Sdrh     char *zName;      /* Name of the identifier */
738967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
739ad3cab52Sdrh   } *a;
740ad3cab52Sdrh };
741ad3cab52Sdrh 
742ad3cab52Sdrh /*
743ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
744ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
745ad3cab52Sdrh ** the SrcList.a[] array.
746d24cc427Sdrh **
747d24cc427Sdrh ** With the addition of multiple database support, the following structure
748d24cc427Sdrh ** can also be used to describe a particular table such as the table that
749d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
750d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
751d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
752ad3cab52Sdrh */
753ad3cab52Sdrh struct SrcList {
7544305d103Sdrh   u16 nSrc;        /* Number of tables or subqueries in the FROM clause */
7554305d103Sdrh   u16 nAlloc;      /* Number of entries allocated in a[] below */
756ad3cab52Sdrh   struct SrcList_item {
757113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
758ad3cab52Sdrh     char *zName;      /* Name of the table */
759ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
760daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
761daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
762ad3cab52Sdrh     int jointype;     /* Type of join between this table and the next */
76363eb5f29Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
764ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
765ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
766113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
76775897234Sdrh };
76875897234Sdrh 
76975897234Sdrh /*
77001f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
77101f3f253Sdrh */
77201f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
77301f3f253Sdrh #define JT_NATURAL   0x0002    /* True for a "natural" join */
774195e6967Sdrh #define JT_LEFT      0x0004    /* Left outer join */
775195e6967Sdrh #define JT_RIGHT     0x0008    /* Right outer join */
77601f3f253Sdrh #define JT_OUTER     0x0010    /* The "OUTER" keyword is present */
77701f3f253Sdrh #define JT_ERROR     0x0020    /* unknown or unsupported join type */
77801f3f253Sdrh 
77901f3f253Sdrh /*
7806b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
7816b56344dSdrh ** structure contains a single instance of this structure.  This structure
7826b56344dSdrh ** is intended to be private the the where.c module and should not be
7836b56344dSdrh ** access or modified by other modules.
7846b56344dSdrh */
7856b56344dSdrh struct WhereLevel {
7866b56344dSdrh   int iMem;            /* Memory cell used by this level */
7876b56344dSdrh   Index *pIdx;         /* Index used */
7886b56344dSdrh   int iCur;            /* Cursor number used for this index */
789487ab3caSdrh   int score;           /* How well this indexed scored */
7906b56344dSdrh   int brk;             /* Jump here to break out of the loop */
7916b56344dSdrh   int cont;            /* Jump here to continue with the next loop cycle */
7926b56344dSdrh   int op, p1, p2;      /* Opcode used to terminate the loop */
793ad2d8307Sdrh   int iLeftJoin;       /* Memory cell used to implement LEFT OUTER JOIN */
794ad2d8307Sdrh   int top;             /* First instruction of interior of the loop */
795d99f7068Sdrh   int inOp, inP1, inP2;/* Opcode used to implement an IN operator */
796c045ec51Sdrh   int bRev;            /* Do the scan in the reverse direction */
7976b56344dSdrh };
7986b56344dSdrh 
7996b56344dSdrh /*
80075897234Sdrh ** The WHERE clause processing routine has two halves.  The
80175897234Sdrh ** first part does the start of the WHERE loop and the second
80275897234Sdrh ** half does the tail of the WHERE loop.  An instance of
80375897234Sdrh ** this structure is returned by the first half and passed
80475897234Sdrh ** into the second half to give some continuity.
80575897234Sdrh */
80675897234Sdrh struct WhereInfo {
80775897234Sdrh   Parse *pParse;
808ad3cab52Sdrh   SrcList *pTabList;   /* List of tables in the join */
80919a775c2Sdrh   int iContinue;       /* Jump here to continue with next record */
81019a775c2Sdrh   int iBreak;          /* Jump here to break out of the loop */
8116b56344dSdrh   int nLevel;          /* Number of nested loop */
812832508b7Sdrh   int savedNTab;       /* Value of pParse->nTab before WhereBegin() */
813832508b7Sdrh   int peakNTab;        /* Value of pParse->nTab after WhereBegin() */
8146b56344dSdrh   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
81575897234Sdrh };
81675897234Sdrh 
81775897234Sdrh /*
8189bb61fe7Sdrh ** An instance of the following structure contains all information
8199bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
820a76b5dfcSdrh **
821a76b5dfcSdrh ** The zSelect field is used when the Select structure must be persistent.
822a76b5dfcSdrh ** Normally, the expression tree points to tokens in the original input
823a76b5dfcSdrh ** string that encodes the select.  But if the Select structure must live
824a76b5dfcSdrh ** longer than its input string (for example when it is used to describe
825a76b5dfcSdrh ** a VIEW) we have to make a copy of the input string so that the nodes
826a76b5dfcSdrh ** of the expression tree will have something to point to.  zSelect is used
827a76b5dfcSdrh ** to hold that copy.
828d11d382cSdrh **
829d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
830d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
831d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
832d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
833d11d382cSdrh ** in the VDBE that record the limit and offset counters.
8349bb61fe7Sdrh */
8359bb61fe7Sdrh struct Select {
8369bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
8377b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
8387b58daeaSdrh   u8 isDistinct;         /* True if the DISTINCT keyword is present */
839ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
8409bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
8419bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
8429bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
8439bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
844967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
8459bbca4c1Sdrh   int nLimit, nOffset;   /* LIMIT and OFFSET values.  -1 means not used */
8467b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
847a76b5dfcSdrh   char *zSelect;         /* Complete text of the SELECT command */
8489bb61fe7Sdrh };
8499bb61fe7Sdrh 
8509bb61fe7Sdrh /*
851fef5208cSdrh ** The results of a select can be distributed in several ways.
852fef5208cSdrh */
853fef5208cSdrh #define SRT_Callback     1  /* Invoke a callback with each row of result */
854fef5208cSdrh #define SRT_Mem          2  /* Store result in a memory cell */
85582c3d636Sdrh #define SRT_Set          3  /* Store result as unique keys in a table */
85682c3d636Sdrh #define SRT_Union        5  /* Store result as keys in a table */
85782c3d636Sdrh #define SRT_Except       6  /* Remove result from a UNION table */
8585974a30fSdrh #define SRT_Table        7  /* Store result as data with a unique key */
8592d0794e3Sdrh #define SRT_TempTable    8  /* Store result in a trasient table */
860d7489c39Sdrh #define SRT_Discard      9  /* Do not save the results anywhere */
861f46f905aSdrh #define SRT_Sorter      10  /* Store results in the sorter */
862142e30dfSdrh #define SRT_Subroutine  11  /* Call a subroutine to handle results */
863fef5208cSdrh 
864fef5208cSdrh /*
8652282792aSdrh ** When a SELECT uses aggregate functions (like "count(*)" or "avg(f1)")
8662282792aSdrh ** we have to do some additional analysis of expressions.  An instance
8672282792aSdrh ** of the following structure holds information about a single subexpression
8682282792aSdrh ** somewhere in the SELECT statement.  An array of these structures holds
8692282792aSdrh ** all the information we need to generate code for aggregate
8702282792aSdrh ** expressions.
8712282792aSdrh **
8722282792aSdrh ** Note that when analyzing a SELECT containing aggregates, both
8732282792aSdrh ** non-aggregate field variables and aggregate functions are stored
8742282792aSdrh ** in the AggExpr array of the Parser structure.
8752282792aSdrh **
8762282792aSdrh ** The pExpr field points to an expression that is part of either the
8772282792aSdrh ** field list, the GROUP BY clause, the HAVING clause or the ORDER BY
8782282792aSdrh ** clause.  The expression will be freed when those clauses are cleaned
8792282792aSdrh ** up.  Do not try to delete the expression attached to AggExpr.pExpr.
8802282792aSdrh **
8812282792aSdrh ** If AggExpr.pExpr==0, that means the expression is "count(*)".
8822282792aSdrh */
8832282792aSdrh struct AggExpr {
8842282792aSdrh   int isAgg;        /* if TRUE contains an aggregate function */
8852282792aSdrh   Expr *pExpr;      /* The expression */
8860bce8354Sdrh   FuncDef *pFunc;   /* Information about the aggregate function */
8872282792aSdrh };
8882282792aSdrh 
8892282792aSdrh /*
890f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
891f57b3399Sdrh ** the parser and down into all the parser action routine in order to
892f57b3399Sdrh ** carry around information that is global to the entire parse.
89375897234Sdrh */
89475897234Sdrh struct Parse {
89575897234Sdrh   sqlite *db;          /* The main database structure */
8964c504391Sdrh   int rc;              /* Return code from execution */
89775897234Sdrh   char *zErrMsg;       /* An error message */
89875897234Sdrh   Token sErrToken;     /* The token at which the error occurred */
89975897234Sdrh   Token sFirstToken;   /* The first token parsed */
90075897234Sdrh   Token sLastToken;    /* The last token parsed */
901326dce74Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
90275897234Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
90375897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
904836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
905e0bc4048Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
906e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
907e0bc4048Sdrh   u8 useAgg;           /* If true, extract field values from the aggregator
908e0bc4048Sdrh                        ** while generating expressions.  Normally false */
90975897234Sdrh   int nErr;            /* Number of errors seen */
910832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
91119a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
912fef5208cSdrh   int nSet;            /* Number of sets used so far */
9132282792aSdrh   int nAgg;            /* Number of aggregate expressions */
9147c972decSdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
9152282792aSdrh   AggExpr *aAgg;       /* An array of aggregate expressions */
9165cf590c1Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
917f0f258b1Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
918f0f258b1Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
91975897234Sdrh };
92075897234Sdrh 
921d99bc930Sdanielk1977 /*
92285e2096fSdrh ** An instance of the following structure can be declared on a stack and used
92385e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
92485e2096fSdrh */
92585e2096fSdrh struct AuthContext {
92685e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
92785e2096fSdrh   Parse *pParse;              /* The Parse structure */
92885e2096fSdrh };
92985e2096fSdrh 
93085e2096fSdrh /*
931*b0c374ffSrdc ** Bitfield flags for P2 value in OP_PutIntKey and OP_Delete
932*b0c374ffSrdc */
933*b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
934*b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
935*b0c374ffSrdc #define OPFLAG_CSCHANGE  4    /* Set to update db->csChange */
936*b0c374ffSrdc 
937*b0c374ffSrdc /*
938d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
939d99bc930Sdanielk1977  * struct Trigger.
940d99bc930Sdanielk1977  *
941d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
942d99bc930Sdanielk1977  * 1. In the "trigHash" hash table (part of the sqlite* that represents the
943d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
944d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
945ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
946ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
947ad3cab52Sdrh  *    struct Table.
948d99bc930Sdanielk1977  *
949ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
950ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
951d99bc930Sdanielk1977  */
952d99bc930Sdanielk1977 struct Trigger {
953d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
954d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
955f0f258b1Sdrh   u8 iDb;                 /* Database containing this trigger               */
95679a519c0Sdrh   u8 iTabDb;              /* Database containing Trigger.table              */
957f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
958f0f258b1Sdrh   u8 tr_tm;               /* One of TK_BEFORE, TK_AFTER */
959d99bc930Sdanielk1977   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
960d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
961d99bc930Sdanielk1977                              the <column-list> is stored here */
962d99bc930Sdanielk1977   int foreach;            /* One of TK_ROW or TK_STATEMENT */
9634312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
964d99bc930Sdanielk1977 
965d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
966d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
967c3f9bad2Sdanielk1977 };
968d99bc930Sdanielk1977 
969d99bc930Sdanielk1977 /*
970d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
971d99bc930Sdanielk1977  * that is a part of a trigger-program.
972d99bc930Sdanielk1977  *
973d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
974d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
975d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
976d99bc930Sdanielk1977  * the first step of the trigger-program.
977d99bc930Sdanielk1977  *
978d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
979d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
980d99bc930Sdanielk1977  * value of "op" as follows:
981d99bc930Sdanielk1977  *
982d99bc930Sdanielk1977  * (op == TK_INSERT)
983d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
984d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
985d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
986d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
987d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
988d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
989d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
990ad3cab52Sdrh  *              statement, then this stores the column-names to be
991ad3cab52Sdrh  *              inserted into.
992d99bc930Sdanielk1977  *
993d99bc930Sdanielk1977  * (op == TK_DELETE)
994d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
995d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
996d99bc930Sdanielk1977  *              Otherwise NULL.
997d99bc930Sdanielk1977  *
998d99bc930Sdanielk1977  * (op == TK_UPDATE)
999d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
1000d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1001d99bc930Sdanielk1977  *              Otherwise NULL.
1002d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
1003ad3cab52Sdrh  *              them to. See sqliteUpdate() documentation of "pChanges"
1004ad3cab52Sdrh  *              argument.
1005d99bc930Sdanielk1977  *
1006d99bc930Sdanielk1977  */
1007c3f9bad2Sdanielk1977 struct TriggerStep {
1008c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1009d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
1010a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
1011c3f9bad2Sdanielk1977 
1012c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
1013c3f9bad2Sdanielk1977 			  INSERT steps (when pExprList == 0) */
1014c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1015c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1016c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1017c3f9bad2Sdanielk1977 			   INSERT steps (when pSelect == 0)         */
1018c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
1019c3f9bad2Sdanielk1977 
1020c3f9bad2Sdanielk1977   TriggerStep * pNext; /* Next in the link-list */
1021c3f9bad2Sdanielk1977 };
1022c3f9bad2Sdanielk1977 
1023d99bc930Sdanielk1977 /*
1024d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
1025d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
1026d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
1027d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
1028d99bc930Sdanielk1977  *
1029d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
1030d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
1031d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
1032d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1033d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1034d99bc930Sdanielk1977  *
1035d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
1036d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1037d99bc930Sdanielk1977  * specified for individual triggers steps is used.
1038d99bc930Sdanielk1977  *
1039d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1040d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
1041d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1042d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
1043d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
1044d99bc930Sdanielk1977  * trigger continues.
1045d99bc930Sdanielk1977  *
1046d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
1047d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1048d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
1049d99bc930Sdanielk1977  */
1050d99bc930Sdanielk1977 struct TriggerStack {
1051d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
1052d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1053d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
1054d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
10556f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1056e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
1057e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1058c3f9bad2Sdanielk1977 };
1059c3f9bad2Sdanielk1977 
1060d99bc930Sdanielk1977 /*
1061f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
1062f26e09c8Sdrh ** routines as they walk the parse tree to make database references
1063f26e09c8Sdrh ** explicit.
1064f26e09c8Sdrh */
1065f26e09c8Sdrh typedef struct DbFixer DbFixer;
1066f26e09c8Sdrh struct DbFixer {
1067f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
1068f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
1069f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
1070f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
1071f26e09c8Sdrh };
1072f26e09c8Sdrh 
1073f26e09c8Sdrh /*
1074d99bc930Sdanielk1977  * This global flag is set for performance testing of triggers. When it is set
1075d99bc930Sdanielk1977  * SQLite will perform the overhead of building new and old trigger references
1076d99bc930Sdanielk1977  * even when no triggers exist
1077d99bc930Sdanielk1977  */
1078c3f9bad2Sdanielk1977 extern int always_code_trigger_setup;
1079c3f9bad2Sdanielk1977 
108075897234Sdrh /*
108175897234Sdrh ** Internal function prototypes
108275897234Sdrh */
108375897234Sdrh int sqliteStrICmp(const char *, const char *);
108475897234Sdrh int sqliteStrNICmp(const char *, const char *, int);
108575897234Sdrh int sqliteHashNoCase(const char *, int);
1086bb07e9a3Sdrh int sqliteIsNumber(const char*);
108775897234Sdrh int sqliteCompare(const char *, const char *);
108875897234Sdrh int sqliteSortCompare(const char *, const char *);
10899bbca4c1Sdrh void sqliteRealToSortable(double r, char *);
1090dcc581ccSdrh #ifdef MEMORY_DEBUG
10918c1238aeSdrh   void *sqliteMalloc_(int,int,char*,int);
1092dcc581ccSdrh   void sqliteFree_(void*,char*,int);
1093dcc581ccSdrh   void *sqliteRealloc_(void*,int,char*,int);
10946e142f54Sdrh   char *sqliteStrDup_(const char*,char*,int);
10956e142f54Sdrh   char *sqliteStrNDup_(const char*, int,char*,int);
1096ed6c8671Sdrh   void sqliteCheckMemory(void*,int);
1097dcc581ccSdrh #else
109875897234Sdrh   void *sqliteMalloc(int);
10998c1238aeSdrh   void *sqliteMallocRaw(int);
110075897234Sdrh   void sqliteFree(void*);
110175897234Sdrh   void *sqliteRealloc(void*,int);
11026e142f54Sdrh   char *sqliteStrDup(const char*);
11036e142f54Sdrh   char *sqliteStrNDup(const char*, int);
1104ed6c8671Sdrh # define sqliteCheckMemory(a,b)
1105dcc581ccSdrh #endif
1106483750baSdrh char *sqliteMPrintf(const char *,...);
110775897234Sdrh void sqliteSetString(char **, const char *, ...);
110875897234Sdrh void sqliteSetNString(char **, ...);
1109da93d238Sdrh void sqliteErrorMsg(Parse*, const char*, ...);
1110982cef7eSdrh void sqliteDequote(char*);
111117f71934Sdrh int sqliteKeywordCode(const char*, int);
111280ff32f5Sdrh int sqliteRunParser(Parse*, const char*, char **);
111375897234Sdrh void sqliteExec(Parse*);
111475897234Sdrh Expr *sqliteExpr(int, Expr*, Expr*, Token*);
1115e1b6a5b8Sdrh void sqliteExprSpan(Expr*,Token*,Token*);
111675897234Sdrh Expr *sqliteExprFunction(ExprList*, Token*);
111775897234Sdrh void sqliteExprDelete(Expr*);
111875897234Sdrh ExprList *sqliteExprListAppend(ExprList*,Expr*,Token*);
111975897234Sdrh void sqliteExprListDelete(ExprList*);
1120e0bc4048Sdrh int sqliteInit(sqlite*, char**);
11211c2d8414Sdrh void sqlitePragma(Parse*,Token*,Token*,int);
11221c2d8414Sdrh void sqliteResetInternalSchema(sqlite*, int);
1123e0bc4048Sdrh void sqliteBeginParse(Parse*,int);
11245e00f6c7Sdrh void sqliteRollbackInternalChanges(sqlite*);
1125e0bc4048Sdrh void sqliteCommitInternalChanges(sqlite*);
1126969fa7c1Sdrh Table *sqliteResultSetOfSelect(Parse*,char*,Select*);
1127e0bc4048Sdrh void sqliteOpenMasterTable(Vdbe *v, int);
1128e5f9c644Sdrh void sqliteStartTable(Parse*,Token*,Token*,int,int);
112975897234Sdrh void sqliteAddColumn(Parse*,Token*);
11309cfcf5d4Sdrh void sqliteAddNotNull(Parse*, int);
11319cfcf5d4Sdrh void sqliteAddPrimaryKey(Parse*, IdList*, int);
1132382c0247Sdrh void sqliteAddColumnType(Parse*,Token*,Token*);
11337020f651Sdrh void sqliteAddDefaultValue(Parse*,Token*,int);
1134fcb78a49Sdrh int sqliteCollateType(const char*, int);
11358e2ca029Sdrh void sqliteAddCollateType(Parse*, int);
1136969fa7c1Sdrh void sqliteEndTable(Parse*,Token*,Select*);
11376276c1cbSdrh void sqliteCreateView(Parse*,Token*,Token*,Select*,int);
1138417be79cSdrh int sqliteViewGetColumnNames(Parse*,Table*);
11394ff6dfa7Sdrh void sqliteDropTable(Parse*, Token*, int);
114075897234Sdrh void sqliteDeleteTable(sqlite*, Table*);
1141113088ecSdrh void sqliteInsert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
114275897234Sdrh IdList *sqliteIdListAppend(IdList*, Token*);
1143ad2d8307Sdrh int sqliteIdListIndex(IdList*,const char*);
1144113088ecSdrh SrcList *sqliteSrcListAppend(SrcList*, Token*, Token*);
1145ad3cab52Sdrh void sqliteSrcListAddAlias(SrcList*, Token*);
11466a3ea0e6Sdrh void sqliteSrcListAssignCursors(Parse*, SrcList*);
114775897234Sdrh void sqliteIdListDelete(IdList*);
1148ad3cab52Sdrh void sqliteSrcListDelete(SrcList*);
11494925ca00Sdrh void sqliteCreateIndex(Parse*,Token*,SrcList*,IdList*,int,Token*,Token*);
1150d24cc427Sdrh void sqliteDropIndex(Parse*, SrcList*);
115138640e15Sdrh void sqliteAddKeyType(Vdbe*, ExprList*);
115238640e15Sdrh void sqliteAddIdxKeyType(Vdbe*, Index*);
11531b2e0329Sdrh int sqliteSelect(Parse*, Select*, int, int, Select*, int, int*);
1154ad3cab52Sdrh Select *sqliteSelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
11559bbca4c1Sdrh                         int,int,int);
11569bb61fe7Sdrh void sqliteSelectDelete(Select*);
1157ff78bd2fSdrh void sqliteSelectUnbind(Select*);
1158812d7a21Sdrh Table *sqliteSrcListLookup(Parse*, SrcList*);
11595cf590c1Sdrh int sqliteIsReadOnly(Parse*, Table*, int);
1160113088ecSdrh void sqliteDeleteFrom(Parse*, SrcList*, Expr*);
1161113088ecSdrh void sqliteUpdate(Parse*, SrcList*, ExprList*, Expr*, int);
11626a3ea0e6Sdrh WhereInfo *sqliteWhereBegin(Parse*, SrcList*, Expr*, int, ExprList**);
116375897234Sdrh void sqliteWhereEnd(WhereInfo*);
116475897234Sdrh void sqliteExprCode(Parse*, Expr*);
1165f5905aa7Sdrh void sqliteExprIfTrue(Parse*, Expr*, int, int);
1166f5905aa7Sdrh void sqliteExprIfFalse(Parse*, Expr*, int, int);
1167d24cc427Sdrh Table *sqliteFindTable(sqlite*,const char*, const char*);
1168a69d9168Sdrh Table *sqliteLocateTable(Parse*,const char*, const char*);
1169d24cc427Sdrh Index *sqliteFindIndex(sqlite*,const char*, const char*);
11706d4abfbeSdrh void sqliteUnlinkAndDeleteIndex(sqlite*,Index*);
1171d24cc427Sdrh void sqliteCopy(Parse*, SrcList*, Token*, Token*, int);
1172dce2cbe6Sdrh void sqliteVacuum(Parse*, Token*);
11736f8c91caSdrh int sqliteRunVacuum(char**, sqlite*);
1174e17a7e33Sdrh int sqliteGlobCompare(const unsigned char*,const unsigned char*);
1175dce2cbe6Sdrh int sqliteLikeCompare(const unsigned char*,const unsigned char*);
1176cce7d176Sdrh char *sqliteTableNameFromToken(Token*);
1177cce7d176Sdrh int sqliteExprCheck(Parse*, Expr*, int, int*);
1178c9b84a1fSdrh int sqliteExprType(Expr*);
1179d8bc7086Sdrh int sqliteExprCompare(Expr*, Expr*);
1180cce7d176Sdrh int sqliteFuncId(Token*);
11816a3ea0e6Sdrh int sqliteExprResolveIds(Parse*, SrcList*, ExprList*, Expr*);
11822282792aSdrh int sqliteExprAnalyzeAggregates(Parse*, Expr*);
1183d8bc7086Sdrh Vdbe *sqliteGetVdbe(Parse*);
1184bbd82df6Sdrh void sqliteRandomness(int, void*);
1185001bbcbbSdrh void sqliteRollbackAll(sqlite*);
11868bf8dc92Sdrh void sqliteCodeVerifySchema(Parse*, int);
11871c92853dSdrh void sqliteBeginTransaction(Parse*, int);
1188c4a3c779Sdrh void sqliteCommitTransaction(Parse*);
1189c4a3c779Sdrh void sqliteRollbackTransaction(Parse*);
11909208643dSdrh int sqliteExprIsConstant(Expr*);
1191e4de1febSdrh int sqliteExprIsInteger(Expr*, int*);
1192a9f9d1c0Sdrh int sqliteIsRowid(const char*);
119338640e15Sdrh void sqliteGenerateRowDelete(sqlite*, Vdbe*, Table*, int, int);
119438640e15Sdrh void sqliteGenerateRowIndexDelete(sqlite*, Vdbe*, Table*, int, char*);
11950ca3e24bSdrh void sqliteGenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
119670ce3f0cSdrh void sqliteCompleteInsertion(Parse*, Table*, int, char*, int, int, int);
1197cabb0819Sdrh void sqliteBeginWriteOperation(Parse*, int, int);
11981c92853dSdrh void sqliteEndWriteOperation(Parse*);
1199ff78bd2fSdrh Expr *sqliteExprDup(Expr*);
12004b59ab5eSdrh void sqliteTokenCopy(Token*, Token*);
1201ff78bd2fSdrh ExprList *sqliteExprListDup(ExprList*);
1202ad3cab52Sdrh SrcList *sqliteSrcListDup(SrcList*);
1203ff78bd2fSdrh IdList *sqliteIdListDup(IdList*);
1204ff78bd2fSdrh Select *sqliteSelectDup(Select*);
12050bce8354Sdrh FuncDef *sqliteFindFunction(sqlite*,const char*,int,int,int);
120628f4b688Sdrh void sqliteRegisterBuiltinFunctions(sqlite*);
12077014aff3Sdrh void sqliteRegisterDateTimeFunctions(sqlite*);
1208247be43dSdrh int sqliteSafetyOn(sqlite*);
1209247be43dSdrh int sqliteSafetyOff(sqlite*);
1210c22bd47dSdrh int sqliteSafetyCheck(sqlite*);
1211e0bc4048Sdrh void sqliteChangeCookie(sqlite*, Vdbe*);
1212f0f258b1Sdrh void sqliteBeginTrigger(Parse*, Token*,int,int,IdList*,SrcList*,int,Expr*,int);
1213f0f258b1Sdrh void sqliteFinishTrigger(Parse*, TriggerStep*, Token*);
121479a519c0Sdrh void sqliteDropTrigger(Parse*, SrcList*);
121579a519c0Sdrh void sqliteDropTriggerPtr(Parse*, Trigger*, int);
1216dc379456Sdrh int sqliteTriggersExist(Parse* , Trigger* , int , int , int, ExprList*);
12176f34903eSdanielk1977 int sqliteCodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
12186f34903eSdanielk1977                          int, int);
1219dc379456Sdrh void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1220f0f258b1Sdrh void sqliteDeleteTriggerStep(TriggerStep*);
1221dc379456Sdrh TriggerStep *sqliteTriggerSelectStep(Select*);
1222dc379456Sdrh TriggerStep *sqliteTriggerInsertStep(Token*, IdList*, ExprList*, Select*, int);
1223dc379456Sdrh TriggerStep *sqliteTriggerUpdateStep(Token*, ExprList*, Expr*, int);
1224dc379456Sdrh TriggerStep *sqliteTriggerDeleteStep(Token*, Expr*);
12251d1f3055Sdrh void sqliteDeleteTrigger(Trigger*);
122601f3f253Sdrh int sqliteJoinType(Parse*, Token*, Token*, Token*);
1227c2eef3b3Sdrh void sqliteCreateForeignKey(Parse*, IdList*, Token*, IdList*, int);
1228c2eef3b3Sdrh void sqliteDeferForeignKey(Parse*, int);
1229ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
12306a3ea0e6Sdrh   void sqliteAuthRead(Parse*,Expr*,SrcList*);
1231e22a334bSdrh   int sqliteAuthCheck(Parse*,int, const char*, const char*, const char*);
123285e2096fSdrh   void sqliteAuthContextPush(Parse*, AuthContext*, const char*);
123385e2096fSdrh   void sqliteAuthContextPop(AuthContext*);
1234ed6c8671Sdrh #else
12356a3ea0e6Sdrh # define sqliteAuthRead(a,b,c)
12367a73eb48Sdrh # define sqliteAuthCheck(a,b,c,d,e)    SQLITE_OK
123785e2096fSdrh # define sqliteAuthContextPush(a,b,c)
12387a73eb48Sdrh # define sqliteAuthContextPop(a)  ((void)(a))
1239ed6c8671Sdrh #endif
12404d189ca4Sdrh void sqliteAttach(Parse*, Token*, Token*, Token*);
12411c2d8414Sdrh void sqliteDetach(Parse*, Token*);
1242bb07e9a3Sdrh int sqliteBtreeFactory(const sqlite *db, const char *zFilename,
1243bb07e9a3Sdrh                        int mode, int nPg, Btree **ppBtree);
1244f26e09c8Sdrh int sqliteFixInit(DbFixer*, Parse*, int, const char*, const Token*);
1245f26e09c8Sdrh int sqliteFixSrcList(DbFixer*, SrcList*);
1246f26e09c8Sdrh int sqliteFixSelect(DbFixer*, Select*);
1247f26e09c8Sdrh int sqliteFixExpr(DbFixer*, Expr*);
1248f26e09c8Sdrh int sqliteFixExprList(DbFixer*, ExprList*);
1249f26e09c8Sdrh int sqliteFixTriggerStep(DbFixer*, TriggerStep*);
125093a5c6bdSdrh double sqliteAtoF(const char *z);
125193a5c6bdSdrh int sqlite_snprintf(int,char*,const char*,...);
1252202b2df7Sdrh int sqliteFitsIn32Bits(const char *);
1253