xref: /sqlite-3.40.0/src/sqliteInt.h (revision a34b6764)
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*a34b6764Sdrh ** @(#) $Id: sqliteInt.h,v 1.223 2004/05/07 13:30:42 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*a34b6764Sdrh #ifndef INT64_TYPE
99*a34b6764Sdrh # define INT64_TYPE long long int
100*a34b6764Sdrh #endif
1013aac2dd7Sdrh #ifndef UINT64_TYPE
1023aac2dd7Sdrh # define UINT64_TYPE unsigned long long int
1033aac2dd7Sdrh #endif
1045a2c2c20Sdrh #ifndef UINT32_TYPE
1055a2c2c20Sdrh # define UINT32_TYPE unsigned int
1065a2c2c20Sdrh #endif
1075a2c2c20Sdrh #ifndef UINT16_TYPE
1085a2c2c20Sdrh # define UINT16_TYPE unsigned short int
1095a2c2c20Sdrh #endif
1105a2c2c20Sdrh #ifndef UINT8_TYPE
1115a2c2c20Sdrh # define UINT8_TYPE unsigned char
1125a2c2c20Sdrh #endif
113905793e2Sdrh #ifndef INT8_TYPE
114905793e2Sdrh # define INT8_TYPE signed char
115905793e2Sdrh #endif
1165a2c2c20Sdrh #ifndef INTPTR_TYPE
11758f391b3Sdrh # if SQLITE_PTR_SZ==4
1185a2c2c20Sdrh #   define INTPTR_TYPE int
11958f391b3Sdrh # else
12058f391b3Sdrh #   define INTPTR_TYPE long long
12158f391b3Sdrh # endif
1225a2c2c20Sdrh #endif
1233aac2dd7Sdrh typedef UINT64_TYPE u64;           /* 8-byte unsigned integer */
1245a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
1255a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
1265a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
127905793e2Sdrh typedef UINT8_TYPE i8;             /* 1-byte signed integer */
1285a2c2c20Sdrh typedef INTPTR_TYPE ptr;           /* Big enough to hold a pointer */
1295a2c2c20Sdrh typedef unsigned INTPTR_TYPE uptr; /* Big enough to hold a pointer */
1305a2c2c20Sdrh 
1315a2c2c20Sdrh /*
132905793e2Sdrh ** Defer sourcing vdbe.h until after the "u8" typedef is defined.
133905793e2Sdrh */
134905793e2Sdrh #include "vdbe.h"
1353aac2dd7Sdrh #include "btree.h"
136905793e2Sdrh 
137905793e2Sdrh /*
138384eef32Sdrh ** Most C compilers these days recognize "long double", don't they?
139384eef32Sdrh ** Just in case we encounter one that does not, we will create a macro
140384eef32Sdrh ** for long double so that it can be easily changed to just "double".
141384eef32Sdrh */
142384eef32Sdrh #ifndef LONGDOUBLE_TYPE
143384eef32Sdrh # define LONGDOUBLE_TYPE long double
144384eef32Sdrh #endif
145384eef32Sdrh 
146384eef32Sdrh /*
1475a2c2c20Sdrh ** This macro casts a pointer to an integer.  Useful for doing
1485a2c2c20Sdrh ** pointer arithmetic.
1495a2c2c20Sdrh */
1505a2c2c20Sdrh #define Addr(X)  ((uptr)X)
15141a2b48bSdrh 
15241a2b48bSdrh /*
153872ff86fSdrh ** The maximum number of bytes of data that can be put into a single
15480ff32f5Sdrh ** row of a single table.  The upper bound on this limit is 16777215
15580ff32f5Sdrh ** bytes (or 16MB-1).  We have arbitrarily set the limit to just 1MB
15680ff32f5Sdrh ** here because the overflow page chain is inefficient for really big
15780ff32f5Sdrh ** records and we want to discourage people from thinking that
15880ff32f5Sdrh ** multi-megabyte records are OK.  If your needs are different, you can
15980ff32f5Sdrh ** change this define and recompile to increase or decrease the record
16080ff32f5Sdrh ** size.
1619ac717d7Sdrh **
1629ac717d7Sdrh ** The 16777198 is computed as follows:  238 bytes of payload on the
1639ac717d7Sdrh ** original pages plus 16448 overflow pages each holding 1020 bytes of
1649ac717d7Sdrh ** data.
165872ff86fSdrh */
1668372b8d1Sdrh #define MAX_BYTES_PER_ROW  1048576
1678372b8d1Sdrh /* #define MAX_BYTES_PER_ROW 16777198 */
168872ff86fSdrh 
169872ff86fSdrh /*
170967e8b73Sdrh ** If memory allocation problems are found, recompile with
171967e8b73Sdrh **
172967e8b73Sdrh **      -DMEMORY_DEBUG=1
173967e8b73Sdrh **
174967e8b73Sdrh ** to enable some sanity checking on malloc() and free().  To
175967e8b73Sdrh ** check for memory leaks, recompile with
176967e8b73Sdrh **
177967e8b73Sdrh **      -DMEMORY_DEBUG=2
178967e8b73Sdrh **
179967e8b73Sdrh ** and a line of text will be written to standard error for
180967e8b73Sdrh ** each malloc() and free().  This output can be analyzed
181967e8b73Sdrh ** by an AWK script to determine if there are any leaks.
182967e8b73Sdrh */
183dcc581ccSdrh #ifdef MEMORY_DEBUG
1848c1238aeSdrh # define sqliteMalloc(X)    sqliteMalloc_(X,1,__FILE__,__LINE__)
1858c1238aeSdrh # define sqliteMallocRaw(X) sqliteMalloc_(X,0,__FILE__,__LINE__)
186dcc581ccSdrh # define sqliteFree(X)      sqliteFree_(X,__FILE__,__LINE__)
187dcc581ccSdrh # define sqliteRealloc(X,Y) sqliteRealloc_(X,Y,__FILE__,__LINE__)
1886e142f54Sdrh # define sqliteStrDup(X)    sqliteStrDup_(X,__FILE__,__LINE__)
1896e142f54Sdrh # define sqliteStrNDup(X,Y) sqliteStrNDup_(X,Y,__FILE__,__LINE__)
190c3c2fc9aSdrh   void sqliteStrRealloc(char**);
191c3c2fc9aSdrh #else
1925f968436Sdrh # define sqliteRealloc_(X,Y) sqliteRealloc(X,Y)
193c3c2fc9aSdrh # define sqliteStrRealloc(X)
194dcc581ccSdrh #endif
195dcc581ccSdrh 
19675897234Sdrh /*
197daffd0e5Sdrh ** This variable gets set if malloc() ever fails.  After it gets set,
198daffd0e5Sdrh ** the SQLite library shuts down permanently.
199daffd0e5Sdrh */
200daffd0e5Sdrh extern int sqlite_malloc_failed;
201daffd0e5Sdrh 
202daffd0e5Sdrh /*
2036e142f54Sdrh ** The following global variables are used for testing and debugging
2048c82b350Sdrh ** only.  They only work if MEMORY_DEBUG is defined.
2056e142f54Sdrh */
2066e142f54Sdrh #ifdef MEMORY_DEBUG
2078c82b350Sdrh extern int sqlite_nMalloc;       /* Number of sqliteMalloc() calls */
2088c82b350Sdrh extern int sqlite_nFree;         /* Number of sqliteFree() calls */
2098c82b350Sdrh extern int sqlite_iMallocFail;   /* Fail sqliteMalloc() after this many calls */
2106e142f54Sdrh #endif
2116e142f54Sdrh 
2126e142f54Sdrh /*
21375897234Sdrh ** Name of the master database table.  The master database table
21475897234Sdrh ** is a special table that holds the names and attributes of all
21575897234Sdrh ** user tables and indices.
21675897234Sdrh */
21775897234Sdrh #define MASTER_NAME       "sqlite_master"
218e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
21975897234Sdrh 
22075897234Sdrh /*
221ed6c8671Sdrh ** The name of the schema table.
222ed6c8671Sdrh */
223ed6c8671Sdrh #define SCHEMA_TABLE(x)  (x?TEMP_MASTER_NAME:MASTER_NAME)
224ed6c8671Sdrh 
225ed6c8671Sdrh /*
22675897234Sdrh ** A convenience macro that returns the number of elements in
22775897234Sdrh ** an array.
22875897234Sdrh */
22975897234Sdrh #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
23075897234Sdrh 
23175897234Sdrh /*
23275897234Sdrh ** Forward references to structures
23375897234Sdrh */
2347020f651Sdrh typedef struct Column Column;
23575897234Sdrh typedef struct Table Table;
23675897234Sdrh typedef struct Index Index;
23775897234Sdrh typedef struct Instruction Instruction;
23875897234Sdrh typedef struct Expr Expr;
23975897234Sdrh typedef struct ExprList ExprList;
24075897234Sdrh typedef struct Parse Parse;
24175897234Sdrh typedef struct Token Token;
24275897234Sdrh typedef struct IdList IdList;
243ad3cab52Sdrh typedef struct SrcList SrcList;
24475897234Sdrh typedef struct WhereInfo WhereInfo;
2456b56344dSdrh typedef struct WhereLevel WhereLevel;
2469bb61fe7Sdrh typedef struct Select Select;
2472282792aSdrh typedef struct AggExpr AggExpr;
2480bce8354Sdrh typedef struct FuncDef FuncDef;
249c3f9bad2Sdanielk1977 typedef struct Trigger Trigger;
250c3f9bad2Sdanielk1977 typedef struct TriggerStep TriggerStep;
251c3f9bad2Sdanielk1977 typedef struct TriggerStack TriggerStack;
252c2eef3b3Sdrh typedef struct FKey FKey;
253001bbcbbSdrh typedef struct Db Db;
25485e2096fSdrh typedef struct AuthContext AuthContext;
255001bbcbbSdrh 
256001bbcbbSdrh /*
257001bbcbbSdrh ** Each database file to be accessed by the system is an instance
258001bbcbbSdrh ** of the following structure.  There are normally two of these structures
259001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
260a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
261a69d9168Sdrh ** databases may be attached.
262001bbcbbSdrh */
263001bbcbbSdrh struct Db {
264001bbcbbSdrh   char *zName;         /* Name of this database */
265001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
266001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
267d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
268d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
269d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
270d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
2711aa4965aSdrh   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
272d24cc427Sdrh   u16 flags;           /* Flags associated with this database */
2734d189ca4Sdrh   void *pAux;          /* Auxiliary data.  Usually NULL */
2744d189ca4Sdrh   void (*xFreeAux)(void*);  /* Routine to free pAux */
275001bbcbbSdrh };
27675897234Sdrh 
27775897234Sdrh /*
2788bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
2798bf8dc92Sdrh ** Db.flags field.
2808bf8dc92Sdrh */
2818bf8dc92Sdrh #define DbHasProperty(D,I,P)     (((D)->aDb[I].flags&(P))==(P))
2828bf8dc92Sdrh #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].flags&(P))!=0)
2838bf8dc92Sdrh #define DbSetProperty(D,I,P)     (D)->aDb[I].flags|=(P)
2848bf8dc92Sdrh #define DbClearProperty(D,I,P)   (D)->aDb[I].flags&=~(P)
2858bf8dc92Sdrh 
2868bf8dc92Sdrh /*
2878bf8dc92Sdrh ** Allowed values for the DB.flags field.
2888bf8dc92Sdrh **
2898bf8dc92Sdrh ** The DB_Locked flag is set when the first OP_Transaction or OP_Checkpoint
2908bf8dc92Sdrh ** opcode is emitted for a database.  This prevents multiple occurances
2918bf8dc92Sdrh ** of those opcodes for the same database in the same program.  Similarly,
2928bf8dc92Sdrh ** the DB_Cookie flag is set when the OP_VerifyCookie opcode is emitted,
2938bf8dc92Sdrh ** and prevents duplicate OP_VerifyCookies from taking up space and slowing
2948bf8dc92Sdrh ** down execution.
2958bf8dc92Sdrh **
2968bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
2978bf8dc92Sdrh ** read into internal hash tables.
2988bf8dc92Sdrh **
2998bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
3008bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
3018bf8dc92Sdrh ** changes and so the view will need to be reset.
3028bf8dc92Sdrh */
3038bf8dc92Sdrh #define DB_Locked          0x0001  /* OP_Transaction opcode has been emitted */
3048bf8dc92Sdrh #define DB_Cookie          0x0002  /* OP_VerifyCookie opcode has been emiited */
3058bf8dc92Sdrh #define DB_SchemaLoaded    0x0004  /* The schema has been loaded */
3068bf8dc92Sdrh #define DB_UnresetViews    0x0008  /* Some views have defined column names */
3078bf8dc92Sdrh 
3088bf8dc92Sdrh 
3098bf8dc92Sdrh /*
310c9b84a1fSdrh ** Each database is an instance of the following structure.
311c9b84a1fSdrh **
312c9b84a1fSdrh ** The sqlite.file_format is initialized by the database file
313c9b84a1fSdrh ** and helps determines how the data in the database file is
314c9b84a1fSdrh ** represented.  This field allows newer versions of the library
315c9b84a1fSdrh ** to read and write older databases.  The various file formats
316c9b84a1fSdrh ** are as follows:
317c9b84a1fSdrh **
318c9b84a1fSdrh **     file_format==1    Version 2.1.0.
319c9b84a1fSdrh **     file_format==2    Version 2.2.0. Add support for INTEGER PRIMARY KEY.
320491791a8Sdrh **     file_format==3    Version 2.6.0. Fix empty-string index bug.
321491791a8Sdrh **     file_format==4    Version 2.7.0. Add support for separate numeric and
322c9b84a1fSdrh **                       text datatypes.
32313bff815Sdrh **
32413bff815Sdrh ** The sqlite.temp_store determines where temporary database files
32513bff815Sdrh ** are stored.  If 1, then a file is created to hold those tables.  If
32613bff815Sdrh ** 2, then they are held in memory.  0 means use the default value in
32713bff815Sdrh ** the TEMP_STORE macro.
328b0c374ffSrdc **
329b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
330b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
331b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
332b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
333b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
334b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
335b0c374ffSrdc **
336b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
337b0c374ffSrdc ** context.  It is reset at start of sqlite_exec.
338b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
339b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
340b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
341b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
342b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
343b0c374ffSrdc ** affect the value of lsChange.
344b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
345b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
34675897234Sdrh */
34775897234Sdrh struct sqlite {
348001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
349001bbcbbSdrh   Db *aDb;                      /* All backends */
350001bbcbbSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
3518c82b350Sdrh   int flags;                    /* Miscellanous flags. See below */
352973b6e33Sdrh   u8 file_format;               /* What file format version is this database? */
353973b6e33Sdrh   u8 safety_level;              /* How aggressive at synching data to disk */
35494e92032Sdrh   u8 want_to_close;             /* Close after all VDBEs are deallocated */
3551d85d931Sdrh   u8 temp_store;                /* 1=file, 2=memory, 0=compile-time default */
3561d85d931Sdrh   u8 onError;                   /* Default conflict algorithm */
357001bbcbbSdrh   int next_cookie;              /* Next value of aDb[0].schema_cookie */
358cd61c281Sdrh   int cache_size;               /* Number of pages to use in the cache */
3592803757aSdrh   int nTable;                   /* Number of tables in the database */
3602dfbbcafSdrh   void *pBusyArg;               /* 1st Argument to the busy callback */
361353f57e0Sdrh   int (*xBusyCallback)(void *,const char*,int);  /* The busy callback */
362aa940eacSdrh   void *pCommitArg;             /* Argument to xCommitCallback() */
363aa940eacSdrh   int (*xCommitCallback)(void*);/* Invoked at every commit. */
3640bce8354Sdrh   Hash aFunc;                   /* All functions that can be in SQL exprs */
365b0c374ffSrdc   int lastRowid;                /* ROWID of most recent insert (see above) */
3665cf8e8c7Sdrh   int priorNewRowid;            /* Last randomly generated ROWID */
367247be43dSdrh   int magic;                    /* Magic number for detect library misuse */
368b0c374ffSrdc   int nChange;                  /* Number of rows changed (see above) */
369b0c374ffSrdc   int lsChange;                 /* Last statement change count (see above) */
370b0c374ffSrdc   int csChange;                 /* Current statement change count (see above) */
3711d85d931Sdrh   struct sqliteInitInfo {       /* Information used during initialization */
3721d85d931Sdrh     int iDb;                       /* When back is being initialized */
3731d85d931Sdrh     int newTnum;                   /* Rootpage of table being initialized */
3741d85d931Sdrh     u8 busy;                       /* TRUE if currently initializing */
3751d85d931Sdrh   } init;
376326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
37718de4824Sdrh   void (*xTrace)(void*,const char*);     /* Trace function */
37818de4824Sdrh   void *pTraceArg;                       /* Argument to the trace function */
379ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
380e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
381e22a334bSdrh                                 /* Access authorization function */
382ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
383ed6c8671Sdrh #endif
384348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
385348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
386348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
387348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
388348bb5d6Sdanielk1977 #endif
38975897234Sdrh };
39075897234Sdrh 
39175897234Sdrh /*
3928bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
3938bf8dc92Sdrh **
3948bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
3958bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
3968bf8dc92Sdrh ** transaction is active on that particular database file.
39775897234Sdrh */
3984c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
3994c504391Sdrh #define SQLITE_Initialized    0x00000002  /* True after initialization */
4004c504391Sdrh #define SQLITE_Interrupt      0x00000004  /* Cancel current operation */
401c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
4025e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
403382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
404fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
405fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
4061bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
4071bee3d7bSdrh                                           /*   the count using a callback. */
408fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
4096a535340Sdrh                                           /*   result set is empty */
4108bf8dc92Sdrh #define SQLITE_ReportTypes    0x00000200  /* Include information on datatypes */
4115080aaa7Sdrh                                           /*   in 4th argument of callback */
41258b9576bSdrh 
41358b9576bSdrh /*
414247be43dSdrh ** Possible values for the sqlite.magic field.
415247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
416247be43dSdrh ** than being distinct from one another.
417247be43dSdrh */
418247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
419247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
420247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
421247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
422247be43dSdrh 
423247be43dSdrh /*
4240bce8354Sdrh ** Each SQL function is defined by an instance of the following
4250bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
4268e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
4278e0a2f90Sdrh ** points to a linked list of these structures.
4282803757aSdrh */
4290bce8354Sdrh struct FuncDef {
4301350b030Sdrh   void (*xFunc)(sqlite_func*,int,const char**);  /* Regular function */
43156c0e926Sdrh   void (*xStep)(sqlite_func*,int,const char**);  /* Aggregate function step */
4321350b030Sdrh   void (*xFinalize)(sqlite_func*);           /* Aggregate function finializer */
433268380caSdrh   signed char nArg;         /* Number of arguments.  -1 means unlimited */
434268380caSdrh   signed char dataType;     /* Arg that determines datatype.  -1=NUMERIC, */
435268380caSdrh                             /* -2=TEXT. -3=SQLITE_ARGS */
436268380caSdrh   u8 includeTypes;          /* Add datatypes to args of xFunc and xStep */
4371350b030Sdrh   void *pUserData;          /* User data parameter */
4380bce8354Sdrh   FuncDef *pNext;           /* Next function with same name */
4398e0a2f90Sdrh };
4402803757aSdrh 
4412803757aSdrh /*
442967e8b73Sdrh ** information about each column of an SQL table is held in an instance
4437020f651Sdrh ** of this structure.
4447020f651Sdrh */
4457020f651Sdrh struct Column {
4467020f651Sdrh   char *zName;     /* Name of this column */
4477020f651Sdrh   char *zDflt;     /* Default value of this column */
448382c0247Sdrh   char *zType;     /* Data type for this column */
4494a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
45078100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
4518e2ca029Sdrh   u8 sortOrder;    /* Some combination of SQLITE_SO_... values */
452fcabd464Sdrh   u8 dottedName;   /* True if zName contains a "." character */
4537020f651Sdrh };
4547020f651Sdrh 
4557020f651Sdrh /*
4568e2ca029Sdrh ** The allowed sort orders.
4578e2ca029Sdrh **
4588e2ca029Sdrh ** The TEXT and NUM values use bits that do not overlap with DESC and ASC.
4598e2ca029Sdrh ** That way the two can be combined into a single number.
4608e2ca029Sdrh */
4618e2ca029Sdrh #define SQLITE_SO_UNK       0  /* Use the default collating type.  (SCT_NUM) */
4628e2ca029Sdrh #define SQLITE_SO_TEXT      2  /* Sort using memcmp() */
4638e2ca029Sdrh #define SQLITE_SO_NUM       4  /* Sort using sqliteCompare() */
4648e2ca029Sdrh #define SQLITE_SO_TYPEMASK  6  /* Mask to extract the collating sequence */
4658e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
4668e2ca029Sdrh #define SQLITE_SO_DESC      1  /* Sort in descending order */
4678e2ca029Sdrh #define SQLITE_SO_DIRMASK   1  /* Mask to extract the sort direction */
4688e2ca029Sdrh 
4698e2ca029Sdrh /*
47022f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
47122f70c32Sdrh ** following structure.
47222f70c32Sdrh **
473d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
47422f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
47522f70c32Sdrh ** comparisons.
47622f70c32Sdrh **
477d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
47822f70c32Sdrh ** pointer to an array of Column structures, one for each column.
47922f70c32Sdrh **
480d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
481d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
48222f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
48322f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
48422f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
485d24cc427Sdrh ** is generated for each row of the table.  Table.hasPrimKey is true if
48622f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
48722f70c32Sdrh **
488d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
489d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
490d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
491d24cc427Sdrh ** holds temporary tables and indices.  If Table.isTransient
49222f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted
493d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
49422f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
49522f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
49622f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
49722f70c32Sdrh ** of a SELECT statement.
49875897234Sdrh */
49975897234Sdrh struct Table {
50075897234Sdrh   char *zName;     /* Name of the table */
50175897234Sdrh   int nCol;        /* Number of columns in this table */
5027020f651Sdrh   Column *aCol;    /* Information about each column */
503c8392586Sdrh   int iPKey;       /* If not less then 0, use aCol[iPKey] as the primary key */
504967e8b73Sdrh   Index *pIndex;   /* List of SQL indexes on this table. */
50522f70c32Sdrh   int tnum;        /* Root BTree node for this table (see note above) */
506a76b5dfcSdrh   Select *pSelect; /* NULL for tables.  Points to definition if a view. */
507717e6402Sdrh   u8 readOnly;     /* True if this table should not be written by the user */
508d24cc427Sdrh   u8 iDb;          /* Index into sqlite.aDb[] of the backend for this table */
50922f70c32Sdrh   u8 isTransient;  /* True if automatically deleted when VDBE finishes */
5104a32431cSdrh   u8 hasPrimKey;   /* True if there exists a primary key */
5119cfcf5d4Sdrh   u8 keyConf;      /* What to do in case of uniqueness conflict on iPKey */
512c3f9bad2Sdanielk1977   Trigger *pTrigger; /* List of SQL triggers on this table */
513c2eef3b3Sdrh   FKey *pFKey;       /* Linked list of all foreign keys in this table */
51475897234Sdrh };
51575897234Sdrh 
51675897234Sdrh /*
517c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
518c2eef3b3Sdrh **
519c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
520c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
521c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
522c2eef3b3Sdrh ** Consider this example:
523c2eef3b3Sdrh **
524c2eef3b3Sdrh **     CREATE TABLE ex1(
525c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
526c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
527c2eef3b3Sdrh **     );
528c2eef3b3Sdrh **
529c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
530c2eef3b3Sdrh **
531c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
532c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
533c2eef3b3Sdrh ** the from-table is created.  The existance of the to-table is not checked
534c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
535c2eef3b3Sdrh **
536ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
537c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
538c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
539c2eef3b3Sdrh ** field.
540c2eef3b3Sdrh */
541c2eef3b3Sdrh struct FKey {
542c2eef3b3Sdrh   Table *pFrom;     /* The table that constains the REFERENCES clause */
543c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
544c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
545c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
546c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
547c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
548c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
549c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
550c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
551c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
552c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
553c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
554c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
555c2eef3b3Sdrh };
556c2eef3b3Sdrh 
557c2eef3b3Sdrh /*
558c2eef3b3Sdrh ** SQLite supports many different ways to resolve a contraint
55922f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
5600bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
5611c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
5621c92853dSdrh ** fails and any prior changes from that one operation are backed out,
5631c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
5641c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
5651c92853dSdrh ** changes due to the same operation are not backed out and no rollback
5661c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
5671c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
5681c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
5691c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
5701c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
5711c92853dSdrh **
572c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
573c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
574c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
575c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
576c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
577c2eef3b3Sdrh ** foreign key.
578c2eef3b3Sdrh **
579968af52aSdrh ** The following symbolic values are used to record which type
5801c92853dSdrh ** of action to take.
5819cfcf5d4Sdrh */
5829cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
5831c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
5841c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
5851c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
5861c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
5871c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
588c2eef3b3Sdrh 
589c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
590c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
591c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
592c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
593c2eef3b3Sdrh 
594c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
5959cfcf5d4Sdrh 
5969cfcf5d4Sdrh /*
59766b89c8fSdrh ** Each SQL index is represented in memory by an
59875897234Sdrh ** instance of the following structure.
599967e8b73Sdrh **
600967e8b73Sdrh ** The columns of the table that are to be indexed are described
601967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
602967e8b73Sdrh ** we have the following table and index:
603967e8b73Sdrh **
604967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
605967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
606967e8b73Sdrh **
607967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
608967e8b73Sdrh ** three columns in the table.  In the Index structure describing
609967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
610967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
611967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
612967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
613967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
614ea1ba17cSdrh **
615ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
616ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
617ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
618ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
619ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
620ea1ba17cSdrh ** element.
62175897234Sdrh */
62275897234Sdrh struct Index {
62375897234Sdrh   char *zName;     /* Name of this index */
624967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
625967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
626967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
627be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
6289cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
629485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
630d24cc427Sdrh   u8 iDb;          /* Index in sqlite.aDb[] of where this index is stored */
63175897234Sdrh   Index *pNext;    /* The next index associated with the same table */
63275897234Sdrh };
63375897234Sdrh 
63475897234Sdrh /*
63575897234Sdrh ** Each token coming out of the lexer is an instance of
6364b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
6374efc4754Sdrh **
6384efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
6394efc4754Sdrh ** may contain random values.  Do not make any assuptions about Token.dyn
6404efc4754Sdrh ** and Token.n when Token.z==0.
64175897234Sdrh */
64275897234Sdrh struct Token {
64380ff32f5Sdrh   const char *z;      /* Text of the token.  Not NULL-terminated! */
6444b59ab5eSdrh   unsigned dyn  : 1;  /* True for malloced memory, false for static */
6456977fea8Sdrh   unsigned n    : 31; /* Number of characters in this token */
64675897234Sdrh };
64775897234Sdrh 
64875897234Sdrh /*
64975897234Sdrh ** Each node of an expression in the parse tree is an instance
65022f70c32Sdrh ** of this structure.
65122f70c32Sdrh **
65222f70c32Sdrh ** Expr.op is the opcode.  The integer parser token codes are reused
65322f70c32Sdrh ** as opcodes here.  For example, the parser defines TK_GE to be an integer
65422f70c32Sdrh ** code representing the ">=" operator.  This same integer code is reused
65522f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
65622f70c32Sdrh ** tree.
65722f70c32Sdrh **
65822f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
65922f70c32Sdrh ** of argument if the expression is a function.
66022f70c32Sdrh **
6614b59ab5eSdrh ** Expr.token is the operator token for this node.  For some expressions
6624b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave
6634b59ab5eSdrh ** rise to the Expr.  In the latter case, the token is marked as being
6644b59ab5eSdrh ** a compound token.
66522f70c32Sdrh **
66622f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
66722f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
66822f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
66922f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
67022f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
67122f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
67222f70c32Sdrh ** it can be accessed after all aggregates are computed.
67322f70c32Sdrh **
67422f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code
6757c972decSdrh ** representing which function.  If the expression is an unbound variable
6767c972decSdrh ** marker (a question mark character '?' in the original SQL) then the
6777c972decSdrh ** Expr.iTable holds the index number for that variable.
67822f70c32Sdrh **
67922f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
68022f70c32Sdrh ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
68122f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
68222f70c32Sdrh ** operand.
68375897234Sdrh */
68475897234Sdrh struct Expr {
6851cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
6868e2ca029Sdrh   u8 dataType;           /* Either SQLITE_SO_TEXT or SQLITE_SO_NUM */
687b5a20d3cSdrh   u8 iDb;                /* Database referenced by this expression */
688e22a334bSdrh   u8 flags;              /* Various flags.  See below */
68975897234Sdrh   Expr *pLeft, *pRight;  /* Left and right subnodes */
690d99f7068Sdrh   ExprList *pList;       /* A list of expressions used as function arguments
691d99f7068Sdrh                          ** or in "<expr> IN (<expr-list)" */
69275897234Sdrh   Token token;           /* An operand token */
6936977fea8Sdrh   Token span;            /* Complete text of the expression */
694967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
6958e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
696967e8b73Sdrh   int iAgg;              /* When op==TK_COLUMN and pParse->useAgg==TRUE, pull
697967e8b73Sdrh                          ** result from the iAgg-th element of the aggregator */
698d99f7068Sdrh   Select *pSelect;       /* When the expression is a sub-select.  Also the
699d99f7068Sdrh                          ** right side of "<expr> IN (<select>)" */
70075897234Sdrh };
70175897234Sdrh 
70275897234Sdrh /*
7031f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
7041f16230bSdrh */
7051f16230bSdrh #define EP_FromJoin     0x0001  /* Originated in ON or USING clause of a join */
7061f16230bSdrh 
7071f16230bSdrh /*
7081f16230bSdrh ** These macros can be used to test, set, or clear bits in the
7091f16230bSdrh ** Expr.flags field.
7101f16230bSdrh */
7111f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
7121f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
7131f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
7141f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
7151f16230bSdrh 
7161f16230bSdrh /*
71775897234Sdrh ** A list of expressions.  Each expression may optionally have a
71875897234Sdrh ** name.  An expr/name combination can be used in several ways, such
71975897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
72075897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
721ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
72275897234Sdrh ** field is not used.
72375897234Sdrh */
72475897234Sdrh struct ExprList {
72575897234Sdrh   int nExpr;             /* Number of expressions on the list */
7264305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
7276d4abfbeSdrh   struct ExprList_item {
72875897234Sdrh     Expr *pExpr;           /* The list of expressions */
72975897234Sdrh     char *zName;           /* Token associated with this expression */
7308e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
7318e2ca029Sdrh     u8 isAgg;              /* True if this is an aggregate like count(*) */
7328e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
73375897234Sdrh   } *a;                  /* One entry for each expression */
73475897234Sdrh };
73575897234Sdrh 
73675897234Sdrh /*
737ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
738ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
739ad3cab52Sdrh **
740ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
741ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
742ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
743ad3cab52Sdrh **
744ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
745ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
746ad3cab52Sdrh **
747ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
748ad3cab52Sdrh **
749ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
75075897234Sdrh */
75175897234Sdrh struct IdList {
75275897234Sdrh   int nId;         /* Number of identifiers on the list */
7534305d103Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
7546d4abfbeSdrh   struct IdList_item {
755ad3cab52Sdrh     char *zName;      /* Name of the identifier */
756967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
757ad3cab52Sdrh   } *a;
758ad3cab52Sdrh };
759ad3cab52Sdrh 
760ad3cab52Sdrh /*
761ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
762ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
763ad3cab52Sdrh ** the SrcList.a[] array.
764d24cc427Sdrh **
765d24cc427Sdrh ** With the addition of multiple database support, the following structure
766d24cc427Sdrh ** can also be used to describe a particular table such as the table that
767d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
768d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
769d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
770ad3cab52Sdrh */
771ad3cab52Sdrh struct SrcList {
7724305d103Sdrh   u16 nSrc;        /* Number of tables or subqueries in the FROM clause */
7734305d103Sdrh   u16 nAlloc;      /* Number of entries allocated in a[] below */
774ad3cab52Sdrh   struct SrcList_item {
775113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
776ad3cab52Sdrh     char *zName;      /* Name of the table */
777ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
778daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
779daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
780ad3cab52Sdrh     int jointype;     /* Type of join between this table and the next */
78163eb5f29Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
782ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
783ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
784113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
78575897234Sdrh };
78675897234Sdrh 
78775897234Sdrh /*
78801f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
78901f3f253Sdrh */
79001f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
79101f3f253Sdrh #define JT_NATURAL   0x0002    /* True for a "natural" join */
792195e6967Sdrh #define JT_LEFT      0x0004    /* Left outer join */
793195e6967Sdrh #define JT_RIGHT     0x0008    /* Right outer join */
79401f3f253Sdrh #define JT_OUTER     0x0010    /* The "OUTER" keyword is present */
79501f3f253Sdrh #define JT_ERROR     0x0020    /* unknown or unsupported join type */
79601f3f253Sdrh 
79701f3f253Sdrh /*
7986b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
7996b56344dSdrh ** structure contains a single instance of this structure.  This structure
8006b56344dSdrh ** is intended to be private the the where.c module and should not be
8016b56344dSdrh ** access or modified by other modules.
8026b56344dSdrh */
8036b56344dSdrh struct WhereLevel {
8046b56344dSdrh   int iMem;            /* Memory cell used by this level */
8056b56344dSdrh   Index *pIdx;         /* Index used */
8066b56344dSdrh   int iCur;            /* Cursor number used for this index */
807487ab3caSdrh   int score;           /* How well this indexed scored */
8086b56344dSdrh   int brk;             /* Jump here to break out of the loop */
8096b56344dSdrh   int cont;            /* Jump here to continue with the next loop cycle */
8106b56344dSdrh   int op, p1, p2;      /* Opcode used to terminate the loop */
811ad2d8307Sdrh   int iLeftJoin;       /* Memory cell used to implement LEFT OUTER JOIN */
812ad2d8307Sdrh   int top;             /* First instruction of interior of the loop */
813d99f7068Sdrh   int inOp, inP1, inP2;/* Opcode used to implement an IN operator */
814c045ec51Sdrh   int bRev;            /* Do the scan in the reverse direction */
8156b56344dSdrh };
8166b56344dSdrh 
8176b56344dSdrh /*
81875897234Sdrh ** The WHERE clause processing routine has two halves.  The
81975897234Sdrh ** first part does the start of the WHERE loop and the second
82075897234Sdrh ** half does the tail of the WHERE loop.  An instance of
82175897234Sdrh ** this structure is returned by the first half and passed
82275897234Sdrh ** into the second half to give some continuity.
82375897234Sdrh */
82475897234Sdrh struct WhereInfo {
82575897234Sdrh   Parse *pParse;
826ad3cab52Sdrh   SrcList *pTabList;   /* List of tables in the join */
82719a775c2Sdrh   int iContinue;       /* Jump here to continue with next record */
82819a775c2Sdrh   int iBreak;          /* Jump here to break out of the loop */
8296b56344dSdrh   int nLevel;          /* Number of nested loop */
830832508b7Sdrh   int savedNTab;       /* Value of pParse->nTab before WhereBegin() */
831832508b7Sdrh   int peakNTab;        /* Value of pParse->nTab after WhereBegin() */
8326b56344dSdrh   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
83375897234Sdrh };
83475897234Sdrh 
83575897234Sdrh /*
8369bb61fe7Sdrh ** An instance of the following structure contains all information
8379bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
838a76b5dfcSdrh **
839a76b5dfcSdrh ** The zSelect field is used when the Select structure must be persistent.
840a76b5dfcSdrh ** Normally, the expression tree points to tokens in the original input
841a76b5dfcSdrh ** string that encodes the select.  But if the Select structure must live
842a76b5dfcSdrh ** longer than its input string (for example when it is used to describe
843a76b5dfcSdrh ** a VIEW) we have to make a copy of the input string so that the nodes
844a76b5dfcSdrh ** of the expression tree will have something to point to.  zSelect is used
845a76b5dfcSdrh ** to hold that copy.
846d11d382cSdrh **
847d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
848d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
849d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
850d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
851d11d382cSdrh ** in the VDBE that record the limit and offset counters.
8529bb61fe7Sdrh */
8539bb61fe7Sdrh struct Select {
8549bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
8557b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
8567b58daeaSdrh   u8 isDistinct;         /* True if the DISTINCT keyword is present */
857ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
8589bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
8599bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
8609bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
8619bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
862967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
8639bbca4c1Sdrh   int nLimit, nOffset;   /* LIMIT and OFFSET values.  -1 means not used */
8647b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
865a76b5dfcSdrh   char *zSelect;         /* Complete text of the SELECT command */
8669bb61fe7Sdrh };
8679bb61fe7Sdrh 
8689bb61fe7Sdrh /*
869fef5208cSdrh ** The results of a select can be distributed in several ways.
870fef5208cSdrh */
871fef5208cSdrh #define SRT_Callback     1  /* Invoke a callback with each row of result */
872fef5208cSdrh #define SRT_Mem          2  /* Store result in a memory cell */
87382c3d636Sdrh #define SRT_Set          3  /* Store result as unique keys in a table */
87482c3d636Sdrh #define SRT_Union        5  /* Store result as keys in a table */
87582c3d636Sdrh #define SRT_Except       6  /* Remove result from a UNION table */
8765974a30fSdrh #define SRT_Table        7  /* Store result as data with a unique key */
8772d0794e3Sdrh #define SRT_TempTable    8  /* Store result in a trasient table */
878d7489c39Sdrh #define SRT_Discard      9  /* Do not save the results anywhere */
879f46f905aSdrh #define SRT_Sorter      10  /* Store results in the sorter */
880142e30dfSdrh #define SRT_Subroutine  11  /* Call a subroutine to handle results */
881fef5208cSdrh 
882fef5208cSdrh /*
8832282792aSdrh ** When a SELECT uses aggregate functions (like "count(*)" or "avg(f1)")
8842282792aSdrh ** we have to do some additional analysis of expressions.  An instance
8852282792aSdrh ** of the following structure holds information about a single subexpression
8862282792aSdrh ** somewhere in the SELECT statement.  An array of these structures holds
8872282792aSdrh ** all the information we need to generate code for aggregate
8882282792aSdrh ** expressions.
8892282792aSdrh **
8902282792aSdrh ** Note that when analyzing a SELECT containing aggregates, both
8912282792aSdrh ** non-aggregate field variables and aggregate functions are stored
8922282792aSdrh ** in the AggExpr array of the Parser structure.
8932282792aSdrh **
8942282792aSdrh ** The pExpr field points to an expression that is part of either the
8952282792aSdrh ** field list, the GROUP BY clause, the HAVING clause or the ORDER BY
8962282792aSdrh ** clause.  The expression will be freed when those clauses are cleaned
8972282792aSdrh ** up.  Do not try to delete the expression attached to AggExpr.pExpr.
8982282792aSdrh **
8992282792aSdrh ** If AggExpr.pExpr==0, that means the expression is "count(*)".
9002282792aSdrh */
9012282792aSdrh struct AggExpr {
9022282792aSdrh   int isAgg;        /* if TRUE contains an aggregate function */
9032282792aSdrh   Expr *pExpr;      /* The expression */
9040bce8354Sdrh   FuncDef *pFunc;   /* Information about the aggregate function */
9052282792aSdrh };
9062282792aSdrh 
9072282792aSdrh /*
908f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
909f57b3399Sdrh ** the parser and down into all the parser action routine in order to
910f57b3399Sdrh ** carry around information that is global to the entire parse.
91175897234Sdrh */
91275897234Sdrh struct Parse {
91375897234Sdrh   sqlite *db;          /* The main database structure */
9144c504391Sdrh   int rc;              /* Return code from execution */
91575897234Sdrh   char *zErrMsg;       /* An error message */
91675897234Sdrh   Token sErrToken;     /* The token at which the error occurred */
91775897234Sdrh   Token sFirstToken;   /* The first token parsed */
91875897234Sdrh   Token sLastToken;    /* The last token parsed */
919326dce74Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
92075897234Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
92175897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
922836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
923e0bc4048Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
924e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
925e0bc4048Sdrh   u8 useAgg;           /* If true, extract field values from the aggregator
926e0bc4048Sdrh                        ** while generating expressions.  Normally false */
92775897234Sdrh   int nErr;            /* Number of errors seen */
928832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
92919a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
930fef5208cSdrh   int nSet;            /* Number of sets used so far */
9312282792aSdrh   int nAgg;            /* Number of aggregate expressions */
9327c972decSdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
9332282792aSdrh   AggExpr *aAgg;       /* An array of aggregate expressions */
9345cf590c1Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
935f0f258b1Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
936f0f258b1Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
93775897234Sdrh };
93875897234Sdrh 
939d99bc930Sdanielk1977 /*
94085e2096fSdrh ** An instance of the following structure can be declared on a stack and used
94185e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
94285e2096fSdrh */
94385e2096fSdrh struct AuthContext {
94485e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
94585e2096fSdrh   Parse *pParse;              /* The Parse structure */
94685e2096fSdrh };
94785e2096fSdrh 
94885e2096fSdrh /*
949b0c374ffSrdc ** Bitfield flags for P2 value in OP_PutIntKey and OP_Delete
950b0c374ffSrdc */
951b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
952b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
953b0c374ffSrdc #define OPFLAG_CSCHANGE  4    /* Set to update db->csChange */
954b0c374ffSrdc 
955b0c374ffSrdc /*
956d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
957d99bc930Sdanielk1977  * struct Trigger.
958d99bc930Sdanielk1977  *
959d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
960d99bc930Sdanielk1977  * 1. In the "trigHash" hash table (part of the sqlite* that represents the
961d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
962d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
963ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
964ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
965ad3cab52Sdrh  *    struct Table.
966d99bc930Sdanielk1977  *
967ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
968ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
969d99bc930Sdanielk1977  */
970d99bc930Sdanielk1977 struct Trigger {
971d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
972d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
973f0f258b1Sdrh   u8 iDb;                 /* Database containing this trigger               */
97479a519c0Sdrh   u8 iTabDb;              /* Database containing Trigger.table              */
975f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
976f0f258b1Sdrh   u8 tr_tm;               /* One of TK_BEFORE, TK_AFTER */
977d99bc930Sdanielk1977   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
978d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
979d99bc930Sdanielk1977                              the <column-list> is stored here */
980d99bc930Sdanielk1977   int foreach;            /* One of TK_ROW or TK_STATEMENT */
9814312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
982d99bc930Sdanielk1977 
983d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
984d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
985c3f9bad2Sdanielk1977 };
986d99bc930Sdanielk1977 
987d99bc930Sdanielk1977 /*
988d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
989d99bc930Sdanielk1977  * that is a part of a trigger-program.
990d99bc930Sdanielk1977  *
991d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
992d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
993d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
994d99bc930Sdanielk1977  * the first step of the trigger-program.
995d99bc930Sdanielk1977  *
996d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
997d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
998d99bc930Sdanielk1977  * value of "op" as follows:
999d99bc930Sdanielk1977  *
1000d99bc930Sdanielk1977  * (op == TK_INSERT)
1001d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
1002d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
1003d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
1004d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
1005d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1006d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
1007d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
1008ad3cab52Sdrh  *              statement, then this stores the column-names to be
1009ad3cab52Sdrh  *              inserted into.
1010d99bc930Sdanielk1977  *
1011d99bc930Sdanielk1977  * (op == TK_DELETE)
1012d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
1013d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
1014d99bc930Sdanielk1977  *              Otherwise NULL.
1015d99bc930Sdanielk1977  *
1016d99bc930Sdanielk1977  * (op == TK_UPDATE)
1017d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
1018d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1019d99bc930Sdanielk1977  *              Otherwise NULL.
1020d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
1021ad3cab52Sdrh  *              them to. See sqliteUpdate() documentation of "pChanges"
1022ad3cab52Sdrh  *              argument.
1023d99bc930Sdanielk1977  *
1024d99bc930Sdanielk1977  */
1025c3f9bad2Sdanielk1977 struct TriggerStep {
1026c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1027d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
1028a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
1029c3f9bad2Sdanielk1977 
1030c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
1031c3f9bad2Sdanielk1977 			  INSERT steps (when pExprList == 0) */
1032c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1033c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1034c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1035c3f9bad2Sdanielk1977 			   INSERT steps (when pSelect == 0)         */
1036c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
1037c3f9bad2Sdanielk1977 
1038c3f9bad2Sdanielk1977   TriggerStep * pNext; /* Next in the link-list */
1039c3f9bad2Sdanielk1977 };
1040c3f9bad2Sdanielk1977 
1041d99bc930Sdanielk1977 /*
1042d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
1043d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
1044d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
1045d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
1046d99bc930Sdanielk1977  *
1047d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
1048d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
1049d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
1050d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1051d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1052d99bc930Sdanielk1977  *
1053d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
1054d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1055d99bc930Sdanielk1977  * specified for individual triggers steps is used.
1056d99bc930Sdanielk1977  *
1057d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1058d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
1059d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1060d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
1061d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
1062d99bc930Sdanielk1977  * trigger continues.
1063d99bc930Sdanielk1977  *
1064d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
1065d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1066d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
1067d99bc930Sdanielk1977  */
1068d99bc930Sdanielk1977 struct TriggerStack {
1069d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
1070d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1071d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
1072d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
10736f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1074e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
1075e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1076c3f9bad2Sdanielk1977 };
1077c3f9bad2Sdanielk1977 
1078d99bc930Sdanielk1977 /*
1079f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
1080f26e09c8Sdrh ** routines as they walk the parse tree to make database references
1081f26e09c8Sdrh ** explicit.
1082f26e09c8Sdrh */
1083f26e09c8Sdrh typedef struct DbFixer DbFixer;
1084f26e09c8Sdrh struct DbFixer {
1085f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
1086f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
1087f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
1088f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
1089f26e09c8Sdrh };
1090f26e09c8Sdrh 
1091f26e09c8Sdrh /*
1092d99bc930Sdanielk1977  * This global flag is set for performance testing of triggers. When it is set
1093d99bc930Sdanielk1977  * SQLite will perform the overhead of building new and old trigger references
1094d99bc930Sdanielk1977  * even when no triggers exist
1095d99bc930Sdanielk1977  */
1096c3f9bad2Sdanielk1977 extern int always_code_trigger_setup;
1097c3f9bad2Sdanielk1977 
109875897234Sdrh /*
109975897234Sdrh ** Internal function prototypes
110075897234Sdrh */
110175897234Sdrh int sqliteStrICmp(const char *, const char *);
110275897234Sdrh int sqliteStrNICmp(const char *, const char *, int);
110375897234Sdrh int sqliteHashNoCase(const char *, int);
1104bb07e9a3Sdrh int sqliteIsNumber(const char*);
110575897234Sdrh int sqliteCompare(const char *, const char *);
110675897234Sdrh int sqliteSortCompare(const char *, const char *);
11079bbca4c1Sdrh void sqliteRealToSortable(double r, char *);
1108dcc581ccSdrh #ifdef MEMORY_DEBUG
11098c1238aeSdrh   void *sqliteMalloc_(int,int,char*,int);
1110dcc581ccSdrh   void sqliteFree_(void*,char*,int);
1111dcc581ccSdrh   void *sqliteRealloc_(void*,int,char*,int);
11126e142f54Sdrh   char *sqliteStrDup_(const char*,char*,int);
11136e142f54Sdrh   char *sqliteStrNDup_(const char*, int,char*,int);
1114ed6c8671Sdrh   void sqliteCheckMemory(void*,int);
1115dcc581ccSdrh #else
111675897234Sdrh   void *sqliteMalloc(int);
11178c1238aeSdrh   void *sqliteMallocRaw(int);
111875897234Sdrh   void sqliteFree(void*);
111975897234Sdrh   void *sqliteRealloc(void*,int);
11206e142f54Sdrh   char *sqliteStrDup(const char*);
11216e142f54Sdrh   char *sqliteStrNDup(const char*, int);
1122ed6c8671Sdrh # define sqliteCheckMemory(a,b)
1123dcc581ccSdrh #endif
1124483750baSdrh char *sqliteMPrintf(const char*, ...);
11255f968436Sdrh char *sqliteVMPrintf(const char*, va_list);
112675897234Sdrh void sqliteSetString(char **, const char *, ...);
112775897234Sdrh void sqliteSetNString(char **, ...);
1128da93d238Sdrh void sqliteErrorMsg(Parse*, const char*, ...);
1129982cef7eSdrh void sqliteDequote(char*);
113017f71934Sdrh int sqliteKeywordCode(const char*, int);
113180ff32f5Sdrh int sqliteRunParser(Parse*, const char*, char **);
113275897234Sdrh void sqliteExec(Parse*);
113375897234Sdrh Expr *sqliteExpr(int, Expr*, Expr*, Token*);
1134e1b6a5b8Sdrh void sqliteExprSpan(Expr*,Token*,Token*);
113575897234Sdrh Expr *sqliteExprFunction(ExprList*, Token*);
113675897234Sdrh void sqliteExprDelete(Expr*);
113775897234Sdrh ExprList *sqliteExprListAppend(ExprList*,Expr*,Token*);
113875897234Sdrh void sqliteExprListDelete(ExprList*);
1139e0bc4048Sdrh int sqliteInit(sqlite*, char**);
11401c2d8414Sdrh void sqlitePragma(Parse*,Token*,Token*,int);
11411c2d8414Sdrh void sqliteResetInternalSchema(sqlite*, int);
1142e0bc4048Sdrh void sqliteBeginParse(Parse*,int);
11435e00f6c7Sdrh void sqliteRollbackInternalChanges(sqlite*);
1144e0bc4048Sdrh void sqliteCommitInternalChanges(sqlite*);
1145969fa7c1Sdrh Table *sqliteResultSetOfSelect(Parse*,char*,Select*);
1146e0bc4048Sdrh void sqliteOpenMasterTable(Vdbe *v, int);
1147e5f9c644Sdrh void sqliteStartTable(Parse*,Token*,Token*,int,int);
114875897234Sdrh void sqliteAddColumn(Parse*,Token*);
11499cfcf5d4Sdrh void sqliteAddNotNull(Parse*, int);
11509cfcf5d4Sdrh void sqliteAddPrimaryKey(Parse*, IdList*, int);
1151382c0247Sdrh void sqliteAddColumnType(Parse*,Token*,Token*);
11527020f651Sdrh void sqliteAddDefaultValue(Parse*,Token*,int);
1153fcb78a49Sdrh int sqliteCollateType(const char*, int);
11548e2ca029Sdrh void sqliteAddCollateType(Parse*, int);
1155969fa7c1Sdrh void sqliteEndTable(Parse*,Token*,Select*);
11566276c1cbSdrh void sqliteCreateView(Parse*,Token*,Token*,Select*,int);
1157417be79cSdrh int sqliteViewGetColumnNames(Parse*,Table*);
11584ff6dfa7Sdrh void sqliteDropTable(Parse*, Token*, int);
115975897234Sdrh void sqliteDeleteTable(sqlite*, Table*);
1160113088ecSdrh void sqliteInsert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
116175897234Sdrh IdList *sqliteIdListAppend(IdList*, Token*);
1162ad2d8307Sdrh int sqliteIdListIndex(IdList*,const char*);
1163113088ecSdrh SrcList *sqliteSrcListAppend(SrcList*, Token*, Token*);
1164ad3cab52Sdrh void sqliteSrcListAddAlias(SrcList*, Token*);
11656a3ea0e6Sdrh void sqliteSrcListAssignCursors(Parse*, SrcList*);
116675897234Sdrh void sqliteIdListDelete(IdList*);
1167ad3cab52Sdrh void sqliteSrcListDelete(SrcList*);
11684925ca00Sdrh void sqliteCreateIndex(Parse*,Token*,SrcList*,IdList*,int,Token*,Token*);
1169d24cc427Sdrh void sqliteDropIndex(Parse*, SrcList*);
117038640e15Sdrh void sqliteAddKeyType(Vdbe*, ExprList*);
117138640e15Sdrh void sqliteAddIdxKeyType(Vdbe*, Index*);
11721b2e0329Sdrh int sqliteSelect(Parse*, Select*, int, int, Select*, int, int*);
1173ad3cab52Sdrh Select *sqliteSelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
11749bbca4c1Sdrh                         int,int,int);
11759bb61fe7Sdrh void sqliteSelectDelete(Select*);
1176ff78bd2fSdrh void sqliteSelectUnbind(Select*);
1177812d7a21Sdrh Table *sqliteSrcListLookup(Parse*, SrcList*);
11785cf590c1Sdrh int sqliteIsReadOnly(Parse*, Table*, int);
1179113088ecSdrh void sqliteDeleteFrom(Parse*, SrcList*, Expr*);
1180113088ecSdrh void sqliteUpdate(Parse*, SrcList*, ExprList*, Expr*, int);
11816a3ea0e6Sdrh WhereInfo *sqliteWhereBegin(Parse*, SrcList*, Expr*, int, ExprList**);
118275897234Sdrh void sqliteWhereEnd(WhereInfo*);
118375897234Sdrh void sqliteExprCode(Parse*, Expr*);
1184268380caSdrh int sqliteExprCodeExprList(Parse*, ExprList*, int);
1185f5905aa7Sdrh void sqliteExprIfTrue(Parse*, Expr*, int, int);
1186f5905aa7Sdrh void sqliteExprIfFalse(Parse*, Expr*, int, int);
1187d24cc427Sdrh Table *sqliteFindTable(sqlite*,const char*, const char*);
1188a69d9168Sdrh Table *sqliteLocateTable(Parse*,const char*, const char*);
1189d24cc427Sdrh Index *sqliteFindIndex(sqlite*,const char*, const char*);
11906d4abfbeSdrh void sqliteUnlinkAndDeleteIndex(sqlite*,Index*);
1191d24cc427Sdrh void sqliteCopy(Parse*, SrcList*, Token*, Token*, int);
1192dce2cbe6Sdrh void sqliteVacuum(Parse*, Token*);
11936f8c91caSdrh int sqliteRunVacuum(char**, sqlite*);
1194e17a7e33Sdrh int sqliteGlobCompare(const unsigned char*,const unsigned char*);
1195dce2cbe6Sdrh int sqliteLikeCompare(const unsigned char*,const unsigned char*);
1196cce7d176Sdrh char *sqliteTableNameFromToken(Token*);
1197cce7d176Sdrh int sqliteExprCheck(Parse*, Expr*, int, int*);
1198c9b84a1fSdrh int sqliteExprType(Expr*);
1199d8bc7086Sdrh int sqliteExprCompare(Expr*, Expr*);
1200cce7d176Sdrh int sqliteFuncId(Token*);
12016a3ea0e6Sdrh int sqliteExprResolveIds(Parse*, SrcList*, ExprList*, Expr*);
12022282792aSdrh int sqliteExprAnalyzeAggregates(Parse*, Expr*);
1203d8bc7086Sdrh Vdbe *sqliteGetVdbe(Parse*);
1204bbd82df6Sdrh void sqliteRandomness(int, void*);
1205001bbcbbSdrh void sqliteRollbackAll(sqlite*);
12068bf8dc92Sdrh void sqliteCodeVerifySchema(Parse*, int);
12071c92853dSdrh void sqliteBeginTransaction(Parse*, int);
1208c4a3c779Sdrh void sqliteCommitTransaction(Parse*);
1209c4a3c779Sdrh void sqliteRollbackTransaction(Parse*);
12109208643dSdrh int sqliteExprIsConstant(Expr*);
1211e4de1febSdrh int sqliteExprIsInteger(Expr*, int*);
1212a9f9d1c0Sdrh int sqliteIsRowid(const char*);
121338640e15Sdrh void sqliteGenerateRowDelete(sqlite*, Vdbe*, Table*, int, int);
121438640e15Sdrh void sqliteGenerateRowIndexDelete(sqlite*, Vdbe*, Table*, int, char*);
12150ca3e24bSdrh void sqliteGenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
121670ce3f0cSdrh void sqliteCompleteInsertion(Parse*, Table*, int, char*, int, int, int);
1217cd44690aSdrh int sqliteOpenTableAndIndices(Parse*, Table*, int);
1218cabb0819Sdrh void sqliteBeginWriteOperation(Parse*, int, int);
12191c92853dSdrh void sqliteEndWriteOperation(Parse*);
1220ff78bd2fSdrh Expr *sqliteExprDup(Expr*);
12214b59ab5eSdrh void sqliteTokenCopy(Token*, Token*);
1222ff78bd2fSdrh ExprList *sqliteExprListDup(ExprList*);
1223ad3cab52Sdrh SrcList *sqliteSrcListDup(SrcList*);
1224ff78bd2fSdrh IdList *sqliteIdListDup(IdList*);
1225ff78bd2fSdrh Select *sqliteSelectDup(Select*);
12260bce8354Sdrh FuncDef *sqliteFindFunction(sqlite*,const char*,int,int,int);
122728f4b688Sdrh void sqliteRegisterBuiltinFunctions(sqlite*);
12287014aff3Sdrh void sqliteRegisterDateTimeFunctions(sqlite*);
1229247be43dSdrh int sqliteSafetyOn(sqlite*);
1230247be43dSdrh int sqliteSafetyOff(sqlite*);
1231c22bd47dSdrh int sqliteSafetyCheck(sqlite*);
1232e0bc4048Sdrh void sqliteChangeCookie(sqlite*, Vdbe*);
1233f0f258b1Sdrh void sqliteBeginTrigger(Parse*, Token*,int,int,IdList*,SrcList*,int,Expr*,int);
1234f0f258b1Sdrh void sqliteFinishTrigger(Parse*, TriggerStep*, Token*);
123579a519c0Sdrh void sqliteDropTrigger(Parse*, SrcList*);
123679a519c0Sdrh void sqliteDropTriggerPtr(Parse*, Trigger*, int);
1237dc379456Sdrh int sqliteTriggersExist(Parse* , Trigger* , int , int , int, ExprList*);
12386f34903eSdanielk1977 int sqliteCodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
12396f34903eSdanielk1977                          int, int);
1240dc379456Sdrh void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1241f0f258b1Sdrh void sqliteDeleteTriggerStep(TriggerStep*);
1242dc379456Sdrh TriggerStep *sqliteTriggerSelectStep(Select*);
1243dc379456Sdrh TriggerStep *sqliteTriggerInsertStep(Token*, IdList*, ExprList*, Select*, int);
1244dc379456Sdrh TriggerStep *sqliteTriggerUpdateStep(Token*, ExprList*, Expr*, int);
1245dc379456Sdrh TriggerStep *sqliteTriggerDeleteStep(Token*, Expr*);
12461d1f3055Sdrh void sqliteDeleteTrigger(Trigger*);
124701f3f253Sdrh int sqliteJoinType(Parse*, Token*, Token*, Token*);
1248c2eef3b3Sdrh void sqliteCreateForeignKey(Parse*, IdList*, Token*, IdList*, int);
1249c2eef3b3Sdrh void sqliteDeferForeignKey(Parse*, int);
1250ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
12516a3ea0e6Sdrh   void sqliteAuthRead(Parse*,Expr*,SrcList*);
1252e22a334bSdrh   int sqliteAuthCheck(Parse*,int, const char*, const char*, const char*);
125385e2096fSdrh   void sqliteAuthContextPush(Parse*, AuthContext*, const char*);
125485e2096fSdrh   void sqliteAuthContextPop(AuthContext*);
1255ed6c8671Sdrh #else
12566a3ea0e6Sdrh # define sqliteAuthRead(a,b,c)
12577a73eb48Sdrh # define sqliteAuthCheck(a,b,c,d,e)    SQLITE_OK
125885e2096fSdrh # define sqliteAuthContextPush(a,b,c)
12597a73eb48Sdrh # define sqliteAuthContextPop(a)  ((void)(a))
1260ed6c8671Sdrh #endif
12614d189ca4Sdrh void sqliteAttach(Parse*, Token*, Token*, Token*);
12621c2d8414Sdrh void sqliteDetach(Parse*, Token*);
1263bb07e9a3Sdrh int sqliteBtreeFactory(const sqlite *db, const char *zFilename,
1264bb07e9a3Sdrh                        int mode, int nPg, Btree **ppBtree);
1265f26e09c8Sdrh int sqliteFixInit(DbFixer*, Parse*, int, const char*, const Token*);
1266f26e09c8Sdrh int sqliteFixSrcList(DbFixer*, SrcList*);
1267f26e09c8Sdrh int sqliteFixSelect(DbFixer*, Select*);
1268f26e09c8Sdrh int sqliteFixExpr(DbFixer*, Expr*);
1269f26e09c8Sdrh int sqliteFixExprList(DbFixer*, ExprList*);
1270f26e09c8Sdrh int sqliteFixTriggerStep(DbFixer*, TriggerStep*);
1271eb9a9e88Sdrh double sqliteAtoF(const char *z, const char **);
12725f968436Sdrh char *sqlite_snprintf(int,char*,const char*,...);
1273202b2df7Sdrh int sqliteFitsIn32Bits(const char *);
1274998b56c3Sdanielk1977 
1275998b56c3Sdanielk1977 unsigned char *sqlite3utf16to8(const void *pData, int N);
1276998b56c3Sdanielk1977 void *sqlite3utf8to16be(const unsigned char *pIn, int N);
1277998b56c3Sdanielk1977 void *sqlite3utf8to16le(const unsigned char *pIn, int N);
1278998b56c3Sdanielk1977 void sqlite3utf16to16le(void *pData, int N);
1279998b56c3Sdanielk1977 void sqlite3utf16to16be(void *pData, int N);
1280